XM

Add Shipment

Path:

POST /api-order/orders/shipments

This endpoint offer your customers the flexibilty to select shipment of their choice.

Headers

x-site-context : { "date": "2020-08-28T02:35:27.787Z", "channel": 12, "account": 5f493c9f30ec2a0007a94fc8", "stage": "sandbox" }

x-api-key : d41d8cd98f00b204e9800998ecf8427e

Consumes

  • application/json

Produces

  • application/json

Parameters

Type: body

Name: shipment details

Required: true

Sample Request

{
"orderId": "4217-7227-80339",
"shipments": [
{
"shipmentRef": "ref-100",
"shipmentCarrier": "Fedex",
"shipmentCarrierUrl": "https://fedex.com",
"trackingNumber": "2345367890876549",
"lineItems": [
{
"lineItemId": 2,
"quantity": 1
}
],
"shipmentStatus": "awaiting",
"estimatedDeliveryDate": "2019-03-01",
"shippedDate": "2020-04-05"
}
]
}

Response

Response Code: 200

Message: OK

Sample

{
"orderId": "4217-7227-80339",
"status": "Successfully added shipment"
}

Changelog

  • Last Updated - April 2021

  • First Updated - July 2020