Create an order
Creates an order and returns its checkout_url, where the customer picks a payment method and pays. Prices, stock, coupons, product rules, fraud checks, shipping and affiliate attribution work exactly as on your storefront.
For physical products send shipping_address; without it the customer enters the address on the checkout page. The order expires after 3 hours if unpaid.
Permission: orders:write
Yetkilendirmeler
Your Store API key (pk_live_...). Create it in Developers › API keys.
The ID of the store the request is for. Shown in Developers › API keys.
Başlıklar
Unique key (for example a UUID) that makes retries safe. The first response is stored for 24 hours and replayed for retries with the same key and body.
255Gövde
Buyer email. Receives the invoice email and the delivery.
"buyer@example.com"
1–50 lines. Prices come from your catalogue; you cannot set them.
1 - 50 elementsSend the delivery to a different address.
Applied if valid for these products. An invalid coupon is ignored.
"SUMMER10"
Must match the products' currency. Defaults to it.
"USD"
Optional safety check. If the server total differs by more than 1 cent, the call fails with TOTAL_MISMATCH.
Answers to your checkout fields, keyed by field key.
Rate from POST /shipping/quote. Without it the cheapest rate is used.
Buyer's IP address. Enables your fraud, VPN and blocklist rules for this order.
"203.0.113.10"
Partner link code to credit (affiliate programme).
"alex"
Send the invoice email to the customer.
Up to 20 keys (≤40 chars) with string values (≤500 chars). Returned on the order and in webhooks of your systems.