Skip to main content
API docs by Redocly

Availabilities API (0.1.0)

Download OpenAPI specification:Download

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

Represents the ATP of products in a fulfillment location (store or DC). Use this API to retrieve the ATP for products across your fulfillment locations.

ATP is calculated by subtracting the sum of all allocations, reservations, and safety stock quantity, from the stock on hand. That value is present ATP (atp). Future ATP is a separate quantity and is not included in atp.

For example, use it to get the ATP of the products in a store, to perform a reconciliation with your ERP.

List ATP information

Use this method to retrieve ATP information for the specified products and fulfillment locations.

In this request, each ATP key (atp_keys) is defined as a combination of a product ID and a fulfillment location set up in your business.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
required
Array of objects [ 1 .. 2000 ] items
Array ([ 1 .. 2000 ] items)
product_id
required
string non-empty

The id of the product.

fulfillment_node_id
required
string non-empty

The id of the fulfillment node.

Responses

Request samples

Content type
application/json
{
  • "atp_keys": [
    ]
}

Response samples

Content type
application/json
{
  • "items": [
    ]
}