Export Full Available to Promise Inventory

This endpoint enables you to export the full “Available to Promise” (ATP) inventory. Response data can be configured to include all the items/SKUs that are flagged as active in ROM or only those with a positive supply quantity.

Details

Resource
GET /availability-service/stores/{storeId}/exportFullAtp
Sample Request URL
curl -L -X GET 'https://uat-apg.radial.com/availability-service/stores/TRLUS/exportFullAtp?pageId=1&pageSize=2'

Parameters

Parameter	Description	Required?
storeId	Identifies the Seller.	Yes
pageId	Controls the pageId data returned. For example, if the pageSize is 100, pageId=1 would respond with items 1-100, while pageId=2 would respond with items 101-200.	Yes
pageSize	Controls the number of items returned in the response. The maximum value allowed is 500. If the max value exceeds that amount, the response will include only 500.	Yes

Rate Limiting Policy

As part of Radial's commitment to ensuring optimal performance and reliability of our services, Radial has implemented a rate limiting policy on our API endpoints. This policy prevents excessive use that could negatively affect the overall functionality of our system. Review the following details to understand how these limits are applied and what they mean for your usage.

Requests Allowance: This specific API call can be made up to a maximum of 30 times within a 15-minute window. This rate limit is applied on a per-user basis, identified by your API key. Each user or application using a unique API key is independently subject to this limit.
Time Window: The time window for calculating the number of requests is fixed to a rolling 15-minute period, beginning with your first request and continuing for the next 15 minutes. It's not tied to the clock. After 15 minutes, the rate limit window resets. For example, if you hit your limit at 10:05 AM, you can make requests again at 10:20 AM.

Examples and Field Definitions

Sample Request

Copy

curl -L -X GET 'https://uat-apg.radial.com/availability-service/stores/TRLUS/exportFullAtp?pageId=1&pageSize=2' \
-H 'apiKey: ********************************' \
-H 'Authorization: Basic ********************************'

Sample Response

HTTP Status 200: Success

Copy

{
    "storeId": "TRLUS",
    "lines": [
        {
            "lineId": "line1",
            "itemId": "276-RITMAXTRL012",
            "supplyQuantity": 10,
            "demandQuantity": 10,
            "availableQuantity": 0,
            "nodeDetails": [
                {
                    "nodeId": "TRLNA-DC462",
                    "nodeTypeId": "RADIAL_DC",
                    "supplyQuantity": 10,
                    "demandQuantity": 10,
                    "availableQuantity": 0
                }
            ]
        },
        {
            "lineId": "line0",
            "itemId": "276-RITMAXTRL011",
            "supplyQuantity": 25,
            "demandQuantity": 10,
            "availableQuantity": 15,
            "nodeDetails": [
                {
                    "nodeId": "TRLNA-DC462",
                    "nodeTypeId": "RADIAL_DC",
                    "supplyQuantity": 25,
                    "demandQuantity": 10,
                    "availableQuantity": 15
                }
            ]
        }
    ],
    "pageId": 1,
    "pageSize": 2,
    "totalRecords": 22
}

HTTP Status 401: Unauthorized
HTTP Status 403: Forbidden
HTTP Status 404: Not Found

Field Definitions

Field Name	Parent	Type	Comment
storeId	root	String	Contains the Radial-assigned identifier for the Seller.
lines	root	Array	List of Lines
lineId	lines	String	Incrementing Line ID for the associated item quantities, starting with zero.
itemId	lines	String	Radial’s unique identifier for the item, which is comprised of “CatalogId” and “ClientItemId” separated by a dash.
supplyQuantity	lines	Integer	The total sellable quantity across all Radial DCs for the requested Seller. Damaged quantities are excluded. Pull data from this field if you are either in a single Radial DC or looking for aggregated inventory across multiple Radial DCs.
demandQuantity	lines	Integer	The total demand quantity across all Radial DCs for the requested Seller. Pull data from this field if you are either in a single Radial DC or looking for aggregated inventory across multiple Radial DCs.
availableQuantity	lines	Integer	The total quantity available for sale across all Radial DCs for the requested Seller. This is calculated as “supplyQuantity – demandQuantity – Safety Stock”. Pull data from this field if you are either in a single Radial DC or looking for aggregated inventory across multiple Radial DCs.
nodeDetails	lines	Array	List of Node Details
nodeId	lines/nodeDetails	String	Unique identifier representing the fulfillment location. Radial will provide this value to you.
nodeTypeId	lines/nodeDetails	String	Indicates the fulfillment location type. Currently only “RADIAL_DC” is supported.
supplyQuantity	lines/nodeDetails	Integer	The total sellable quantity in the specified Radial DC for the requested Seller. Damaged quantities are excluded.
demandQuantity	lines/nodeDetails	Integer	The total demand quantity in the specified Radial DC for the requested Seller.
availableQuantity	lines/nodeDetails	Integer	The total quantity available for sale in the specified Radial DC for the requested Seller. This is calculated as “supplyQuantity – demandQuantity – Safety Stock”.
pageId	root	Integer	Requested pageId in the URL query parameters
pageSize	root	Integer	Requested pageSize in the URL query parameters
totalRecords	root	Integer	Total number of items currently available to be included in the responses based on configuration settings.