XPM

Add Shipment

Path:

POST /api-order/orders/shipments

Through this endpoint, we offer your customers the flexibilty to select shipment of their choice.

Headers

x-api-key:

Consumes

  • application/json

Produces

  • application/json

Parameters

Type: body

Name: orderID and Shipment details

Required: true

Sample Request

{
"orderId": "6379-6380-55110",
"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

Description: You'll see this message when the order shipment is successfully created.

Sample

{
"_id": "5ebb73b5684a750007fb121a",
"deleted": false,
"isLoggedIn": false,
"cartId": 78,
"items": [
{
"price": {
"discount": {
"price": 0,
"promosApplied": []
},
"sale": 0,
"base": 400,
"currency": "USD"
},
"discountedQuantity": 0,
"group": [
"5ddd1a156c5a5fed1e0d91fb"
],
"createdAt": "2020-05-13T04:12:36.802Z",
"updatedAt": "2020-05-13T04:13:51.203Z",
"_id": "5ebb73b5684a750007fb121b",
"itemId": 1000000016,
"quantity": 2,
"sku": "1586729",
"taxCode": "PH060771",
"lineItemId": 1,
"totalPrice": {
"currency": "USD",
"amount": 800
},
"id": "5ebb73b5684a750007fb121b"
}
],
"allPromosApplied": [],
"createdAt": "2020-05-13T04:12:37.389Z",
"updatedAt": "2020-05-13T04:13:51.228Z",
"__v": 0,
"totalAmount": {
"currency": "USD",
"amount": 800
},
"quantity": 2,
"errors": {
"inventory": [],
"price": [],
"promo": []
}
}

Changelog

  • Last updated - July 2020