Create an order cart and checkout (2 in 1)

post

https://api-sandbox.blackhawknetwork.com/v3/orders/checkout

Create an order cart with checkout session having payment details and order information

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Order checkout request

A model that represents an order within BHN$

external_id

string

required

length ≤ 36

Order reference ID, generated and provided by the calling application. Should be used as a co-relation ID or to enforce idempotency.

* Every new order must have a unique external_id

external_PO_number

string

Purchase order number used by accounting for purposes such as reconciliation.

locale

string

Defaults to en_US

Locale corresponding to country codes according to ISO 3166 standard.

IE: en_US, fr_CA, en_GB

partner_customer_identifier

string

length ≤ 100

Identifies the end-customer on behalf of whom the order is placed.

client_account_id

string

length ≤ 36

Used to tie an order to a specific BHN client account (e.g., partners selling Amazon content via Tango).

order_items

array of objects

required

A list of items to be ordered

order_items*

sender

object

The sender of the order items

For the order to be accepted, at least one of the following is required:
1. External ID
2. Email Address
3. Individual Name + Address

payment_info

object

fees

array of objects

A list of fees applied to the order.

fees

shipping_fee

object

Holds the shipping fee applied to the order

promos

array of objects

A list of promotional codes that have been applied to an order

promos

grand_total

object

Amount to be paid by the sender, after all fees and promotions are applied.

This value can be sent if caller is configured to skip pricing.

meta_data

object

Meta data for the order as a whole, used to keep track of fields not available in the order API.
Will be returned to the caller.
Has no effect on the order.

device_info

object

channel

string

enum

Allowed:

Headers

financial_account_id

string

This determines which source configuration is used to process the order. Optional. If not provided, 'default' is used.

May be left blank to use default value.

correlation_id

string

trace_id

string

Responses

201successful operation

400Invalid request

404Resource not found

500Internal server error