inventory-pricing.md

Inventory & Pricing APIs

Resource path param: /inventory

APIs

METHOD	URL	AUTH	USAGE
GET	/inventory/list-by/variant	no	Get the available inventory for a variant.

GET /inventory/list-by/variant

Get the available inventory for a variant.

Request

MODE	KEY	TYPE	OPTIONAL	DESCRIPTION
QUERY	variantId	string	no	The ID of the variant for which the inventory needs to be fetched.
QUERY	startDateTime	string	yes	The start date time from which the inventory needs to be fetched. If unspecified then the current timestamp is taken into consideration. Format: fm-date-time. Ref: inventory.startDateTime
QUERY	endDateTime	string	yes	The end date time till which the inventory needs to be fetched. If unspecified then this is taken as infinity. Format: fm-date-time. Ref: inventory.startDateTime
QUERY	offset	string	yes	The offset for pagination. Ref: Pagination - Request Params
QUERY	limit	int	yes	The limit for pagination. Ref: Pagination - Request Params
QUERY	currencyCode	string	yes	The currency in which pricing information will be returned. Eg: USD, AED. Ref: https://en.wikipedia.org/wiki/ISO_4217

Response

Object: pagination-wrapper<inventory>

Response Example

{
	"items": [
		{
			"id": "1212121",
			"startDateTime": "2017-03-30T15:30:00",
			"endDateTime": "2017-03-30T15:30:00",
			"availability": "LIMITED/UNLIMITED/CLOSED",
			"remaining": 5,
			"pricing": {
				"persons": [
					{
						"type": "ADULT",
						"name": "Adult",
						"ageFrom": 13,
						"ageTo": null,
						"price": 100,
						"originalPrice": 110
					},
					{
						"type": "CHILD",
						"name": "Child",
						"ageFrom": 4,
						"ageTo": 12,
						"price": 50,
						"originalPrice": 60
					}
				],
				"groups": [
					{
						"size": 4,
						"price": 100,
						"originalPrice": 120
					}
				]
			}
		}
	],
	"nextUrl": "https://www.headout.com/api/public/v1/inventory/list-by/variant?variantId=1234&offset=21&limit=20",
	"prevUrl": "https://www.headout.com/api/public/v1/inventory/list-by/variant?variantId=1234&offset=0&limit=20",
	"total": 100,
	"nextOffset": 21
}