v1
latestOpenAPI 3.0.12026-07-242871595.3 MBCreate an order
Creates a new order object.
Headers
Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>
Request body
Three-letter ISO 4217 currency code. Format: Lower case Length: Max 3
Displays order details for the customer placing the order.
Email address of the customer placing the order.
Additional information is provided as an expanded response, for example, related objects nested within the parent. See Use expandable fields.
Set of key-value pairs that you can attach to the object. This parameter is useful for storing additional information about the object in a structured format. Length: Maximum 500 characters
Response
Successful response. An order created.
Total order amount in the smallest monetary unit of the merchant's currency.
Amount currently paid toward the order total.
Amount still due toward the order total.
Merchant-defined flat tax amount for the order. Format: Cents
Amount currently paid toward the tax total.
Amount paid in tips. This value is automatically added to the total amount when the transaction is finalized.
Indicates if partial approval has occurred.
Charge identifier. Returns the result when the order status is paid, fulfilled, or refunded.
Authorization code of the charge, if available.
External coupon code available for this order.
Billing address country, if provided.
Time stamps when the order was last updated.
First 6 numbers of the primary account number.
Displays the pre-authorized amount for the order. If any.
If available, the reference number returned from the payment gateway if the transaction is successful.
Detailed warning information about the order or associated charge (for example, missing original transaction id for c-token).
Indicates who entered the card data used for a charge - customer (ecom) or merchant (moto).
Displays results based on the object's created field. Values: String with a Unix timestamp (in milliseconds) or Dictionary of multiple options describing a time range.
Three-letter ISO 4217 currency code.
Customer identifier.
Email address of the customer placing the order.
An identifier such as an invoice or PO number, passed to the merchant's gateway and ultimately appears in settlement records. Note: Applicable for US customers, spaces are allowed in the reference number. Length: Max 12 (including alphanumeric characters)
Customer reference number from the merchant's order management system.
Order identifier.
Indicates whether the item is in production or sandbox. True - Item is in production False - Item is in sandbox
Set of key-value pairs that you can attach to the object. This parameter is useful for storing additional information about the object in a structured format. Length: Maximum 500 characters
Object type. Objects with the same type have the same value.
Selected shipping method of the order. If present, the value is set from the shipping_methods list. For multiple shipping methods, the first method is automatically selected.
Current order status.