XM

Retrieve Single Shipping Method

Path:

GET https://{baseurl}/api-shipping/shipping/{ship-method ID}

Enables you to get the details of a specific shipping method, by shipping method ID.

Headers

Content-Type : application/json

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

Parameters

Type : path

Name : The shipping method ID to retrieve the details of the selected shipping method.

Required: true

Sample Request

GET https://{baseurl}/api-shipping/shipping/10034

Sample Response

Response Code: 200

Message: OK

You will see this message when the details of the shipping method are successfully retrieved.

{
"_id": "60b907db27585000080d66ed",
"dimension": {
"min": {
"height": 0,
"length": 50,
"width": 0
},
"max": {
"height": 10,
"length": 0,
"width": 0
}
},
"addressType": [
"PO",
"Business",
"Residence",
"APO",
"MPO"
],
"channel": [
12,
13
],
"deleted": false,
"name": "DHL - Documentation",
"description": "Guaranteed delivery by 9pm tomorrow.",
"taxCode": "FR123456",
"minimumDays": 2,
"maximumDays": 4,
"cutOffTime": 1600,
"cost": 5.99,
"region": "CA",
"createdBy": "41224d776a326fb40f000001",
"shippingMethodId": 10034,
"createdAt": "2021-06-03T16:48:27.894Z",
"updatedAt": "2021-06-03T16:48:27.894Z",
"__v": 0
}

Response Code: 404

Message: Not Found

Description: You will see this message when the ShipMethodId is incorrect.

{
"code": "SHIPPING_METHOD_NOT_FOUND",
"message": "Shipping Method Not Found."
}

Error Code: 500

Message: Internal Server Error

Description: You will see this error when the account number is incorrect in the x-site-context (for a multi-tenent client).

Change Log

  • June - 2021

  • July - 2020 First updated