XM

Retrieve Pickup Points

Path:

POST https://{baseurl}/api-inventory/inventory/pickup-point/{itemId}

Retrieves all the available pickup points for the requested item. When no pickup points are available for a requested item, the response returns a blank array for locations. To retrieve the inventory details for multiple items, the Retrieve Inventory for Multiple Items is recommended.

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.

Required: true

Sample Request

POST https://{baseurl}/api-inventory/inventory/pickup-point/{itemId}

Sample Response

Response Code: 200

Message: OK

Description: You will see this message when the pickup points are successfully retrieved for the requested item.

{
"query": {
"limit": 10,
"offset": 0,
"count": 3
},
"locations": [
{
"_id": "60a5849fea4dcb00082ba853",
"channel": [
12
],
"isActive": true,
"isDefault": false,
"name": "ABC MANHATTEN STORE",
"address": {
"street1": "888 Broadway",
"street2": "",
"zipCode": "10003",
"city": "New York",
"state": "NY",
"country": "USA",
"phone": []
},
"pickup": true,
"type": "60a5844452e07600089d2cb7",
"kind": "Warehouse",
"locationId": 102,
"createdAt": "2021-05-19T21:35:27.947Z",
"updatedAt": "2021-06-04T21:53:00.733Z",
"__v": 0,
"coordinates": {
"latitude": 40.738417,
"longitude": -73.98985
}
},
{
"_id": "60a6e23ca02bd20008849641",
"channel": [
12
],
"isActive": true,
"isDefault": false,
"name": "USA Delivery",
"address": {
"street1": "2060 N Loop Rd",
"street2": "",
"city": "Alameda",
"state": "CA",
"country": "USA",
"zipCode": "94502",
"phone": []
},
"pickup": true,
"type": "60a5844452e07600089d2cb7",
"kind": "Warehouse",
"locationId": 104,
"createdAt": "2021-05-20T22:27:08.404Z",
"updatedAt": "2021-05-24T19:37:34.985Z",
"__v": 0,
"coordinates": {
"latitude": 37.729976,
"longitude": -122.243312
}
},
{
"_id": "60ac42ecc956070008e15ea6",
"channel": [
12
],
"isActive": true,
"isDefault": false,
"name": "New785",
"address": {
"street1": "5608 17th Avenue NW",
"street2": "suite 219",
"city": "Seattle",
"state": "WA",
"country": "United States",
"zipCode": "98107",
"phone": []
},
"pickup": true,
"type": "60a5844e52e07600089d2cb8",
"kind": "Warehouse",
"coordinates": {
"latitude": 47.669702,
"longitude": -122.378762
},
"locationId": 106,
"createdAt": "2021-05-25T00:21:00.738Z",
"updatedAt": "2021-05-25T00:21:00.738Z",
"__v": 0
}
]
}

Error Code: 404

Message: Not Found

Description: You will see this error when the requested item is not found.

{
"code": "Item_NOT_FOUND",
"message": "Item not found"
}

Error Code: 403

Message: Forbidden

Description: You will see this error when the account number is incorrect in the x-site-context (for a multi-tenent client).

{
"message": "Forbidden"
}

Change Log

  • June - 2021

  • July - 2020 First updated