Stock insights API (0.1.0)

Download OpenAPI specification:Download

team-order-management: team-order-management@newstore.com

Use this API to get insights into the current allocations and reservation for a product at a fulfillment node. The API returns reservations, allocations and future allocations for that product.

The allocations and reservations are not grouped on purpose to keep the load on the service and database to a minimum especially since the stock-http container is used for routing to get unallocated item counts. The list of allocations and reservations each have a limit of 1000 items. For simplicity, there will be no pagination provided.

Get ATP insights.

Retrieves the allocations and reservations by ATP keys in your business.

Authorizations:

newStoreAccessToken

query Parameters

product_id required	string The product ID of the item.
fulfillment_node_id required	string The fulfillment node ID of the store/warehouse.

Responses

Response samples

Content type

application/json

{"product_id": 10000102,
"fulfillment_node_id": "US01",
"allocations": [{"order_uuid": "5ca1548c-d228-4f98-a54e-c54bbba0a204",
"item_uuid": "3409090f-1881-486e-9e2d-2278020e5655",
"created_at": "2022-01-31T20:00:00Z"
},
{"order_uuid": "5ca1548c-d228-4f98-a54e-c54bbba0a204",
"item_uuid": "236a3594-2db2-4491-a5b4-9741ce680b03",
"created_at": "2022-01-31T20:00:00Z"
}
],
"reservations": [{"order_uuid": "5ca1548c-d228-4f98-a54e-c54bbba0a204",
"item_uuid": "3409090f-1881-486e-9e2d-2278020e5655",
"created_at": "2022-01-31T20:00:00Z",
"expires_at": "2022-01-31T20:30:00Z"
},
{"order_uuid": "5ca1548c-d228-4f98-a54e-c54bbba0a204",
"item_uuid": "236a3594-2db2-4491-a5b4-9741ce680b03",
"created_at": "2022-01-31T20:00:00Z",
"expires_at": "2022-01-31T20:30:00Z"
}
],
"future_allocations": [{"order_uuid": "017b8d63-76a8-46fc-b53a-4e2af8594427",
"item_uuid": "aaf13724-94a3-11ec-b909-0242ac120002",
"created_at": "2022-01-31T20:00:00Z"
},
{"order_uuid": "017b8d63-76a8-46fc-b53a-4e2af8594427",
"item_uuid": "ba44378a-94a3-11ec-b909-0242ac120002",
"created_at": "2022-01-31T20:00:00Z"
}
]
}