Get all stores
Get information as a list of all stores.
Query parameters
The number of records to return in API response.
⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.
The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.
Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.
Direction of sorting the response list.
State of the visibility of the customer. Possible values are: 0 - invisible / 1- visible. If query string is not used, return both.
Store property ID from resource GET /store-properties. The parameter determines property, which is used to filter stores by their properties. The parameter must be used in combination with property_value otherwise is ignored in the request.
Store property record value from resource GET /stores/{store_id}/property-records or store-properties in case of datatype with multiple values. Parameter filters stores depends of store property record value. The parameter must be used in combination with property_id otherwise is ignored in the request. For a list of stores, see GET /stores.
The unique ID of the store in external system (e-shop, POS, etc.)
Headers
The unique ID of the language code by ISO 639-1.
Response
OK
Example response
{
"data": {
"stores": [
{
"store_id": "81eaeea13b8984a169c490a325",
"store_code": "84a169c490a325",
"name": "Another good store",
"store_address": {
"address1": "Old Town Square",
"address2": "34",
"address3": "1a",
"zip": "11000",
"city": "Prague 1",
"country_code": "cz"
},
"contact_email": "good.store@crmcarecloud.com",
"manager_name": "Andrew Black",
"phone_number": "420523828931",
"partner_id": "86e05affc7a7abefcd513ab400",
"system_id": "2375303497",
"url_address": "www.crmcarecloud.com",
"opening": [
{
"day_id": "MON",
"time_intervals": [
{
"from": "08:00:00",
"to": "15:30:00"
}
]
}
],
"visibility_for_customer": 1,
"short_description": "Another good store for buying beverages",
"description": "Another good store for buying beverages: beer, wine, juice, soda",
"registration_id": "81eaeea13b89",
"last_change": "2023-03-28 16:12:56",
"state": 1
}
],
"total_items": 1
}
}