POST
/
api-order
/
orders
/
shipments-bulk
curl --request POST \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-order/orders/shipments-bulk \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '[
  {
    "orderId": "2947-5955-82579",
    "shipments": [
      {
        "shipmentRef": "ref-1234",
        "shipmentCarrier": "FedEx",
        "shipmentCarrierUrl": "https://www.fedex.com/",
        "trackingNumber": "2345367890876543",
        "lineItems": [
          {
            "lineItemId": 1,
            "quantity": 2
          }
        ],
        "shipmentStatus": "Delivered",
        "shippedDate": "<string>",
        "estimatedDeliveryDate": "<string>"
      }
    ]
  }
]'
{
  "successMessages": [
    "Order: 1729-8742-69296 was sucessfully imported",
    "Order: 1742-1203-79830 was sucessfully imported"
  ],
  "errorMessages": [
    "Order: 6562-1726-73447 - Error: Invalid Item Quantity",
    "Order: 2224-7457-16398 - Error: Invalid Item Quantity"
  ]
}

Headers

​
x-api-key
string
Example:

"0LybWR49k95cCwYh3cu0waCYoh4H2Eux2J52wn4k"

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Body

application/json · object[]
​
orderId
string
required
Required string length: 15
Example:

"2947-5955-82579"

​
shipments
object[]
required

Response

200
application/json
Successfully Added shipment
​
successMessages
string[]
Example:
[
  "Order: 1729-8742-69296 was sucessfully imported",
  "Order: 1742-1203-79830 was sucessfully imported"
]
​
errorMessages
string[]
Example:
[
  "Order: 6562-1726-73447 - Error: Invalid Item Quantity",
  "Order: 2224-7457-16398 - Error: Invalid Item Quantity"
]