Get supplier delivery details

Order API v1
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
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.

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

Response

200 Content-type: application/json

status

string
required
ok if success, else no.

delivery

object
required

Information about this specific supplier order delivery.

id

string
Internal ID for the supplier order delivery.

deliveryId

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

orderId

string
ID of the supplier order.

supplierCountry

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

created

datetime
The date this supplier order delivery was created.

ETA

datetime
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
Estimated time of delivery for the customer.

productsQty

int
The total quantity of products in this supplier order.

orders

array

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

orderId

string
The order ID for the customer order.

accountId

string
The account ID for the customer.

accountName

string
The name of the account.

buyer

string
The name of the buyer from account placing the order.

carrier

string
The preferred carrier for this account.

service

string
The preferred carrier service for this account.

paymentTerms

string
The payment terms defined for this order.

shippingTerms

string
The shipping terms defined for this order.

poNumber

string
PO number used when placing the order.

deliveryName deliveryCompany deliveryEmail deliveryCell deliveryTele deliveryAddress deliveryCoaddress deliveryZipcode deliveryCity deliveryState

string
The address the order should be delivered to.

deliveryCountry

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

products

array

The product items in this supplier order delivery. Most of the fields are described in the Get stock response but the following ones are specific to supplier order deliveries:

quantity

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

cost

string
The cost / pcs for this item.

costCurrency

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

Response example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
{
  "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": "..."}
    ]
  }
}