v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Orders

Get an order

Get information about a specific order.

get/orders/{order_id}

Path parameters

order_idstring required

The unique ID of the order.

Headers

Accept-Languagestring

The unique ID of the language code by ISO 639-1.

Response

OK

Example response

{
  "data": {
    "order_id": "80af8a5dcc0702daf336f4de41",
    "order_number": "A3NKI89NFDS82434B",
    "customer_id": "87a6f37e138c1ef18918e747d",
    "currency_id": "8bed991c68a470eaaeffbf048",
    "total_price": 36,
    "order_items": [
      {
        "product_variant_id": "8fcc724e1514dafb0a70228d3",
        "amount": 1,
        "unit_price": 36,
        "vat_rate": 19
      }
    ],
    "invoicing_data": {
      "payment_id": "8bd481170064960b1788109b8",
      "paid_date": "2021-07-15 13:26:34",
      "personal_information": {
        "salutation": "Dear Mr. Smith",
        "gender": 1,
        "first_name": "John",
        "last_name": "Smith",
        "pre_nominals": "Dr.",
        "post_nominals": "Ph.D",
        "birthdate": "1985-02-12",
        "email": "happy_customer@crmcarecloud.com",
        "phone": "420523828931",
        "language_id": "en",
        "store_id": "8bed991c68a4",
        "photo_url": "https://example.com/photos/customer.jpg",
        "address": {
          "address1": "Old Town Square",
          "address2": "34",
          "address3": "1a",
          "zip": "11000",
          "city": "Prague 1",
          "country_code": "cz"
        },
        "agreement": {
          "agreement_gtc": 1,
          "agreement_profiling": 1,
          "agreement_marketing_communication": 1,
          "custom_agreements": [
            {
              "agreement_id": "8fd73167342d06899c4c015320",
              "agreement_value": 2
            }
          ]
        },
        "consents": [
          {
            "consent_id": "8fd73167342d06899c4c015320",
            "consent_value": 2,
            "last_change": "2024-06-23 11:47:23"
          }
        ]
      }
    },
    "shipping_data": {
      "shipping_id": "81eaeea13b8984a69c490a325",
      "contact_firstname": "John",
      "contact_lastname": "Smith",
      "phone": "38612345678",
      "address": {
        "address1": "Old Town Square",
        "address2": "34",
        "address3": "1a",
        "zip": "11000",
        "city": "Prague 1",
        "country_code": "cz"
      }
    },
    "customer_note": "Have a nice day!",
    "order_status": "New Uncomfirmed",
    "shipping_date": "2019-07-19 17:26:34",
    "program_ranking": 4,
    "payment_status": "Unpaid",
    "invoice_document_url": "https://example.crmcarecloud.com/invoices/1c68a470eaaeff",
    "last_change": "2019-07-15 17:26:34"
  }
}