from_name
string
required

The name of the sender of the order (typically a gift), to be displayed as "from".

message
string

For gifts, a message for the gift to be displayed in the digital unwrapping and email notifications, if enabled.

recipients
object[]
required
cart
object
required
send_method
enum<string>
required

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.

Available options:
email_and_link,
link_multiple_custom_list,
direct_send
card_id
string

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.

payment_method_id
string

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.

workspace_id
string

Workspace to create the order batch in. If not specified, creates the order batch in the oldest workspace the user has access to.

scheduled_send_on
string | null

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.

expires_at
string | null

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.

swap
enum<string>

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.

Available options:
single,
multiple,
disabled
reserved_options
object | null

For approved API partners only.

SenderCartInput