Find the item
The agent turns the user’s request into a purchasable variant.
- Your application searches the catalog with Search products
- Get product details returns the product’s options. When the product has options, Resolve variant turns the selected option ids into the variant id that feeds the quote
Quote the item
The quote opens the merchant checkout and locks the payable amount.
- Your application opens the quote with Create quote, passing the variant ids and a shipping address when the items ship
- The response itemizes the subtotal, the shipping options, the tax, and the final amount
- Select shipping option re-prices the quote for a different delivery choice
Open the checkout and hand over for approval
Reap executes the real merchant checkout after the user approves it.
- Your application opens the payment with Create checkout, passing the quote id, the owner reference, and a
returnUrl - The response carries a redirect link to the hosted approval page. Send the user there to review the order, provide or select a card, and approve the payment
- After the approval the user returns to your
returnUrland Reap completes the merchant checkout
Confirm the completed order
The checkout reports its progress until the order exists at the merchant.
- Your application polls Get checkout until the status reaches
COMPLETEDorFAILED - A completed checkout carries the merchant order reference and the final charged amount, and the agent confirms the order back to the user
The create endpoints require an
Idempotency-Key header, so a retried request cannot open a duplicate quote or charge twice.A worked example
- What the user sees
- What happens underneath
The user asks the agent to buy Sony WH-1000XM5 headphones for about USD 130. The agent finds them at audiohub.com and quotes USD 138.42 including shipping and tax. The user opens the approval link, checks the order, and pays with their card. The agent reports order 12345 with Friday delivery.
Next steps
Recurring purchases
The planned standing approval that covers every later cycle
Read the FAQ
Coverage, limits, and the questions prospects ask