--- title: "GET inventory_objects" method: GET path: "/v3/suppliers/{supplier_id}/inventory_objects" tags: ["InventoryObjects"] --- # GET inventory_objects `GET /v3/suppliers/{supplier_id}/inventory_objects` ## Request - Base URL: `https://api.bookingexperts.com` - URL: `https://api.bookingexperts.com/v3/suppliers/{supplier_id}/inventory_objects` - Auth: one of: - API key in header `X-API-KEY` - OAuth 2 - Authorization code: `/oauth/authorize` - Token URL: `/oauth/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns inventory_objects of the supplier ## Path parameters - `supplier_id` string, required ## Query parameters - `page[number]` integer - `page[size]` integer - `sort` string - `fields[inventory_object]` string - `include` string - `filter[id]` string - `filter[name]` string - `filter[original_identifier]` string - `filter[door_name]` string - `filter[energy_label]` string - `filter[surface_area]` string - `filter[lot_number]` string - `filter[blocked]` string - `filter[attachment_text]` string - `filter[archived]` string - `filter[created_at]` string - `filter[updated_at]` string - `filter[labels]` string - `filter[administration]` string - `filter[cluster_children]` string - `filter[images]` string - `filter[rentable_type]` string ## Headers - `Accept-Language` string ## Response `200` InventoryObjectCollectionResponse - object - `data` InventoryObject[] - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` string - `original_identifier` string: The identifier of this object in a previous system - `door_name` string - `energy_label` 'exempt' | 'A++++' | 'A+++' | 'A++' | 'A+' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H': Energy label of building, may be any of the official energy labels or "exempt" if the accommodation is exempt from the energy label requirement.When blank, the current energy label of the acommmodation is unknown. - `surface_area` integer: The surface area in square meters - `lot_number` string: The lot number of the object - `blocked` boolean: Whether the inventory object is blocked or not from being booked - `custom_fields` object[]: Custom attributes assigned to this resource - `key` string - `text_value` string - `integer_value` integer - `attachment_text` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `name_with_type` string - `cluster_parent` boolean: If an object is a cluster parent, it represents a cluster of other (real) objects. - `archived` boolean - `created_at` string, date-time - `updated_at` string, date-time - `relationships` object: Relationships - `current_or_future_external_blocked_agenda_periods` object: Relationship for sideposting external blocked agenda periods. This relationship will never be returned in a response. - `data` object[] - `id` string: current_or_future_external_blocked_agenda_periods ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `labels` object - `data` object[] - `id` string: labels ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `administration` object - `data` object - `id` string: administration ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `cluster_children` object: The objects that form this cluster object - `data` object[] - `id` string: cluster_children ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `images` object - `data` object[] - `id` string: images ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - `included` union[] - union - ExternalBlockedAgendaPeriod: A blocking event on the calendar of a Rentable, blocked by an external party. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `start_date` string, date - `end_date` string, date - `created_at` string, date-time - `updated_at` string, date-time - `relationships` object: Relationships - `rentable` object - `data` object - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Label: A label provides a way to categorize InventoryObjects, Owners and Reservations. These categorizations are created by backoffice users. **Important: A label is for internal use only and should never be exposed outside the Organization itself. This can for example be used to flag Customers that have been known for making a mess.** - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` string - `background` string: The background color of the label. The foreground color is automatically determined when the label is saved. - `foreground` string: The foreground color of the label. This color is automatically determined based on the background color when updating or creating the label. - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Administration: An organization can have multiple administrations, usually a holiday park or camping. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` string - `email` string - `phone` string - `website` string - `native_currency` string - `address` string - `country_code` string - `postal_code` string - `city` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `description` object: A description of the administration - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `surroundings_description` object: A description of the surroundings - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `tin` string: Tax Identification Number - `vat_nr` string: VAT Number - `available_locales` string[]: Enabled locales - `native_locale` string: The default locale used by the administration internally, and which should be used for communication with the administration - `timezone` string: The timezone of the administration, for example: Amsterdam - `invoice_email` string: The email address to contact for invoicing questions - `invoice_phone` string: The phone number to contact for invoicing questions - `invoice_address` string: The address to use for invoicing - `invoice_postalcode` string: The postal code to use for invoicing - `invoice_city` string: The city to use for invoicing - `invoice_country_code` string: The country code to use for invoicing - `billing_vat_percentage` integer - `available_currencies` string[]: Enabled currencies - `map_available` boolean: If a map is available. The map can be used to pick a specific accommodation or pitch. - `guest_list_group` 'main_guest' | 'all' | 'adults' | 'none' - `guest_accepted_document_type` string[] - `guest_identification_required` 'none' | 'main_guest' | 'all' | 'adults' - `ask_for_guest_gender` boolean - `ask_for_guest_address` boolean - `ask_for_guest_postal_code` boolean - `ask_for_guest_city` boolean - `ask_for_guest_country` boolean - `ask_for_guest_email` boolean - `ask_for_guest_phone` boolean - `ask_for_guest_profession` boolean - `ask_for_guest_signature` boolean - `ask_for_fellow_guest_gender` boolean - `ask_for_fellow_guest_address` boolean - `ask_for_fellow_guest_postal_code` boolean - `ask_for_fellow_guest_city` boolean - `ask_for_fellow_guest_country` boolean - `ask_for_fellow_guest_email` boolean - `ask_for_fellow_guest_phone` boolean - `ask_for_fellow_guest_profession` boolean - `ask_for_fellow_guest_signature` boolean - `default_option_validity` integer: The default option validity in days. When 0, customer options are not allowed. - `max_options_per_customer` integer: DEPRECATED use max_options_per_booker instead - `max_options_per_booker` integer: The maximum number of options that can be created at the same time by a particular customer - `latitude` number, double - `longitude` number, double - `allow_multi_reservation_bookings_through_api` boolean: Whether the administration accepts bookings containing multiple reservations. - `accounting_closed_upto` string, date: Date up to which accounting is closed. All financial transactions made before this date are locked and cannot be changed. - `enable_license_plates` boolean: Whether the administration accepts license plates for bookings. - `iban` string: International Bank Account Number - `bic` string: Bank Identifier Code - `peppol_identifiers` object[]: PEPPOL Identifiers for the administration with scheme ID. See https://docs.peppol.eu/edelivery/codelists/v9.4/Peppol%20Code%20Lists%20-%20Participant%20identifier%20schemes%20v9.4.html - `scheme` string - `value` string - `created_at` string, date-time - `updated_at` string, date-time - `links` object: Links - `self` string: Link to self - `url` string: Link to url - `relationships` object: Relationships - `city` object - `data` object - … - `checkin_timetable` object: The timetable that defines the default check-in times for this administration. It can be overridden for each rentable type. - `data` object - … - `checkout_timetable` object: The timetable that defines the default check-out times for this administration. It can be overridden for each rentable type. - `data` object - … - `interactive_map` object - `data` object - … - `payment_handlers` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - InventoryObject: An accommodation that can be booked as part of a Reservation - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` string - `original_identifier` string: The identifier of this object in a previous system - `door_name` string - `energy_label` 'exempt' | 'A++++' | 'A+++' | 'A++' | 'A+' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H': Energy label of building, may be any of the official energy labels or "exempt" if the accommodation is exempt from the energy label requirement.When blank, the current energy label of the acommmodation is unknown. - `surface_area` integer: The surface area in square meters - `lot_number` string: The lot number of the object - `blocked` boolean: Whether the inventory object is blocked or not from being booked - `custom_fields` object[]: Custom attributes assigned to this resource - `key` string - `text_value` string - `integer_value` integer - `attachment_text` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `name_with_type` string - `cluster_parent` boolean: If an object is a cluster parent, it represents a cluster of other (real) objects. - `archived` boolean - `created_at` string, date-time - `updated_at` string, date-time - `relationships` object: Relationships - `current_or_future_external_blocked_agenda_periods` object: Relationship for sideposting external blocked agenda periods. This relationship will never be returned in a response. - `data` object[] - … - `labels` object - `data` object[] - … - `administration` object - `data` object - … - `cluster_children` object: The objects that form this cluster object - `data` object[] - … - `images` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Image: Represents an image with multiple versions. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `image` object - `original` string - `banner` string - `cover` string - `large` string - `polaroid` string - `thumb` string - `filename` string - `data` string, byte: Base64-encoded image data of the original image. Must be specified when adding a new image. - `alt_text` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `season` 'whole_year' | 'winter' | 'summer': The season to which the image applies - `position` integer - `created_at` string, date-time - `updated_at` string, date-time - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - `meta` object - `pagination` object - `total_records` integer - `page` integer - `size` integer ## Other responses - `429`: Error - `default`: Error ## Changes - **2026-11-03** `ff81bc4fefa9`: 16 info - added the optional property `data/items/attributes/attachment_text/da-DK` to the response with the `200` status - added the optional property `data/items/attributes/attachment_text/en-GB` to the response with the `200` status - added the optional property `data/items/attributes/attachment_text/en-US` to the response with the `200` status - added the optional property `included/items/anyOf[#/components/schemas/Administration]/attributes/city/da-DK` to the response with the `200` status - …12 more [Operation history](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/changes/v3/suppliers/:supplier_id/inventory_objects/get.md) --- [API](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3.md) - [All operations](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/revisions/ff81bc4fefa9?raw)