Order API - List supplier orders

List supplier orders

Endpoint: GET *base*/supplier-orders
Authentication: API Key

Get all confirmed supplier orders visible by the plugin.

Parameters

xml
boolean
optional

Response in xml format instead of json.

Request example

GET <base>/supplier-orders HTTP/1.1

Response

200 Content-type: application/json

status
string
required

ok if success, else no.

orders
array
optional

Array of orders returned

orderId
string
required

ID of the supplier order.

supplierCountry
string
optional

ISO-Alpha-2 (SE, US, GB etc).

created
datetime
optional

The date this supplier order was created.

ETA
datetime
optional

Estimated time of arrival to the warehouse. This will be used to calculate what orders that fits into a specific delivery window.

ETD
datetime
optional

Estimated time of delivery for the customer.

productsQty
int
optional

The total quantity of products in this supplier order.

Response example

{
  "status": "ok",
  "orders": [
    {
      "orderId": "957",
      "supplierName": "Falca",
      "supplierCountry": "ES",
      "created": "2019-01-28 01:15",
      "ETD": "2019-03-31 15:15",
      "ETA": "2019-04-05 20:15",
      "message": "Text entered by centra admin",
      "productsQty": 20000
    },
    {
      "orderId": "957",
      "supplierName": "Falca",
      "supplierCountry": "ES",
      "created": "2019-01-28 01:15",
      "ETD": "2019-03-31 15:15",
      "ETA": "2019-04-05 20:15",
      "message": "Text entered by centra admin",
      "productsQty": 10000
    }
  ]
}