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

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

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

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

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

BigCommerce

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

Lightspeed

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.

oauth_credentials

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.

connection

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

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

3dcart

Actindo

Ad Up

Afosto

Airbit

Fulfillment by Amazon (FBA)

Amazon Seller Central

AmeriCommerce

Auction Mobility

bol.com

Bold Commerce

Bolt

brickfox

BuiltOn

CartHook

CCV Shop

ChannelReply

Clearbanc

Clearhaus

Commerce.js

Commerce Layer

commercetools

DataHawk

Deliverr

Demandware

Diebold Nixdorf

Easy Digital Downloads

Easyship

Enjoy

ExtensionTree

FnnlDb

Foursixty

Frendy

MarketSpace

Google Shopping

Happy Returns

Hello Retail

i95Dev

Fast Simon

Itembase

Honey

Kartaca

LeadCart

Littledata

LiveRecover

Marketflow

Mercari

Mijnwebwinkel

moltin

NitroSell

OpenCart

OXID eSales

Paid

parcelLab

Payrexx

PingPong

Plug&pay

Salesforce Commerce Cloud

Searchanise

Segmentino

Sendcloud

ShipperHQ

Shogun

Shopfiy Plus

Shipup

Stackline

Stitch Labs

Storetasker

Tapcart

Tapfiliate

TrueCommerce

Trunkrs

Videoly

VirtueMart

Webwinkelfacturen.nl

Wiremo

Wish

Yaguara

Zen Cart

OneClickUpsell

eBay

Amplifier

Asset Panda

Big Cartel

ClickBank

CloudCart

Coupon River

Coupon Carrier

Custom Gateway OMS

Deadline Funnel

Dropified

E-junkie

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

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.

Ecommerce connectors