Table of Contents | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Expand | ||
---|---|---|
| ||
Represents products in your Shopify store. |
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Expand | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||
List of collections containing products.
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||
Represents a product variant.
|
Expand | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Represents custom metadata attached to a resource.
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Represents an image resource.
|
Expand | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Shopify-hosted images related to a product.
|
Expand | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||
Represents a Shopify-hosted 3D model related to a product.
|
Expand | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||
Shopify-hosted videos related to a product.
|
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
Represents product-related videos hosted outside of Shopify.
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Represents store customer information such as contact details, order history, and consent to receive email marketing information..
|
Expand | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||
The default address associated with the customer.
|
Expand | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||
A list of customer-related addresses.
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
A list of the customer's orders.
|
Expand | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
A list of the resource-related metafields.
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The customer's last order.
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
A list of the customer's orders.
|
Expand | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||
If the order was processed using Shopify POS, then this is its location as provided by the merchant.
|
Expand | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||
List of line items that contains the shipping costs.
|
Expand | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||
The app associated with the publication.
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||
List of all transactions associated with the order.
|
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
The transaction fees charged on the order transaction. Only present for Shopify Payments transactions.
|
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Summary of each dispute associated with the order.
|
Expand | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
List of refunds that have been applied to the order.
|
Expand | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
The taxes charged for the order minus the taxes for line items that have been returned.
|
Expand | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Represents custom metadata attached to a resource.
|
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
List of fulfillment orders.
|
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
The order risks associated with this order.
|
Expand | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||
Primary address of the customer, which is shown on the order.
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
An order represents an agreement to do business between a customer and a merchant.
|
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Publication that created the order.
|
Expand | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||
Mailing address for shipping provided by the customer.
|
Expand | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||
A list of mailing addresses provided by the customers.
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Customer who placed the order. Not all orders have customers associated with them.
|
Expand | ||||||
---|---|---|---|---|---|---|
| ||||||
Custom information added to the order by your customer (Also referred to as note attributes).
|
Expand | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
The events preceding a customer order, such as shop sessions.
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Description of the customer's experience with the store leading up to the order.
|
Expand | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
The last session before an order is made.
|
Expand | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
The customer's first session going into the shop.
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
List of the order's line items.
|
Expand | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
The Variant object associated with the line item.
|
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
The Tax Line object connected to the line item.
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
The Product object associated with the line item's variant.
|
Expand | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
The discounts that have been allocated onto the line item by discount applications.
|
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
Service provider who fulfilled the order.
|
Expand | ||||||
---|---|---|---|---|---|---|
| ||||||
List of additional information (metafields) about the line item.
|
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
Fulfillment service associated with the fulfillment.
|
Expand | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
List of shipments for the order.
|
Expand | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||
The location that the fulfillment was processed at.
|
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Tracking information associated with the fulfillment, such as the tracking company, tracking number, and tracking URL.
|
Expand | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||
Represents the goods available to be shipped to a customer. It holds essential information about the goods, including SKU and whether it is tracked.
|
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
List of inventory levels for each location that the inventory item is stocked at.
|
Expand | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||
Location associated with the inventory level.
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||
The variant that owns this inventory item.
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||
List of the product variants.
|
Expand | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
A profile for multi-location, per-product delivery.
|
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
Represents a fulfillment service. A fulfillment service is a third-party service that prepares and ships orders on behalf of the store owner.
|
Expand | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||
The inventory item, which is used to query for inventory information.
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The product that this variant belongs to.
|
Expand | ||||||
---|---|---|---|---|---|---|
| ||||||
List of prices and compare-at prices in the presentment currencies for this shop.
|
Expand | ||||||
---|---|---|---|---|---|---|
| ||||||
List of product options applied to the variant.
|
Expand | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Represents custom metadata attached to a resource.
|
Expand | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Represents custom metadata attached to a resource.
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||
List of the draft orders.
|
Expand | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||
The shipping address of the customer.
|
Expand | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
Order-level discount applied to the draft order.
|
Expand | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||
The billing address of the customer.
|
Expand | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
Total amount of taxes charged for each line item and shipping line.
|
Expand | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||
List of line items that contains the shipping costs.
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Order that was created from this draft order.
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Customer who will be sent an invoice for the draft order, if there is one.
|
Expand | ||||||
---|---|---|---|---|---|---|
| ||||||
Custom information added to the draft order on behalf of your customer.
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||
List of the line items in the draft order.
|
Expand | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
The Variant object associated with the line item.
|
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
The TaxLine object connected to the line item.
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
The product corresponding to the line item’s product variant.
|
Expand | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
Discount which will be applied to the line item or the overall order.
|
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
Name of the service provider who fulfilled the order.
|
Expand | ||||||
---|---|---|---|---|---|---|
| ||||||
List of additional information (metafields) about the line item.
|
Expand | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
List of tender transactions associated with the Shop. A tender transaction represents a transaction which modifies the shop's balance.
|
Expand | ||||||
---|---|---|---|---|---|---|
| ||||||
Information about the payment instrument used for transaction.
|
Expand | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
All bank accounts configured for the Shopify Payments account.
|
Expand | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
All current and previous payouts made between the account and the bank account.
|
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
All disputes related to the Shopify Payments account.
|
Expand | ||||||
---|---|---|---|---|---|---|
| ||||||
The reason of the dispute.
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The order that contains the charge that is under dispute.
|
Expand | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
All current and previous payouts made between the account and the bank account. Payouts represent the movement of money between a merchant's Shopify Payments balance and their bank account.
|
Expand | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
The bank account for the payout.
|
Expand | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||
List of product collections.
|
Expand | ||||
---|---|---|---|---|
| ||||
The set of rules that are used to determine which products are included in the collection. This applies only to smart collections.
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
A list of metafields that belong to the resource.
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||
A list of variants associated with the product.
|
Expand | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
A list of metafields that belong to the resource.
|
Gift Cards (Shopify plus plan only)
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Field | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ID | Globally unique identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created at | The date and time at which the gift card was created. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Balance | The gift card's remaining balance. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Disabled at | The date and time at which the gift card was disabled. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Enabled | Whether the gift card is enabled. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expires on | The date at which the gift card will expire. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Initial value | The initial value of the gift card. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Last characters | The final four characters of the gift card code. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Masked code | The gift card code. Everything but the final four characters is masked. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Note | The note associated with the gift card, which is not visible to the customer. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Field | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ID | Globally unique identifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Unique identifier for the order that appears on the order. For example, #1000 or _Store1001. This value is not unique across multiple stores. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Billing address matches the shipping address | Whether the billing address matches the shipping address. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Can marked as paid | Whether the order can be manually marked as paid. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Can notify customer | Whether notifications can be sent to the customer or not. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cancel reason | Reason the order was canceled. Returns null if the order wasn't canceled. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cancelled at | Date and time when the order was canceled. Returns null if the order wasn't canceled. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Capturable | Whether payment for the order can be captured. Returns true when the customer's credit card has been authorized for payment and the authorization period has not expired. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Presentment cart discount | Amount of the order-level discount (does not contain any line item discounts) in presentment currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Shop cart discount | Amount of the order-level discount (does not contain any line item discounts) in shop currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Client ip | The ip address of the client that is associated with this order. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Closed | Whether the order is closed. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Closed at | Date and time when the order closed. If the order is not closed, then this field is null. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Confirmed | Whether inventory has been reserved for the order. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created at | Date and time when the order was created in Shopify. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Currency code | The currency of the store at the time of the order. If payment hasn't occurred, then this field is null. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Presentment current cart discount | The amount of the order-level discount minus the amounts for line items that have been returned in presentment currency. This doesn't include line item discounts. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Shop current cart discount | The amount of the order-level discount minus the amounts for line items that have been returned in shop currency. This doesn't include line item discounts. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Current subtotal line items quantity | The sum of the quantities for the line items that contribute to the order's subtotal. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Presentment current subtotal price | The subtotal of line items and their discounts minus the line items that have been returned in presentment currency. This includes order-level discounts, unless the argument with_cart_discount is set to false. This doesn't include shipping costs and shipping discounts. Taxes are not included unless the order is a taxes-included order. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Shop current subtotal price | The subtotal of line items and their discounts minus the line items that have been returned in shop currency. This includes order-level discounts, unless the argument with_cart_discount is set to false. This doesn't include shipping costs and shipping discounts. Taxes are not included unless the order is a taxes-included order. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Presentment current total discounts | The total amount discounted from the order (including order-level and line item discounts) minus the amounts for items that have been returned in presentment currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Shop current total discounts | The total amount discounted from the order (including order-level and line item discounts) minus the amounts for items that have been returned in shop currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Presentment current total duties | Total amount of duties for the order in presentment currency. If duties are not applicable, then this value is null. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Shop current total duties | Total amount of duties for the order in shop currency. If duties are not applicable, then this value is null. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Presentment current total price | The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned in presentment currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Shop current total price | The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned in shop currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Presentment current total tax | The total of all taxes applied to the order minus the taxes for line items that have been returned in presentment currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Shop current total tax | The total of all taxes applied to the order minus the taxes for line items that have been returned in shop currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Current total weight | The total weight (grams) of the order minus the weights for line items that have been returned. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Customer accepts marketing | Whether the customer agreed to receive marketing materials. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Customer locale | A two-letter or three-letter language code, optionally followed by a region modifier. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Discount code | Discount code provided by the customer. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Display financial status | Financial status of the order that can be shown to the merchant. This field does not capture all the possible details of an order's financial state and should only be used for display summary purposes. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Display fulfillment status | Fulfillment status for the order that can be shown to the merchant. This field does not capture all the possible details of an order's fulfillment state. It should only be used for display summary purposes. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Edited | Whether the order has had any edits applied or not. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Email address provided by the customer. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Fulfillable | Whether there are items that can be fulfilled. After an order is completely fulfilled (or completely refunded without any fulfillments) then this field returns false. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Fully paid | Whether the order has been paid in full. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Has timeline comment | Whether the merchant added timeline comments to the order. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Merchant editable | Whether the order can be edited or not. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Presentment net payment | Net payment for the order, based on the total amount received - total amount refunded in presentment currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Shop net payment | Net payment for the order, based on the total amount received - total amount refunded in shop currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Note | Contents of the note associated with the order. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Presentment original total duties | Total amount of duties prior to any applied edits for the order in presentment currency. If duties are not applicable, then this value is null. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Shop original total duties | Total amount of duties prior to any applied edits for the order in shop currency. If duties are not applicable, then this value is null. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Presentment original total price | Total price of the order prior to any applied edits in presentment currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Shop original total price | Total price of the order prior to any applied edits in shop currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Payment gateways | List of all payment gateways used for the order. For example, authorize_net and Cash on Delivery (COD). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Phone | Phone number provided by the customer. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Presentment currency | The payment currency of the customer for this order. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Processed at | Date and time when the order was processed. When orders are imported from an app, this date and time may not match the date and time when the order was created. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Presentment refund discrepancy | The difference between suggested and actual refund amounts in presentment currency. A positive value indicates a difference in the merchants favor and a negative value indicates a difference in the customers favor. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Shop original refund discrepancy | The difference between suggested and actual refund amounts in shop currency. A positive value indicates a difference in the merchants favor and a negative value indicates a difference in the customers favor. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Refundable | Whether the order can be refunded. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requires shipping | Whether any line item in the order requires physical shipping. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Restockable | Whether the order can be restocked. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Risk level | Fraud risk level of the order. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Subtotal line items quantity | The sum of the quantities for the line items that contribute to the order's subtotal. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Presentment subtotal price | Subtotal of the line items and their discounts (does not contain shipping costs and shipping discounts) in presentment currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Shop subtotal price | Subtotal of the line items and their discounts (does not contain shipping costs and shipping discounts) in shop currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Tags | A comma separated list of tags that have been added to the order. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Taxes included | Whether taxes are included in the subtotal price of the order. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Test | Whether the order is a test. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Presentment total capturable | Amount authorized for the order, that is uncaptured or undercaptured in presentment currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Shop total capturable | Amount authorized for the order, that is uncaptured or undercaptured in shop currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Presentment total discounts | Total amount discounted from the order (includes order-level and line item discounts) in presentment currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Shop total discounts | Total amount discounted from the order (includes order-level and line item discounts) in shop currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Presentment total outstanding | Total amount of money not yet authorized for the order in presentment currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Shop total outstanding | Total amount of money not yet authorized for the order in shop currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Presentment total price | Total amount of the order (includes taxes and discounts) in presentment currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Shop total price | Total amount of the order (includes taxes and discounts) in shop currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Presentment total received | Total amount received by the customer for the order in presentment currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Shop total received | Total amount received by the customer for the order in shop currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Presentment total refunded | Total amount refunded for the order in presentment currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Shop total refunded | Total amount refunded for the order in shop currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Presentment total refunded shipping | Total amount refunded for shipping in presentment currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Shop total refunded shipping | Total amount refunded for shipping in shop currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Presentment total shipping price | Total amount charged for shipping the order in presentment currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Shop total shipping price | Total amount charged for shipping the order in shop currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Presentment total tax | Total of all taxes applied to the order in presentment currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Shop total tax | Total of all taxes applied to the order in shop currency. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Total tip received | Total tip amount received for the order. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Total weight | Total weight (grams) of the order. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unpaid | Whether no payments have been made for the order. If no payments have been made for the order, then this returns true. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Updated at | Date and time when the order was last modified. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The customer who will receive the gift card. Field Description ID Globally unique identifier. Display name The full name of the customer, based on the first and last name values. If the first and last name are not available, then this falls back to the customer's email address, and if that is not available, the customer's phone number. Accepts marketing Whether the customer has agreed to receive marketing materials. Accepts marketing updated at The date and time when the customer consented or objected to receiving marketing material by email. Average order amount The average amount that the customer spent per order. Can delete Whether the merchant can delete the customer from their store. Created at The date and time when the customer was added to the store. The customer's email address. First name The customer's first name. Has note Whether the customer has a note associated with them. Has timeline comment Whether the merchant has added timeline comments about the customer on the customer's page. Image alt text A word or phrase to share the nature or contents of an image associated with the customer. Original image URL The location of the original image associated with the customer as a URL. Transformed image URL The location of the transformed image associated with the customer as a URL. Last name The customer's last name. Lifetime duration The amount of time since the customer was first added to the store. Locale The customer's locale. Marketing opt-in level The marketing subscription opt-in level (as described by the M3AAWG best practices guideline) that the customer gave when they consented to receive marketing material by email. If the customer does not accept email marketing, then this property will be null. Multipass identifier A unique identifier for the customer that's used with Multipass login. Note A note about the customer. Orders count The number of orders that the customer has made at the store in their lifetime. Phone The customer's phone number. State The state of the customer's account with the shop. Tax exempt Whether the customer is exempt from being charged taxes on their orders. Total spent The total amount that the customer has spent on orders in their lifetime. Updated at The date and time when the customer was last updated. Valid email address Whether the email address is formatted correctly. This does not guarantee that the email address actually exists. | Whether the customer has verified their email addressVerified email
|
Visit the https://aserve.atlassian.net/l/c/GS5hAcYQ page, if you have a question or need any kind of assistance.