Get shipment

Order API v1

GET*base*/shipments/*shipmentId*

Authentication:API key

Will list the shipment with the corresponding shipment Id.

Parameters

order int optional	Return shipment for a specific order.
xml boolean optional	Response in xml format instead of json.
status string optional	Default value: goodtogo. Allowed values: inprogress, goodtogo, completed
newer_than date optional	Only return shipment newer than provided date
older_than date optional	Only return shipment older than provided date

Request example

GET <base>/shipment/1234 HTTP/1.1

Response

200 Content-type: application/json

status string required

ok if success, else no.

shipments array required

Array of shipments returned, will only be one returned if found. orderId string Id of the order. shipmentId string Id of the shipment. selectionId string Selection ID of the order. orderDate datetime Date when order was created. shouldCapture boolean If the shipment needs to be captured before being shipped. deliveryNote string optional URL to a PDF delivery note for the shipment. shippingTerms object optional Shipping Terms object selected on this shipment. id int Id of the specific shipping terms object. name string Name of the specific shipping terms object. description string Description of the specific shipping terms object. paymentTerms object optional Payment Terms object selected on this shipment. id int Id of the specific payment terms object. name string Name of the specific payment terms object. description string Description of the specific payment terms object. proforma string optional URL to a PDF proforma for the shipment. defaultCarrier string optional Name of the carrier for this shipment. deliveryService string optional Name of the delivery service for this shipment. invoices array optional URLs to PDF invoices for the shipment. Will only be set if any invoices exists. products array Products inside the shipment. lineId string Id of the specific product item in this shipment. qty int Quantity of this specific product item. isBundle bool Flag showing if product is bundle isPartOfBundle int Bundle id bundle array Array of containing items for bundle taxBreakdown array Lists all tax rules applied to the order. description string Text description of tax rule. ex: VAT taxPercent float Percentage of tax. ex 25 value float How much tax. ex 20

Response example

HTTP/1.1 200 OK
Content-type: application/json

{
  "status": "ok",
  "shipments": [
    {
      "orderId": "83651",
      "selectionId": "ff805e6dc70f905553e2225c6977a27a",
      "orderDate": "2012-02-04 15:16:13",
      "cancelDate": "2012-08-04 15:16:13",
      "preferredDeliveryDate": "2012-05-04 15:16:13",
      "estimatedDeliveryDate": "2012-05-04 15:16:13",
      "orderStore": "retail",
      "orderCurrency": "EUR",
      "shipmentId": "83651-1",
      "customerId": "11627",
      "accountId": "0",
      "billingName": "Someones Name",
      "billingCompany": "",
      "billingAddress": "Examplestreet 1",
      "billingCoaddress": "",
      "billingCity": "Somecity",
      "billingState": "",
      "billingZipcode": "12345",
      "billingCountry": "DE",
      "billingEmail": "someone@example.com",
      "billingTele": "",
      "deliveryName": "Someones Name",
      "deliveryCompany": "",
      "deliveryEmail": "someone@example.com",
      "deliveryCell": "+4912345678",
      "deliveryTele": "",
      "deliveryAddress": "Examplestreet 1",
      "deliveryCoaddress": "",
      "deliveryZipcode": "12345",
      "deliveryCity": "Somecity",
      "deliveryState": "",
      "deliveryCountry": "DE",
      "billingVAT": "",
      "poNumber": "",
      "shippingList": "standard",
      "shippingTerms": {
         "id": 5, 
         "name": "ShippingTermName", 
         "description": "ShippingTermDescription"
      },
      "paymentTerms": {
         "id": 10, 
         "name": "PaymentTermName", 
         "description": "PaymentTermDescription"
      },
      "proforma": "http://.../proforma?shipment=83651-1",
      "deliveryNote": "http://../delnote?shipment=83651-1",
      "defaultCarrier": "Delivery Carrier",
      "deliveryService": "Delivery Service",
      "shipmentDate": "2019-07-01 12:56:00",
      "trackingNumber": "123456789",
      "trackingUrl": "https://www.dhl.com.pl/exp-en/express/tracking.html?AWB=123456789",
      "returnSlipTracking": "123456789",
      "invoices": [
        "https://online.klarna.com/invoice_public_show.yaws/invoice.pdf?invno=&orgno="
      ],
      "suspect": 0,
      "hold": 0,
      "paid": 1,
      "shouldCapture": 0,
      "shippingValue": 25,
      "voucherValue": 0,
      "grandTotalValue": 3978.75,
      "grandTotalTaxValue": 795.75,
      "taxAdded": 0,
      "taxDeducted": 0,
      "internalComment": "",
      "otherComment": "",
      "taxBreakdown": [
        {
          "description": "VAT",
          "taxPercent": 25,
          "value": 795.75
        }
      ],
      "products": [
        {
          "lineId": "43243",
          "sku": "S123K456U1",
          "variantSku": "",
          "sizeSku": "",
          "name": "Product #1",
          "variant": "White",
          "size": "XS",
          "ean": "1234567890123",
          "qty": 1,
          "originalPrice": 500.5,
          "price": 450.5,
          "weight": 2,
          "weightUnit": "kg",
          "countryOfOrigin": "DE",
          "harmCode": "12345",
          "comment": "",
          "warehouses": [
             {
                 "name": "Default warehouse",
                 "itemQty": "1"
             }
          ],
         "isBundle": false,
         "isPartOfBundle": "217"
        },
        {
          "lineId": "43244",
          "sku": "S123K456U2",
          "variantSku": "",
          "sizeSku": "",
          "name": "Product #2",
          "variant": "Blue",
          "size": "XS",
          "ean": "1234567890124",
          "qty": 2,
          "originalPrice": 200.5,
          "price": 180.5,
          "weight": 1.5,
          "weightUnit": "kg",
          "countryOfOrigin": "CI",
          "harmCode": "12345",
          "comment": "",
          "isBundle": true,
          "bundle": [
            {
              "lineId": "43243",
              "sku": "S123K456U1",
              "variantSku": "",
              "sizeSku": "",
              "name": "Product #1",
              "variant": "White",
              "size": "XS",
              "ean": "1234567890123",
              "qty": 1,
              "originalPrice": 500.5,
              "price": 450.5,
              "weight": 2,
              "weightUnit": "kg",
              "countryOfOrigin": "DE",
              "harmCode": "12345",
              "comment": "",
              "warehouses": [
                 {
                     "name": "Default warehouse",
                     "itemQty": "1"
                 }
              ],
             "isBundle": false,
             "isPartOfBundle": "217"
            },
         ]
        }
      ]
    }
  ]
}