XM
Powered By GitBook
Retrieve Pickup Points
Path:
1
GET https://{baseurl}/api-inventory/inventory/pickup-point/{itemId}
Copied!
Retrieves all the available pickup points for the requested item. When no pickup points are available for the requested item, the response returns a blank array for locations.

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 item ID to retrieve the pickup points for that item.
Required: true

Sample Request

1
GET https://{baseurl}/api-inventory/inventory/pickup-point/1000000050
Copied!

Sample Response

Response Code: 200
Message: OK
Description: You will see this message when the pickup points are successfully retrieved for the requested item.
1
{
2
"query": {
3
"limit": 10,
4
"offset": 0,
5
"count": 3
6
},
7
"locations": [
8
{
9
"_id": "60a5849fea4dcb00082ba853",
10
"channel": [
11
12
12
],
13
"isActive": true,
14
"isDefault": false,
15
"name": "ABC MANHATTEN STORE",
16
"address": {
17
"street1": "888 Broadway",
18
"street2": "",
19
"zipCode": "10003",
20
"city": "New York",
21
"state": "NY",
22
"country": "USA",
23
"phone": []
24
},
25
"pickup": true,
26
"type": "60a5844452e07600089d2cb7",
27
"kind": "Warehouse",
28
"locationId": 102,
29
"createdAt": "2021-05-19T21:35:27.947Z",
30
"updatedAt": "2021-06-04T21:53:00.733Z",
31
"__v": 0,
32
"coordinates": {
33
"latitude": 40.738417,
34
"longitude": -73.98985
35
}
36
},
37
{
38
"_id": "60a6e23ca02bd20008849641",
39
"channel": [
40
12
41
],
42
"isActive": true,
43
"isDefault": false,
44
"name": "USA Delivery",
45
"address": {
46
"street1": "2060 N Loop Rd",
47
"street2": "",
48
"city": "Alameda",
49
"state": "CA",
50
"country": "USA",
51
"zipCode": "94502",
52
"phone": []
53
},
54
"pickup": true,
55
"type": "60a5844452e07600089d2cb7",
56
"kind": "Warehouse",
57
"locationId": 104,
58
"createdAt": "2021-05-20T22:27:08.404Z",
59
"updatedAt": "2021-05-24T19:37:34.985Z",
60
"__v": 0,
61
"coordinates": {
62
"latitude": 37.729976,
63
"longitude": -122.243312
64
}
65
},
66
{
67
"_id": "60ac42ecc956070008e15ea6",
68
"channel": [
69
12
70
],
71
"isActive": true,
72
"isDefault": false,
73
"name": "New785",
74
"address": {
75
"street1": "5608 17th Avenue NW",
76
"street2": "suite 219",
77
"city": "Seattle",
78
"state": "WA",
79
"country": "United States",
80
"zipCode": "98107",
81
"phone": []
82
},
83
"pickup": true,
84
"type": "60a5844e52e07600089d2cb8",
85
"kind": "Warehouse",
86
"coordinates": {
87
"latitude": 47.669702,
88
"longitude": -122.378762
89
},
90
"locationId": 106,
91
"createdAt": "2021-05-25T00:21:00.738Z",
92
"updatedAt": "2021-05-25T00:21:00.738Z",
93
"__v": 0
94
}
95
]
96
}
Copied!
Error Code: 404
Message: Not Found
Description: You will see this error when the requested item is not found.
1
{
2
"code": "Item_NOT_FOUND",
3
"message": "Item 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