Ecommerce API

Orders

An object representing a shipping or billing address.

City

Company Name

Country

Address line 1

Address line 2

Postal code

State

Ecommerce Address

Coupon discount

The date and time when the object was created.

Created at (timestamp)

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

Currency

UNKNOWN_CURRENCY

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

First Name

The ID of the customer this entity is linked to.

Customer ID

Last Name

Full Name

LinkedEcommerceCustomer

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

Ecommerce Discount

Fulfillment status

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

Ecommerce Order Line Item

critical

Note

Order number

Payment method

Payment status

Refunded amount

Ecommerce Order Refund

Shipping cost

Order Status

Sub-total amount

Total amount

Total discount

Total tax

Represents the tracking information associated with an ecommerce order.

Ecommerce Order Tracking Item

The date and time when the object was last updated.

Updated at (timestamp)

Products

Product Description

Product Images

Inventory Quantity

The name of the product as it should be displayed to customers.

Product Name

Product Options

Product Price

Product SKU

The current status of the product (active or archived).

Product Status

Product Weight

The unit of measurement for the weight of the product.

Weight Unit

Customers

Addresses

An array of email addresses for the customer.

Email Addresses

LinkedEcommerceOrder

An array of phone numbers for the customer.

Phone Numbers

Customer status

Stores

Store Admin URL

Store name

Store URL

Amazon Seller Central enables both individuals and businesses to sell their products and inventory on Amazon.com (US accounts only).

oauth_credentials

connection

Amazon Seller Central

Create differentiated commerce experiences on the industry’s most versatile enterprise ecommerce solution. Learn more about BigCommerce.

BigCommerce

Etsy is a store that makes it easy to buy and sell handmade, vintage or uniquely manufactured goods online!

Etsy

See how our point of sale software will help you work more efficiently and increase your bottom line. Read more >>>

Lightspeed

Lightspeed's eCommerce platform and online store software will help your business build a strong web presence.

Lightspeed eCom (C-Series)

Magento is the premier open source e-commerce app used by millions of customers each and every day.

Magento

Mollie builds payment products, commerce solutions and APIs that let you accept online and mobile payments, for small online stores and Fortune 500s alike.

Mollie

Picqer is een super eenvoudig te gebruiken online tool voor het beheren van je magazijn. Speciaal gericht op webwinkels.

Picqer

PrestaShop is an eCommerce website builder to create and manage your online business. You can launch your online store right now and start to sell online!

Prestashop

Sell anywhere, to anyone, with Shopify’s ecommerce platform and point of sale features.

Shopify

Shopware is a trendsetting ecommerce platform to power your online business. Our ecommerce solution offers the perfect combination of beauty & brains you need to build and customize a fully responsive online store.

Shopware

TikTok is the destination for short-form mobile videos. Our mission is to capture and present the world's creativity, knowledge, and precious life moments, directly from the mobile phone. TikTok enables everyone to be a creator, and encourages users to share their passion and creative expression through their videos.

TikTok Shop

Shop Walmart.com for Every Day Low Prices. Free Shipping on Orders $35+ or Pickup In-Store and get a Pickup Discount. Open a Walmart Credit Card to Save Even More!

Walmart

Create a professional website with the Wix website builder. Choose a customizable designer-made template and add the features you need. Get started today.

Wix 

WooCommerce is a WordPress eCommerce plugin that transforms your WordPress website into a fully featured eCommerce store.

WooCommerce

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.

Notes

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.

Created by

Description

Name

medium

Code

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

Division

Discount amount

Discount code

Discount percentage

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.

Variant ID

Amount

Reason

Unique consumer identifier. You can freely choose a consumer ID yourself. Most of the time, this is an ID of your internal data model that represents a user or account in your system (for example account:12345). If the consumer doesn't exist yet, Vault will upsert a consumer based on your ID.

The service provider's ID of the entity that triggered this event

The type entity that triggered this event

The current count this request event has been attempted

ISO Datetime for when the original event occurred

First name

The gender represents the gender identity of a person.

Gender

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

Last name

Order Total

Links to navigate to previous or next pages through the API

Link to navigate to the current page through the API

Link to navigate to the previous page through the API

Middle name

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Simple object allowing any properties for direct extension.

Array of objects for structured data modifications via paths.

Optional identifier for a workflow operation to which this pass_through should be applied. This is useful for Unify calls that are making more than one downstream request.

Identifier for the service to which this pass_through should be applied.

All passthrough query parameters are passed along to the connector as is (?pass_through[search]=leads becomes ?search=leads)

Unit of measurement for employee compensation.

Payment Unit

The area code of the phone number, e.g. 323

Area code

The country code of the phone number, e.g. +1

Country code

Phone extension

Phone number

Photo URL

Raw response from the integration when raw=true query param is provided

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.

Row version

The direction in which to sort the results

Job title

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

Ecommerce API Reference