Apideck

POS API

Welcome to the POS API. You can use this API to access all POS API endpoints. Base URL The base URL for all API requests is https://unify.apideck.com Headers…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Welcome to the POS API.

You can use this API to access all POS API endpoints.

Base URL

The base URL for all API requests is https://unify.apideck.com

Headers

Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive.

NameTypeRequiredDescription
x-apideck-consumer-idStringYesThe id of the customer stored inside Apideck Vault. This can be a user id, account id, device id or whatever entity that can have integration within your app.
x-apideck-service-idStringNoDescribe the service you want to call (e.g., pipedrive). Only needed when a customer has activated multiple integrations for the same Unified API.
x-apideck-app-idStringYesThe application id of your Unify application. Available at https://app.apideck.com/unify/api-keys.
AuthorizationStringYesBearer KEY

Authorization

You can interact with the API through the authorization methods below.

-->

Pagination

All API resources have support for bulk retrieval via list APIs. Apideck uses cursor-based pagination via the optional cursor and limit parameters.

To fetch the first page of results, call the list API without a cursor parameter. Afterwards you can fetch subsequent pages by providing a cursor parameter. You will find the next cursor in the response body in meta.cursors.next. If meta.cursors.next is null you're at the end of the list.

In the REST API you can also use the links from the response for added convenience. Simply call the URL in links.next to get the next page of results.

Query Parameters

NameTypeRequiredDescription
cursorStringNoCursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response.
limitNumberNoNumber of results to return. Minimum 1, Maximum 200, Default 20

Response Body

NameTypeDescription
meta.cursors.previousStringCursor to navigate to the previous page of results through the API
meta.cursors.currentStringCursor to navigate to the current page of results through the API
meta.cursors.nextStringCursor to navigate to the next page of results through the API
meta.items_on_pageNumberNumber of items returned in the data property of the response
links.previousStringLink to navigate to the previous page of results through the API
links.currentStringLink to navigate to the current page of results through the API
links.nextStringLink to navigate to the next page of results through the API

⚠️ meta.cursors.previous/links.previous is not available for all connectors.

SDKs and API Clients

We currently offer a Node.js, PHP, Python and .NET SDK.
Need another SDK? Request the SDK of your choice.

Debugging

Because of the nature of the abstraction we do in Apideck Unify we still provide the option to the receive raw requests and responses being handled underlying. By including the raw flag ?raw=true in your requests you can still receive the full request. Please note that this increases the response size and can introduce extra latency.

Errors

The API returns standard HTTP response codes to indicate success or failure of the API requests. For errors, we also return a customized error message inside the JSON response. You can see the returned HTTP status codes below.

CodeTitleDescription …

Endpoints 46

Orders

  • GETList Orders/pos/orders?raw=false&cursor=string&limit=20&location_id=string&fields=id,updated_atList Orders
  • POSTCreate Order/pos/orders?raw=falseCreate Order
  • GETGet Order/pos/orders/:id?raw=false&fields=id,updated_atGet Order
  • DELETEDelete Order/pos/orders/:id?raw=falseDelete Order
  • PATCHUpdate Order/pos/orders/:id?raw=falseUpdates an open order by adding, replacing, or deleting fields. Square-only: Orders with a completed or canceled status cannot be updated. To pay for an…
  • POSTPay Order/pos/orders/:id/pay?raw=false&fields=id,updated_atPay Order

Payments

  • GETList Payments/pos/payments?raw=false&cursor=string&limit=20&fields=id,updated_atList Payments
  • POSTCreate Payment/pos/payments?raw=falseCreate Payment
  • GETGet Payment/pos/payments/:id?raw=false&fields=id,updated_atGet Payment
  • DELETEDelete Payment/pos/payments/:id?raw=falseDelete Payment
  • PATCHUpdate Payment/pos/payments/:id?raw=falseUpdate Payment

Merchants

  • GETList Merchants/pos/merchants?raw=false&cursor=string&limit=20&fields=id,updated_atList Merchants
  • POSTCreate Merchant/pos/merchants?raw=falseCreate Merchant
  • GETGet Merchant/pos/merchants/:id?raw=false&fields=id,updated_atGet Merchant
  • DELETEDelete Merchant/pos/merchants/:id?raw=falseDelete Merchant
  • PATCHUpdate Merchant/pos/merchants/:id?raw=falseUpdate Merchant

Locations

  • GETList Locations/pos/locations?raw=false&cursor=string&limit=20&fields=id,updated_atList Locations
  • POSTCreate Location/pos/locations?raw=falseCreate Location
  • GETGet Location/pos/locations/:id?raw=false&fields=id,updated_atGet Location
  • DELETEDelete Location/pos/locations/:id?raw=falseDelete Location
  • PATCHUpdate Location/pos/locations/:id?raw=falseUpdate Location

Items

  • GETList Items/pos/items?raw=false&cursor=string&limit=20&fields=id,updated_atList Items
  • POSTCreate Item/pos/items?raw=falseCreate Item
  • GETGet Item/pos/items/:id?raw=false&fields=id,updated_atGet Item
  • DELETEDelete Item/pos/items/:id?raw=falseDelete Item
  • PATCHUpdate Item/pos/items/:id?raw=falseUpdate Item

Modifiers

  • GETList Modifiers/pos/modifiers?raw=false&cursor=string&limit=20&fields=id,updated_atList Modifiers
  • POSTCreate Modifier/pos/modifiers?raw=falseCreate Modifier
  • GETGet Modifier/pos/modifiers/:id?raw=false&filter={"modifier_group_id":"1234"}&fields=id,updated_atGet Modifier
  • DELETEDelete Modifier/pos/modifiers/:id?raw=false&filter={"modifier_group_id":"1234"}Delete Modifier
  • PATCHUpdate Modifier/pos/modifiers/:id?raw=falseUpdate Modifier

Modifier Groups

  • GETList Modifier Groups/pos/modifier-groups?raw=false&cursor=string&limit=20&fields=id,updated_atList Modifier Groups
  • POSTCreate Modifier Group/pos/modifier-groups?raw=falseCreate Modifier Group
  • GETGet Modifier Group/pos/modifier-groups/:id?raw=false&fields=id,updated_atGet Modifier Group
  • DELETEDelete Modifier Group/pos/modifier-groups/:id?raw=falseDelete Modifier Group
  • PATCHUpdate Modifier Group/pos/modifier-groups/:id?raw=falseUpdate Modifier Group

Order Types

  • GETList Order Types/pos/order-types?raw=false&cursor=string&limit=20&fields=id,updated_atList Order Types
  • POSTCreate Order Type/pos/order-types?raw=falseCreate Order Type
  • GETGet Order Type/pos/order-types/:id?raw=false&fields=id,updated_atGet Order Type
  • DELETEDelete Order Type/pos/order-types/:id?raw=falseDelete Order Type
  • PATCHUpdate Order Type/pos/order-types/:id?raw=falseUpdate Order Type

Tenders

  • GETList Tenders/pos/tenders?raw=false&cursor=string&limit=20&fields=id,updated_atList Tenders
  • POSTCreate Tender/pos/tenders?raw=falseCreate Tender
  • GETGet Tender/pos/tenders/:id?raw=false&fields=id,updated_atGet Tender
  • DELETEDelete Tender/pos/tenders/:id?raw=falseDelete Tender
  • PATCHUpdate Tender/pos/tenders/:id?raw=falseUpdate Tender

API details

Base URL
https://unify.apideck.com
Authentication
An API key in the Authorization header
Operations
46 operations on 19 pathsGET 18POST 10PATCH 9DELETE 9
Main resources
Orders 6Items 5Locations 5Merchants 5Modifier Groups 5Modifiers 5Order Types 5Payments 5Tenders 5
Description format
OpenAPI 3.0.0, API version 10.83.0

How to test the POS API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the POS API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List Orders” (GET /pos/orders?raw=false&cursor=string&limit=20&location_id=string&fields=id,updated_at), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the POS API?

Welcome to the POS API. You can use this API to access all POS API endpoints. Base URL The base URL for all API requests is https://unify.apideck.com Headers… It is listed under Developer tools and has 46 endpoints.

Who publishes the POS API?

It is listed from Apideck's public API description (an OpenAPI document), not published by Apideck on Swastik Codes. Anyone who controls apideck.com can claim the profile by adding a DNS TXT record.

What is the base URL of the POS API?

Requests go to https://unify.apideck.com. Endpoint paths are added to this base URL.

How do I authenticate with the POS API?

With an API key in the Authorization header.

How many endpoints does the POS API have?

46 operations on 19 paths (18 GET, 10 POST, 9 PATCH, 9 DELETE). The largest groups are Orders, Items, Locations, Merchants.

Is forking the POS API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.