Order API - Get Supplier Order

Get supplier order

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

List the products inside a supplier order.

Parameters

xml
boolean
optional

Response in xml format instead of json.

Request example

GET <base>/supplier-orders/*supplierOrderId* HTTP/1.1

Response

200 Content-type: application/json

status
boolean
required

ok if success, else no.

order
object
required

Information about this specific supplier order.

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.

products
array
optional

The product items in this supplier order. Most of the fields are described in the :ref:Get stock response <order-api-get-stock-response> but the following ones are specific to supplier orders:

quantity
int
optional

The amount of product items ordered.

cost
string
optional

The cost / pcs for this item.

costCurrency
string
optional

The currency code for the cost / pcs. ISO-Alpha-2 (SE, US, GB etc).

Response example

{
  "status": "ok",
  "order": {
    "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,
    "products": [
      {
        "sku": "12019005",
        "variantSku": "A",
        "sizeSku": "",
        "brand": "Kronan",
        "collection": "ALL",
        "product": "Bike Lady 0 speed BLACK",
        "variant": "SVART",
        "size": "ONE SIZE",
        "ean": "898989891212",
        "weight": 22,
        "weightUnit": "kg",
        "quantity": 122
        "cost": "9.40",
        "costCurrency": "USD"
      },
      {
        "sku": "12019007",
        "variantSku": "A",
        "sizeSku": "",
        "brand": "Kronan",
        "collection": "ALL",
        "product": "Bike Lady 0 speed BLUE",
        "variant": "BLUE",
        "size": "ONE SIZE",
        "ean": "898989891213",
        "weight": 22,
        "weightUnit": "kg",
        "quantity": 342,
        "cost": "12.40",
        "costCurrency": "EUR"
      }
    ]
  }
}