Get Sales Order by ID

Search for sales order by a specific AVA reference. Call returns comprehensive sales order details.

Headers

Property	Value
Request Type	GET
Content Type	application-json
URL	{{EnvironmentURL}}/api/services/app/SalesOrder/GetSalesOrdersById

Please see Environments under Getting Started for test and production environment URLs.

Request Parameters

Property	Type	Description	Required
salesOrderId	string	The sales order id. Use AvaReference if it’s still a sales request.	✓

Sample Request

{
  "SalesOrderId": "AVA-SJAXI9986-0084"
}

Response Parameters

Property	Type	Description
siteId	string	The unique sales reference for this sales order.
salesOrderId	string	The sales order id.
orderDate	date	Date order was created.
orderStatus	string	List of statuses.
avaReference	GUID	Reference in Axiz Digital.
waybill	List	List of Waybill numbers associated with the order.
resellerId	string	The ResellerId is the Tenant Account Number in Axiz Digital.
resellerName	string	Partner name in Axiz Digital.
resellerReference	string	Reference for the reseller.
enduserId	string	Customer account number.
enduserName	string	The customer name.
billingAddress	string	Billing address.
deliveryAddress	string	The provided delivery address.
totals	string	Contains the currency and the amount.
expectedReceiptDate	Date	The expected delivery date.
created	string	Contains the date created and name and id of the user who created the order.
lastUpdatedUtc	dateTime	Date the record was last updated.
lines	List	List of sales order lines.
lineStatus	string	Specific line status.

Sample Response

{
  "result": {
    "orderStatusDescription": "Ordered",
    "markets": [],
    "overallOrderStatus": 2,
    "lines": [
      {
        "salesOrderId": null,
        "lineNumber": 0,
        "lineStatus": null,
        "deliveryNumber": null,
        "delivery": null,
        "programId": null,
        "itemId": "CFQ7TTC0MBMD",
        "description": "Microsoft 365 F1",
        "allocatedQuantity": 0,
        "deliveredQuantity": 0,
        "invoicedQuantity": 0,
        "quantity": 1,
        "unitPrice": 48.87,
        "unitPriceIncl": 56.2,
        "lineAmount": 48.87,
        "lineAmountIncl": 56.2,
        "expectedReceiptDate": null,
        "lastUpdatedUtc": "0001-01-01T00:00:00",
        "market": 2,
        "purchaseOption": null,
        "isBackOrder": false,
        "isQuantityReservation": false,
        "dealType": 0,
        "productConfigurationId": "CFQ7TTC0MBMD:0002:commercial",
        "purchaseOptionId": 146,
        "parentProductConfigurationId": null
      }
    ],
    "waybillNumbers": [],
    "paymentMethod": "AxizCloudCredit",
    "deliveryMethod": "Delivery",
    "deliveryComments": null,
    "siteId": null,
    "salesOrderId": null,
    "orderDate": "2024-06-18T10:01:53.9440799",
    "status": null,
    "avaReference": "AVA-SJAXI9986-0084",
    "resellerId": "SJAXI9986",
    "resellerName": "AXIZ PTY LTD-TEST ACCOUNT",
    "resellerReference": "AXI-259",
    "enduserId": null,
    "enduserName": "CloudTestAccountQA1",
    "created": {
      "createdBy": "26851",
      "name": "Kyle Bradshaw",
      "utc": "0001-01-01T00:00:00",
      "emailAddress": "[email protected]",
      "employeeNumber": null,
      "phoneNumber": null
    },
    "billingAddress": null,
    "deliveryAddress": null,
    "totals": {
      "currency": "ZAR",
      "symbol": "R",
      "amount": 56.2
    },
    "expectedReceiptDate": null,
    "lastUpdatedUtc": "0001-01-01T00:00:00",
    "originalDeliveryDate": "0001-01-01T00:00:00"
  },
  "targetUrl": null,
  "success": true,
  "error": null,
  "unAuthorizedRequest": false,
  "__abp": true
}