• Register

ATP Stock Check

This API is consumed by a user in order to check stock availability for one or more materials. #### Request URI

Request Structure - API Fields

API Fields Type Mandatory Description Technical Details
ATPCheckRequest (0..∞)
materialCode String Y Material code of material provided Max 18 charachers
plant String Y Plant asked for material in interest
neededQuantity Integer N Quantity needed of material If not provided, it will be considered as "0"
neededQuantityUOM String Y Unit of Measure of needed material
storageLocation String N Strorage location in interest related to "plant" provided If not provided, all plant availability will be considered

Request Example

Response Structure - API Fields

API Fields Type Description Technical Details
ATPCheckResponse (0..∞)
materialCode String Material code of material provided
plant String Plant asked for material in interest
status String Status of current material, active or no more in production Possible options: "active","inactive"
neededQuantity Integer Quantity needed of material
availableQuantity Integer Actual available quantity of material
isAvailable Boolean If needed quantity is available true if "neededQuantity" is less or equal to "availableQuantity", false otherwise

Response Example

Response Error

API Fields Type Description
statusCode String Error Code given by API
message String Message given by API

Response Error Example

Docs Navigation