We launched the Accounting Sample!Manage invoices, payments, expenses, and more across multiple connectors.

Apideck Documentation Page
Search docs

POS API Reference

One single API to push and pull data from multiple connectors.

9.7.4

Introduction

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

We also provide a Mock API that can be used for testing purposes: https://mock-api.apideck.com

Headers

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

Name Type Required Description
x-apideck-consumer-id String Yes The 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-id String No Describe 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-raw Boolean No Include raw response. Mostly used for debugging purposes.
x-apideck-app-id String Yes The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys.
Authorization String Yes Bearer API KEY

Authorization

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

apiKey

To use API you have to sign up and get your own API key. Unify API accounts have sandbox mode and live mode API keys. To change modes just use the appropriate key to get a live or test object. You can find your API keys on the unify settings of your Apideck app. Your Apideck application_id can also be found on the same page.

Authenticate your API requests by including your test or live secret API key in the request header.

  • Bearer authorization header: Authorization: Bearer <your-apideck-api-key>
  • Application id header: x-apideck-app-id: <your-apideck-app-id>

You should use the public keys on the SDKs and the secret keys to authenticate API requests.

Do not share or include your secret API keys on client side code. Your API keys carry significant privileges. Please ensure to keep them 100% secure and be sure to not share your secret API keys in areas that are publicly accessible like GitHub.

Learn how to set the Authorization header inside Postman https://learning.postman.com/docs/postman/sending-api-requests/authorization/#api-key

Go to Unify to grab your API KEY https://app.apideck.com/unify/api-keys

Security Scheme Type API Key
Header parameter name Authorization

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

Name Type Required Description
cursor String No Cursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response.
limit Number No Number of results to return. Minimum 1, Maximum 200, Default 20

Response Body

Name Type Description
meta.cursors.previous String Cursor to navigate to the previous page of results through the API
meta.cursors.current String Cursor to navigate to the current page of results through the API
meta.cursors.next String Cursor to navigate to the next page of results through the API
meta.items_on_page Number Number of items returned in the data property of the response
links.previous String Link to navigate to the previous page of results through the API
links.current String Link to navigate to the current page of results through the API
links.next String Link 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 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.

Code Title Description
200 OK The request message has been successfully processed, and it has produced a response. The response message varies, depending on the request method and the requested data.
201 Created The request has been fulfilled and has resulted in one or more new resources being created.
204 No Content The server has successfully fulfilled the request and that there is no additional content to send in the response payload body.
400 Bad Request The receiving server cannot understand the request because of malformed syntax. Do not repeat the request without first modifying it; check the request for errors, fix them and then retry the request.
401 Unauthorized The request has not been applied because it lacks valid authentication credentials for the target resource.
402 Payment Required Subscription data is incomplete or out of date. You'll need to provide payment details to continue.
403 Forbidden You do not have the appropriate user rights to access the request. Do not repeat the request.
404 Not Found The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.
409 Conflict The request could not be completed due to a conflict with the current state of the target resource.
422 Unprocessable Entity The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions.
429 Too Many Requests You sent too many requests in a given amount of time ("rate limit"). Try again later
5xx Server Errors Something went wrong with the Unify API. These errors are logged on our side. You can contact our team to resolve the issue.

Handling errors

The Unify API and SDKs can produce errors for many reasons, such as a failed requests due to misconfigured integrations, invalid parameters, authentication errors, and network unavailability.

Error Types

RequestValidationError

Request is not valid for the current endpoint. The response body will include details on the validation error. Check the spelling and types of your attributes, and ensure you are not passing data that is outside of the specification.

UnsupportedFiltersError

Filters in the request are valid, but not supported by the connector. Remove the unsupported filter(s) to get a successful response.

UnsupportedSortFieldError

Sort field (sort[by]) in the request is valid, but not supported by the connector. Replace or remove the sort field to get a successful response.

InvalidCursorError

Pagination cursor in the request is not valid for the current connector. Make sure to use a cursor returned from the API, for the same connector.

ConnectorExecutionError

A Unified API request made via one of our downstream connectors returned an unexpected error. The status_code returned is proxied through to error response along with their original response via the error detail.

UnauthorizedError

We were unable to authorize the request as made. This can happen for a number of reasons, from missing header params to passing an incorrect authorization token. Verify your Api Key is being set correctly in the authorization header. ie: Authorization: 'Bearer sk_live_***'

ConnectorCredentialsError

A request using a given connector has not been authorized. Ensure the connector you are trying to use has been configured correctly and been authorized for use.

ConnectorDisabledError

A request has been made to a connector that has since been disabled. This may be temporary - You can contact our team to resolve the issue.

ConnectorRateLimitError

You sent too many request to a connector. These rate limits vary from connector to connector. You will need to try again later.

RequestLimitError

You have reached the number of requests included in your Free Tier Subscription. You will no be able to make further requests until this limit resets at the end of the month, or talk to us about upgrading your subscription to continue immediately.

EntityNotFoundError

You've made a request for a resource or route that does not exist. Verify your path parameters or any identifiers used to fetch this resource.

OAuthCredentialsNotFoundError

When adding a connector integration that implements OAuth, both a client_id and client_secret must be provided before any authorizations can be performed. Verify the integration has been configured properly before continuing.

IntegrationNotFoundError

The requested connector integration could not be found associated to your application_id. Verify your application_id is correct, and that this connector has been added and configured for your application.

ConnectionNotFoundError

A valid connection could not be found associated to your application_id. Something may have interrupted the authorization flow. You may need to start the connector authorization process again.

ConnectionSettingsError

The connector has required settings that were not supplied. Verify connection.settings contains all required settings for the connector to be callable.

ConnectorNotFoundError

A request was made for an unknown connector. Verify your service_id is spelled correctly, and that this connector is enabled for your provided unified_api.

OAuthRedirectUriError

A request was made either in a connector authorization flow, or attempting to revoke connector access without a valid redirect_uri. This is the url the user should be returned to on completion of process.

OAuthInvalidStateError

The state param is required and is used to ensure the outgoing authorization state has not been altered before the user is redirected back. It also contains required params needed to identify the connector being used. If this has been altered, the authorization will not succeed.

OAuthCodeExchangeError

When attempting to exchange the authorization code for an access_token during an OAuth flow, an error occurred. This may be temporary. You can reattempt authorization or contact our team to resolve the issue.

OAuthConnectorError

It seems something went wrong on the connector side. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.

MappingError

There was an error attempting to retrieve the mapping for a given attribute. We've been notified and are working to fix this issue.

ConnectorMappingNotFoundError

It seems the implementation for this connector is incomplete. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.

ConnectorResponseMappingNotFoundError

We were unable to retrieve the response mapping for this connector. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.

ConnectorOperationMappingNotFoundError

Connector mapping has not been implemented for the requested operation. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.

ConnectorWorkflowMappingError

The composite api calls required for this operation have not been mapped entirely. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.

ConnectorOperationUnsupportedError

You're attempting a call that is not supported by the connector. It's likely this operation is supported by another connector, but we're unable to implement for this one.

PaginationNotSupportedError

Pagination is not yet supported for this connector, try removing limit and/or cursor from the query. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.

API Design

API Styles and data formats

REST API

The API is organized around REST, providing simple and predictable URIs to access and modify objects. Requests support standard HTTP methods like GET, PUT, POST, and DELETE and standard status codes. JSON is returned by all API responses, including errors. In all API requests, you must set the content-type HTTP header to application/json. All API requests must be made over HTTPS. Calls made over HTTP will fail.

Available HTTP methods

The Apideck API uses HTTP verbs to understand if you want to read (GET), delete (DELETE) or create (POST) an object. When your web application cannot do a POST or DELETE, we provide the ability to set the method through the query parameter _method.

POST /messages
GET /messages
GET /messages/{messageId}
PATCH /messages/{messageId}
DELETE /messages/{messageId}

Response bodies are always UTF-8 encoded JSON objects, unless explicitly documented otherwise. For some endpoints and use cases we divert from REST to provide a better developer experience.

Schema

All API requests and response bodies adhere to a common JSON format representing individual items, collections of items, links to related items and additional meta data.

Meta

Meta data can be represented as a top level member named “meta”. Any information may be provided in the meta data. It’s most common use is to return the total number of records when requesting a collection of resources.

Idempotence (upcoming)

To prevent the creation of duplicate resources, every POST method (such as one that creates a consumer record) must specify a unique value for the X-Unique-Transaction-ID header name. Uniquely identifying each unique POST request ensures that the API processes a given request once and only once.

Uniquely identifying new resource-creation POSTs is especially important when the outcome of a response is ambiguous because of a transient service interruption, such as a server-side timeout or network disruption. If a service interruption occurs, then the client application can safely retry the uniquely identified request without creating duplicate operations. (API endpoints that guarantee that every uniquely identified request is processed only once no matter how many times that uniquely identifiable request is made are described as idempotent.)

Request IDs

Each API request has an associated request identifier. You can find this value in the response headers, under Request-Id. You can also find request identifiers in the URLs of individual request logs in your Dashboard. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.

Fixed field types

Dates

The dates returned by the API are all represented in UTC (ISO8601 format).

This example 2019-11-14T00:55:31.820Z is defined by the ISO 8601 standard. The T in the middle separates the year-month-day portion from the hour-minute-second portion. The Z on the end means UTC, that is, an offset-from-UTC of zero hours-minutes-seconds. The Z is pronounced "Zulu" per military/aviation tradition.

The ISO 8601 standard is more modern. The formats are wisely designed to be easy to parse by machine as well as easy to read by humans across cultures.

Prices and Currencies

All prices returned by the API are represented as integer amounts in a currency’s smallest unit. For example, $5 USD would be returned as 500 (i.e, 500 cents).

For zero-decimal currencies, amounts will still be provided as an integer but without the need to divide by 100. For example, an amount of ¥5 (JPY) would be returned as 5.

All currency codes conform to ISO 4217.

Support

If you have problems or need help with your case, you can always reach out to our Support.

Orders

The Orders model

idstring

A unique identifier for an object.

idempotency_keystring<= 45 characters

A value you specify that uniquely identifies this request among requests you have sent.

order_numberstring
order_datestring or null
closed_datestring or null
reference_idstring or null

An optional user-defined reference ID that associates this record with another entity in an external system. For example, a customer ID from an external customer management system.

Orders example
{}

List Orders

get
https://unify.apideck.com/pos/orders

List Orders

Authorizations:
apiKey

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

location_idstring

ID of the location.

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Orders
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clover
Square
Toast
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.pos.ordersAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "clover",
  "resource": "orders",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "idempotency_key": "random_string",
      "order_number": "1F",
      "order_date": "2022-08-12",
      "closed_date": "2022-08-13",
      "reference_id": "my-order-001",
      "status": "open",
      "payment_status": "open",
      "currency": "USD",
      "title": "string",
      "note": "string",
      "merchant_id": "12345",
      "customer_id": "12345",
      "employee_id": "12345",
      "location_id": "12345",
      "order_type_id": "12345",
      "table": "1F",
      "seat": "23F",
      "total_amount": 275,
      "total_tip": 700,
      "total_tax": 275,
      "total_discount": 300,
      "total_refund": 0,
      "total_service_charge": 0,
      "refunded": false,
      "customers": [
        {
          "id": "12345",
          "first_name": "Elon",
          "middle_name": "D.",
          "last_name": "Musk",
          "phone_numbers": [
            {
              "id": "12345",
              "country_code": "1",
              "area_code": "323",
              "number": "111-111-1111",
              "extension": "105",
              "type": "primary"
            }
          ],
          "emails": [
            {
              "id": "123",
              "email": "elon@musk.com",
              "type": "primary"
            }
          ]
        }
      ],
      "fulfillments": [
        {
          "id": "12345",
          "status": "proposed",
          "type": "shipment",
          "pickup_details": {
            "accepted_at": "2020-09-30T07:43:32.000Z",
            "auto_complete_duration": "P1W3D",
            "cancel_reason": "Not hungry",
            "expires_at": "2016-09-04T23:59:33.123Z",
            "schedule_type": "scheduled",
            "pickup_at": "2016-09-04T23:59:33.123Z",
            "pickup_window_duration": "P1W3D",
            "prep_time_duration": "P1W3D",
            "note": "Pickup in the back.",
            "placed_at": "2016-09-04T23:59:33.123Z",
            "rejected_at": "2016-09-04T23:59:33.123Z",
            "ready_at": "2016-09-04T23:59:33.123Z",
            "expired_at": "2016-09-04T23:59:33.123Z",
            "picked_up_at": "2016-09-04T23:59:33.123Z",
            "canceled_at": "2016-09-04T23:59:33.123Z",
            "is_curbside_pickup": true,
            "curbside_pickup_details": {
              "curbside_details": "string",
              "buyer_arrived_at": "2016-09-04T23:59:33.123Z"
            },
            "recipient": {
              "customer_id": "12345",
              "display_name": "Elon Musk",
              "address": {
                "id": "123",
                "type": "primary",
                "string": "25 Spring Street, Blackburn, VIC 3130",
                "name": "HQ US",
                "line1": "Main street",
                "line2": "apt #",
                "line3": "Suite #",
                "line4": "delivery instructions",
                "street_number": "25",
                "city": "San Francisco",
                "state": "CA",
                "postal_code": "94104",
                "country": "US",
                "latitude": "40.759211",
                "longitude": "-73.984638",
                "county": "Santa Clara",
                "contact_name": "Elon Musk",
                "salutation": "Mr",
                "phone_number": "111-111-1111",
                "fax": "122-111-1111",
                "email": "elon@musk.com",
                "website": "https://elonmusk.com",
                "notes": "Address notes or delivery instructions.",
                "row_version": "1-12345"
              },
              "phone_number": {
                "id": "12345",
                "country_code": "1",
                "area_code": "323",
                "number": "111-111-1111",
                "extension": "105",
                "type": "primary"
              },
              "email": {
                "id": "123",
                "email": "elon@musk.com",
                "type": "primary"
              }
            }
          },
          "shipment_details": {}
        }
      ],
      "line_items": [
        {
          "id": "12345",
          "name": "New York Strip Steak",
          "item": {
            "id": "12345"
          },
          "total_tax": 2000,
          "total_discount": 3000,
          "total_amount": 27500,
          "quantity": 1,
          "unit_price": 27500.5,
          "applied_taxes": [
            {
              "id": "12345",
              "tax_id": "sales-tax",
              "amount": 27500,
              "currency": "USD"
            }
          ],
          "applied_discounts": [
            {
              "id": "12345",
              "discount_id": "12345",
              "amount": 27500,
              "currency": "USD"
            }
          ],
          "modifiers": [
            {
              "id": "12345",
              "name": "New York Strip Steak - no cheese",
              "amount": 27500,
              "currency": "USD",
              "alternate_name": "Modifier New",
              "modifier_group_id": "123"
            }
          ]
        }
      ],
      "payments": [
        {
          "id": "12345",
          "amount": 27500,
          "currency": "USD"
        }
      ],
      "service_charges": [
        {
          "id": "12345",
          "name": "Charge for delivery",
          "amount": 27500,
          "percentage": 12.5,
          "currency": "USD",
          "active": true,
          "type": "auto_gratuity"
        }
      ],
      "refunds": [
        {
          "id": "12345",
          "location_id": "12345",
          "amount": 27500,
          "currency": "USD",
          "reason": "The reason for the refund being issued.",
          "status": "pending",
          "tender_id": "12345",
          "transaction_id": "12345"
        }
      ],
      "taxes": [
        {
          "id": "state-sales-tax",
          "name": "State Sales Tax",
          "amount": 27500,
          "currency": "USD",
          "percentage": 15,
          "scope": "order",
          "type": "unknown",
          "auto_applied": true
        }
      ],
      "discounts": [
        {
          "id": "12345",
          "product_id": "12345",
          "name": "10% off",
          "type": "percentage",
          "amount": 27500,
          "currency": "USD",
          "scope": "order"
        }
      ],
      "tenders": [
        {
          "id": "12345",
          "name": "10% off",
          "type": "cash",
          "note": "An optional note associated with the tender at the time of payment.",
          "amount": 27500,
          "percentage": 10,
          "currency": "USD",
          "total_amount": 27.5,
          "total_tip": 7,
          "total_processing_fee": 0,
          "total_tax": 2.75,
          "total_discount": 3,
          "total_refund": 0,
          "total_service_charge": 0,
          "buyer_tendered_cash_amount": 27500,
          "change_back_cash_amount": 27500,
          "card": {
            "id": "12345",
            "bin": "41111",
            "card_brand": "visa",
            "card_type": "credit",
            "prepaid_type": "prepaid",
            "cardholder_name": "John Doe",
            "customer_id": "12345",
            "merchant_id": "12345",
            "exp_month": 1,
            "exp_year": 2022,
            "fingerprint": " Intended as a POS-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.",
            "last_4": "The last 4 digits of the card number.",
            "enabled": true,
            "billing_address": {
              "id": "123",
              "type": "primary",
              "string": "25 Spring Street, Blackburn, VIC 3130",
              "name": "HQ US",
              "line1": "Main street",
              "line2": "apt #",
              "line3": "Suite #",
              "line4": "delivery instructions",
              "street_number": "25",
              "city": "San Francisco",
              "state": "CA",
              "postal_code": "94104",
              "country": "US",
              "latitude": "40.759211",
              "longitude": "-73.984638",
              "county": "Santa Clara",
              "contact_name": "Elon Musk",
              "salutation": "Mr",
              "phone_number": "111-111-1111",
              "fax": "122-111-1111",
              "email": "elon@musk.com",
              "website": "https://elonmusk.com",
              "notes": "Address notes or delivery instructions.",
              "row_version": "1-12345"
            },
            "reference_id": "card-001",
            "version": "230320320320"
          },
          "card_status": "authorized",
          "card_entry_method": "swiped",
          "payment_id": "12345",
          "location_id": "12345",
          "transaction_id": "12345"
        }
      ],
      "source": "api",
      "voided": false,
      "voided_at": "2020-09-30T07:43:32.000Z",
      "version": "230320320320",
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create Order

post
https://unify.apideck.com/pos/orders

Create Order

Authorizations:
apiKey

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
idempotency_keystring<= 45 characters

A value you specify that uniquely identifies this request among requests you have sent.

order_numberstring
order_datestring or null
closed_datestring or null
reference_idstring or null

An optional user-defined reference ID that associates this record with another entity in an external system. For example, a customer ID from an external customer management system.

statusstring
Enum:opendraftdelivereddelayed

Order status. Clover specific: If no value is set, the status defaults to hidden, which indicates a hidden order. A hidden order is not displayed in user interfaces and can only be retrieved by its id. When creating an order via the REST API the value must be manually set to 'open'. More info https://docs.clover.com/reference/orderupdateorder

payment_statusstring
Enum:openpaidrefundedcredited

Is this order paid or not?

currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

titlestring
notestring

A note with information about this order, may be printed on the order receipt and displayed in apps

merchant_idstring
required
customer_idstring
employee_idstring
location_idstring
required
order_type_idstring
tablestring
seatstring
total_amountinteger or null
total_tipinteger or null
total_taxinteger or null
total_discountinteger or null
total_refundinteger or null
total_service_chargeinteger or null
refundedboolean
customersobjects
fulfillmentsobjects
line_itemsobjects
paymentsobjects
service_chargesobjects

Optional service charges or gratuity tip applied to the order.

refundsobjects
taxesobjects
discountsobjects
tendersobjects
voidedboolean
versionstring or null

Responses

201Orders
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clover
Square
Toast
Request

Request example

{
  "idempotency_key": "random_string",
  "order_number": "1F",
  "order_date": "2022-08-12",
  "closed_date": "2022-08-13",
  "reference_id": "my-order-001",
  "status": "open",
  "payment_status": "open",
  "currency": "USD",
  "title": "string",
  "note": "string",
  "merchant_id": "12345",
  "customer_id": "12345",
  "employee_id": "12345",
  "location_id": "12345",
  "order_type_id": "12345",
  "table": "1F",
  "seat": "23F",
  "total_amount": 275,
  "total_tip": 700,
  "total_tax": 275,
  "total_discount": 300,
  "total_refund": 0,
  "total_service_charge": 0,
  "refunded": false,
  "customers": [
    {
      "id": "12345",
      "first_name": "Elon",
      "middle_name": "D.",
      "last_name": "Musk",
      "phone_numbers": [
        {
          "id": "12345",
          "country_code": "1",
          "area_code": "323",
          "number": "111-111-1111",
          "extension": "105",
          "type": "primary"
        }
      ],
      "emails": [
        {
          "id": "123",
          "email": "elon@musk.com",
          "type": "primary"
        }
      ]
    }
  ],
  "fulfillments": [
    {
      "id": "12345",
      "status": "proposed",
      "type": "shipment",
      "pickup_details": {
        "auto_complete_duration": "P1W3D",
        "cancel_reason": "Not hungry",
        "expires_at": "2016-09-04T23:59:33.123Z",
        "schedule_type": "scheduled",
        "pickup_at": "2016-09-04T23:59:33.123Z",
        "pickup_window_duration": "P1W3D",
        "prep_time_duration": "P1W3D",
        "note": "Pickup in the back.",
        "placed_at": "2016-09-04T23:59:33.123Z",
        "rejected_at": "2016-09-04T23:59:33.123Z",
        "ready_at": "2016-09-04T23:59:33.123Z",
        "expired_at": "2016-09-04T23:59:33.123Z",
        "picked_up_at": "2016-09-04T23:59:33.123Z",
        "canceled_at": "2016-09-04T23:59:33.123Z",
        "is_curbside_pickup": true,
        "curbside_pickup_details": {
          "curbside_details": "string",
          "buyer_arrived_at": "2016-09-04T23:59:33.123Z"
        },
        "recipient": {
          "customer_id": "12345",
          "display_name": "Elon Musk",
          "address": {
            "id": "123",
            "type": "primary",
            "string": "25 Spring Street, Blackburn, VIC 3130",
            "name": "HQ US",
            "line1": "Main street",
            "line2": "apt #",
            "line3": "Suite #",
            "line4": "delivery instructions",
            "street_number": "25",
            "city": "San Francisco",
            "state": "CA",
            "postal_code": "94104",
            "country": "US",
            "latitude": "40.759211",
            "longitude": "-73.984638",
            "county": "Santa Clara",
            "contact_name": "Elon Musk",
            "salutation": "Mr",
            "phone_number": "111-111-1111",
            "fax": "122-111-1111",
            "email": "elon@musk.com",
            "website": "https://elonmusk.com",
            "notes": "Address notes or delivery instructions.",
            "row_version": "1-12345"
          },
          "phone_number": {
            "id": "12345",
            "country_code": "1",
            "area_code": "323",
            "number": "111-111-1111",
            "extension": "105",
            "type": "primary"
          },
          "email": {
            "id": "123",
            "email": "elon@musk.com",
            "type": "primary"
          }
        }
      },
      "shipment_details": {}
    }
  ],
  "line_items": [
    {
      "name": "New York Strip Steak",
      "item": {},
      "total_tax": 2000,
      "total_discount": 3000,
      "total_amount": 27500,
      "quantity": 1,
      "unit_price": 27500.5,
      "applied_taxes": [
        {
          "tax_id": "sales-tax",
          "amount": 27500,
          "currency": "USD"
        }
      ],
      "applied_discounts": [
        {
          "discount_id": "12345",
          "amount": 27500,
          "currency": "USD"
        }
      ],
      "modifiers": [
        {
          "id": "12345",
          "name": "New York Strip Steak - no cheese",
          "amount": 27500,
          "currency": "USD",
          "alternate_name": "Modifier New",
          "modifier_group_id": "123"
        }
      ]
    }
  ],
  "payments": [
    {
      "amount": 27500,
      "currency": "USD"
    }
  ],
  "service_charges": [
    {
      "name": "Charge for delivery",
      "amount": 27500,
      "percentage": 12.5,
      "currency": "USD",
      "active": true,
      "type": "auto_gratuity"
    }
  ],
  "refunds": [
    {
      "amount": 27500,
      "currency": "USD",
      "reason": "The reason for the refund being issued.",
      "status": "pending"
    }
  ],
  "taxes": [
    {
      "id": "state-sales-tax",
      "name": "State Sales Tax",
      "amount": 27500,
      "currency": "USD",
      "percentage": 15,
      "scope": "order",
      "type": "unknown",
      "auto_applied": true
    }
  ],
  "discounts": [
    {
      "name": "10% off",
      "type": "percentage",
      "amount": 27500,
      "currency": "USD",
      "scope": "order"
    }
  ],
  "tenders": [
    {
      "name": "10% off",
      "type": "cash",
      "note": "An optional note associated with the tender at the time of payment.",
      "amount": 27500,
      "percentage": 10,
      "currency": "USD",
      "total_amount": 27.5,
      "total_tip": 7,
      "total_processing_fee": 0,
      "total_tax": 2.75,
      "total_discount": 3,
      "total_refund": 0,
      "total_service_charge": 0,
      "buyer_tendered_cash_amount": 27500,
      "change_back_cash_amount": 27500,
      "card": {
        "bin": "41111",
        "card_brand": "visa",
        "card_type": "credit",
        "prepaid_type": "prepaid",
        "cardholder_name": "John Doe",
        "customer_id": "12345",
        "merchant_id": "12345",
        "exp_month": 1,
        "exp_year": 2022,
        "fingerprint": " Intended as a POS-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.",
        "last_4": "The last 4 digits of the card number.",
        "enabled": true,
        "billing_address": {
          "id": "123",
          "type": "primary",
          "string": "25 Spring Street, Blackburn, VIC 3130",
          "name": "HQ US",
          "line1": "Main street",
          "line2": "apt #",
          "line3": "Suite #",
          "line4": "delivery instructions",
          "street_number": "25",
          "city": "San Francisco",
          "state": "CA",
          "postal_code": "94104",
          "country": "US",
          "latitude": "40.759211",
          "longitude": "-73.984638",
          "county": "Santa Clara",
          "contact_name": "Elon Musk",
          "salutation": "Mr",
          "phone_number": "111-111-1111",
          "fax": "122-111-1111",
          "email": "elon@musk.com",
          "website": "https://elonmusk.com",
          "notes": "Address notes or delivery instructions.",
          "row_version": "1-12345"
        },
        "reference_id": "card-001",
        "version": "230320320320"
      },
      "card_status": "authorized",
      "card_entry_method": "swiped"
    }
  ],
  "voided": false,
  "version": "230320320320"
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "clover",
  "resource": "orders",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get Order

get
https://unify.apideck.com/pos/orders/{id}

Get Order

Authorizations:
apiKey

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Orders
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clover
Square
Toast
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.pos.ordersOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "clover",
  "resource": "orders",
  "operation": "one",
  "data": {
    "id": "12345",
    "idempotency_key": "random_string",
    "order_number": "1F",
    "order_date": "2022-08-12",
    "closed_date": "2022-08-13",
    "reference_id": "my-order-001",
    "status": "open",
    "payment_status": "open",
    "currency": "USD",
    "title": "string",
    "note": "string",
    "merchant_id": "12345",
    "customer_id": "12345",
    "employee_id": "12345",
    "location_id": "12345",
    "order_type_id": "12345",
    "table": "1F",
    "seat": "23F",
    "total_amount": 275,
    "total_tip": 700,
    "total_tax": 275,
    "total_discount": 300,
    "total_refund": 0,
    "total_service_charge": 0,
    "refunded": false,
    "customers": [
      {
        "id": "12345",
        "first_name": "Elon",
        "middle_name": "D.",
        "last_name": "Musk",
        "phone_numbers": [
          {
            "id": "12345",
            "country_code": "1",
            "area_code": "323",
            "number": "111-111-1111",
            "extension": "105",
            "type": "primary"
          }
        ],
        "emails": [
          {
            "id": "123",
            "email": "elon@musk.com",
            "type": "primary"
          }
        ]
      }
    ],
    "fulfillments": [
      {
        "id": "12345",
        "status": "proposed",
        "type": "shipment",
        "pickup_details": {
          "accepted_at": "2020-09-30T07:43:32.000Z",
          "auto_complete_duration": "P1W3D",
          "cancel_reason": "Not hungry",
          "expires_at": "2016-09-04T23:59:33.123Z",
          "schedule_type": "scheduled",
          "pickup_at": "2016-09-04T23:59:33.123Z",
          "pickup_window_duration": "P1W3D",
          "prep_time_duration": "P1W3D",
          "note": "Pickup in the back.",
          "placed_at": "2016-09-04T23:59:33.123Z",
          "rejected_at": "2016-09-04T23:59:33.123Z",
          "ready_at": "2016-09-04T23:59:33.123Z",
          "expired_at": "2016-09-04T23:59:33.123Z",
          "picked_up_at": "2016-09-04T23:59:33.123Z",
          "canceled_at": "2016-09-04T23:59:33.123Z",
          "is_curbside_pickup": true,
          "curbside_pickup_details": {
            "curbside_details": "string",
            "buyer_arrived_at": "2016-09-04T23:59:33.123Z"
          },
          "recipient": {
            "customer_id": "12345",
            "display_name": "Elon Musk",
            "address": {
              "id": "123",
              "type": "primary",
              "string": "25 Spring Street, Blackburn, VIC 3130",
              "name": "HQ US",
              "line1": "Main street",
              "line2": "apt #",
              "line3": "Suite #",
              "line4": "delivery instructions",
              "street_number": "25",
              "city": "San Francisco",
              "state": "CA",
              "postal_code": "94104",
              "country": "US",
              "latitude": "40.759211",
              "longitude": "-73.984638",
              "county": "Santa Clara",
              "contact_name": "Elon Musk",
              "salutation": "Mr",
              "phone_number": "111-111-1111",
              "fax": "122-111-1111",
              "email": "elon@musk.com",
              "website": "https://elonmusk.com",
              "notes": "Address notes or delivery instructions.",
              "row_version": "1-12345"
            },
            "phone_number": {
              "id": "12345",
              "country_code": "1",
              "area_code": "323",
              "number": "111-111-1111",
              "extension": "105",
              "type": "primary"
            },
            "email": {
              "id": "123",
              "email": "elon@musk.com",
              "type": "primary"
            }
          }
        },
        "shipment_details": {}
      }
    ],
    "line_items": [
      {
        "id": "12345",
        "name": "New York Strip Steak",
        "item": {
          "id": "12345"
        },
        "total_tax": 2000,
        "total_discount": 3000,
        "total_amount": 27500,
        "quantity": 1,
        "unit_price": 27500.5,
        "applied_taxes": [
          {
            "id": "12345",
            "tax_id": "sales-tax",
            "amount": 27500,
            "currency": "USD"
          }
        ],
        "applied_discounts": [
          {
            "id": "12345",
            "discount_id": "12345",
            "amount": 27500,
            "currency": "USD"
          }
        ],
        "modifiers": [
          {
            "id": "12345",
            "name": "New York Strip Steak - no cheese",
            "amount": 27500,
            "currency": "USD",
            "alternate_name": "Modifier New",
            "modifier_group_id": "123"
          }
        ]
      }
    ],
    "payments": [
      {
        "id": "12345",
        "amount": 27500,
        "currency": "USD"
      }
    ],
    "service_charges": [
      {
        "id": "12345",
        "name": "Charge for delivery",
        "amount": 27500,
        "percentage": 12.5,
        "currency": "USD",
        "active": true,
        "type": "auto_gratuity"
      }
    ],
    "refunds": [
      {
        "id": "12345",
        "location_id": "12345",
        "amount": 27500,
        "currency": "USD",
        "reason": "The reason for the refund being issued.",
        "status": "pending",
        "tender_id": "12345",
        "transaction_id": "12345"
      }
    ],
    "taxes": [
      {
        "id": "state-sales-tax",
        "name": "State Sales Tax",
        "amount": 27500,
        "currency": "USD",
        "percentage": 15,
        "scope": "order",
        "type": "unknown",
        "auto_applied": true
      }
    ],
    "discounts": [
      {
        "id": "12345",
        "product_id": "12345",
        "name": "10% off",
        "type": "percentage",
        "amount": 27500,
        "currency": "USD",
        "scope": "order"
      }
    ],
    "tenders": [
      {
        "id": "12345",
        "name": "10% off",
        "type": "cash",
        "note": "An optional note associated with the tender at the time of payment.",
        "amount": 27500,
        "percentage": 10,
        "currency": "USD",
        "total_amount": 27.5,
        "total_tip": 7,
        "total_processing_fee": 0,
        "total_tax": 2.75,
        "total_discount": 3,
        "total_refund": 0,
        "total_service_charge": 0,
        "buyer_tendered_cash_amount": 27500,
        "change_back_cash_amount": 27500,
        "card": {
          "id": "12345",
          "bin": "41111",
          "card_brand": "visa",
          "card_type": "credit",
          "prepaid_type": "prepaid",
          "cardholder_name": "John Doe",
          "customer_id": "12345",
          "merchant_id": "12345",
          "exp_month": 1,
          "exp_year": 2022,
          "fingerprint": " Intended as a POS-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.",
          "last_4": "The last 4 digits of the card number.",
          "enabled": true,
          "billing_address": {
            "id": "123",
            "type": "primary",
            "string": "25 Spring Street, Blackburn, VIC 3130",
            "name": "HQ US",
            "line1": "Main street",
            "line2": "apt #",
            "line3": "Suite #",
            "line4": "delivery instructions",
            "street_number": "25",
            "city": "San Francisco",
            "state": "CA",
            "postal_code": "94104",
            "country": "US",
            "latitude": "40.759211",
            "longitude": "-73.984638",
            "county": "Santa Clara",
            "contact_name": "Elon Musk",
            "salutation": "Mr",
            "phone_number": "111-111-1111",
            "fax": "122-111-1111",
            "email": "elon@musk.com",
            "website": "https://elonmusk.com",
            "notes": "Address notes or delivery instructions.",
            "row_version": "1-12345"
          },
          "reference_id": "card-001",
          "version": "230320320320"
        },
        "card_status": "authorized",
        "card_entry_method": "swiped",
        "payment_id": "12345",
        "location_id": "12345",
        "transaction_id": "12345"
      }
    ],
    "source": "api",
    "voided": false,
    "voided_at": "2020-09-30T07:43:32.000Z",
    "version": "230320320320",
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z"
  }
}

Update Order

patch
https://unify.apideck.com/pos/orders/{id}

Updates 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 order, use the payments endpoint.

Authorizations:
apiKey

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
idempotency_keystring<= 45 characters

A value you specify that uniquely identifies this request among requests you have sent.

order_numberstring
order_datestring or null
closed_datestring or null
reference_idstring or null

An optional user-defined reference ID that associates this record with another entity in an external system. For example, a customer ID from an external customer management system.

statusstring
Enum:opendraftdelivereddelayed

Order status. Clover specific: If no value is set, the status defaults to hidden, which indicates a hidden order. A hidden order is not displayed in user interfaces and can only be retrieved by its id. When creating an order via the REST API the value must be manually set to 'open'. More info https://docs.clover.com/reference/orderupdateorder

payment_statusstring
Enum:openpaidrefundedcredited

Is this order paid or not?

currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

titlestring
notestring

A note with information about this order, may be printed on the order receipt and displayed in apps

merchant_idstring
required
customer_idstring
employee_idstring
location_idstring
required
order_type_idstring
tablestring
seatstring
total_amountinteger or null
total_tipinteger or null
total_taxinteger or null
total_discountinteger or null
total_refundinteger or null
total_service_chargeinteger or null
refundedboolean
customersobjects
fulfillmentsobjects
line_itemsobjects
paymentsobjects
service_chargesobjects

Optional service charges or gratuity tip applied to the order.

refundsobjects
taxesobjects
discountsobjects
tendersobjects
voidedboolean
versionstring or null

Responses

200Orders
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clover
Square
Toast
Request

Request example

{
  "idempotency_key": "random_string",
  "order_number": "1F",
  "order_date": "2022-08-12",
  "closed_date": "2022-08-13",
  "reference_id": "my-order-001",
  "status": "open",
  "payment_status": "open",
  "currency": "USD",
  "title": "string",
  "note": "string",
  "merchant_id": "12345",
  "customer_id": "12345",
  "employee_id": "12345",
  "location_id": "12345",
  "order_type_id": "12345",
  "table": "1F",
  "seat": "23F",
  "total_amount": 275,
  "total_tip": 700,
  "total_tax": 275,
  "total_discount": 300,
  "total_refund": 0,
  "total_service_charge": 0,
  "refunded": false,
  "customers": [
    {
      "id": "12345",
      "first_name": "Elon",
      "middle_name": "D.",
      "last_name": "Musk",
      "phone_numbers": [
        {
          "id": "12345",
          "country_code": "1",
          "area_code": "323",
          "number": "111-111-1111",
          "extension": "105",
          "type": "primary"
        }
      ],
      "emails": [
        {
          "id": "123",
          "email": "elon@musk.com",
          "type": "primary"
        }
      ]
    }
  ],
  "fulfillments": [
    {
      "id": "12345",
      "status": "proposed",
      "type": "shipment",
      "pickup_details": {
        "auto_complete_duration": "P1W3D",
        "cancel_reason": "Not hungry",
        "expires_at": "2016-09-04T23:59:33.123Z",
        "schedule_type": "scheduled",
        "pickup_at": "2016-09-04T23:59:33.123Z",
        "pickup_window_duration": "P1W3D",
        "prep_time_duration": "P1W3D",
        "note": "Pickup in the back.",
        "placed_at": "2016-09-04T23:59:33.123Z",
        "rejected_at": "2016-09-04T23:59:33.123Z",
        "ready_at": "2016-09-04T23:59:33.123Z",
        "expired_at": "2016-09-04T23:59:33.123Z",
        "picked_up_at": "2016-09-04T23:59:33.123Z",
        "canceled_at": "2016-09-04T23:59:33.123Z",
        "is_curbside_pickup": true,
        "curbside_pickup_details": {
          "curbside_details": "string",
          "buyer_arrived_at": "2016-09-04T23:59:33.123Z"
        },
        "recipient": {
          "customer_id": "12345",
          "display_name": "Elon Musk",
          "address": {
            "id": "123",
            "type": "primary",
            "string": "25 Spring Street, Blackburn, VIC 3130",
            "name": "HQ US",
            "line1": "Main street",
            "line2": "apt #",
            "line3": "Suite #",
            "line4": "delivery instructions",
            "street_number": "25",
            "city": "San Francisco",
            "state": "CA",
            "postal_code": "94104",
            "country": "US",
            "latitude": "40.759211",
            "longitude": "-73.984638",
            "county": "Santa Clara",
            "contact_name": "Elon Musk",
            "salutation": "Mr",
            "phone_number": "111-111-1111",
            "fax": "122-111-1111",
            "email": "elon@musk.com",
            "website": "https://elonmusk.com",
            "notes": "Address notes or delivery instructions.",
            "row_version": "1-12345"
          },
          "phone_number": {
            "id": "12345",
            "country_code": "1",
            "area_code": "323",
            "number": "111-111-1111",
            "extension": "105",
            "type": "primary"
          },
          "email": {
            "id": "123",
            "email": "elon@musk.com",
            "type": "primary"
          }
        }
      },
      "shipment_details": {}
    }
  ],
  "line_items": [
    {
      "name": "New York Strip Steak",
      "item": {},
      "total_tax": 2000,
      "total_discount": 3000,
      "total_amount": 27500,
      "quantity": 1,
      "unit_price": 27500.5,
      "applied_taxes": [
        {
          "tax_id": "sales-tax",
          "amount": 27500,
          "currency": "USD"
        }
      ],
      "applied_discounts": [
        {
          "discount_id": "12345",
          "amount": 27500,
          "currency": "USD"
        }
      ],
      "modifiers": [
        {
          "id": "12345",
          "name": "New York Strip Steak - no cheese",
          "amount": 27500,
          "currency": "USD",
          "alternate_name": "Modifier New",
          "modifier_group_id": "123"
        }
      ]
    }
  ],
  "payments": [
    {
      "amount": 27500,
      "currency": "USD"
    }
  ],
  "service_charges": [
    {
      "name": "Charge for delivery",
      "amount": 27500,
      "percentage": 12.5,
      "currency": "USD",
      "active": true,
      "type": "auto_gratuity"
    }
  ],
  "refunds": [
    {
      "amount": 27500,
      "currency": "USD",
      "reason": "The reason for the refund being issued.",
      "status": "pending"
    }
  ],
  "taxes": [
    {
      "id": "state-sales-tax",
      "name": "State Sales Tax",
      "amount": 27500,
      "currency": "USD",
      "percentage": 15,
      "scope": "order",
      "type": "unknown",
      "auto_applied": true
    }
  ],
  "discounts": [
    {
      "name": "10% off",
      "type": "percentage",
      "amount": 27500,
      "currency": "USD",
      "scope": "order"
    }
  ],
  "tenders": [
    {
      "name": "10% off",
      "type": "cash",
      "note": "An optional note associated with the tender at the time of payment.",
      "amount": 27500,
      "percentage": 10,
      "currency": "USD",
      "total_amount": 27.5,
      "total_tip": 7,
      "total_processing_fee": 0,
      "total_tax": 2.75,
      "total_discount": 3,
      "total_refund": 0,
      "total_service_charge": 0,
      "buyer_tendered_cash_amount": 27500,
      "change_back_cash_amount": 27500,
      "card": {
        "bin": "41111",
        "card_brand": "visa",
        "card_type": "credit",
        "prepaid_type": "prepaid",
        "cardholder_name": "John Doe",
        "customer_id": "12345",
        "merchant_id": "12345",
        "exp_month": 1,
        "exp_year": 2022,
        "fingerprint": " Intended as a POS-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.",
        "last_4": "The last 4 digits of the card number.",
        "enabled": true,
        "billing_address": {
          "id": "123",
          "type": "primary",
          "string": "25 Spring Street, Blackburn, VIC 3130",
          "name": "HQ US",
          "line1": "Main street",
          "line2": "apt #",
          "line3": "Suite #",
          "line4": "delivery instructions",
          "street_number": "25",
          "city": "San Francisco",
          "state": "CA",
          "postal_code": "94104",
          "country": "US",
          "latitude": "40.759211",
          "longitude": "-73.984638",
          "county": "Santa Clara",
          "contact_name": "Elon Musk",
          "salutation": "Mr",
          "phone_number": "111-111-1111",
          "fax": "122-111-1111",
          "email": "elon@musk.com",
          "website": "https://elonmusk.com",
          "notes": "Address notes or delivery instructions.",
          "row_version": "1-12345"
        },
        "reference_id": "card-001",
        "version": "230320320320"
      },
      "card_status": "authorized",
      "card_entry_method": "swiped"
    }
  ],
  "voided": false,
  "version": "230320320320"
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "clover",
  "resource": "orders",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Delete Order

delete
https://unify.apideck.com/pos/orders/{id}

Delete Order

Authorizations:
apiKey

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200Orders
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clover
Square
Toast
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.pos.ordersDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "clover",
  "resource": "orders",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Pay Order

post
https://unify.apideck.com/pos/orders/{id}/pay

Pay Order

Authorizations:
apiKey

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Request body schema

application/json
idempotency_keystring<= 45 characters

A value you specify that uniquely identifies this request among requests you have sent.

order_numberstring
order_datestring or null
closed_datestring or null
reference_idstring or null

An optional user-defined reference ID that associates this record with another entity in an external system. For example, a customer ID from an external customer management system.

statusstring
Enum:opendraftdelivereddelayed

Order status. Clover specific: If no value is set, the status defaults to hidden, which indicates a hidden order. A hidden order is not displayed in user interfaces and can only be retrieved by its id. When creating an order via the REST API the value must be manually set to 'open'. More info https://docs.clover.com/reference/orderupdateorder

payment_statusstring
Enum:openpaidrefundedcredited

Is this order paid or not?

currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

titlestring
notestring

A note with information about this order, may be printed on the order receipt and displayed in apps

merchant_idstring
required
customer_idstring
employee_idstring
location_idstring
required
order_type_idstring
tablestring
seatstring
total_amountinteger or null
total_tipinteger or null
total_taxinteger or null
total_discountinteger or null
total_refundinteger or null
total_service_chargeinteger or null
refundedboolean
customersobjects
fulfillmentsobjects
line_itemsobjects
paymentsobjects
service_chargesobjects

Optional service charges or gratuity tip applied to the order.

refundsobjects
taxesobjects
discountsobjects
tendersobjects
voidedboolean
versionstring or null

Responses

201Orders
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable
Clover
Request
Square
Request
Toast
Request

Request example

{
  "idempotency_key": "random_string",
  "order_number": "1F",
  "order_date": "2022-08-12",
  "closed_date": "2022-08-13",
  "reference_id": "my-order-001",
  "status": "open",
  "payment_status": "open",
  "currency": "USD",
  "title": "string",
  "note": "string",
  "merchant_id": "12345",
  "customer_id": "12345",
  "employee_id": "12345",
  "location_id": "12345",
  "order_type_id": "12345",
  "table": "1F",
  "seat": "23F",
  "total_amount": 275,
  "total_tip": 700,
  "total_tax": 275,
  "total_discount": 300,
  "total_refund": 0,
  "total_service_charge": 0,
  "refunded": false,
  "customers": [
    {
      "id": "12345",
      "first_name": "Elon",
      "middle_name": "D.",
      "last_name": "Musk",
      "phone_numbers": [
        {
          "id": "12345",
          "country_code": "1",
          "area_code": "323",
          "number": "111-111-1111",
          "extension": "105",
          "type": "primary"
        }
      ],
      "emails": [
        {
          "id": "123",
          "email": "elon@musk.com",
          "type": "primary"
        }
      ]
    }
  ],
  "fulfillments": [
    {
      "id": "12345",
      "status": "proposed",
      "type": "shipment",
      "pickup_details": {
        "auto_complete_duration": "P1W3D",
        "cancel_reason": "Not hungry",
        "expires_at": "2016-09-04T23:59:33.123Z",
        "schedule_type": "scheduled",
        "pickup_at": "2016-09-04T23:59:33.123Z",
        "pickup_window_duration": "P1W3D",
        "prep_time_duration": "P1W3D",
        "note": "Pickup in the back.",
        "placed_at": "2016-09-04T23:59:33.123Z",
        "rejected_at": "2016-09-04T23:59:33.123Z",
        "ready_at": "2016-09-04T23:59:33.123Z",
        "expired_at": "2016-09-04T23:59:33.123Z",
        "picked_up_at": "2016-09-04T23:59:33.123Z",
        "canceled_at": "2016-09-04T23:59:33.123Z",
        "is_curbside_pickup": true,
        "curbside_pickup_details": {
          "curbside_details": "string",
          "buyer_arrived_at": "2016-09-04T23:59:33.123Z"
        },
        "recipient": {
          "customer_id": "12345",
          "display_name": "Elon Musk",
          "address": {
            "id": "123",
            "type": "primary",
            "string": "25 Spring Street, Blackburn, VIC 3130",
            "name": "HQ US",
            "line1": "Main street",
            "line2": "apt #",
            "line3": "Suite #",
            "line4": "delivery instructions",
            "street_number": "25",
            "city": "San Francisco",
            "state": "CA",
            "postal_code": "94104",
            "country": "US",
            "latitude": "40.759211",
            "longitude": "-73.984638",
            "county": "Santa Clara",
            "contact_name": "Elon Musk",
            "salutation": "Mr",
            "phone_number": "111-111-1111",
            "fax": "122-111-1111",
            "email": "elon@musk.com",
            "website": "https://elonmusk.com",
            "notes": "Address notes or delivery instructions.",
            "row_version": "1-12345"
          },
          "phone_number": {
            "id": "12345",
            "country_code": "1",
            "area_code": "323",
            "number": "111-111-1111",
            "extension": "105",
            "type": "primary"
          },
          "email": {
            "id": "123",
            "email": "elon@musk.com",
            "type": "primary"
          }
        }
      },
      "shipment_details": {}
    }
  ],
  "line_items": [
    {
      "name": "New York Strip Steak",
      "item": {},
      "total_tax": 2000,
      "total_discount": 3000,
      "total_amount": 27500,
      "quantity": 1,
      "unit_price": 27500.5,
      "applied_taxes": [
        {
          "tax_id": "sales-tax",
          "amount": 27500,
          "currency": "USD"
        }
      ],
      "applied_discounts": [
        {
          "discount_id": "12345",
          "amount": 27500,
          "currency": "USD"
        }
      ],
      "modifiers": [
        {
          "id": "12345",
          "name": "New York Strip Steak - no cheese",
          "amount": 27500,
          "currency": "USD",
          "alternate_name": "Modifier New",
          "modifier_group_id": "123"
        }
      ]
    }
  ],
  "payments": [
    {
      "amount": 27500,
      "currency": "USD"
    }
  ],
  "service_charges": [
    {
      "name": "Charge for delivery",
      "amount": 27500,
      "percentage": 12.5,
      "currency": "USD",
      "active": true,
      "type": "auto_gratuity"
    }
  ],
  "refunds": [
    {
      "amount": 27500,
      "currency": "USD",
      "reason": "The reason for the refund being issued.",
      "status": "pending"
    }
  ],
  "taxes": [
    {
      "id": "state-sales-tax",
      "name": "State Sales Tax",
      "amount": 27500,
      "currency": "USD",
      "percentage": 15,
      "scope": "order",
      "type": "unknown",
      "auto_applied": true
    }
  ],
  "discounts": [
    {
      "name": "10% off",
      "type": "percentage",
      "amount": 27500,
      "currency": "USD",
      "scope": "order"
    }
  ],
  "tenders": [
    {
      "name": "10% off",
      "type": "cash",
      "note": "An optional note associated with the tender at the time of payment.",
      "amount": 27500,
      "percentage": 10,
      "currency": "USD",
      "total_amount": 27.5,
      "total_tip": 7,
      "total_processing_fee": 0,
      "total_tax": 2.75,
      "total_discount": 3,
      "total_refund": 0,
      "total_service_charge": 0,
      "buyer_tendered_cash_amount": 27500,
      "change_back_cash_amount": 27500,
      "card": {
        "bin": "41111",
        "card_brand": "visa",
        "card_type": "credit",
        "prepaid_type": "prepaid",
        "cardholder_name": "John Doe",
        "customer_id": "12345",
        "merchant_id": "12345",
        "exp_month": 1,
        "exp_year": 2022,
        "fingerprint": " Intended as a POS-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.",
        "last_4": "The last 4 digits of the card number.",
        "enabled": true,
        "billing_address": {
          "id": "123",
          "type": "primary",
          "string": "25 Spring Street, Blackburn, VIC 3130",
          "name": "HQ US",
          "line1": "Main street",
          "line2": "apt #",
          "line3": "Suite #",
          "line4": "delivery instructions",
          "street_number": "25",
          "city": "San Francisco",
          "state": "CA",
          "postal_code": "94104",
          "country": "US",
          "latitude": "40.759211",
          "longitude": "-73.984638",
          "county": "Santa Clara",
          "contact_name": "Elon Musk",
          "salutation": "Mr",
          "phone_number": "111-111-1111",
          "fax": "122-111-1111",
          "email": "elon@musk.com",
          "website": "https://elonmusk.com",
          "notes": "Address notes or delivery instructions.",
          "row_version": "1-12345"
        },
        "reference_id": "card-001",
        "version": "230320320320"
      },
      "card_status": "authorized",
      "card_entry_method": "swiped"
    }
  ],
  "voided": false,
  "version": "230320320320"
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "clover",
  "resource": "orders",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Payments

The Payments model

idstring

A unique identifier for an object.

source_idstring
required

The ID for the source of funds for this payment. Square-only: This can be a payment token (card nonce) generated by the payment form or a card on file made linked to the customer. if recording a payment that the seller received outside of Square, specify either CASH or EXTERNAL.

order_idstring
required
merchant_idstring
customer_idstring
required
employee_idstring
Payments example
{}

List Payments

get
https://unify.apideck.com/pos/payments

List Payments

Authorizations:
apiKey

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200PosPayments
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Square
Clover
Request
Toast
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.pos.paymentsAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "PosPayments",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "source_id": "12345",
      "order_id": "12345",
      "merchant_id": "12345",
      "customer_id": "12345",
      "employee_id": "12345",
      "location_id": "12345",
      "device_id": "12345",
      "tender_id": "12345",
      "external_payment_id": "12345",
      "idempotency_key": "random_string",
      "amount": 27.5,
      "currency": "USD",
      "tip": 7,
      "tax": 20,
      "total": 37.5,
      "app_fee": 3,
      "change_back_cash_amount": 20,
      "approved": 37.5,
      "refunded": 37.5,
      "processing_fees": [
        {
          "amount": 1.05,
          "effective_at": "2020-09-30T07:43:32.000Z",
          "processing_type": "initial"
        }
      ],
      "source": "external",
      "status": "approved",
      "cash": {
        "amount": null,
        "charge_back_amount": null
      },
      "card_details": {
        "card": {
          "id": "12345",
          "bin": "41111",
          "card_brand": "visa",
          "card_type": "credit",
          "prepaid_type": "prepaid",
          "cardholder_name": "John Doe",
          "customer_id": "12345",
          "merchant_id": "12345",
          "exp_month": 1,
          "exp_year": 2022,
          "fingerprint": " Intended as a POS-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.",
          "last_4": "The last 4 digits of the card number.",
          "enabled": true,
          "billing_address": {
            "id": "123",
            "type": "primary",
            "string": "25 Spring Street, Blackburn, VIC 3130",
            "name": "HQ US",
            "line1": "Main street",
            "line2": "apt #",
            "line3": "Suite #",
            "line4": "delivery instructions",
            "street_number": "25",
            "city": "San Francisco",
            "state": "CA",
            "postal_code": "94104",
            "country": "US",
            "latitude": "40.759211",
            "longitude": "-73.984638",
            "county": "Santa Clara",
            "contact_name": "Elon Musk",
            "salutation": "Mr",
            "phone_number": "111-111-1111",
            "fax": "122-111-1111",
            "email": "elon@musk.com",
            "website": "https://elonmusk.com",
            "notes": "Address notes or delivery instructions.",
            "row_version": "1-12345"
          },
          "reference_id": "card-001",
          "version": "230320320320"
        }
      },
      "bank_account": {
        "bank_name": "string",
        "transfer_type": "string",
        "account_ownership_type": "string",
        "fingerprint": "string",
        "country": "US",
        "statement_description": "string",
        "ach_details": {
          "routing_number": "string",
          "account_number_suffix": "stri",
          "account_type": "string"
        }
      },
      "wallet": {
        "status": "authorized"
      },
      "external_details": {
        "type": "check",
        "source": "string",
        "source_id": "string",
        "source_fee_amount": 2.5
      },
      "service_charges": [
        {
          "id": "12345",
          "name": "Charge for delivery",
          "amount": 27500,
          "percentage": 12.5,
          "currency": "USD",
          "active": true,
          "type": "auto_gratuity"
        }
      ],
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create Payment

post
https://unify.apideck.com/pos/payments

Create Payment

Authorizations:
apiKey

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
source_idstring
required

The ID for the source of funds for this payment. Square-only: This can be a payment token (card nonce) generated by the payment form or a card on file made linked to the customer. if recording a payment that the seller received outside of Square, specify either CASH or EXTERNAL.

order_idstring
required
merchant_idstring
customer_idstring
required
employee_idstring
location_idstring
device_idstring
tender_idstring
required
external_payment_idstring
idempotency_keystring<= 45 characters

A value you specify that uniquely identifies this request among requests you have sent.

amountnumber
required
currencystring or null
required
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

tipnumber
taxnumber
totalnumber
app_feenumber

The amount the developer is taking as a fee for facilitating the payment on behalf of the seller.

change_back_cash_amountnumber
approvednumber

The initial amount of money approved for this payment.

refundednumber

The initial amount of money approved for this payment.

processing_feesobjects
sourcestring
Enum:cardbank_accountwalletbnpl

Source of this payment.

statusstring
Enum:approvedpendingcompletedcanceled

Status of this payment.

cashobject

Cash details for this payment

card_detailsobject
bank_accountobject

Card details for this payment. This field is currently not available. Reach out to our team for more info.

walletobject

Wallet details for this payment. This field is currently not available. Reach out to our team for more info.

external_detailsobject

Details about an external payment.

service_chargesobjects

Optional service charges or gratuity tip applied to the order.

Responses

201PosPayments
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clover
Square
Toast
Request

Request example

{
  "source_id": "12345",
  "order_id": "12345",
  "merchant_id": "12345",
  "customer_id": "12345",
  "employee_id": "12345",
  "location_id": "12345",
  "device_id": "12345",
  "tender_id": "12345",
  "external_payment_id": "12345",
  "idempotency_key": "random_string",
  "amount": 27.5,
  "currency": "USD",
  "tip": 7,
  "tax": 20,
  "total": 37.5,
  "app_fee": 3,
  "change_back_cash_amount": 20,
  "approved": 37.5,
  "refunded": 37.5,
  "processing_fees": [
    {
      "amount": 1.05,
      "effective_at": "2020-09-30T07:43:32.000Z",
      "processing_type": "initial"
    }
  ],
  "source": "external",
  "status": "approved",
  "cash": {
    "amount": null,
    "charge_back_amount": null
  },
  "card_details": {
    "card": {
      "bin": "41111",
      "card_brand": "visa",
      "card_type": "credit",
      "prepaid_type": "prepaid",
      "cardholder_name": "John Doe",
      "customer_id": "12345",
      "merchant_id": "12345",
      "exp_month": 1,
      "exp_year": 2022,
      "fingerprint": " Intended as a POS-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.",
      "last_4": "The last 4 digits of the card number.",
      "enabled": true,
      "billing_address": {
        "id": "123",
        "type": "primary",
        "string": "25 Spring Street, Blackburn, VIC 3130",
        "name": "HQ US",
        "line1": "Main street",
        "line2": "apt #",
        "line3": "Suite #",
        "line4": "delivery instructions",
        "street_number": "25",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94104",
        "country": "US",
        "latitude": "40.759211",
        "longitude": "-73.984638",
        "county": "Santa Clara",
        "contact_name": "Elon Musk",
        "salutation": "Mr",
        "phone_number": "111-111-1111",
        "fax": "122-111-1111",
        "email": "elon@musk.com",
        "website": "https://elonmusk.com",
        "notes": "Address notes or delivery instructions.",
        "row_version": "1-12345"
      },
      "reference_id": "card-001",
      "version": "230320320320"
    }
  },
  "bank_account": {
    "bank_name": "string",
    "transfer_type": "string",
    "account_ownership_type": "string",
    "fingerprint": "string",
    "country": "US",
    "statement_description": "string",
    "ach_details": {
      "routing_number": "string",
      "account_number_suffix": "stri",
      "account_type": "string"
    }
  },
  "wallet": {
    "status": "authorized"
  },
  "external_details": {
    "type": "check",
    "source": "string",
    "source_id": "string",
    "source_fee_amount": 2.5
  },
  "service_charges": [
    {
      "name": "Charge for delivery",
      "amount": 27500,
      "percentage": 12.5,
      "currency": "USD",
      "active": true,
      "type": "auto_gratuity"
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "PosPayments",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get Payment

get
https://unify.apideck.com/pos/payments/{id}

Get Payment

Authorizations:
apiKey

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200PosPayments
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Square
Clover
Request
Toast
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.pos.paymentsOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "PosPayments",
  "operation": "one",
  "data": {
    "id": "12345",
    "source_id": "12345",
    "order_id": "12345",
    "merchant_id": "12345",
    "customer_id": "12345",
    "employee_id": "12345",
    "location_id": "12345",
    "device_id": "12345",
    "tender_id": "12345",
    "external_payment_id": "12345",
    "idempotency_key": "random_string",
    "amount": 27.5,
    "currency": "USD",
    "tip": 7,
    "tax": 20,
    "total": 37.5,
    "app_fee": 3,
    "change_back_cash_amount": 20,
    "approved": 37.5,
    "refunded": 37.5,
    "processing_fees": [
      {
        "amount": 1.05,
        "effective_at": "2020-09-30T07:43:32.000Z",
        "processing_type": "initial"
      }
    ],
    "source": "external",
    "status": "approved",
    "cash": {
      "amount": null,
      "charge_back_amount": null
    },
    "card_details": {
      "card": {
        "id": "12345",
        "bin": "41111",
        "card_brand": "visa",
        "card_type": "credit",
        "prepaid_type": "prepaid",
        "cardholder_name": "John Doe",
        "customer_id": "12345",
        "merchant_id": "12345",
        "exp_month": 1,
        "exp_year": 2022,
        "fingerprint": " Intended as a POS-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.",
        "last_4": "The last 4 digits of the card number.",
        "enabled": true,
        "billing_address": {
          "id": "123",
          "type": "primary",
          "string": "25 Spring Street, Blackburn, VIC 3130",
          "name": "HQ US",
          "line1": "Main street",
          "line2": "apt #",
          "line3": "Suite #",
          "line4": "delivery instructions",
          "street_number": "25",
          "city": "San Francisco",
          "state": "CA",
          "postal_code": "94104",
          "country": "US",
          "latitude": "40.759211",
          "longitude": "-73.984638",
          "county": "Santa Clara",
          "contact_name": "Elon Musk",
          "salutation": "Mr",
          "phone_number": "111-111-1111",
          "fax": "122-111-1111",
          "email": "elon@musk.com",
          "website": "https://elonmusk.com",
          "notes": "Address notes or delivery instructions.",
          "row_version": "1-12345"
        },
        "reference_id": "card-001",
        "version": "230320320320"
      }
    },
    "bank_account": {
      "bank_name": "string",
      "transfer_type": "string",
      "account_ownership_type": "string",
      "fingerprint": "string",
      "country": "US",
      "statement_description": "string",
      "ach_details": {
        "routing_number": "string",
        "account_number_suffix": "stri",
        "account_type": "string"
      }
    },
    "wallet": {
      "status": "authorized"
    },
    "external_details": {
      "type": "check",
      "source": "string",
      "source_id": "string",
      "source_fee_amount": 2.5
    },
    "service_charges": [
      {
        "id": "12345",
        "name": "Charge for delivery",
        "amount": 27500,
        "percentage": 12.5,
        "currency": "USD",
        "active": true,
        "type": "auto_gratuity"
      }
    ],
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z"
  }
}

Update Payment

patch
https://unify.apideck.com/pos/payments/{id}

Update Payment

Authorizations:
apiKey

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
source_idstring
required

The ID for the source of funds for this payment. Square-only: This can be a payment token (card nonce) generated by the payment form or a card on file made linked to the customer. if recording a payment that the seller received outside of Square, specify either CASH or EXTERNAL.

order_idstring
required
merchant_idstring
customer_idstring
required
employee_idstring
location_idstring
device_idstring
tender_idstring
required
external_payment_idstring
idempotency_keystring<= 45 characters

A value you specify that uniquely identifies this request among requests you have sent.

amountnumber
required
currencystring or null
required
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

tipnumber
taxnumber
totalnumber
app_feenumber

The amount the developer is taking as a fee for facilitating the payment on behalf of the seller.

change_back_cash_amountnumber
approvednumber

The initial amount of money approved for this payment.

refundednumber

The initial amount of money approved for this payment.

processing_feesobjects
sourcestring
Enum:cardbank_accountwalletbnpl

Source of this payment.

statusstring
Enum:approvedpendingcompletedcanceled

Status of this payment.

cashobject

Cash details for this payment

card_detailsobject
bank_accountobject

Card details for this payment. This field is currently not available. Reach out to our team for more info.

walletobject

Wallet details for this payment. This field is currently not available. Reach out to our team for more info.

external_detailsobject

Details about an external payment.

service_chargesobjects

Optional service charges or gratuity tip applied to the order.

Responses

200PosPayments
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Square
Clover
Request
Toast
Request

Request example

{
  "source_id": "12345",
  "order_id": "12345",
  "merchant_id": "12345",
  "customer_id": "12345",
  "employee_id": "12345",
  "location_id": "12345",
  "device_id": "12345",
  "tender_id": "12345",
  "external_payment_id": "12345",
  "idempotency_key": "random_string",
  "amount": 27.5,
  "currency": "USD",
  "tip": 7,
  "tax": 20,
  "total": 37.5,
  "app_fee": 3,
  "change_back_cash_amount": 20,
  "approved": 37.5,
  "refunded": 37.5,
  "processing_fees": [
    {
      "amount": 1.05,
      "effective_at": "2020-09-30T07:43:32.000Z",
      "processing_type": "initial"
    }
  ],
  "source": "external",
  "status": "approved",
  "cash": {
    "amount": null,
    "charge_back_amount": null
  },
  "card_details": {
    "card": {
      "bin": "41111",
      "card_brand": "visa",
      "card_type": "credit",
      "prepaid_type": "prepaid",
      "cardholder_name": "John Doe",
      "customer_id": "12345",
      "merchant_id": "12345",
      "exp_month": 1,
      "exp_year": 2022,
      "fingerprint": " Intended as a POS-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.",
      "last_4": "The last 4 digits of the card number.",
      "enabled": true,
      "billing_address": {
        "id": "123",
        "type": "primary",
        "string": "25 Spring Street, Blackburn, VIC 3130",
        "name": "HQ US",
        "line1": "Main street",
        "line2": "apt #",
        "line3": "Suite #",
        "line4": "delivery instructions",
        "street_number": "25",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94104",
        "country": "US",
        "latitude": "40.759211",
        "longitude": "-73.984638",
        "county": "Santa Clara",
        "contact_name": "Elon Musk",
        "salutation": "Mr",
        "phone_number": "111-111-1111",
        "fax": "122-111-1111",
        "email": "elon@musk.com",
        "website": "https://elonmusk.com",
        "notes": "Address notes or delivery instructions.",
        "row_version": "1-12345"
      },
      "reference_id": "card-001",
      "version": "230320320320"
    }
  },
  "bank_account": {
    "bank_name": "string",
    "transfer_type": "string",
    "account_ownership_type": "string",
    "fingerprint": "string",
    "country": "US",
    "statement_description": "string",
    "ach_details": {
      "routing_number": "string",
      "account_number_suffix": "stri",
      "account_type": "string"
    }
  },
  "wallet": {
    "status": "authorized"
  },
  "external_details": {
    "type": "check",
    "source": "string",
    "source_id": "string",
    "source_fee_amount": 2.5
  },
  "service_charges": [
    {
      "name": "Charge for delivery",
      "amount": 27500,
      "percentage": 12.5,
      "currency": "USD",
      "active": true,
      "type": "auto_gratuity"
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "PosPayments",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Delete Payment

delete
https://unify.apideck.com/pos/payments/{id}

Delete Payment

Authorizations:
apiKey

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200PosPayments
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable
Clover
Request
Square
Request
Toast
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.pos.paymentsDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "PosPayments",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Merchants

The Merchants model

idstring

A unique identifier for an object.

namestring or null

The name of the merchant

addressobject
owner_idstring
main_location_idstring or null

The main location ID of the merchant

statusstring or null
Enum:activeinactiveother

Status of this merchant.

Merchants example
{}

List Merchants

get
https://unify.apideck.com/pos/merchants

List Merchants

Authorizations:
apiKey

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Merchants
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clover
Square
Toast
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.pos.merchantsAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "Merchants",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "name": "Dunkin Donuts",
      "address": {
        "id": "123",
        "type": "primary",
        "string": "25 Spring Street, Blackburn, VIC 3130",
        "name": "HQ US",
        "line1": "Main street",
        "line2": "apt #",
        "line3": "Suite #",
        "line4": "delivery instructions",
        "street_number": "25",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94104",
        "country": "US",
        "latitude": "40.759211",
        "longitude": "-73.984638",
        "county": "Santa Clara",
        "contact_name": "Elon Musk",
        "salutation": "Mr",
        "phone_number": "111-111-1111",
        "fax": "122-111-1111",
        "email": "elon@musk.com",
        "website": "https://elonmusk.com",
        "notes": "Address notes or delivery instructions.",
        "row_version": "1-12345"
      },
      "owner_id": "12345",
      "main_location_id": "12345",
      "status": "active",
      "service_charges": [
        {
          "id": "12345",
          "name": "Charge for delivery",
          "amount": 27500,
          "percentage": 12.5,
          "currency": "USD",
          "active": true,
          "type": "auto_gratuity"
        }
      ],
      "language": "EN",
      "currency": "USD",
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create Merchant

post
https://unify.apideck.com/pos/merchants

Create Merchant

Authorizations:
apiKey

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
namestring or null

The name of the merchant

addressobject
owner_idstring
main_location_idstring or null

The main location ID of the merchant

statusstring or null
Enum:activeinactiveother

Status of this merchant.

service_chargesobjects
languagestring or null

language code according to ISO 639-1. For the United States - EN

currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

Responses

201Merchants
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable
Clover
Request
Square
Request
Toast
Request

Request example

{
  "name": "Dunkin Donuts",
  "address": {
    "id": "123",
    "type": "primary",
    "string": "25 Spring Street, Blackburn, VIC 3130",
    "name": "HQ US",
    "line1": "Main street",
    "line2": "apt #",
    "line3": "Suite #",
    "line4": "delivery instructions",
    "street_number": "25",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94104",
    "country": "US",
    "latitude": "40.759211",
    "longitude": "-73.984638",
    "county": "Santa Clara",
    "contact_name": "Elon Musk",
    "salutation": "Mr",
    "phone_number": "111-111-1111",
    "fax": "122-111-1111",
    "email": "elon@musk.com",
    "website": "https://elonmusk.com",
    "notes": "Address notes or delivery instructions.",
    "row_version": "1-12345"
  },
  "owner_id": "12345",
  "main_location_id": "12345",
  "status": "active",
  "service_charges": [
    {
      "name": "Charge for delivery",
      "amount": 27500,
      "percentage": 12.5,
      "currency": "USD",
      "active": true,
      "type": "auto_gratuity"
    }
  ],
  "language": "EN",
  "currency": "USD"
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "Merchants",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get Merchant

get
https://unify.apideck.com/pos/merchants/{id}

Get Merchant

Authorizations:
apiKey

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Merchants
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clover
Square
Toast
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.pos.merchantsOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "Merchants",
  "operation": "one",
  "data": {
    "id": "12345",
    "name": "Dunkin Donuts",
    "address": {
      "id": "123",
      "type": "primary",
      "string": "25 Spring Street, Blackburn, VIC 3130",
      "name": "HQ US",
      "line1": "Main street",
      "line2": "apt #",
      "line3": "Suite #",
      "line4": "delivery instructions",
      "street_number": "25",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94104",
      "country": "US",
      "latitude": "40.759211",
      "longitude": "-73.984638",
      "county": "Santa Clara",
      "contact_name": "Elon Musk",
      "salutation": "Mr",
      "phone_number": "111-111-1111",
      "fax": "122-111-1111",
      "email": "elon@musk.com",
      "website": "https://elonmusk.com",
      "notes": "Address notes or delivery instructions.",
      "row_version": "1-12345"
    },
    "owner_id": "12345",
    "main_location_id": "12345",
    "status": "active",
    "service_charges": [
      {
        "id": "12345",
        "name": "Charge for delivery",
        "amount": 27500,
        "percentage": 12.5,
        "currency": "USD",
        "active": true,
        "type": "auto_gratuity"
      }
    ],
    "language": "EN",
    "currency": "USD",
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z"
  }
}

Update Merchant

patch
https://unify.apideck.com/pos/merchants/{id}

Update Merchant

Authorizations:
apiKey

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
namestring or null

The name of the merchant

addressobject
owner_idstring
main_location_idstring or null

The main location ID of the merchant

statusstring or null
Enum:activeinactiveother

Status of this merchant.

service_chargesobjects
languagestring or null

language code according to ISO 639-1. For the United States - EN

currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

Responses

200Merchants
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clover
Square
Request
Toast
Request

Request example

{
  "name": "Dunkin Donuts",
  "address": {
    "id": "123",
    "type": "primary",
    "string": "25 Spring Street, Blackburn, VIC 3130",
    "name": "HQ US",
    "line1": "Main street",
    "line2": "apt #",
    "line3": "Suite #",
    "line4": "delivery instructions",
    "street_number": "25",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94104",
    "country": "US",
    "latitude": "40.759211",
    "longitude": "-73.984638",
    "county": "Santa Clara",
    "contact_name": "Elon Musk",
    "salutation": "Mr",
    "phone_number": "111-111-1111",
    "fax": "122-111-1111",
    "email": "elon@musk.com",
    "website": "https://elonmusk.com",
    "notes": "Address notes or delivery instructions.",
    "row_version": "1-12345"
  },
  "owner_id": "12345",
  "main_location_id": "12345",
  "status": "active",
  "service_charges": [
    {
      "name": "Charge for delivery",
      "amount": 27500,
      "percentage": 12.5,
      "currency": "USD",
      "active": true,
      "type": "auto_gratuity"
    }
  ],
  "language": "EN",
  "currency": "USD"
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "Merchants",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Delete Merchant

delete
https://unify.apideck.com/pos/merchants/{id}

Delete Merchant

Authorizations:
apiKey

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200Merchants
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable
Clover
Request
Square
Request
Toast
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.pos.merchantsDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "Merchants",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Locations

The Locations model

idstring

A unique identifier for an object.

namestring or null

The name of the location

business_namestring or null

The business name of the location

addressobject
statusstring or null
Enum:activeinactiveother

Status of this location.

merchant_idstring
Locations example
{}

List Locations

get
https://unify.apideck.com/pos/locations

List Locations

Authorizations:
apiKey

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Locations
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Square
Clover
Request
Toast
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.pos.locationsAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "Locations",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "name": "Dunkin Donuts",
      "business_name": "Dunkin Donuts LLC",
      "address": {
        "id": "123",
        "type": "primary",
        "string": "25 Spring Street, Blackburn, VIC 3130",
        "name": "HQ US",
        "line1": "Main street",
        "line2": "apt #",
        "line3": "Suite #",
        "line4": "delivery instructions",
        "street_number": "25",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94104",
        "country": "US",
        "latitude": "40.759211",
        "longitude": "-73.984638",
        "county": "Santa Clara",
        "contact_name": "Elon Musk",
        "salutation": "Mr",
        "phone_number": "111-111-1111",
        "fax": "122-111-1111",
        "email": "elon@musk.com",
        "website": "https://elonmusk.com",
        "notes": "Address notes or delivery instructions.",
        "row_version": "1-12345"
      },
      "status": "active",
      "merchant_id": "12345",
      "currency": "USD",
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create Location

post
https://unify.apideck.com/pos/locations

Create Location

Authorizations:
apiKey

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
namestring or null

The name of the location

business_namestring or null

The business name of the location

addressobject
statusstring or null
Enum:activeinactiveother

Status of this location.

merchant_idstring
currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

Responses

201Locations
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Square
Clover
Request
Toast
Request

Request example

{
  "name": "Dunkin Donuts",
  "business_name": "Dunkin Donuts LLC",
  "address": {
    "id": "123",
    "type": "primary",
    "string": "25 Spring Street, Blackburn, VIC 3130",
    "name": "HQ US",
    "line1": "Main street",
    "line2": "apt #",
    "line3": "Suite #",
    "line4": "delivery instructions",
    "street_number": "25",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94104",
    "country": "US",
    "latitude": "40.759211",
    "longitude": "-73.984638",
    "county": "Santa Clara",
    "contact_name": "Elon Musk",
    "salutation": "Mr",
    "phone_number": "111-111-1111",
    "fax": "122-111-1111",
    "email": "elon@musk.com",
    "website": "https://elonmusk.com",
    "notes": "Address notes or delivery instructions.",
    "row_version": "1-12345"
  },
  "status": "active",
  "merchant_id": "12345",
  "currency": "USD"
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "Locations",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get Location

get
https://unify.apideck.com/pos/locations/{id}

Get Location

Authorizations:
apiKey

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Locations
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Square
Clover
Request
Toast
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.pos.locationsOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "Locations",
  "operation": "one",
  "data": {
    "id": "12345",
    "name": "Dunkin Donuts",
    "business_name": "Dunkin Donuts LLC",
    "address": {
      "id": "123",
      "type": "primary",
      "string": "25 Spring Street, Blackburn, VIC 3130",
      "name": "HQ US",
      "line1": "Main street",
      "line2": "apt #",
      "line3": "Suite #",
      "line4": "delivery instructions",
      "street_number": "25",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94104",
      "country": "US",
      "latitude": "40.759211",
      "longitude": "-73.984638",
      "county": "Santa Clara",
      "contact_name": "Elon Musk",
      "salutation": "Mr",
      "phone_number": "111-111-1111",
      "fax": "122-111-1111",
      "email": "elon@musk.com",
      "website": "https://elonmusk.com",
      "notes": "Address notes or delivery instructions.",
      "row_version": "1-12345"
    },
    "status": "active",
    "merchant_id": "12345",
    "currency": "USD",
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z"
  }
}

Update Location

patch
https://unify.apideck.com/pos/locations/{id}

Update Location

Authorizations:
apiKey

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
namestring or null

The name of the location

business_namestring or null

The business name of the location

addressobject
statusstring or null
Enum:activeinactiveother

Status of this location.

merchant_idstring
currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

Responses

200Locations
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Square
Clover
Request
Toast
Request

Request example

{
  "name": "Dunkin Donuts",
  "business_name": "Dunkin Donuts LLC",
  "address": {
    "id": "123",
    "type": "primary",
    "string": "25 Spring Street, Blackburn, VIC 3130",
    "name": "HQ US",
    "line1": "Main street",
    "line2": "apt #",
    "line3": "Suite #",
    "line4": "delivery instructions",
    "street_number": "25",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94104",
    "country": "US",
    "latitude": "40.759211",
    "longitude": "-73.984638",
    "county": "Santa Clara",
    "contact_name": "Elon Musk",
    "salutation": "Mr",
    "phone_number": "111-111-1111",
    "fax": "122-111-1111",
    "email": "elon@musk.com",
    "website": "https://elonmusk.com",
    "notes": "Address notes or delivery instructions.",
    "row_version": "1-12345"
  },
  "status": "active",
  "merchant_id": "12345",
  "currency": "USD"
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "Locations",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Delete Location

delete
https://unify.apideck.com/pos/locations/{id}

Delete Location

Authorizations:
apiKey

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200Locations
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Square
Clover
Request
Toast
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.pos.locationsDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "Locations",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Items

The Items model

idstring
idempotency_keystring<= 45 characters

A value you specify that uniquely identifies this request among requests you have sent.

namestring
required
descriptionstring
abbreviationstring
product_typestring
Enum:regularother
Items example
{}

List Items

get
https://unify.apideck.com/pos/items

List Items

Authorizations:
apiKey

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Items
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clover
Square
Toast
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.pos.itemsAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "Items",
  "operation": "all",
  "data": [
    {
      "id": "#cocoa",
      "idempotency_key": "random_string",
      "name": "Cocoa",
      "description": "Hot Chocolate",
      "abbreviation": "Ch",
      "product_type": "regular",
      "price_amount": 10,
      "pricing_type": "fixed",
      "price_currency": "USD",
      "cost": 2,
      "tax_ids": [
        "12345",
        "67890"
      ],
      "is_revenue": false,
      "use_default_tax_rates": false,
      "absent_at_location_ids": [
        "12345",
        "67890"
      ],
      "present_at_all_locations": false,
      "available_for_pickup": false,
      "available_online": false,
      "sku": "11910345",
      "code": "11910345",
      "categories": [
        {
          "id": "12345",
          "name": "Food",
          "image_ids": [
            "12345",
            "67890"
          ]
        }
      ],
      "options": [
        {
          "id": "12345",
          "name": "Option 1",
          "attribute_id": "12345"
        }
      ],
      "variations": [
        {
          "id": "12345",
          "name": "Food",
          "sku": "11910345",
          "item_id": "12345",
          "sequence": 0,
          "pricing_type": "fixed",
          "price_amount": 10,
          "price_currency": "USD",
          "image_ids": [
            "12345",
            "67890"
          ]
        }
      ],
      "modifier_groups": [
        {
          "id": "12345"
        }
      ],
      "available": true,
      "hidden": true,
      "version": "12345",
      "deleted": true,
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create Item

post
https://unify.apideck.com/pos/items

Create Item

Authorizations:
apiKey

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
idstring
idempotency_keystring<= 45 characters

A value you specify that uniquely identifies this request among requests you have sent.

namestring
required
descriptionstring
abbreviationstring
product_typestring
Enum:regularother
price_amountnumber
pricing_typestring
Enum:fixedvariableper_unitother
price_currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

costnumber
tax_idsstrings

A list of Tax IDs for the product.

is_revenueboolean

True if this item should be counted as revenue. For example, gift cards and donations would not be counted as revenue.

use_default_tax_ratesboolean
absent_at_location_idsstrings

A list of locations where the object is not present, even if present_at_all_locations is true. This can include locations that are deactivated.

present_at_all_locationsboolean
available_for_pickupboolean
available_onlineboolean
skustring

SKU of the item

codestring

Product code, e.g. UPC or EAN

categoriesobjects
optionsobjects

List of options pertaining to this item's attribute variation

variationsobjects
modifier_groupsobjects
availableboolean or null
hiddenboolean or null
deletedboolean or null

Responses

201Items
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clover
Square
Toast
Request

Request example

{
  "id": "#cocoa",
  "idempotency_key": "random_string",
  "name": "Cocoa",
  "description": "Hot Chocolate",
  "abbreviation": "Ch",
  "product_type": "regular",
  "price_amount": 10,
  "pricing_type": "fixed",
  "price_currency": "USD",
  "cost": 2,
  "tax_ids": [
    "12345",
    "67890"
  ],
  "is_revenue": false,
  "use_default_tax_rates": false,
  "absent_at_location_ids": [
    "12345",
    "67890"
  ],
  "present_at_all_locations": false,
  "available_for_pickup": false,
  "available_online": false,
  "sku": "11910345",
  "code": "11910345",
  "categories": [
    {
      "id": "12345",
      "name": "Food",
      "image_ids": [
        "12345",
        "67890"
      ]
    }
  ],
  "options": [
    {
      "id": "12345",
      "name": "Option 1",
      "attribute_id": "12345"
    }
  ],
  "variations": [
    {
      "id": "12345",
      "name": "Food",
      "sku": "11910345",
      "item_id": "12345",
      "sequence": 0,
      "pricing_type": "fixed",
      "price_amount": 10,
      "price_currency": "USD",
      "image_ids": [
        "12345",
        "67890"
      ]
    }
  ],
  "modifier_groups": [
    {
      "id": "12345"
    }
  ],
  "available": true,
  "hidden": true,
  "deleted": true
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "Items",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get Item

get
https://unify.apideck.com/pos/items/{id}

Get Item

Authorizations:
apiKey

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Items
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clover
Square
Toast
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.pos.itemsOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "Items",
  "operation": "one",
  "data": {
    "id": "#cocoa",
    "idempotency_key": "random_string",
    "name": "Cocoa",
    "description": "Hot Chocolate",
    "abbreviation": "Ch",
    "product_type": "regular",
    "price_amount": 10,
    "pricing_type": "fixed",
    "price_currency": "USD",
    "cost": 2,
    "tax_ids": [
      "12345",
      "67890"
    ],
    "is_revenue": false,
    "use_default_tax_rates": false,
    "absent_at_location_ids": [
      "12345",
      "67890"
    ],
    "present_at_all_locations": false,
    "available_for_pickup": false,
    "available_online": false,
    "sku": "11910345",
    "code": "11910345",
    "categories": [
      {
        "id": "12345",
        "name": "Food",
        "image_ids": [
          "12345",
          "67890"
        ]
      }
    ],
    "options": [
      {
        "id": "12345",
        "name": "Option 1",
        "attribute_id": "12345"
      }
    ],
    "variations": [
      {
        "id": "12345",
        "name": "Food",
        "sku": "11910345",
        "item_id": "12345",
        "sequence": 0,
        "pricing_type": "fixed",
        "price_amount": 10,
        "price_currency": "USD",
        "image_ids": [
          "12345",
          "67890"
        ]
      }
    ],
    "modifier_groups": [
      {
        "id": "12345"
      }
    ],
    "available": true,
    "hidden": true,
    "version": "12345",
    "deleted": true,
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z"
  }
}

Update Item

patch
https://unify.apideck.com/pos/items/{id}

Update Item

Authorizations:
apiKey

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
idstring
idempotency_keystring<= 45 characters

A value you specify that uniquely identifies this request among requests you have sent.

namestring
required
descriptionstring
abbreviationstring
product_typestring
Enum:regularother
price_amountnumber
pricing_typestring
Enum:fixedvariableper_unitother
price_currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

costnumber
tax_idsstrings

A list of Tax IDs for the product.

is_revenueboolean

True if this item should be counted as revenue. For example, gift cards and donations would not be counted as revenue.

use_default_tax_ratesboolean
absent_at_location_idsstrings

A list of locations where the object is not present, even if present_at_all_locations is true. This can include locations that are deactivated.

present_at_all_locationsboolean
available_for_pickupboolean
available_onlineboolean
skustring

SKU of the item

codestring

Product code, e.g. UPC or EAN

categoriesobjects
optionsobjects

List of options pertaining to this item's attribute variation

variationsobjects
modifier_groupsobjects
availableboolean or null
hiddenboolean or null
deletedboolean or null

Responses

200Items
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clover
Square
Toast
Request

Request example

{
  "id": "#cocoa",
  "idempotency_key": "random_string",
  "name": "Cocoa",
  "description": "Hot Chocolate",
  "abbreviation": "Ch",
  "product_type": "regular",
  "price_amount": 10,
  "pricing_type": "fixed",
  "price_currency": "USD",
  "cost": 2,
  "tax_ids": [
    "12345",
    "67890"
  ],
  "is_revenue": false,
  "use_default_tax_rates": false,
  "absent_at_location_ids": [
    "12345",
    "67890"
  ],
  "present_at_all_locations": false,
  "available_for_pickup": false,
  "available_online": false,
  "sku": "11910345",
  "code": "11910345",
  "categories": [
    {
      "id": "12345",
      "name": "Food",
      "image_ids": [
        "12345",
        "67890"
      ]
    }
  ],
  "options": [
    {
      "id": "12345",
      "name": "Option 1",
      "attribute_id": "12345"
    }
  ],
  "variations": [
    {
      "id": "12345",
      "name": "Food",
      "sku": "11910345",
      "item_id": "12345",
      "sequence": 0,
      "pricing_type": "fixed",
      "price_amount": 10,
      "price_currency": "USD",
      "image_ids": [
        "12345",
        "67890"
      ]
    }
  ],
  "modifier_groups": [
    {
      "id": "12345"
    }
  ],
  "available": true,
  "hidden": true,
  "deleted": true
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "Items",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Delete Item

delete
https://unify.apideck.com/pos/items/{id}

Delete Item

Authorizations:
apiKey

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200Items
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clover
Square
Toast
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.pos.itemsDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "Items",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Modifiers

The Modifiers model

idstring

A unique identifier for an object.

idempotency_keystring<= 45 characters

A value you specify that uniquely identifies this request among requests you have sent.

namestring
required
alternate_namestring
price_amountnumber
currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

Modifiers example
{}

List Modifiers

get
https://unify.apideck.com/pos/modifiers

List Modifiers

Authorizations:
apiKey

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Modifiers
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clover
Square
Toast
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.pos.modifiersAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "Modifiers",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "idempotency_key": "random_string",
      "name": "Modifier",
      "alternate_name": "Modifier New",
      "price_amount": 10,
      "currency": "USD",
      "modifier_group_id": "123",
      "available": true,
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create Modifier

post
https://unify.apideck.com/pos/modifiers

Create Modifier

Authorizations:
apiKey

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
idempotency_keystring<= 45 characters

A value you specify that uniquely identifies this request among requests you have sent.

namestring
required
alternate_namestring
price_amountnumber
currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

modifier_group_idstring
required
availableboolean or null

Responses

201Modifiers
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clover
Square
Toast
Request

Request example

{
  "idempotency_key": "random_string",
  "name": "Modifier",
  "alternate_name": "Modifier New",
  "price_amount": 10,
  "currency": "USD",
  "modifier_group_id": "123",
  "available": true
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "Modifiers",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get Modifier

get
https://unify.apideck.com/pos/modifiers/{id}

Get Modifier

Authorizations:
apiKey

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

filterobjectfilter[modifier_group_id]=1234

Apply filters

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Modifiers
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clover
Square
Toast
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.pos.modifiersOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "Modifiers",
  "operation": "one",
  "data": {
    "id": "12345",
    "idempotency_key": "random_string",
    "name": "Modifier",
    "alternate_name": "Modifier New",
    "price_amount": 10,
    "currency": "USD",
    "modifier_group_id": "123",
    "available": true,
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z"
  }
}

Update Modifier

patch
https://unify.apideck.com/pos/modifiers/{id}

Update Modifier

Authorizations:
apiKey

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
idempotency_keystring<= 45 characters

A value you specify that uniquely identifies this request among requests you have sent.

namestring
required
alternate_namestring
price_amountnumber
currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

modifier_group_idstring
required
availableboolean or null

Responses

200Modifiers
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clover
Square
Toast
Request

Request example

{
  "idempotency_key": "random_string",
  "name": "Modifier",
  "alternate_name": "Modifier New",
  "price_amount": 10,
  "currency": "USD",
  "modifier_group_id": "123",
  "available": true
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "Modifiers",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Delete Modifier

delete
https://unify.apideck.com/pos/modifiers/{id}

Delete Modifier

Authorizations:
apiKey

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

filterobjectfilter[modifier_group_id]=1234

Apply filters

Responses

200Modifiers
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clover
Square
Toast
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.pos.modifiersDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "Modifiers",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Modifier Groups

The Modifier Groups model

idstring

A unique identifier for an object.

namestring
alternate_namestring
minimum_requiredinteger
maximum_allowedinteger
selection_typestring
Enum:singlemultiple
Modifier Groups example
{}

List Modifier Groups

get
https://unify.apideck.com/pos/modifier-groups

List Modifier Groups

Authorizations:
apiKey

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200ModifierGroups
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clover
Square
Toast
Request

Request example

Node
import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.pos.modifierGroupsAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "ModifierGroups",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "name": "Modifier",
      "alternate_name": "Modifier New",
      "minimum_required": 1,
      "maximum_allowed": 5,
      "selection_type": "single",
      "present_at_all_locations": false,
      "modifiers": [
        {
          "id": "12345",
          "name": "Modifier",
          "alternate_name": "Modifier New",
          "price_amount": 10,
          "currency": "USD",
          "available": true
        }
      ],
      "deleted": true,
      "row_version": "1-12345",
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create Modifier Group

post
https://unify.apideck.com/pos/modifier-groups

Create Modifier Group

Authorizations:
apiKey

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
namestring
alternate_namestring
minimum_requiredinteger
maximum_allowedinteger
selection_typestring
Enum:singlemultiple
present_at_all_locationsboolean
modifiersobjects
deletedboolean or null
row_versionstring or null

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

Responses

201ModifierGroups
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Clover
Square
Toast
Request

Request example

{
  "name": "Modifier",
  "alternate_name": "Modifier New",
  "minimum_required": 1,
  "maximum_allowed": 5,
  "selection_type": "single",
  "present_at_all_locations": false,
  "modifiers": [
    {
      "id": "12345",
      "name": "Modifier",
      "alternate_name": "Modifier New",
      "price_amount": 10,
      "currency": "USD",
      "available": true
    }
  ],
  "deleted": true,
  "row_version": "1-12345"
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "ModifierGroups",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get Modifier Group