latestOpenAPI 3.0.22026-08-10312271.6 KB

c5159bc39a84

Orders

Get shipments

get a list with all shipments for this order

get/orders/{orderId}/shipments

Path parameters

orderIdinteger required

spreadconnect order id

Response

idinteger

shipment id

orderIdinteger

spreadconnect order id

orderReferenceinteger

order reference from spreadconnect, can be changed after order updates

externalOrderReferencestring

external order reference from merchant (you)

orderItemReferencesinteger[]

spreadconnect order item references

externalOrderItemReferencesstring[]

external order item references

closedDatestring

ready for shipment date

sentDatestring

sent date

Example response

[
  {
    "shipping": {
      "address": {
        "company": "Example Ltd.",
        "firstName": "Joshua",
        "lastName": "Anderson",
        "street": "1572 Roseytown Rd",
        "streetAnnex": "2nd Floor",
        "city": "Greensburg",
        "country": "US",
        "state": "AL",
        "zipCode": "15601"
      },
      "type": {
        "id": "29",
        "company": "DHL",
        "name": "International Standard",
        "description": "No tracking provided. May be subject to import taxes, customs, and duties upon delivery."
      },
      "price": {
        "amount": 21.56,
        "taxRate": 19,
        "taxAmount": 12.45,
        "currency": "USD"
      }
    }
  }
]