Grand Shift PoS Integration API

Seamlessly integrate your Point of Sale system with Grand Shift to automate transactions, invoices, and cashback processing.

Overview

The Grand Shift PoS Integration API enables vendors to:

Lookup customers before submitting transactions
Submit customer purchase transactions
Automatically approve invoices and calculate cashback
Credit cashback rewards to customers' GrandShift wallets
Handle full refunds with automatic cashback reversal

Environment & Base URL

All endpoints in the development environment are relative to:

Base URL (Development)

https://dev.api.grandshifts.com

Development Swagger

Access the interactive Swagger documentation at https://dev.api.grandshifts.com/pos-docs

Production Access

After development is complete, switch to the production environment by contacting Grand Shift technical support.

Authentication

All API requests require authentication using an API key. Include your API key in the request header:

x-api-keyYour PoS API key

Example Request with Authentication

curl -X 'GET' \
  'https://dev.api.grandshifts.com/pos/v1/invoices/INV-001/status' \
  -H 'accept: application/json' \
  -H 'x-api-key: YOUR_API_KEY'

Get Your API Key

To obtain an API key, log in to your vendor dashboard, navigate to a branch, go to the PoS Configuration page, and create a new API key. See the Authentication guide for step-by-step instructions.

Security Scheme

Type	apiKey
Location	header
Header Name	x-api-key

Available Endpoints

GET/pos/v1/invoices/customers/lookupLookup Customer

POST/pos/v1/invoicesSubmit Transaction

GET/pos/v1/invoices/{invoiceNumber}/statusCheck Status

POST/pos/v1/invoices/{invoiceNumber}/refundProcess Refund

Quick Start

Create a vendor account if you don't have one
Obtain your API key from the vendor dashboard
Lookup customers before submitting transactions
Submit your first transaction
Review error handling and transaction lifecycle