Get all product reservation prices

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

Get a list of product reservation prices. Each price represents the value of the product for the reservation for a specific store and currency.

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.

reservable_product_id

string

The unique ID of the reservable product. In case you want to filter multiple options use array syntax : reservable_product_id[]=8bc8ca16f9c5039951021700a2&reservable_product_id[]=82c06812c0756528660784fef

store_id

string

The unique ID of the store in CareCloud.

currency_id

string

The unique ID of a currency from Currencies resource.

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_reservation_prices

array of objects

List of the product reservation prices.

product_reservation_prices

object

product_reservation_price_id

string

The unique ID of the product reservation price.

reservable_product_id

string

The unique ID of the reservable product. This represents relation in between price and product. Required if plu_ids is not set.

plu_ids

array of objects

An array of all available pluIDs from the particular product lists (default is Product ID from Global product list (consist cleaned data - unique ID of every product across all POS systems)). This is an alternative to reservable_product_id. It will accept only products that could be reserved. Required if reservable_product_id is not set.

plu_ids

object

list_code

string

required

Code of the particular product list (basic is code of Global product list (consist cleaned data - unique ID of every product across all POS systems)). For example, “GLOBAL”, “SKU”, “PLU”, etc.

code

string

required

Code of product from the product list (basic is Product ID from Global product list (consist cleaned data - unique ID of every product across all POS systems)).

value

float

required

Value of a price for store and currency.

currency_id

string

required

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

store_id

string

The unique ID of the store tied to the product reservation price. Prices of product can vary depending on the store.

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 reservation prices.

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


xxxxxxxxxx
22
 
1
{
2
  "data": {
3
    "product_reservation_prices": [
4
      {
5
        "product_reservation_price_id": "81eaeea13b8984a169c490a325",
6
        "reservable_product_id": "8ea2591121e636086a4a9c0992",
7
        "plu_ids": [
8
          {
9
            "list_code": "GLOBAL",
10
            "code": "abc"
11
          }
12
        ],
13
        "value": 69,
14
        "currency_id": "8bed991c68a470e7aaeffbf048",
15
        "store_id": "82db62087b0f79a6e14e5747e7",
16
        "last_change": "2020-04-20 11:23:35",
17
        "state": 1
18
      }
19
    ],
20
    "total_items": 1
21
  }
22
}

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.