List in-person sales
curl --request GET \
--url https://api.salesive.com/api/v1/pos/sales \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.salesive.com/api/v1/pos/sales"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.salesive.com/api/v1/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.salesive.com/api/v1/pos/sales",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.salesive.com/api/v1/pos/sales"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.salesive.com/api/v1/pos/sales")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.salesive.com/api/v1/pos/sales")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": 123,
"success": true,
"message": "<string>",
"data": {
"sales": [
{
"_id": "<string>",
"orderId": 123,
"shop": "<string>",
"user": "<string>",
"items": [
{
"_id": "<string>",
"name": "<string>",
"price": 123,
"quantity": 123,
"sku": "<string>",
"imageUrl": "<string>",
"itemType": "product"
}
],
"subtotal": 123,
"discount": 123,
"tax": 123,
"shippingCost": 123,
"status": "pending",
"source": "online",
"paymentMethod": "cash",
"posCustomerName": "<string>",
"posCustomerEmail": "<string>",
"posCustomerPhone": "<string>",
"additionalInfo": [
{
"label": "<string>",
"value": "<string>"
}
],
"payment": {
"_id": "<string>",
"status": "<string>",
"amount": 123,
"total": 123,
"channel": "<string>",
"provider": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"total": 123,
"page": 123,
"limit": 123,
"pages": 123,
"hasNext": true,
"hasPrev": true,
"nextPage": 123,
"prevPage": 123
}
}
}Point of sale
List in-person sales
List POS sales, newest first, with date and payment filters. Requires the READ_POS scope.
GET
/
pos
/
sales
List in-person sales
curl --request GET \
--url https://api.salesive.com/api/v1/pos/sales \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.salesive.com/api/v1/pos/sales"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.salesive.com/api/v1/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.salesive.com/api/v1/pos/sales",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.salesive.com/api/v1/pos/sales"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.salesive.com/api/v1/pos/sales")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.salesive.com/api/v1/pos/sales")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": 123,
"success": true,
"message": "<string>",
"data": {
"sales": [
{
"_id": "<string>",
"orderId": 123,
"shop": "<string>",
"user": "<string>",
"items": [
{
"_id": "<string>",
"name": "<string>",
"price": 123,
"quantity": 123,
"sku": "<string>",
"imageUrl": "<string>",
"itemType": "product"
}
],
"subtotal": 123,
"discount": 123,
"tax": 123,
"shippingCost": 123,
"status": "pending",
"source": "online",
"paymentMethod": "cash",
"posCustomerName": "<string>",
"posCustomerEmail": "<string>",
"posCustomerPhone": "<string>",
"additionalInfo": [
{
"label": "<string>",
"value": "<string>"
}
],
"payment": {
"_id": "<string>",
"status": "<string>",
"amount": 123,
"total": 123,
"channel": "<string>",
"provider": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"total": 123,
"page": 123,
"limit": 123,
"pages": 123,
"hasNext": true,
"hasPrev": true,
"nextPage": 123,
"prevPage": 123
}
}
}Only records with source
pos are returned, so this route cannot be used to read online orders. Use from and to for the date range, paymentMethod to split cash, card, transfer and other, and page/limit to paginate.Authorizations
Query Parameters
Response
The matching sales and pagination metadata.
Was this page helpful?

