Stock Insights Admin API (1.0.0)

Download OpenAPI specification:Download

team-order-management: team-order-management@newstore.com URL: https://newstoreinc.slack.com/archives/CBDLEJLTB

This internal stock insights API provides a way to post ATP events.

Provide new ATP events.

This API endpoint accepts a list of ATP events and processes them to generate an updated view for the stock levels page.

header Parameters

Request-Id required	string
Tenant	string

Request Body schema: application/json

required

Array of objects non-empty

Array (non-empty)

product_id required	string <= 256 characters Unique Id number of the product
fulfillment_node_id required	string [ 1 .. 256 ] characters Id of the fulfillment location
atp required	integer >= 0 Number of items Available to Promise. Note that name of this field is `atp` unlike `availability` in other payloads. We choose `atp` as the better suiting name for this property and other payloads will be modified to use the name `atp` too. Currently is equal to 'present_atp'
revision required	integer The revision of this data.
required	object Contains number of allocations, reservations and on hand items. This helps to understand how the atp value is being calculated.

Responses

Request samples

Payload

Content type

application/json

{"atps": [{"product_id": "string",
"fulfillment_node_id": "string",
"atp": 0,
"revision": 0,
"details": {"unallocated_reservations": 0,
"allocations": 0,
"on_hand": 0,
"present_atp": 0,
"future_atp": 0,
"future_availability_date": "2019-08-24",
"is_inventory_master": true,
"changes": [{"change_reason": "string",
"changed_at": "2019-08-24T14:15:22Z"
}
]
}
}
]
}

Response samples

Content type

application/problem+json

{"error_code": "string",
"message": "string",
"request_id": "string"
}