Get a store

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

Get information about a specific store.

Responses

Response body

object

data

object

Store structure.

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

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/store_id \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


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

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.