External Availability Webhook (v0)

Download OpenAPI specification:Download

Requests availability information from an external system.

A typical use case for this webhook is when NewStore is being used as Tier 2 OMS and doesn't maintain ATP.

Note: When the request can't be processed, either by the server implementing this webhook or the external system, the platform will assume none of the items are available.

Note: As of now only product identifiers is a supported external identifier.

Request availabilities

Requests availability information for a given list of products for a list of fulfillment locations.

Request Body schema: application/json

required	Array of objects non-empty List of all availabilities per product and fulfillment location
fulfillment_locations required	Array of strings non-empty [ items non-empty ] The list of fulfillment locations we want to request availabilities from.

Responses

Request samples

Payload

Content type

application/json

{"products": [{"product_id": "1000061",
"external_identifier": "1000061"
},
{"product_id": "10000211",
"external_identifier": "10000211"
}
],
"fulfillment_locations": ["US01",
"US02",
"DC01"
]
}

Response samples

Content type

application/json

{"availabilities": [{"product_id": "1000061",
"external_identifier": "1000061",
"fulfillment_location": "US01",
"atp": 10
},
{"product_id": "1000061",
"external_identifier": "1000061",
"fulfillment_location": "US02",
"atp": 0
},
{"product_id": "10000211",
"external_identifier": "10000211",
"fulfillment_location": "US01",
"atp": 10
},
{"product_id": "10000211",
"external_identifier": "10000211",
"fulfillment_location": "US02",
"atp": 0
}
]
}