Get all orders

curl --request GET \
  --url https://api.chift.eu/consumers/{consumer_id}/commerce/orders

import requests

url = "https://api.chift.eu/consumers/{consumer_id}/commerce/orders"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.chift.eu/consumers/{consumer_id}/commerce/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.chift.eu/consumers/{consumer_id}/commerce/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.chift.eu/consumers/{consumer_id}/commerce/orders"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.chift.eu/consumers/{consumer_id}/commerce/orders")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.chift.eu/consumers/{consumer_id}/commerce/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": "<string>",
      "source_ref": {
        "id": "<string>",
        "model": "<string>"
      },
      "discount_amount": 123,
      "untaxed_amount_without_fees": 123,
      "tax_amount_without_fees": 123,
      "total_without_fees": 123,
      "current_untaxed_amount": 123,
      "current_tax_amount": 123,
      "current_total": 123,
      "untaxed_amount": 123,
      "tax_amount": 123,
      "total": 123,
      "currency": "<string>",
      "lines": [
        {
          "id": "<string>",
          "source_ref": {
            "id": "<string>",
            "model": "<string>"
          },
          "quantity": 123,
          "current_quantity": 123,
          "unit_price": 123,
          "description": "<string>",
          "tax_rate": 123,
          "untaxed_amount": 123,
          "tax_amount": 123,
          "total": 123,
          "created_on": "2023-11-07T05:31:56Z",
          "variant": {
            "id": "<string>",
            "name": "<string>",
            "sku": "<string>",
            "categories": []
          },
          "tax_id": "<string>",
          "discounts": [],
          "gift_card": false,
          "is_gift": false
        }
      ],
      "order_number": "<string>",
      "customer": {
        "id": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "phone": "<string>",
        "internal_notes": "<string>",
        "email": "<string>"
      },
      "billing_address": {
        "company_name": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "street": "<string>",
        "number": "<string>",
        "box": "<string>",
        "city": "<string>",
        "postal_code": "<string>",
        "country": "<string>",
        "phone": "<string>",
        "email": "<string>",
        "vat": "<string>"
      },
      "shipping_address": {
        "company_name": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "street": "<string>",
        "number": "<string>",
        "box": "<string>",
        "city": "<string>",
        "postal_code": "<string>",
        "country": "<string>",
        "phone": "<string>",
        "email": "<string>",
        "vat": "<string>"
      },
      "created_on": "2023-11-07T05:31:56Z",
      "last_updated_on": "2023-11-07T05:31:56Z",
      "confirmed_on": "2023-11-07T05:31:56Z",
      "delivery_date": "2023-11-07T05:31:56Z",
      "cancelled_on": "2023-11-07T05:31:56Z",
      "fulfillment": {
        "shipping_from_address": {
          "name": "<string>",
          "number": "<string>",
          "box": "<string>",
          "phone": "<string>",
          "mobile": "<string>",
          "email": "<string>",
          "street": "<string>",
          "city": "<string>",
          "postal_code": "<string>",
          "country": "<string>"
        }
      },
      "refunded_amount": 0,
      "note": "<string>",
      "tags": [],
      "other_fees": [],
      "payment_method_id": "<string>",
      "transactions": [],
      "payment_methods": [],
      "detailed_refunds": [
        {
          "id": "<string>",
          "source_ref": {
            "id": "<string>",
            "model": "<string>"
          },
          "total": 123,
          "created_on": "2023-11-07T05:31:56Z",
          "reason": "<string>",
          "order_lines": [],
          "other": 0,
          "shipping_refunds": [],
          "other_fees": [],
          "transactions": []
        }
      ],
      "returns": []
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2
}

GET

consumers

{consumer_id}

commerce

orders

Get all orders

curl --request GET \
  --url https://api.chift.eu/consumers/{consumer_id}/commerce/orders

import requests

url = "https://api.chift.eu/consumers/{consumer_id}/commerce/orders"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.chift.eu/consumers/{consumer_id}/commerce/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.chift.eu/consumers/{consumer_id}/commerce/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.chift.eu/consumers/{consumer_id}/commerce/orders"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.chift.eu/consumers/{consumer_id}/commerce/orders")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.chift.eu/consumers/{consumer_id}/commerce/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": "<string>",
      "source_ref": {
        "id": "<string>",
        "model": "<string>"
      },
      "discount_amount": 123,
      "untaxed_amount_without_fees": 123,
      "tax_amount_without_fees": 123,
      "total_without_fees": 123,
      "current_untaxed_amount": 123,
      "current_tax_amount": 123,
      "current_total": 123,
      "untaxed_amount": 123,
      "tax_amount": 123,
      "total": 123,
      "currency": "<string>",
      "lines": [
        {
          "id": "<string>",
          "source_ref": {
            "id": "<string>",
            "model": "<string>"
          },
          "quantity": 123,
          "current_quantity": 123,
          "unit_price": 123,
          "description": "<string>",
          "tax_rate": 123,
          "untaxed_amount": 123,
          "tax_amount": 123,
          "total": 123,
          "created_on": "2023-11-07T05:31:56Z",
          "variant": {
            "id": "<string>",
            "name": "<string>",
            "sku": "<string>",
            "categories": []
          },
          "tax_id": "<string>",
          "discounts": [],
          "gift_card": false,
          "is_gift": false
        }
      ],
      "order_number": "<string>",
      "customer": {
        "id": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "phone": "<string>",
        "internal_notes": "<string>",
        "email": "<string>"
      },
      "billing_address": {
        "company_name": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "street": "<string>",
        "number": "<string>",
        "box": "<string>",
        "city": "<string>",
        "postal_code": "<string>",
        "country": "<string>",
        "phone": "<string>",
        "email": "<string>",
        "vat": "<string>"
      },
      "shipping_address": {
        "company_name": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "street": "<string>",
        "number": "<string>",
        "box": "<string>",
        "city": "<string>",
        "postal_code": "<string>",
        "country": "<string>",
        "phone": "<string>",
        "email": "<string>",
        "vat": "<string>"
      },
      "created_on": "2023-11-07T05:31:56Z",
      "last_updated_on": "2023-11-07T05:31:56Z",
      "confirmed_on": "2023-11-07T05:31:56Z",
      "delivery_date": "2023-11-07T05:31:56Z",
      "cancelled_on": "2023-11-07T05:31:56Z",
      "fulfillment": {
        "shipping_from_address": {
          "name": "<string>",
          "number": "<string>",
          "box": "<string>",
          "phone": "<string>",
          "mobile": "<string>",
          "email": "<string>",
          "street": "<string>",
          "city": "<string>",
          "postal_code": "<string>",
          "country": "<string>"
        }
      },
      "refunded_amount": 0,
      "note": "<string>",
      "tags": [],
      "other_fees": [],
      "payment_method_id": "<string>",
      "transactions": [],
      "payment_methods": [],
      "detailed_refunds": [
        {
          "id": "<string>",
          "source_ref": {
            "id": "<string>",
            "model": "<string>"
          },
          "total": 123,
          "created_on": "2023-11-07T05:31:56Z",
          "reason": "<string>",
          "order_lines": [],
          "other": 0,
          "shipping_refunds": [],
          "other_fees": [],
          "transactions": []
        }
      ],
      "returns": []
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2
}

Path Parameters

consumer_id

string<uuid>

required

Query Parameters

page

integer

default:1

Page number

Required range: x >= 1

size

integer

default:50

Page size

Required range: 1 <= x <= 100

date_from

string<date> | null

Filter orders created at or after this date (e.g. 2023-01-31)

date_to

string<date> | null

Filter orders created at or before this date (e.g. 2023-01-31)

updated_after

string<date-time> | null

Filter orders last updated at or after this date (e.g. 2023-01-31T15:00:00 for 31 of January 2023 at 3PM UTC). UTC is the only format that is supported on all connectors.

include_detailed_refunds

enum<string> | null

default:false

Include detailed information concerning refunds

Available options:

true,

false

include_product_categories

enum<string> | null

default:false

Include detailed information about categories

Available options:

true,

false

include_customer_details

enum<string> | null

default:true

Include detailed information about customer

Available options:

true,

false

Response

Successful Response

items

OrderItemOut · object[]

required

Show child attributes

total

integer

required

Required range: x >= 0

page

integer

required

Required range: x >= 1

size

integer

required

Required range: x >= 1

Get tax rates (POS)Get one specific order

⌘I

API Reference Overview

Access & Connections

Accounting

Invoicing

POS

eCommerce

PMS

Payment

Banking

Other

Get all orders

Path Parameters

Query Parameters

Response