Get all stores

get https://{project_url}/webservice/rest-api/{api_interface}/{version}/stores

Get information as a list of all stores.

Query Params

count

integer

≥ 1

Defaults to 100

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.

offset

integer

≥ 0

Defaults to 0

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_field

string

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.

sort_direction

string

Direction of sorting the response list.

visible_for_customer

integer

State of the visibility of the customer. Possible values are: 0 - invisible / 1- visible. If query string is not used, return both.

property_id

string

Store property ID from resource 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.

property_value

string

Store property record value from resource /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.

system_id

string

The unique ID of the store in external system (e-shop, POS, etc.)

Headers

Accept-Language

string

Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

Responses

Response body

object

data

object

stores

array of objects

List of all stores.

stores

object

store_id

string

required

The unique ID of the store in CareCloud.

store_code

string

required

External code of the store.

name

string

required

Name of the store.

store_address

object

The Address Structure in the API defines the standardized format for representing addresses throughout the system. This resource ensures consistency and accuracy in capturing address details, facilitating seamless integration and data exchange.

contact_email

string

Contact email of the store.

manager_name

string

Name of the store manager.

phone_number

string

Phone number of the store with international prefix (420000000000).

partner_id

string

required

The unique ID of the partner.

system_id

string

required

The external unique ID of the store in external system.

gps_coordinates

object

GPS coordinates of the store.

url_address

string

URL address of the store.

opening

array of objects

List of opening days.

opening

object

day_id

string

required

The unique ID of the day of the week.

time_intervals

array of objects

required

List of time Intervals.

time_intervals*

object

from

string

required

Time from. (HH:MM:SS)

string

required

Time to. (HH:MM:SS)

image_urls

array of strings

A list of image URL addresses.

image_urls

visibility_for_customer

integer

State of the visibility for the customer.
Possible values are: 0 - invisible / 1 - visible

1

short_description

string

Short description of the store.

description

string

Long description of the store.

registration_id

string

Legal registration number of the store.

last_change

string

Date and time of the last change. (YYYY-MM-DD HH:MM:SS)

state

integer

State of the store
Possible values are: 0 - deleted / 1 - active / 2 - non active

1 2

total_items

integer

The number of all found stores.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://sandbox.crmcarecloud.com/webservice/rest-api/enterprise-interface/v1.0/stores?count=100&offset=0' \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


xxxxxxxxxx
54
}
1
{
2
  "data": {
3
    "stores": [
4
      {
5
        "store_id": "81eaeea13b8984a169c490a325",
6
        "store_code": "84a169c490a325",
7
        "name": "Another good store",
8
        "store_address": {
9
          "address1": "Old Town Square",
10
          "address2": "34",
11
          "address3": "1a",
12
          "address4": "",
13
          "address5": "",
14
          "address6": "",
15
          "address7": "",
16
          "zip": "11000",
17
          "city": "Prague 1",
18
          "country_code": "cz"
19
        },
20
        "contact_email": "good.store@crmcarecloud.com",
21
        "manager_name": "Andrew Black",
22
        "phone_number": "420523828931",
23
        "partner_id": "86e05affc7a7abefcd513ab400",
24
        "system_id": "2375303497",
25
        "gps_coordinates": {

200OK

400Bad input parameter. Error message specifies the detail.

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access non authorized property/resource.

404The resource was not found.

405The resource does not support the specified HTTP method.

500Server is not working as expected.