POS API

Name: POS API API
Brand: POS API
Availability: InStock

✓ Official Vendor SpecPaymentsPos TerminalapiKey46 EndpointsREST

For Agents

Create orders, capture payments, and manage menu items, modifiers, and locations across Square, Clover, Lightspeed, Toast, and Shopify POS through one unified API.

Connect the POS API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the POS API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with POS API API.

Create an order with line items and modifiers, then close it out via POST /pos/orders/{id}/pay

Capture, list, retrieve, update, and refund payments through the /pos/payments endpoints

Sync a merchant's menu by managing items, modifiers, and modifier groups

List and update merchant and location records to support multi-site rollouts

GET STARTED

Start building with POS API API

Explore with Jentic

View OpenAPI Document

The Apideck POS API is a unified interface across point-of-sale platforms including Square, Clover, Lightspeed, Toast, and Shopify POS. A single set of 46 endpoints covers orders, payments, merchants, locations, items, modifiers, modifier groups, order types, and tenders, eliminating the need to maintain a separate integration per POS vendor. Orders, payments, and the surrounding catalog resources support full CRUD plus a dedicated POST /pos/orders/{id}/pay endpoint that closes out an order. Designed for marketplaces, loyalty programs, and back-office tools that need to read or write to whichever POS the merchant runs.

Use Cases

Patterns agents use POS API API for, with concrete tasks.

★ Online Ordering Connected to In-Store POS

Build an online ordering experience (web or app) that drops orders directly into the merchant's POS — Square, Clover, Lightspeed, Toast, or Shopify POS — without writing a separate integration per platform. POST /pos/orders creates the order with line items and modifiers, then POST /pos/orders/{id}/pay records the payment. Items, modifiers, and locations are read from the same API so the online menu stays in sync.

Create an order at location 'loc_42' with two items including modifier groups, then call POST /pos/orders/{id}/pay with payment_method 'card' and verify the resulting status

Cross-POS Menu Sync

Push menu changes from a central catalog out to every merchant's POS — items, modifiers, modifier groups, and order types are normalised across providers. POST and PATCH on /pos/items, /pos/modifiers, and /pos/modifier-groups apply consistently regardless of whether the merchant is on Square or Clover. Useful for franchise tools or multi-location loyalty programs.

For each item in the new menu, PATCH /pos/items/{id} with the updated price; if the item ID does not exist, POST /pos/items to create it

Sales Reporting and Reconciliation

Aggregate orders, payments, and tender data from a merchant's POS into a back-office reporting tool. GET /pos/orders, GET /pos/payments, and GET /pos/tenders return normalised data across providers, so the same reporting code works whether the merchant runs Square, Clover, or Lightspeed. Useful for accounting integrations and financial dashboards.

List all orders and payments at location 'loc_42' for date 2026-06-08, group by order type, and return total gross sales and total tender count per group

AI Agent POS Workflow via Jentic

An AI agent fields a request like 'how many lattes did we sell today across all locations?'. Through Jentic, the agent searches 'list pos orders', loads the GET /pos/orders operation, and executes it filtered by date and item. Jentic stores the Apideck Authorization, x-apideck-app-id, and x-apideck-consumer-id headers separately, and the agent never holds raw credentials.

Through Jentic, search 'list pos orders', load GET /pos/orders, filter by date 2026-06-08, then aggregate line items by name and return the count for 'Latte'

Key Endpoints

46 endpoints — the apideck pos api is a unified interface across point-of-sale platforms including square, clover, lightspeed, toast, and shopify pos.

METHOD

PATH

DESCRIPTION

POST

/pos/orders

Create an order

POST

/pos/orders/{id}/pay

Pay/close an order

POST

/pos/payments

Create a payment

GET

/pos/payments

List payments

POST

/pos/items

Create a menu item

GET

/pos/locations

List merchant locations

POST

/pos/modifier-groups

Create a modifier group

GET

/pos/orders

List orders

POST

/pos/orders

Create an order

POST

/pos/orders/{id}/pay

Pay/close an order

POST

/pos/payments

Create a payment

GET

/pos/payments

List payments

POST

/pos/items

Create a menu item

GET

/pos/locations

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Apideck application keys, x-apideck-app-id, and x-apideck-consumer-id values are stored encrypted in the Jentic vault. Agents receive scoped execution tokens and never see the raw Authorization value, even when capturing payment on behalf of a merchant.

Intent-based discovery

Agents search by intent (for example 'create a pos order' or 'list payments today') and Jentic returns the matching POS operation with its input schema, so the agent calls POST /pos/orders or GET /pos/payments without consulting Apideck or per-vendor docs.

Time to first call

Direct Apideck POS integration: 2-4 days for auth, item/modifier mapping, payment flow, and per-connector edge cases. Through Jentic: under 1 hour — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Square API

Square-only POS, payments, and catalog API with deeper Square-specific features the unified API does not surface.

Choose Square direct when the merchant is Square-only and needs Square-specific features (Cash App integration, gift cards); choose Apideck POS for write-once cross-platform code.

Alternative

Shopify API

Shopify Admin API covers Shopify POS plus full e-commerce storefront management.

Choose Shopify direct when the merchant is Shopify-only and needs storefront/inventory features beyond POS; choose Apideck POS for multi-vendor portability.

Complementary

Apideck Vault API

Vault sets up the OAuth or API key connection the POS API executes against.

Use Vault first to authorise the merchant's POS connection; then call POS endpoints scoped to the resulting consumer.

FAQs

Specific to using POS API API through Jentic.

What authentication does the Apideck POS API use?

An apiKey scheme on the `Authorization` header with your Apideck application key, plus `x-apideck-app-id` and `x-apideck-consumer-id` headers identifying the application and the merchant. Through Jentic these are stored encrypted in the vault and injected at execution.

Can I create an order and capture payment in one workflow?

Yes. POST /pos/orders creates the order with line items and modifiers, then POST /pos/orders/{id}/pay closes it out — supplying the payment method and any tip or tender details. Both calls are normalised across Square, Clover, Lightspeed, Toast, and Shopify POS.

What are the rate limits for the Apideck POS API?

The OpenAPI spec does not publish per-endpoint rate limits. Apideck applies plan-based limits at unify.apideck.com plus per-connector limits passed through from the underlying POS (Square's 300 req/sec per endpoint, Clover's lower per-merchant burst, etc.). See https://developers.apideck.com for your plan's quotas.

How do I create an order through Jentic?

Install with `pip install jentic`, then run the search query 'create a pos order'. Jentic returns POST /pos/orders — load its schema, supply location_id, line items with item_id and quantity plus any modifiers, then execute. Follow up with POST /pos/orders/{id}/pay to close out.

Which POS providers does this API support?

Apideck's POS Unified API normalises Square, Clover, Lightspeed, Toast, and Shopify POS behind a single set of 46 endpoints. The provider used for a given call is determined by the connection associated with the x-apideck-consumer-id; manage connections via the Vault API.

Can I refund a payment with this API?

Yes. DELETE /pos/payments/{id} initiates a refund/void on the underlying POS. Refund semantics follow the provider's rules — partial refunds and refund windows depend on whether the merchant is on Square, Clover, or another connector.