Place an order via the Machine Payments Protocol (MPP)
/agent/orders with product and shipping details402 with payment challenges for all configured methodsAuthorization headerOrderCreate request body as the standard Create Order endpoint. The only difference is how authentication and payment are handled.WWW-Authenticate headers describing the available payment challenges. Your MPP client uses these to complete payment and resubmit the request.
402 Payment Required with WWW-Authenticate headers describing the available payment methods.
Request model for creating a new order.
Shipping address model.
Supports international addresses. The state field is optional for countries
that don't use states/provinces. The country field uses ISO 3166-1 alpha-2
country codes (e.g., "US", "CA", "GB", "DE").
Maximum price (in cents) allowed for an order before it is finalized.
Optional idempotency key to prevent duplicate orders. If not provided, one will be generated.
36Optional short ID (e.g., 'zn_acct_XXXXXXXX') of specific retailer credentials to use for this order. If not provided, credentials will be selected automatically.
Optional metadata to attach to the order. Can contain arbitrary key-value pairs.
Optional purchase order number for the order.
Successful Response
Response model for order data.
pending, in_progress, order_placed, order_failed, cancelled