Ecommerce API

Orders

Products

Customers

Stores

Accounting API

Ledger Accounts

Tax Rates

Company Info

Invoices

Bills

Suppliers

Invoice Items

Payments

Credit Notes

Journal Entries

Subsidiaries

BalanceSheet

ProfitAndLoss

Purchase Orders

Locations

Departments

Attachments

Tracking Categories

Bill Payments

Expenses

Aged Creditors

Aged Debtors

ATS API

Jobs

Applicants

Applications

Connector API

CRM API

Opportunities

Companies

Leads

Contacts

Pipelines

Notes

Activities

Users

File Storage API

Files

Folders

Shared Links

Upload Sessions

Drives

DriveGroups

HRIS API

Employees

Payrolls

Employee Payrolls

Employee Schedules

Time Off Requests

Lead API

Log API traffic. Add monitoring to every API call with the Proxy API.

Proxy API

SMS API

Messages

Manage API keys, access tokens, OAuth flows and integrations.

Vault API

Webhook API traffic. Add monitoring to every API call with the Proxy API.

Webhook API

Customer Support API

Create your own ecosystem with the Ecosystem API.

Ecosystem API

POS API

Merchants

Items

Modifiers

Modifier Groups

Order Types

Tenders

Issue Tracking API

Collections

Tickets

Comments

x-apideck-app-id

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

x-apideck-consumer-id

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

cursor

filter

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. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />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.

fields

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

limit

sort

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

pass_through

Include raw response. Mostly used for debugging purposes

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

x-apideck-service-id

Name of the contact person at the address

country code according to ISO 3166-1 alpha-2.

Address field that holds a sublocality, such as a county

Line 1 of the address e.g. number, street, suite, apt #, etc.

Salutation of the contact person at the address

The address string. Some APIs don't provide structured address data.

edge-case

Contains parameter or domain specific information related to the error and why it occurred.

Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)

A human-readable message providing more details about the error.

The date and time when the object was created.

Created at (timestamp)

Created by

Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).

Currency

UNKNOWN_CURRENCY

Description

Name

medium

When custom mappings are configured on the resource, the result is included here.

Code

critical

The division the person is currently in. Usually a collection of departments or teams or regions.

Division

An object representing a shipping or billing address.

City

Company Name

Country

Address line 1

Address line 2

Postal code

State

Ecommerce Address

Addresses

An array of email addresses for the customer.

Email Addresses

First Name

Last Name

Full Name

An array of phone numbers for the customer.

Phone Numbers

Customer status

An object representing a discount applied to an ecommerce order or product.

Discount amount

Discount code

Discount percentage

Ecommerce Discount

Coupon discount

Fulfillment status

Note

Order number

Payment method

Payment status

Refunded amount

Shipping cost

Sub-total amount

Total amount

Total discount

Total tax

A single line item of an ecommerce order, representing a product or variant with associated options, quantity, and pricing information.

The description of the product or variant associated with the line item.

Is refunded

The name of the product or variant associated with the line item.

A unique identifier for the product associated with the line item.

Product ID

The quantity of the product or variant associated with the line item.

Quantity

The amount of the line item that has been refunded.

The quantity of the line item that has been refunded.

Refunded quantity

The SKU of the product or variant associated with the line item.

The sub total for the product(s) or variant associated with the line item, excluding taxes and discounts.

Sub total

The total tax amount applied to the product or variant associated with the line item.

Tax amount

The tax rate applied to the product or variant associated with the line item.

Tax rate

The total amount for the product(s) or variant associated with the line item, including taxes and discounts.

The unit price of the product or variant associated with the line item.

Unit price

A unique identifier for the variant of the product associated with the line item, if applicable.

API Explorer

Authorization