Order API - Get Supplier Delivery Details

Get supplier delivery details

Endpoint: GET *base*/supplier-deliveries/*supplierDeliveryId*/details
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

Both id and deliveryId from List supplier deliveries can be used to fetch a supplier delivery.

GET <base>/supplier-deliveries/*supplierDeliveryId* HTTP/1.1

Response

200 Content-type: application/json

status
boolean
required

ok if success, else no.

delivery
object
required

Information about this specific supplier order delivery.

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.

productsQty
int
optional

The total quantity of products in this supplier order.

orders
array
optional

The list of orders that has reserved products for this supplier order delivery.

orderId
string
optional

The order ID for the customer order.

accountId
string
optional

The account ID for the customer.

accountName
string
optional

The name of the account.

buyer
string
optional

The name of the buyer from account placing the order.

carrier
string
optional

The preferred carrier for this account.

service
string
optional

The preferred carrier service for this account.

paymentTerms
string
optional

The payment terms defined for this order.

shippingTerms
string
optional

The shipping terms defined for this order.

poNumber
string
optional

PO number used when placing the order.

deliveryName deliveryCompany deliveryEmail deliveryCell deliveryTele deliveryAddress deliveryCoaddress deliveryZipcode deliveryCity deliveryState
string
optional

The address the order should be delivered to.

deliveryCountry
string
optional

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

products
array
optional

The product items in this supplier order delivery. 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 order deliveries:

quantity
int
optional

The amount of product items reserved from this supplier order delivery to the customer order.

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",
  "delivery": {
    "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,
    "orders": [
      {
        "orderId": "83982",
        "accountId": "478",
        "accountName": "Internal ROW",
        "buyer": "Internal ROW, John ",
        "carrier": "",
        "service": "",
        "other": "Other Comment",
        "paymentTerms": "30 Net",
        "shippingTerms": "Ex. Works",
        "poNumber": "Pre Spring 17",
        "deliveryName": "John Doe",
        "deliveryCompany": "A Company",
        "deliveryEmail": "info@example.com",
        "deliveryCell": "",
        "deliveryTele": "0",
        "deliveryAddress": "Skogsgatan 123",
        "deliveryCoaddress": "C/O: Warehouse",
        "deliveryZipcode": "12345",
        "deliveryCity": "Stockholm",
        "deliveryState": "0",
        "deliveryCountry": "SE",
        "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"
          }
        ]
      },
      { "orderId": "..."}
    ]
  }
}