Purchasing
Requires The user must have access to customers and orders or draft orders.
Represents information about the purchasing entity for the order or draft order.
Anchor to Possible typesPossible types
- Customer (Customer)
- PurchasingCompany (PurchasingCompany)
- •OBJECT
Information about a customer of the shop, such as the customer's contact details, purchase history, and marketing preferences.
Tracks the customer's total spending through the
field and provides access to associated data such as payment methods and subscription contracts.CautionOnly use this data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.
Caution:Only use this data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.
Caution: Only use this data if it's required for your app's functionality. Shopify will restrict <a href="https://shopify.dev/api/usage/access-scopes">access to scopes</a> for apps that don't have a legitimate use for the associated data.
- •OBJECT
Represents information about the purchasing company for the order or draft order.
Anchor to Fields with this unionFields with this union
- •OBJECT
Calculated pricing, taxes, and discounts for a
. Includes the complete financial breakdown with line items, discounts, shipping costs, tax calculations, and totals in both shop and presentment currencies.Available
options are included when a valid shipping address and line items are present.NoteReturns alerts and warnings when issues occur during calculation, such as insufficient inventory or incompatible discounts.
Note:Returns alerts and warnings when issues occur during calculation, such as insufficient inventory or incompatible discounts.
Note: Returns alerts and warnings when issues occur during calculation, such as insufficient inventory or incompatible discounts.
- •OBJECT
An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks:
- Create new orders for sales made by phone, in person, by chat, or elsewhere. When a merchant accepts payment for a draft order, an order is created.
- Send invoices to customers to pay with a secure checkout link.
- Use custom items to represent additional costs or products that aren't displayed in a shop's inventory.
- Re-create orders manually from active sales channels.
- Sell products at discount or wholesale rates.
- Take pre-orders.
For draft orders in multiple currencies
is the source of truth for what a customer is going to be charged andis an estimate of what the merchant might receive in their shop currency.Caution: Only use this data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.
Draft orders created on or after April 1, 2025 will be automatically purged after one year of inactivity.
- •OBJECT
The
Orderobject represents a customer's request to purchase one or more products from a store. Use theOrderobject to handle the complete purchase lifecycle from checkout to fulfillment.Use the
Orderobject when you need to:- Display order details on customer account pages or admin dashboards.
- Create orders for phone sales, wholesale customers, or subscription services.
- Update order information like shipping addresses, notes, or fulfillment status.
- Process returns, exchanges, and partial refunds.
- Generate invoices, receipts, and shipping labels.
The
Orderobject serves as the central hub connecting customer information, product details, payment processing, and fulfillment data within the GraphQL Admin API schema.NoteOnly the last 60 days' worth of orders from a store are accessible from the
Orderobject by default. If you want to access older records, then you need to request access to all orders. If your app is granted access, then you can add the,, andscopes.Note:Only the last 60 days' worth of orders from a store are accessible from the
Orderobject by default. If you want to access older records, then you need to request access to all orders. If your app is granted access, then you can add the,, andscopes.Note: Only the last 60 days' worth of orders from a store are accessible from the <code>Order</code> object by default. If you want to access older records, then you need to <a href="https://shopify.dev/docs/api/usage/access-scopes#orders-permissions">request access to all orders</a>. If your app is granted access, then you can add the <code><span class="PreventFireFoxApplyingGapToWBR">read<wbr/>_all<wbr/>_orders</span></code>, <code><span class="PreventFireFoxApplyingGapToWBR">read<wbr/>_orders</span></code>, and <code><span class="PreventFireFoxApplyingGapToWBR">write<wbr/>_orders</span></code> scopes.
CautionOnly use orders data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.
Caution:Only use orders data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.
Caution: Only use orders data if it's required for your app's functionality. Shopify will restrict <a href="https://shopify.dev/docs/api/usage/access-scopes#requesting-specific-permissions">access to scopes</a> for apps that don't have a legitimate use for the associated data.
Learn more about building apps for orders and fulfillment.