GET/v1/tenants/{tenantId}/core/organisational_units/retail_stores

Synchronize retail_stores Experimental

Live entity representations and retained deletions, ordered by modification/deletion timestamp and ID. Use an overlap window when polling from a completed sync_through checkpoint. Requires organisational_units:read or core:read. Save sync_through after the final page succeeds, then subtract a configurable overlap window for the next poll.

Parameters

tenantIdpathstringnon-nullrequired
sincequerystringnon-nulloptional: Inclusive ISO 8601 timestamp with offset. Omit to synchronize everything. Cannot be combined with cursor.
cursorquerystringnon-nulloptional: Opaque next_cursor from the previous page. Pass it back unchanged to continue the same collection.
limitqueryintegernon-nulloptional: Combined entities and deletions per page: default 100, maximum 500. May change between pages.
Format: int32

Responses

200Response

application/jsonobjectnon-null

itemsarray of objectnon-nullrequired

Show item fields

Exactly one of these shapes is allowed.

deleted objectnon-null

typestringnon-nullrequired: Allowed values"deleted"
idstringnon-nullrequired
changed_atstringnon-nullrequired: Format: ISO 8681 timestamp
Example"2025-10-28T12:37:42Z"
deleted_atstringnon-nullrequired: Format: ISO 8681 timestamp
Example"2025-10-28T12:37:42Z"

entity objectnon-null

typestringnon-nullrequired

Allowed values"entity"

dataobjectnon-nullrequired

Show child fields

idstringnon-nullrequired

addressesarray of objectnon-nullrequired

Show item fields

citystringnon-nullrequired: Further nesting is omitted. See the schema for the full definition.
idstringnon-nullrequired: Further nesting is omitted. See the schema for the full definition.
mainbooleannon-nullrequired: Further nesting is omitted. See the schema for the full definition.
streetstringnon-nullrequired: Further nesting is omitted. See the schema for the full definition.
address_typestringnon-nullrequired: Further nesting is omitted. See the schema for the full definition.
country_iso_codestringnon-nullrequired: Further nesting is omitted. See the schema for the full definition.
post_codestringnon-nullrequired: Further nesting is omitted. See the schema for the full definition.

namestringnon-nullrequired

numberstringnon-nullrequired

statusstringnon-nullrequired

versionintegernon-nullrequired

Format: int64

account_manager_idstringnullableoptional

business_registration_numberstringnullableoptional

company_idstringnon-nullrequired

created_atstringnon-nullrequired

Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

is_customerbooleannon-nullrequired

is_supplierbooleannon-nullrequired

legal_namestringnon-nullrequired

main_contact_user_idstringnullableoptional

modified_atstringnon-nullrequired

Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

retail_chain_idstringnullableoptional

store_emailstringnullableoptional

store_phonestringnullableoptional

store_typestringnon-nullrequired

warehouse_idstringnullableoptional

web_addressstringnullableoptional

changed_atstringnon-nullrequired

Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

View schema definition

next_cursorstringnullablerequired

sync_throughstringnon-nullrequired

Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

View schema definition

400Response

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

401Response

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

403Response

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition