Point of Sales Integration

POS API Overview

The Point of Sale (POS) API allows you to manage the physical infrastructure of your commerce operations. The system follows a hierarchical structure:

  1. Branches: Represent physical store locations with specific operating hours. Each branch can have several Sales Registers.
  2. Sales Registers: Specific checkout stations located within a Branch. Each Sales Register can have one Terminal.
  3. Terminals: Physical hardware enabled for POS mode and linked to a specific Sales Register.

Authentication

All POS API endpoints require JWT authentication. You must include your token in the Authorization header for every request.

Headers

  • Authorization: Bearer <token>
  • Content-Type: application/json

Example Request

curl --location '[https://api.ecartpay.com/api/pos/branches](https://api.ecartpay.com/api/pos/branches)' \
--header 'Authorization: Bearer YOUR_JWT_TOKEN' \
--header 'Content-Type: application/json'