Sales Order - API Reference

Filter Parameters

Used to filter a list of orders/baskets returned, except id which returns a singular.

Action Parameters

The following parameters should be used for advanced processing of the data, and is usually focused on a "single order" GET or POST

Accepted date format is yyy-MM-dd HH:mm:ss. If the time is not provided, then it will default to midnight time.

Useful use cases for a courier company

1. Get all orders that are ready to ship (paid status)

Return all orders that are ready to ship. Use GET to retrieve the data.
EndPoint: https://api.cms-tool.net/webapps/api/basket?readyToShip=1

2. Update an existing order status as shipped (Courier approach)

Assuming you are a courier company, just provide only the minimal data to update your order. The data is provided as a "data" field, or as POST content in JSON format.

The UpdateShippingStatus action will update shipping dates and shipping status, and send a notification to the customer with the courier details, unless you also provide the parameter ?doNotSendNotification=1

EndPoint: https://api.cms-tool.net/webapps/api/order?doAction=UpdateShippingStatus

{
  "id": 26845824,
  "b_courier_ref": "999yourtrackcode999",
  "b_courier_url": "https://mycourier.com/mytrackingsystem?trackcode=999yourtrackcode999"
}

3. Update an existing order to shipped status

EndPoint: https://api.cms-tool.net/webapps/api/order

{
  "id": 26845824, 
  "b_shippedon": "2023-12-31 12:35:00",
  "b_status ": "Shipped"
}

Sample Output

Based on our endpoints, we can expect to receive a sample output data as below. A full same output is provided at the bottom of this page.

endpoint: The end point that is being used
resultCount: The total number of results returned
data: The actual data desried
success: true or false depicting the success of the query

{
       "b_cust_name": "my name",
       "b_ship_address": "123 Street",
       "b_ship_email": "name@myname.nz",
       "basketItems": [
           {
               "b_qty": 1.000,
               "pid": 2332685
   ...
           }
       ],
}