Get all purchases

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

Get a list of purchases saved in CRM.

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.

store_id

string

The unique ID of the store in CareCloud.

customer_id

string

The unique ID of the customer.

type_id

string

Purchase type

payment_time_from

string

Date and time from of the purchase payment. (YYYY-MM-DD HH:MM:SS)

payment_time_to

string

Date and time to of the purchase payment. (YYYY-MM-DD HH:MM:SS)

purchase_items_extension

boolean

Defaults to false

If true, resource returns extended response with purchase items. If false, the resource won't be extended. If the parameter is not set, the default value is false.

external_purchase_id

string

ID of the purchase from external (e-shop, POS) system. This ID should have unique value.

include_property_records

boolean

If true, the property record structure will be included in the response. Possible values: true - property records structure will be included / false or not set - property records structure won't be included, and parameter will return null value

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

purchases

array of objects

List of purchases.

purchases

object

purchase_id

string

The unique ID of the purchase.

customer_id

string

required

The unique ID of the customer.

store_id

string

required

The unique ID of the store in CareCloud.

external_purchase_id

string

required

The external unique ID of the purchase.

payment_time

string

required

Date and time of the purchase payment. (YYYY-MM-DD HH:MM:SS)

items_count

integer

required

Count of the purchase items.

purchase_items

array of objects

List of all items of the purchase. Data is returned if query parameter purchase_items_extension has value true in the query string of the request.

purchase_items

object

purchase_item_id

string

The unique ID of the purchase item.

product_id

string

required

The unique ID of the product.

product_name

string

The unique name of the product.

product_group_id

string

The unique ID of the product group.

product_group_name

string

The unique ID of the product group.

product_brand_id

string

The unique ID of the product brand.

product_brand_name

string

The unique ID of the product brand.

external_id

string

Identifier of the purchase item in external system.

purchase_item_type_id

string

required

Type of the purchase item.There is a distinction between a purchase in an e-shop, in a brick-and-mortar store, a mobile application, or a cancellation of the purchase. It also differentiates purchases without the possibility of applying loyalty benefits from ordinary purchases or from purchases with the application of loyalty points.

price

float

required

Price of the purchase item.

amount

float

required

Amount of the purchase item.

vat_rate

float

required

The rate of an item VAT.

additional_properties

array of objects

List of additional properties.

additional_properties

object

property_record_id

string

The unique ID of the property record.

property_id

string

required

The unique ID of the property.

property_name

string

Name of the property.

property_value

Value of the property.

last_change

string

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

type_id

string

required

Purchase type.

total_price

float

required

Total price of the purchase.

currency_id

string

required

The unique ID of the currency.

card_number

string

Purchasing customer card number.

cashdesk_number

string

required

Number of the cash-desk

last_change

string

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

purchase_property_records

array of objects

Defaults to false

List of purchase property records.

purchase_property_records

object

property_record_id

string

The unique ID of the property record.

property_id

string

required

The unique ID of the property.

property_name

string

Name of the property.

property_value

Value of the property.

last_change

string

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

total_items

integer

The number of all found purchases.

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


xxxxxxxxxx
55
}
1
{
2
  "data": {
3
    "purchases": [
4
      {
5
        "purchase_id": "81eaeea13b8984a169c490a325",
6
        "customer_id": "8ea2591121e636086a4a9c0992",
7
        "store_id": "81eaeea13b8984a169c490a325",
8
        "external_purchase_id": "D67X202789",
9
        "payment_time": "2021-02-24 00:00:00",
10
        "items_count": 1,
11
        "purchase_items": [
12
          {
13
            "purchase_item_id": "84b757641df03b1529c2c7f66c",
14
            "product_id": "89b3b24b405f461c63d8fcaa0c",
15
            "product_name": "Apple Watch Ultra 2",
16
            "product_group_id": "82de12eb8b138791e678fd11c3",
17
            "product_group_name": "Smart watch",
18
            "product_brand_id": "82db62087b0f79a6e14e5747e7",
19
            "product_brand_name": "Apple",
20
            "external_id": null,
21
            "purchase_item_type_id": "86e05affc7a7abefcd513ab400",
22
            "price": 1.99,
23
            "amount": null,
24
            "vat_rate": null,
25
            "additional_properties": [

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.