The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the GraphQL Admin API. For details and migration steps, visit our migration guide.
Important
The REST Checkout API is deprecated as of version 2024-07. Please see the developer changelog for more information.
If you're building an app with the Sales Channel SDK, then you can use the Checkout API to let customers purchase products from Shopify stores that have installed your sales channel.
Shopify uses the Checkout resource to manage a user's cart as it transitions to a paid order. This process includes specifying which line items are included in the checkout, attaching a customer's shipping and payment details, and calculating tax and shipping rates. Credit card payments can be attached to a Checkout using the Payment resource.
Note
You can't use the Checkout API to create a new checkout user experience for an individual store. For that you need to use an SDK that's powered by the Storefront API instead, such as the JavaScript Buy, iOS Buy, and Android Buy SDKs.
amount
, title
, description
, value
,
and value_type
.presentment_currency
.applied_discount
with
the appropriate metadata for that discount code. To remove a discount code, send an empty string or
null
.email
or phone
before it can be completed.{ "checkout": { "gift_cards": [{ "code": "a gift card code" }, { "code": "another gift card code" }] } }
.
Each gift card object has the following properties:null
.checkouts
access scope.
checkouts
access scope.
checkouts
access scope.
checkouts
access scope.