Single Step Order
Create's a complete order from one json API call
Request Body |
---|
uid stringThe API token to authenticate login. Can also be placed in the |
login stringemail address; required if uidKey not present |
password stringrequired if uidKey not present |
card_id integer — REQUIREDthe id of the card you want to send |
denomination_id integerOptional. Use if sending a gift card |
message string — REQUIREDthe full message body. Use '\n' for new lines |
font_label string — REQUIREDthe colloquial name of the font, such as 'Fancy Jenna' or 'Casual David' |
credit_card_id integerthe credit card id to charge for the order. Currently this is required, even for invoiced accounts, it just won't be charged. |
insert_id integerthe insert id for the order |
couponCode stringcoupon code |
date_send stringsend date |
validate_address boolean |
webhook_url stringwebhook URL |
sender_name stringalternate - sender_first_name and sender_last_name |
sender_first_name string |
sender_last_name string |
sender_address1 string — REQUIRED |
sender_address2 string |
sender_city string — REQUIRED |
sender_zip string — REQUIRED |
sender_state stringrequired for US and Canada (country id 1 or 2) |
sender_country_id integer1 (United States) by default |
sender_country stringUnited States by default |
recipient_name stringalternate - recipient_first_name and recipient_last_name |
recipient_first_name string |
recipient_last_name string |
recipient_address1 string — REQUIRED |
recipient_address2 string |
recipient_city string — REQUIRED |
recipient_zip string — REQUIRED |
recipient_state stringrequired for US and Canada (country id 1 or 2) |
recipient_country_id integer1 (United States) by default |
recipient_country stringUnited States by default |
client_metadata stringCard metadata |
Responses | |||||
---|---|---|---|---|---|
200 successful
| |||||
400 Error
| |||||
401 Error
| |||||
500 no uid
|