Get all orders

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

Get information about all customer orders.

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.

state

integer

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

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

orders

array of objects

Collection of the customer orders.

orders

object

order_id

string

The unique ID of the order.

order_number

string

External order number. If not set, internal order number will be set.

customer_id

string

required

The unique ID of the customer, owner of the order.

currency_id

string

required

ID of the currency.

total_price

float

required

Total price of the order.

discount_codes

array of strings

Discount codes used in the order.

discount_codes

order_items

array of objects

required

List of the OrderItems.

order_items*

object

order_item_id

string

The unique ID of the order item.

product_variant_id

string

required

The unique ID of the web-shop product.

customer_id

string

The unique ID of the customer, owner of the order item. If not set, customer_id from order will be saved.

amount

float

required

Amount of products in order item.

unit_price

float

required

Unit price of the ordered product.

vat_rate

float

required

The rate of the VAT of the ordered product.

invoicing_data

object

required

Structure of OrderInvoicing. Contains necessary data for invoicing of the order.

shipping_data

object

Structure of OrderShipping. Contains necessary data for shipping of the order.

customer_note

string

Customer’s note for the merchant.

order_status

string

Text representation of the order status.

shipping_date

string

Date of the order shipping. If the date is in future, order should be shipped in this date.

program_ranking

integer

Rank of order in case of the series of multiple orders.

payment_status

string

Text representation of the payment status.

invoice_document_url

string

URL address with the invoice PDF.

last_change

string

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

total_items

integer

The number of all found customer orders.

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


xxxxxxxxxx
91
}
1
{
2
  "data": {
3
    "orders": [
4
      {
5
        "order_id": "80af8a5dcc0702daf336f4de41",
6
        "order_number": "A3NKI89NFDS82434B",
7
        "customer_id": "87a6f37e138c1ef18918e747d",
8
        "currency_id": "8bed991c68a470eaaeffbf048",
9
        "total_price": 36,
10
        "discount_codes": null,
11
        "order_items": [
12
          {
13
            "order_item_id": null,
14
            "product_variant_id": "8fcc724e1514dafb0a70228d3",
15
            "customer_id": null,
16
            "amount": 1,
17
            "unit_price": 36,
18
            "vat_rate": 19
19
          }
20
        ],
21
        "invoicing_data": {
22
          "payment_id": "8bd481170064960b1788109b8",
23
          "paid_date": "2021-07-15 13:26:34",
24
          "personal_information": {
25
            "salutation": "Dear Mr. Smith",

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.