Skip to main content
POST
/
api-order
/
orders
/
shipments
Add shipment to order
curl --request POST \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-order/orders/shipments \
  --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>"
    }
  ]
}'
{
  "orderId": "4217-7227-80339",
  "status": "Successfully added shipment"
}

Headers

​
x-api-key
string
Example:
​
x-site-context
string
required
Example:

Body

application/json
​
orderId
string
required
Required string length: 15
Example:
​
shipments
object[]
required
Minimum length: 1

Response

​
orderId
string
Example:
​
status
string
Example: