Get sales

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

const options = {method: 'GET'};

fetch('https://api.chift.eu/consumers/{consumer_id}/pos/sales', 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}/pos/sales",
  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}/pos/sales"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

{
  "total": 10,
  "tax_amount": 1,
  "taxes": []
}

{
  "message": "Error while trying to perform your request",
  "status": "error"
}

{
  "message": "The resource {Method} - {Resource} is not supported by {ConnectorName}",
  "status": "error"
}

{
  "message": "Validation error",
  "status": "error",
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "message": "Error while trying to authenticate to {ConnectorName}",
  "status": "error"
}

GET

consumers

{consumer_id}

pos

sales

Get sales

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

const options = {method: 'GET'};

fetch('https://api.chift.eu/consumers/{consumer_id}/pos/sales', 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}/pos/sales",
  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}/pos/sales"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

{
  "total": 10,
  "tax_amount": 1,
  "taxes": []
}

{
  "message": "Error while trying to perform your request",
  "status": "error"
}

{
  "message": "The resource {Method} - {Resource} is not supported by {ConnectorName}",
  "status": "error"
}

{
  "message": "Validation error",
  "status": "error",
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "message": "Error while trying to authenticate to {ConnectorName}",
  "status": "error"
}

Learn more:

What are sales? ↗
What is an order? ↗
How are amounts and taxes rounded? ↗

Path Parameters

consumer_id

string<uuid>

required

Query Parameters

date_from

string<date>

required

Start date (inclusive) of the period to get sales from

date_to

string<date>

required

End date (inclusive) of the period to get sales from

location_id

string | null

Unique identifier of the location. If none passed, sales from all locations will be returned unless the location was selected by the end-user

Response

Successful Response

total

number

required

Total amount including tax of the sales

Example:

10

tax_amount

number

required

Total amount of the taxes

Example:

1

taxes

TotalTaxItem · object[] | null

List of taxes grouped by tax rateapplied to the sales

Show child attributes

API Reference Overview

Access & Connections

Accounting

Invoicing

POS

eCommerce

PMS

Payment

Banking

Other

Get sales

Path Parameters

Query Parameters

Response