Order API - List supplier deliveries

List supplier deliveries

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

Get the incoming and not accepted deliveries that are connected to the warehouse this plugin is connected to.

Deliveries will be listed when these requirements are fulfilled:

  • Delivery created on a confirmed Supplier Order.
  • Supplier order has the Preferred Warehouse set to the "Supplier Delivery Warehouse" in the Plugin.
  • Delivery is not accepted yet.
  • Delivery has items in it.

Parameters

xml
boolean
optional

Response in xml format instead of json.

Request example

GET <base>/supplier-deliveries HTTP/1.1

Response

200 Content-type: application/json

status
string
required

ok if success, else no.

deliveries
array
optional

Array of deliveries returned

id
string
optional

Internal ID for the supplier order delivery.

deliveryId
string
optional

ID of the supplier order delivery. This is the ID communicated externally.

orderId
string
optional

ID of the supplier order.

supplierCountry
string
optional

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

created
datetime
optional

The date this supplier order delivery was created.

ETA
datetime
optional

Estimated time of arrival to the warehouse. This will be used to calculate what orders that should be automatically connected to this specific delivery.

ETD
datetime
optional

Estimated time of delivery for the customer.

Response example

{
  "status": "ok",
  "deliveries": [
    {
      "id": "364",
      "orderId": "957",
      "deliveryId": "957-1",
      "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
    },
    {
      "id": "365",
      "orderId": "957",
      "deliveryId": "957-2",
      "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
    }
  ]
}