Schemas
OrderBatch
Schemas
OrderBatch
An order batch is the primary resource created by the API. Order batches contain an array of orders.
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"send_status": "pending",
"from_name": "<string>",
"message": "<string>",
"orders_count": 123,
"orders_preview": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recipient_first_name": "<string>",
"recipient_last_name": "<string>",
"recipient_email": "<string>",
"status": "created",
"individual_gift_link": "<string>",
"cart": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"product": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"brand": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
},
"quantity": 123
}
]
},
"shipments": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"brand_name": "<string>",
"tracking_carrier": "<string>",
"tracking_number": "<string>",
"shipped_at": "2023-11-07T05:31:56Z",
"delivered_at": "2023-11-07T05:31:56Z",
"delivery_eta": "2023-11-07T05:31:56Z"
}
],
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_name": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"card_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"message": "<string>",
"thank_you_note": "<string>",
"view_count_recipient": 123,
"is_swapped": true,
"order_batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amounts": {
"amount_product": 123,
"amount_shipping": 123,
"amount_processing_fee": 123,
"amount_credit_applied": 123,
"amount_pre_tax_total": 123,
"amount_tax": 123,
"amount_total": 123,
"amount_global_relay_cost": 123
},
"event_times": {
"created_at": "2023-11-07T05:31:56Z",
"notified_at": "2023-11-07T05:31:56Z",
"opened_at": "2023-11-07T05:31:56Z",
"accepted_at": "2023-11-07T05:31:56Z",
"pending_payment_at": "2023-11-07T05:31:56Z",
"paid_at": "2023-11-07T05:31:56Z",
"shipped_at": "2023-11-07T05:31:56Z",
"delivered_at": "2023-11-07T05:31:56Z"
},
"original_cart": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"product": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"brand": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
},
"quantity": 123
}
]
},
"original_amounts": {
"original_amount_product": 123,
"original_amount_shipping": 123,
"original_amount_credit_applied": 123,
"original_amount_pre_tax_total": 123
},
"sender": {
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>"
},
"payment_link": "<string>",
"reference_id": "<string>"
}
],
"recipients_count": 123,
"recipients_preview": [
{
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>"
}
],
"cart": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"product": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"brand": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
},
"quantity": 123
}
]
},
"is_scheduled_send": true,
"scheduled_send_on": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"send_method": "email_and_link",
"batch_name": "<string>",
"card_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sender": {
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>"
},
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_name": "<string>",
"reference_id": "<string>"
}