XM
Powered By GitBook
Retrieve Shipping by shipTo-ID
Path:
1
GET https://{baseurl}/api-cart/ship-to/{ship-toID}
Copied!
This API enables user's to review/confirm their shipping details by passing the shipToId as a path parameter.

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 24 character system-generated ship-to ID (from the Add Shipping API)
Required: true

Sample Request

1
https://{baseurl}/api-cart/ship-to/6080320cdd745b0008b98784
Copied!

Response

Response Code: 200
Message: OK
Sample
1
{
2
"_id": "6080320cdd745b0008b98784",
3
"shipMethod": {
4
"cost": {
5
"currency": "USD",
6
"amount": 10
7
},
8
"shipMethodId": "10002",
9
"shipmentCarrier": "Fedex",
10
"shipmentMethod": "Next Day"
11
},
12
"address": {
13
"phone": {
14
"number": "123-992-9404",
15
"kind": "Mobile"
16
},
17
"name": {
18
"first": "John",
19
"last": "Smith"
20
},
21
"street1": "10400 NE 4th St ",
22
"city": "Bellevue",
23
"state": "WA",
24
"country": "United States",
25
"zipCode": "98004",
26
"kind": "shipping",
27
"email": "[email protected]"
28
},
29
"billTo": [
30
"5f5020443e62350007fe285f"
31
],
32
"shipToType": "SHIP_TO_ADDRESS",
33
"taxCode": "FR1000",
34
"cartId": "5f8f0da2d4cc8e00084b9e8e",
35
"shipToId": 747,
36
"createdAt": "2021-04-21T14:09:16.285Z",
37
"updatedAt": "2021-04-21T14:09:16.285Z",
38
"__v": 0
39
}
Copied!
Error Code: 404
Message: Not found
Description: You will see this error when the specified ship-to ID doesn't exist in the system.
1
{
2
"code": "SHIPTO_NOT_FOUND",
3
"message": "Ship-to 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 2mo ago
Copy link
Contents
Change Log