- API
New in the API: week of September 28, 2026#
102 additions across Gift cards, Customer account, and 18 more areas. These are additions, so nothing you already use needs to change.
Related: Codes for saved details default to the auto channel, Delivery choice groups name their method types, Delivery quotes name required recipient fields before an address, Delivery recipient details are checked at payment, Quotes offer delivery and pickup windows only while they can be chosen, Exact ZIP codes match verified addresses, Pickup search takes the buyer's current choice and lists stores that track no inventory, Request bodies up to 1 MiB, State conditions match the state a buyer sends
- Endpoint
List gift card loads
- Endpoint
Get a gift card load
- Endpoint
List gift card notifications
- Endpoint
Get a gift card notification
- Endpoint
List gift card redemptions
- Endpoint
Get a gift card redemption
- Endpoint
List gift card transactions
- Endpoint
List gift cards
- Endpoint
Remove a saved gift card
- Endpoint
List the current buyer's deletion requests
- Endpoint
Get the current buyer's email preferences
- Endpoint
List your saved gift cards
- Endpoint
Get a saved gift card
- Endpoint
Get one of the current buyer's payment methods
- Endpoint
Get a payment retry for one of the current buyer's subscriptions
- Endpoint
Update the current buyer's email preferences
- Endpoint
Remove a selected gift card
- Endpoint
Apply a gift card to an order
- Endpoint
Send an order receipt
- Request field
gift_card_recipientonPATCH /v1/orders/{order_id}/line-items/{order_line_item_id}Replaces the recipient of an unfunded gift card purchase.
- Request field
accepted_gift_card_allocationonPOST /v1/orders/{order_id}/payThe gift card allocation to apply to this payment.
- Request field
accepted_gift_card_allocationonPOST /v1/orders/{order_id}/payThe gift card allocation to apply to this payment.
- Request field
save_payment_method_phoneonPOST /v1/orders/{order_id}/payA US or Canadian mobile phone number in E.164 format, such as +14155552671, that confirms a card saved while the checkout acts for no customer, or for the customer whose email the buyer confirmed in it.
- Request field
save_payment_method_phoneonPOST /v1/orders/{order_id}/payA US or Canadian mobile phone number in E.164 format, such as +14155552671, that confirms a card saved while the checkout acts for no customer, or for the customer whose email the buyer confirmed in it.
- Request field
gift_card_configurationonPATCH /v1/products/{product_id}/variants/{variant_id}Replaces the complete gift card configuration.
- Request field
gift_card_configurationonPOST /v1/productsOnly valid for product_type gift_card.
- Field
Gift card issuance terms. face_value_money is the reference denomination; unit_price_money is its price.
- Value
gift_card - Value
gift_card - Value
gift_card - Value
gift_card
- Request field
gift_card_load_idonPOST /v1/refundsAllowed with refund_type full or amount.
- Request field
tender_allocationsonPOST /v1/refundsExhaustive allocations to original tenders.
- Field
Every tender the refund drew from, payment or gift card, with its amount, tip share, status, and destination.
- Field
Cash returned after an unissued gift card purchase refund failed.
- Values
amountquantity - Values
catalog_modifiertext
- Request field
cancellation_commentonPOST /v1/subscriptions/{subscription_id}/cancelFree text about the cancellation, up to 500 characters after surrounding spaces are trimmed.
- Request field
cancellation_reason_codeonPOST /v1/subscriptions/{subscription_id}/cancelOptional.
- Field
Who asked to cancel, when, and why.
- Values
catalog_modifiertext - Event
A subscription was set to cancel at the end of its billing period or trial, or in place of its next payment retry.
- Event
A subscription's scheduled cancellation was undone, so it renews as usual.
- Values
gift_card_load.createdgift_card_load.updatedgift_card_notification.createdgift_card_notification.updatedgift_card_redemption.createdgift_card_redemption.updated - Values
gift_card_load.createdgift_card_load.updatedgift_card_notification.createdgift_card_notification.updatedgift_card_redemption.createdgift_card_redemption.updated - Values
gift_card_load.createdgift_card_load.updatedgift_card_notification.createdgift_card_notification.updatedgift_card_redemption.createdgift_card_redemption.updated - Values
gift_card_load.createdgift_card_load.updatedgift_card_notification.createdgift_card_notification.updatedgift_card_redemption.createdgift_card_redemption.updated - Values
gift_card_load.createdgift_card_load.updatedgift_card_notification.createdgift_card_notification.updatedgift_card_redemption.createdgift_card_redemption.updated - Values
gift_card_load.createdgift_card_load.updatedgift_card_notification.createdgift_card_notification.updatedgift_card_redemption.createdgift_card_redemption.updated
- Values
commerce.gift_cards.adjustments.writecommerce.gift_cards.readcommerce.gift_cards.redemptions.writecommerce.gift_cards.secrets.writecommerce.gift_cards.write - Values
commerce.gift_cards.adjustments.writecommerce.gift_cards.readcommerce.gift_cards.redemptions.writecommerce.gift_cards.secrets.writecommerce.gift_cards.write - Values
commerce.gift_cards.adjustments.writecommerce.gift_cards.readcommerce.gift_cards.redemptions.writecommerce.gift_cards.secrets.writecommerce.gift_cards.write
- Field
The card the buyer saved pending with this checkout's payment, and whether they confirmed it.
- Field
Where this option's items leave from, one leg per origin Location.
- Field
Types of the delivery methods that can serve this group's items, each listed once, in the order the methods display.
- Values
gift_card_liability_v1orders_itemized_v2 - Values
gift_card_liability_v1orders_itemized_v2
- Value
undetermined - Value
undetermined
- Field
Buyer-selected face value and recipient for a gift_card variant.
- Field
Inputs this selection still needs before payment: each destination_address member a chosen shipment or local delivery needs that the stored address lacks (line1, city, and country, plus state and postal_code in the US), and each recipient field a chosen option requires that the selection does not include.
- Values
commerce.gift_cards.adjustments.writecommerce.gift_cards.readcommerce.gift_cards.redemptions.writecommerce.gift_cards.secrets.writecommerce.gift_cards.write
- Value
- Field
The theme a checkout opened from this link uses: your checkout branding settings, with the link's own `theme` over them.
- Value
undetermined
- Field
Replaced as a whole: send every field you want to keep.
- Event
A gift card funding lot was recorded with face value and consideration provenance.
- Event
A gift card funding lot's remaining value or risk restriction changed.
- Event
A gift card recipient notification was created.
- Event
A gift card recipient notification's delivery status changed.
- Event
An exact gift card redemption was reserved or captured.
- Event
A gift card redemption was captured, released, expired or refunded.
- Event
An immutable gift card financial movement was posted.
- Error code
The request body is larger than the endpoint accepts.