Ecommerce API

Orders

Products

Customers

Stores

Sell anywhere, to anyone, with Shopify’s ecommerce platform and point of sale features. Public App OAuth for multi-tenant merchant connections.

connection

oauth_credentials

Shopify (Public App)

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

Indicates whether the order's monetary amounts are inclusive of tax.

Tax inclusive

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)

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

Addresses

An array of email addresses for the customer.

Email Addresses

LinkedEcommerceOrder

An array of phone numbers for the customer.

Phone Numbers

Customer status

Shopify exposes counts via dedicated `/count.json` endpoints only — requires an extra API call not currently implemented. `meta.total_count` will not appear.


The `line_items[].discounts[]` array reflects each line item's allocated share from every
discount application on the order, including order-wide discounts. Shopify's
`discountAllocations` field does not distinguish between product-specific and order-wide
discount sources — all allocations for a given line item are returned together. `meta.total_count` will not appear. Surfacing the total requires a separate GET request to the `/admin/api/{version}/{resource}/count.json` endpoint — an extra API call that is not currently implemented.


The `line_items[].discounts[]` array reflects each line item's allocated share from every
discount application on the order, including order-wide discounts. Shopify's
`discountAllocations` field does not distinguish between product-specific and order-wide
discount sources — all allocations for a given line item are returned together.


Shopify (Public App)

Details