XM
Powered By GitBook
Retrieve All Shipping Methods
Path:
1
GET https://{baseurl}/api-shipping/shipping/all
Copied!
Enables you to get all the configured shipping methods. When no shipping method is configured, a blank array is shown in the success response.
To retrieve the shipping methods based on specific criteria (such as address type, channel, and/or region), the Retrieve Available Shipping Methods API is recommended.

Headers

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

Parameters []

Sample Request

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

Sample Response

Response Code: 200
Message: OK
Description: You will see this message when all the shipping methods are successfully retrieved.
1
[
2
{
3
"_id": "607ef87d22e94700087d0d92",
4
"addressType": [
5
"PO",
6
"Business"
7
],
8
"channel": [
9
12
10
],
11
"deleted": false,
12
"name": "muhammad Umer waheed",
13
"description": "12312",
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": "607efdf488d9c100086ef700",
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": 10114,
46
"createdAt": "2021-04-20T16:14:44.567Z",
47
"updatedAt": "2021-04-20T16:14:44.567Z",
48
"__v": 0
49
},
50
{
51
"_id": "607f7bfbf9ca6c000877bb33",
52
"addressType": [
53
"PO",
54
"Business"
55
],
56
"channel": [
57
12
58
],
59
"deleted": false,
60
"name": "muhammad Umer waheed 2",
61
"description": "12",
62
"taxCode": "12",
63
"minimumDays": 12,
64
"maximumDays": 14,
65
"cutOffTime": 12,
66
"cost": 12,
67
"region": "CA",
68
"createdBy": "5fe2330c0ebbf100086392fd",
69
"shippingMethodId": 10120,
70
"createdAt": "2021-04-21T01:12:27.069Z",
71
"updatedAt": "2021-04-21T01:12:27.069Z",
72
"__v": 0
73
},
74
{
75
"_id": "607f7e6d1f50be0007a2411a",
76
"addressType": [
77
"PO",
78
"Business"
79
],
80
"channel": [
81
12
82
],
83
"deleted": false,
84
"name": "muhammad Umer waheed 4",
85
"description": "123",
86
"taxCode": "12",
87
"minimumDays": 12,
88
"maximumDays": 14,
89
"cutOffTime": 11,
90
"cost": 12,
91
"region": "CA",
92
"createdBy": "5fe2330c0ebbf100086392fd",
93
"shippingMethodId": 10127,
94
"createdAt": "2021-04-21T01:22:53.338Z",
95
"updatedAt": "2021-04-21T01:22:53.338Z",
96
"__v": 0
97
}
98
]
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 2mo ago
Copy link
Contents
Change Log