XM
Members
Retrieve Single Shipping Method
This documentation is now outdated, please find the latest docs for this endpoint here
Path:
1
GET https://{baseurl}/api-shipping/shipping/{ship-method ID}
Copied!
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

1
GET https://{baseurl}/api-shipping/shipping/10034
Copied!

Sample Response

Response Code: 200
Message: OK
You will see this message when the details of the shipping method are successfully retrieved.
1
{
2
"_id": "60b907db27585000080d66ed",
3
"dimension": {
4
"min": {
5
"height": 0,
6
"length": 50,
7
"width": 0
8
},
9
"max": {
10
"height": 10,
11
"length": 0,
12
"width": 0
13
}
14
},
15
"addressType": [
16
"PO",
17
"Business",
18
"Residence",
19
"APO",
20
"MPO"
21
],
22
"channel": [
23
12,
24
13
25
],
26
"deleted": false,
27
"name": "DHL - Documentation",
28
"description": "Guaranteed delivery by 9pm tomorrow.",
29
"taxCode": "FR123456",
30
"minimumDays": 2,
31
"maximumDays": 4,
32
"cutOffTime": 1600,
33
"cost": 5.99,
34
"region": "CA",
35
"createdBy": "41224d776a326fb40f000001",
36
"shippingMethodId": 10034,
37
"createdAt": "2021-06-03T16:48:27.894Z",
38
"updatedAt": "2021-06-03T16:48:27.894Z",
39
"__v": 0
40
}
Copied!
Response Code: 404
Message: Not Found
Description: You will see this message when the ShipMethodId is incorrect.
1
{
2
"code": "SHIPPING_METHOD_NOT_FOUND",
3
"message": "Shipping Method Not Found."
4
}
Copied!
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
Last modified 1mo ago
Copy link
Contents
Change Log