OrderBatchInput
Input parameters for an order batch.
The name of the sender of the order (typically a gift), to be displayed as "from".
The method for sending a order batch. email_and_link sends a gift email to the recipient (specify email for each recipient). link_multiple_custom_list generates a gift link without an automatic email. direct_send ships the product directly to the recipient (specify mailing_address for each recipient). For more information, see Send Methods.
email_and_link, link_multiple_custom_list, direct_send The digital greeting card to attach to gifts. A card must be specified if a message is specified, since the message is displayed after the card is opened.
The date and time at which the order batch will expire. If not specified, the order batch does not expire. An expiry must be set for orders paid using account balance. ISO 8601 format.
Whether to enable international gift cards on this order. If true and the international_shipping_tier is standard, then international gift cards can be swapped to. If false, then international gift cards are not available to be swapped to.
Whether to enable international shipping on this order. disabled (default) only enables US shipping on this order. standard combined with international_gift_cards_enabled enables international gift cards. full enables the full global catalog for 100+ countries, with additional tax, duties, and freight costs.
disabled, standard, full For gifts, a message for the gift to be displayed in the digital unwrapping and email notifications, if enabled.
Direct Send only. Whether to enable notifications for Direct Send orders. If true, we send confirmation and shipping notifications to Direct Send recipients. If false, we do not send any notifications to Direct Send recipients.
The payment method used to pay for this order batch. If not specified, defaults to the first payment method on the account. If the account has no payment methods, then the order batch creation will fail.
For approved API partners only.
The date and time at which the order batch will be sent. If not specified, the order batch is sent immediately. If an order batch is scheduled to be sent in the future, then orders will not be created until the scheduled send time. ISO 8601 format.
What method to use to allow recipients to swap their gift. single (default) allows the recipient to swap the gift for one item, with hidden gift prices. multiple allows them to swap for multiple items up to the gift cost, with gift prices shown. disabled disables swapping on the gift. For gift collections (gift of choice), this must not be disabled.
single, multiple, disabled Workspace to create the order batch in. If not specified, creates the order batch in the oldest workspace the user has access to.