Get all product reservations

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

Get a list of product reservations.

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.

customer_id

string

The unique ID of the customer.

store_id

string

The unique ID of the store in CareCloud.

reservation_state

integer

Current state of the product reservation.
Possible values: 0 - Canceled / 1 - Entered / 2 - Accepted / 3 - Ready / 4 - Delivered / 5 - In progress / 6 - Not Picked up / 7 - Ordered / 8 - Being solved /

external_reservation_list_type_id

string

Every reservation can have more than one external code depends of the business requirements. This parameter allows to pick from witch list of external codes you want to choose. If set, external_reservation_code has to be present in request too.

external_reservation_code

string

Code of the reservation from external system (cash-desk, web-shop, production system, others). If set, external_reservation_list_type_id has to be present in request too.

include_reservation_progress_history

boolean

If true, the response will contain information about the reservation progress history. If false, or not set the response will not return this structure.

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

product_reservations

array of objects

List of the product reservations.

product_reservations

object

product_reservation_id

string

The unique ID of the product reservation.

customer_id

string

required

The unique ID of the customer, owner of the product reservation.

store_id

string

required

The unique ID of the store tied to the reservation.

reservation_codes

array of strings

Reservation codes of the reservation from CareCloud.

reservation_codes

external_reservation_codes

array of objects

List of the external reservation codes. Id codes can have different sources. Please get in touch with your account manager for the list of ID sources.

external_reservation_codes

object

external_code_type_id

string

required

The unique ID of the external code type (provided in GET /product-reservation-external-list-types).

value

string

required

Value of the external code.

benefit_codes

array of strings

List of the benefit (rewards, vouchers) codes used in a reservation. After the reservation is delivered, all benefits are applied on the customer account.

benefit_codes

product_reservation_source_id

string

required

The unique ID of the product reservation source.

pickup_date

string

Date of the reservation pickup in the tied store. (YYYY-MM-DD)

customers_note

string

Customer’s note for the merchant.

total_price

float

Total price of reservation. If currency_id is set, then total_price is mandatory.

currency_id

string

ID of the currency. If total_price is set, then currency_id is mandatory.

product_reservation_items

array of objects

List of the Product Reservation Items.

product_reservation_items

object

reservable_product_id

string

required

The unique ID of the reservable product in CareCloud.

amount

float

required

Number of the reserved products.

unit_price

float

Unit price of the reserved product. If vat_rate is set, than unit_price is mandatory.

vat_rate

float

The rate of the VAT of the reserved product. If unit_price is set, than vat_rate is mandatory.

external_purchase_id

string

The unique external ID of the purchase.

utm

object

UTM structure for data from email campaign.

actual_state

integer

Current progress of the product reservation.
Possible values: 0 - Canceled / 1 - Entered / 2 - Accepted / 3 - Ready / 4 - Delivered / 5 - In progress / 6 - Not Picked up / 7 - Ordered / 8 - Being solved /

1 2 4 5 6 7 8

reservation_progress_history

array of objects

History of the product reservation progress. Product reservation progress is sorted in descending order by time.

reservation_progress_history

object

reservation_progress_id

integer

ID of the product reservation progress.

reservation_progress_text

string

String of the product reservation progress.

reservation_progress_time

string

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

comments

array of objects

Product reservation comments. Comments are sorted in descending order by time.

comments

object

comment_text

string

Text of the product reservation comment.

comment_time

string

Date and time of the product reservation comment. (YYYY-MM-DD HH:MM:SS)

last_change

string

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

state

integer

State of the product reservation.
Possible values are: 0 - deleted / 1 - active

1 2

total_items

integer

The number of all found product reservations.

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/product-reservations?count=100&offset=0' \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


xxxxxxxxxx
60
}
1
{
2
  "data": {
3
    "product_reservations": [
4
      {
5
        "product_reservation_id": "81eaeea13b8984a169c490a325",
6
        "customer_id": "8ea2591121e636086a4a9c0992",
7
        "store_id": "82db62087b0f79a6e14e5747e7",
8
        "reservation_codes": [
9
          "3DBKBHA"
10
        ],
11
        "external_reservation_codes": [
12
          {
13
            "external_code_type_id": "86e05affc7a7abefcd513ab400",
14
            "value": "2107225110"
15
          }
16
        ],
17
        "benefit_codes": [
18
          "PTV116",
19
          "PTV120"
20
        ],
21
        "product_reservation_source_id": "8bed991c68a470e7aaeffbf048",
22
        "pickup_date": "2020-04-20",
23
        "customers_note": "Please add a gift package",
24
        "total_price": 69,
25
        "currency_id": "8bed991c68a470e7aaeffbf048",

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.