Add Order to Basket

Adds an order to the basket without submitting. Supports both single and bulk recipients. Once all orders are added, call /basket/send to process payment and submit the orders.

Request Body
uid string Deprecated. Pass your API key in the Authorization header instead.
card_id integer The ID of the card to send.
return_address_id integer If not provided, the account's default return address will be used.
address_id integer A single address id to send an order to. Alternatively, use an array of addresses.
address_ids integer[] Required if addresses is not present
addresses object[] Required if address_ids is not present, for bulk order, from bulk_address_parse_xls request. Contains both the addresses and the message to send. to_first_name string to_last_name string to_business_name string to_address1 string to_address2 string to_city string to_state string to_zip string to_country string return_first_name string return_last_name string return_business_name string return_address1 string return_address2 string return_city string return_state string return_zip string return_country string message string wishes string The right-shifted closing part of the note signature_id integer signature ID for wishes block date_send string signature2_id integer signature ID for main block
font string font id
font_size integer
auto_font_size boolean
for_free boolean
couponCode string
denomination_id integer
insert_id integer
quantity integer
check_quantity boolean check cards and inserts quantity in stock, return insufficient quantity error in case of low stock
delivery_confirmation boolean Request delivery confirmation for the order
client_metadata string Card metadata

Responses
200 successful Schema — OPTIONAL httpCode integer — OPTIONAL status string — OPTIONAL order_id integer — OPTIONAL
400 Error Schema — OPTIONAL httpCode integer — OPTIONAL error string — OPTIONAL Possible values: [no uid, card id error, not found, address error, message error, font error, insufficient quantity, no such card, no such gift card, no such insert, Coupon already used, Coupon already expired, addresses count error, card is not available for free, no free cards, cannot buy, no return info, no such address, no such country] error description
500 Server Error Schema — OPTIONAL success boolean — OPTIONAL code integer — OPTIONAL message string — OPTIONAL Possible values: [error placing order (recipient address not found), error placing main order, error placing child orders, error placing order, error placing order (saving from address), error placing order (saving to address)] error description