XM
Members
Retrieve Available Shipping Methods
This documentation is now outdated, please find the latest docs for this endpoint here
Path:
1
GET https://{baseurl}/api-shipping/shipping/all?
Copied!
This API is similar to the Retrieve All Shipping Methods API but you can narrow down the search results by specifying filter criteria such as address type, channel and/or region. When there is no shipping method for the specified criteria, a blank array is shown as in the success response.

Headers

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

Parameters

Type : query
Name : The addressType, Channel, and/or region.
Required: true

Sample Request

1
GET https://{baseurl}/api-shipping/shipping/all?addressType=Residence&channel=12&region=CA
Copied!
Sample Response
Response Code: 200
Message: OK
Description: You will see this message when the shipment details are successfully retrieved for the attributes specified in the path.
Note: In case of incorrect or invalid query, a blank array is returned in the success response.
1
[
2
{
3
"_id": "607ef87d22e94700087d0d92",
4
"addressType": [
5
"PO",
6
"Business"
7
],
8
"channel": [
9
12
10
],
11
"deleted": false,
12
"name": FedEx",
13
"description": "Guaranteed Delivery",
14
"taxCode": "12",
15
"minimumDays": 12,
16
"maximumDays": 13,
17
"cutOffTime": 123,
18
"cost": 12,
19
"region": "CA",
20
"createdBy": "5fe2330c0ebbf100086392fd",
21
"shippingMethodId": 10105,
22
"createdAt": "2021-04-20T15:51:25.263Z",
23
"updatedAt": "2021-04-20T19:13:53.385Z",
24
"__v": 0
25
},
26
{
27
"_id": "607efded88d9c100086ef6f8",
28
"addressType": [
29
"PO",
30
"Business"
31
],
32
"channel": [
33
12
34
],
35
"deleted": false,
36
"name": "Ryder Canada",
37
"description": "Trust and Speed",
38
"taxCode": "CA657",
39
"minimumDays": 1,
40
"maximumDays": 4,
41
"cutOffTime": 8,
42
"cost": 9,
43
"region": "CA",
44
"createdBy": "5fe160ae4e6fb2000884f84d",
45
"shippingMethodId": 10106,
46
"createdAt": "2021-04-20T16:14:37.452Z",
47
"updatedAt": "2021-04-20T16:14:37.452Z",
48
"__v": 0
49
},
50
51
{
52
"_id": "607efdf488d9c100086ef700",
53
"addressType": [
54
"PO",
55
"Business"
56
],
57
"channel": [
58
12
59
],
60
"deleted": false,
61
"name": "Ryder Canada",
62
"description": "Trust and Speed",
63
"taxCode": "CA657",
64
"minimumDays": 1,
65
"maximumDays": 4,
66
"cutOffTime": 8,
67
"cost": 9,
68
"region": "CA",
69
"createdBy": "5fe160ae4e6fb2000884f84d",
70
"shippingMethodId": 10114,
71
"createdAt": "2021-04-20T16:14:44.567Z",
72
"updatedAt": "2021-04-20T16:14:44.567Z",
73
"__v": 0
74
},
75
{
76
"_id": "607efdf688d9c100086ef701",
77
"addressType": [
78
"PO",
79
"Business"
80
],
81
"channel": [
82
12
83
],
84
"deleted": false,
85
"name": "Ryder Canada",
86
"description": "Trust and Speed",
87
"taxCode": "CA657",
88
"minimumDays": 1,
89
"maximumDays": 4,
90
"cutOffTime": 8,
91
"cost": 9,
92
"region": "CA",
93
"createdBy": "5fe160ae4e6fb2000884f84d",
94
"shippingMethodId": 10115,
95
"createdAt": "2021-04-20T16:14:46.938Z",
96
"updatedAt": "2021-04-20T16:14:46.938Z",
97
"__v": 0
98
},
99
{
100
"_id": "607efdf788d9c100086ef702",
101
"addressType": [
102
"PO",
103
"Business"
104
],
105
"channel": [
106
12
107
],
108
"deleted": false,
109
"name": "Ryder Canada",
110
"description": "Trust and Speed",
111
"taxCode": "CA657",
112
"minimumDays": 1,
113
"maximumDays": 4,
114
"cutOffTime": 8,
115
"cost": 9,
116
"region": "CA",
117
"createdBy": "5fe160ae4e6fb2000884f84d",
118
"shippingMethodId": 10116,
119
"createdAt": "2021-04-20T16:14:47.408Z",
120
"updatedAt": "2021-04-20T16:14:47.408Z",
121
"__v": 0
122
}
123
124
]
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