Get All Sales Orders
Search for all sales order details. Call returns comprehensive order details.
Headers
| Property | Value |
|---|---|
| Request Type | GET |
| Content Type | application-json |
| URL | {{EnvironmentURL}}/api/services/app/SalesOrder/GetAll |
Please see Environments under Getting Started for test and production environment URLs.
Request Parameters
| Property | Type | Description | Required |
|---|---|---|---|
| filter | string | Filtering on End user or Ordered by or Order reference (SalesorderId). | |
| markets | Int array | Markets for the orders. See available markets. Can be skipped if this filter is not used. The same parameter can be used multiple times if filtering on multiple values. | ✓ |
| statuses | Int array | Status of the orders. See available order statuses. Can be skipped if this filter is not used. The same parameter can be used multiple times if filtering on multiple values. | ✓ |
| startDate | dateTime | Start date of records. Returns orders that have been created from the start date. Can be skipped if this filter is not used. | |
| endDate | dateTime | End date of records. Returns orders that have been created from the start date to the end date. Can be skipped if this filter is not used. | |
| lastUpdatedDate | dateTime | Returns orders that have been modified from the LastUpdatedDate. Can be skipped if this filter is not used. | |
| sorting | string | "Orderdate" by default. | |
| maxResultCount | int | 10 by default. | ✓ |
Sample Request
If you want to get results by status, uses the "Statuses" parameter like so: (See Order Enums under constants for Order Status Enums)
{{QA}}/api/services/app/SalesOrder/GetAll?&Statuses=1
If you have a specific date range to check orders from, use the "StartDate" and "EndDate" parameters like so:
{{QA}}/api/services/app/SalesOrder/GetAll?&StartDate=2019-12-31T22%3A00%3A00.000Z&EndDate=2024-01-01T21%3A59%3A59.000Z
Response Parameters
| Property | Type | Description |
|---|---|---|
| token | string | Unique identifier of call instance. |
| totalCount | int | Total number of products returned. |
| items | Array of Objects | List of products. |
Items
| Property | Type | Description |
|---|---|---|
| siteId | string | The unique sales reference for this sales order. |
| salesOrderId | string | AVA order reference. |
| orderDate | Date | Date of order. |
| orderStatus | List | 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 patner 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. |
Sample Response
{
"result": {
"totalCount": 3,
"items": [
{
"orderStatusDescription": "Requested",
"markets": [
14
],
"overallOrderStatus": 1,
"lines": null,
"waybillNumbers": [],
"paymentMethod": "AxizCredit",
"deliveryMethod": "Collect",
"deliveryComments": null,
"siteId": null,
"salesOrderId": null,
"orderDate": "2023-12-05T14:23:52.259353",
"status": null,
"avaReference": "AVA-SJAXI9986-000W",
"resellerId": "SJAXI9986",
"resellerName": "AXIZ PTY LTD-TEST ACCOUNT",
"resellerReference": "AXI-018",
"enduserId": null,
"enduserName": "CloudTesting",
"created": {
"createdBy": "26226",
"name": "Jaco Isaaks",
"utc": "0001-01-01T00:00:00",
"emailAddress": "[email protected]",
"employeeNumber": null,
"phoneNumber": "+27659991407"
},
"billingAddress": null,
"deliveryAddress": {
"name": "CloudTesting",
"line1": "International Business Gateway",
"line2": "C/O New Road and 6th Rd",
"city": "Midrand",
"province": null,
"postalCode": "1685",
"countryCode": null,
"country": "South Africa"
},
"totals": {
"currency": "ZAR",
"symbol": "R",
"amount": 3021.05
},
"expectedReceiptDate": null,
"lastUpdatedUtc": "0001-01-01T00:00:00",
"originalDeliveryDate": "0001-01-01T00:00:00"
},
{
"orderStatusDescription": "Requested",
"markets": [
14
],
"overallOrderStatus": 1,
"lines": null,
"waybillNumbers": [],
"paymentMethod": "AxizCredit",
"deliveryMethod": "Collect",
"deliveryComments": null,
"siteId": null,
"salesOrderId": null,
"orderDate": "2023-11-21T12:16:14.726608",
"status": null,
"avaReference": "AVA-SJAXI9986-000R",
"resellerId": "SJAXI9986",
"resellerName": "AXIZ PTY LTD-TEST ACCOUNT",
"resellerReference": "AXI-013",
"enduserId": null,
"enduserName": null,
"created": {
"createdBy": "26226",
"name": "Jaco Isaaks",
"utc": "0001-01-01T00:00:00",
"emailAddress": "[email protected]",
"employeeNumber": null,
"phoneNumber": "+27659991407"
},
"billingAddress": null,
"deliveryAddress": {
"name": null,
"line1": "PO BOX 2794",
"line2": "",
"city": "RIVONIA",
"province": null,
"postalCode": "2128",
"countryCode": null,
"country": "South Africa"
},
"totals": {
"currency": "ZAR",
"symbol": "R",
"amount": 77.19
},
"expectedReceiptDate": null,
"lastUpdatedUtc": "0001-01-01T00:00:00",
"originalDeliveryDate": "0001-01-01T00:00:00"
},
{
"orderStatusDescription": "Requested",
"markets": [
14
],
"overallOrderStatus": 1,
"lines": null,
"waybillNumbers": [],
"paymentMethod": "AxizCredit",
"deliveryMethod": "Delivery",
"deliveryComments": "Testing - Do not process",
"siteId": null,
"salesOrderId": null,
"orderDate": "2022-11-03T14:19:10.5068731",
"status": null,
"avaReference": "BE01F6C7-AB55-4185-6073-08DABD575E83",
"resellerId": "SJAXI9986",
"resellerName": "AXIZ PTY LTD-TEST ACCOUNT",
"resellerReference": "Testing - Do not process",
"enduserId": "123456",
"enduserName": "TestCustomerHW",
"created": {
"createdBy": "25943",
"name": "admin admin",
"utc": "0001-01-01T00:00:00",
"emailAddress": "[email protected]",
"employeeNumber": null,
"phoneNumber": null
},
"billingAddress": null,
"deliveryAddress": {
"name": "TestCustomerHW",
"line1": "123 First str",
"line2": "123 First str",
"city": "Johannesburg",
"province": null,
"postalCode": "0123",
"countryCode": null,
"country": "South Africa"
},
"totals": {
"currency": "ZAR",
"symbol": "R",
"amount": 243.81
},
"expectedReceiptDate": null,
"lastUpdatedUtc": "0001-01-01T00:00:00",
"originalDeliveryDate": "0001-01-01T00:00:00"
}
]
},
"targetUrl": null,
"success": true,
"error": null,
"unAuthorizedRequest": false,
"__abp": true
}