Headout

Headout integration (Productivity, Data). Imported from open-connector.

API key8 toolshttps://sandbox.api.test-headout.com/api/public/v1

GET

headout_list_cities

List active Headout cities.

/city

2 parameters

Param	Type	Required	Description
offset	string	optional	The pagination offset returned by a previous Headout response.
limit	integer	optional	The number of items to request from Headout.

GET

headout_list_categories_by_city

List Headout categories for a given city.

/category/list-by/city

3 parameters

Param	Type	Required	Description
cityCode	string	required	The Headout city code.
offset	string	optional	The pagination offset returned by a previous Headout response.
limit	integer	optional	The number of items to request from Headout.

GET

headout_list_products_by_city

List Headout product listings for a city.

/product/listing/list-by/city

5 parameters

Param	Type	Required	Description
cityCode	string	required	The Headout city code.
currencyCode	string	optional	The ISO 4217 currency code for returned pricing.
language	string	optional	The Headout language code.
offset	string	optional	The pagination offset returned by a previous Headout response.
limit	integer	optional	The number of items to request from Headout.

GET

headout_list_products_by_category

List Headout product listings for a category.

/product/listing/list-by/category

5 parameters

Param	Type	Required	Description
categoryId	string	required	The Headout category identifier.
currencyCode	string	optional	The ISO 4217 currency code for returned pricing.
language	string	optional	The Headout language code.
offset	string	optional	The pagination offset returned by a previous Headout response.
limit	integer	optional	The number of items to request from Headout.

GET

headout_get_product

Get one Headout product with variants and pricing.

/product/get/{productId}

4 parameters

Param	Type	Required	Description
productId	string	required	The Headout product identifier.
currencyCode	string	optional	The ISO 4217 currency code for returned pricing.
language	string	optional	The Headout language code.
fetchVariants	boolean	optional	Whether to request variants from Headout.

GET

headout_list_inventory_by_variant

List Headout inventory rows for one variant.

/inventory/list-by/variant

6 parameters

Param	Type	Required	Description
variantId	string	required	The Headout variant identifier.
startDateTime	string	optional	The lower bound start date-time in Headout local date-time format.
endDateTime	string	optional	The upper bound end date-time in Headout local date-time format.
currencyCode	string	optional	The ISO 4217 currency code for returned pricing.
offset	string	optional	The pagination offset returned by a previous Headout response.
limit	integer	optional	The number of items to request from Headout.

GET

headout_list_bookings

List bookings accessible to the current Headout API key.

/booking

2 parameters

Param	Type	Required	Description
offset	string	optional	The pagination offset returned by a previous Headout response.
limit	integer	optional	The number of items to request from Headout.

GET

headout_get_booking

Get one booking by its Headout booking id.

/booking/{bookingId}

1 parameter

Param	Type	Required	Description
bookingId	string	required	The Headout booking identifier.