XPM

Shipping - Create

Path:

POST /shipping/create

This endpoint enables your customers to easily select a shipping carrier and method of their choice. The response primarily includes a shippingMethodId, which is required for subsequent calls.

Headers

Content-Type:application/json

Consumes

  • application/json

Consumes

  • application/json

Parameters

Type: Body

Name: shipment details

Required: true

Sample Request

{
"name": "DHL - Next Day Delivery",
"description": "Guaranteed delivery by 9pm tomorrow.",
"taxCode": "FR123456",
"minimumDays": 2,
"maximumDays": 4,
"cutOffTime": 1600,
"cost": 5.99,
"channel": [100, 200],
"addressType": ["PO","Business"],
"region": "WA",
"createdBy": "41224d776a326fb40f000001"
}

2.0.6. Response

{
"name": "DHL - Next Day Delivery",
"shippingMethodId": 10006
}

Response Code: 200

Message: OK

Description: You will see this message when the shipment is successfully created.

Response Code: 404

Message: Not Found

Description: You will see this message when shipment details are invalid in the request body.

Sample

{
"name": "DHL - Next Day Delivery",
"shippingMethodId": 10006
}

Changelog

  • Last updated - July 2020