List all order batches

GET

order_batches

List order batches

curl --request GET \
  --url https://api.ongoody.com/v1/order_batches \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "046cd5ae-f7cd-4ee5-9af9-6ee6bfcd5ff5",
      "send_status": "complete",
      "from_name": "Myron",
      "message": null,
      "orders_count": 2,
      "orders_preview": [
        {
          "id": "3032f143-71be-4af4-968e-c9a707cdfbaf",
          "status": "created",
          "individual_gift_link": "https://gifts.ongoody.com/gift/F2I99SL0LI8MCL0KHXPC13SV",
          "recipient_first_name": "Alena",
          "recipient_last_name": "Kenter",
          "recipient_email": "[email protected]",
          "card_id": "733d2231-1026-41dc-a830-305e7f4464d2",
          "message": "Test Message",
          "thank_you_note": null,
          "view_count_recipient": 0,
          "is_swapped": false,
          "order_batch_id": "046cd5ae-f7cd-4ee5-9af9-6ee6bfcd5ff5",
          "expires_at": null,
          "cart": {
            "id": "e3ac44ba-8521-44f5-9abe-295973256045",
            "items": [
              {
                "id": "93dabf0b-88f5-4dc4-aafe-a6a07fd4d727",
                "quantity": 1,
                "product": {
                  "id": "621e2bfc-be45-45bb-a26b-d5a1c9f05c08",
                  "name": "Cookies",
                  "brand": {
                    "id": "20d7df1f-125c-45c5-ab74-6de4c74f5d9e",
                    "name": "Cookie Company"
                  }
                }
              }
            ]
          },
          "shipments": [],
          "amounts": {
            "amount_product": 2000,
            "amount_shipping": 500,
            "amount_processing_fee": 0,
            "amount_pre_tax_total": 2500,
            "amount_tax": null,
            "amount_total": null,
            "amount_global_relay_cost": null
          },
          "sender": {
            "first_name": "Test",
            "last_name": "User",
            "email": "[email protected]"
          },
          "workspace_id": "a70d0225-d75f-4620-8467-25e7b7923e23",
          "workspace_name": "Test Team",
          "original_cart": null,
          "original_amounts": null,
          "reference_id": "UFIXHDFULQKNQHYYWFJA8DPF",
          "payment_link": null
        },
        {
          "id": "b0435662-ba90-4426-8da7-787ab599c629",
          "status": "created",
          "individual_gift_link": "https://gifts.ongoody.com/gift/YAKIHKEVCHDWSJ9ROC4XJI1I",
          "recipient_first_name": "Michael",
          "recipient_last_name": "Franci",
          "recipient_email": "[email protected]",
          "card_id": "733d2231-1026-41dc-a830-305e7f4464d2",
          "message": "Test Message",
          "thank_you_note": null,
          "view_count_recipient": 0,
          "is_swapped": false,
          "order_batch_id": "046cd5ae-f7cd-4ee5-9af9-6ee6bfcd5ff5",
          "expires_at": null,
          "cart": {
            "id": "e3ac44ba-8521-44f5-9abe-295973256045",
            "items": [
              {
                "id": "93dabf0b-88f5-4dc4-aafe-a6a07fd4d727",
                "quantity": 1,
                "product": {
                  "id": "621e2bfc-be45-45bb-a26b-d5a1c9f05c08",
                  "name": "Cookies",
                  "brand": {
                    "id": "20d7df1f-125c-45c5-ab74-6de4c74f5d9e",
                    "name": "Cookie Company"
                  }
                }
              }
            ]
          },
          "shipments": [],
          "amounts": {
            "amount_product": 2000,
            "amount_shipping": 500,
            "amount_processing_fee": 0,
            "amount_pre_tax_total": 2500,
            "amount_tax": null,
            "amount_total": null,
            "amount_global_relay_cost": null
          },
          "sender": {
            "first_name": "Test",
            "last_name": "User",
            "email": "[email protected]"
          },
          "workspace_id": "a70d0225-d75f-4620-8467-25e7b7923e23",
          "workspace_name": "Test Team",
          "original_cart": null,
          "original_amounts": null,
          "reference_id": "NFZKOAQY25WTAW497GINZYCX",
          "payment_link": null
        }
      ],
      "recipients_count": 2,
      "recipients_preview": [
        {
          "first_name": "Alena",
          "last_name": "Kenter",
          "email": "[email protected]"
        },
        {
          "first_name": "Michael",
          "last_name": "Franci",
          "email": "[email protected]"
        }
      ],
      "cart": {
        "id": "e3ac44ba-8521-44f5-9abe-295973256045",
        "items": [
          {
            "id": "93dabf0b-88f5-4dc4-aafe-a6a07fd4d727",
            "quantity": 1,
            "product": {
              "id": "621e2bfc-be45-45bb-a26b-d5a1c9f05c08",
              "name": "Cookies",
              "brand": {
                "id": "20d7df1f-125c-45c5-ab74-6de4c74f5d9e",
                "name": "Cookie Company"
              }
            }
          }
        ]
      },
      "is_scheduled_send": false,
      "scheduled_send_on": null,
      "expires_at": null,
      "send_method": null,
      "batch_name": "Thank You from Hill, Walker and Barton",
      "card_id": "733d2231-1026-41dc-a830-305e7f4464d2",
      "sender": {
        "first_name": "Test",
        "last_name": "User",
        "email": "[email protected]"
      },
      "workspace_id": "a70d0225-d75f-4620-8467-25e7b7923e23",
      "workspace_name": "Test Team",
      "reference_id": "JXX2IYUYRBZBORKZHT3EOIWW"
    },
    {
      "id": "60f1e518-3ab3-4388-ac9f-366be13f977a",
      "send_status": "complete",
      "from_name": "Eusebio",
      "message": null,
      "orders_count": 2,
      "orders_preview": [
        {
          "id": "5b53b89a-0f2d-4e77-8e9c-d24821b28410",
          "status": "created",
          "individual_gift_link": "https://gifts.ongoody.com/gift/HLSGY3PVVBZDNWGX5QCTWCI9",
          "recipient_first_name": "Alena",
          "recipient_last_name": "Kenter",
          "recipient_email": "[email protected]",
          "card_id": "733d2231-1026-41dc-a830-305e7f4464d2",
          "message": "Test Message",
          "thank_you_note": null,
          "view_count_recipient": 0,
          "is_swapped": false,
          "order_batch_id": "60f1e518-3ab3-4388-ac9f-366be13f977a",
          "expires_at": null,
          "cart": {
            "id": "6dc52b7c-c69d-4628-b338-83f90ab869a6",
            "items": [
              {
                "id": "0571a053-0287-4584-9362-57a3e347d18d",
                "quantity": 1,
                "product": {
                  "id": "a5645f2c-1dea-489d-b14f-149a9edebde8",
                  "name": "Cookies",
                  "brand": {
                    "id": "20d7df1f-125c-45c5-ab74-6de4c74f5d9e",
                    "name": "Cookie Company"
                  }
                }
              }
            ]
          },
          "shipments": [],
          "amounts": {
            "amount_product": 2000,
            "amount_shipping": 500,
            "amount_processing_fee": 0,
            "amount_pre_tax_total": 2500,
            "amount_tax": null,
            "amount_total": null,
            "amount_global_relay_cost": null
          },
          "sender": {
            "first_name": "Test",
            "last_name": "User",
            "email": "[email protected]"
          },
          "workspace_id": "a70d0225-d75f-4620-8467-25e7b7923e23",
          "workspace_name": "Test Team",
          "original_cart": null,
          "original_amounts": null,
          "reference_id": "KCRSFLWWCODWMXZCRPGCNXQZ",
          "payment_link": null
        },
        {
          "id": "ada453df-5e51-47fd-9e5e-7bcc594f8600",
          "status": "created",
          "individual_gift_link": "https://gifts.ongoody.com/gift/R2OIBM8I99CW983CRIB6VV9D",
          "recipient_first_name": "Michael",
          "recipient_last_name": "Franci",
          "recipient_email": "[email protected]",
          "card_id": "733d2231-1026-41dc-a830-305e7f4464d2",
          "message": "Test Message",
          "thank_you_note": null,
          "view_count_recipient": 0,
          "is_swapped": false,
          "order_batch_id": "60f1e518-3ab3-4388-ac9f-366be13f977a",
          "expires_at": null,
          "cart": {
            "id": "6dc52b7c-c69d-4628-b338-83f90ab869a6",
            "items": [
              {
                "id": "0571a053-0287-4584-9362-57a3e347d18d",
                "quantity": 1,
                "product": {
                  "id": "a5645f2c-1dea-489d-b14f-149a9edebde8",
                  "name": "Cookies",
                  "brand": {
                    "id": "20d7df1f-125c-45c5-ab74-6de4c74f5d9e",
                    "name": "Cookie Company"
                  }
                }
              }
            ]
          },
          "shipments": [],
          "amounts": {
            "amount_product": 2000,
            "amount_shipping": 500,
            "amount_processing_fee": 0,
            "amount_pre_tax_total": 2500,
            "amount_tax": null,
            "amount_total": null,
            "amount_global_relay_cost": null
          },
          "sender": {
            "first_name": "Test",
            "last_name": "User",
            "email": "[email protected]"
          },
          "workspace_id": "a70d0225-d75f-4620-8467-25e7b7923e23",
          "workspace_name": "Test Team",
          "original_cart": null,
          "original_amounts": null,
          "reference_id": "7IDP80VTVNB3DFWUNRBPACZU",
          "payment_link": null
        }
      ],
      "recipients_count": 2,
      "recipients_preview": [
        {
          "first_name": "Alena",
          "last_name": "Kenter",
          "email": "[email protected]"
        },
        {
          "first_name": "Michael",
          "last_name": "Franci",
          "email": "[email protected]"
        }
      ],
      "cart": {
        "id": "6dc52b7c-c69d-4628-b338-83f90ab869a6",
        "items": [
          {
            "id": "0571a053-0287-4584-9362-57a3e347d18d",
            "quantity": 1,
            "product": {
              "id": "a5645f2c-1dea-489d-b14f-149a9edebde8",
              "name": "Cookies",
              "brand": {
                "id": "20d7df1f-125c-45c5-ab74-6de4c74f5d9e",
                "name": "Cookie Company"
              }
            }
          }
        ]
      },
      "is_scheduled_send": false,
      "scheduled_send_on": null,
      "expires_at": null,
      "send_method": null,
      "batch_name": "Thank You from Barrows Inc",
      "card_id": "733d2231-1026-41dc-a830-305e7f4464d2",
      "sender": {
        "first_name": "Test",
        "last_name": "User",
        "email": "[email protected]"
      },
      "workspace_id": "a70d0225-d75f-4620-8467-25e7b7923e23",
      "workspace_name": "Test Team",
      "reference_id": "XXROJBTWMAYQS4RCEKI6VG4N"
    }
  ],
  "list_meta": {
    "total_count": 2
  }
}

Authorizations

Authorization

string

header

required

Your Goody API key.

Query Parameters

page

integer

default:1

Page for pagination, starting at 1

Required range: x >= 1

per_page

integer

default:20

Items per page for pagination

Required range: 1 <= x <= 100

Response

200 - application/json

Order batches retrieved

data

object[]

Show child attributes

data.id

string<uuid>

required

data.send_status

enum<string>

required

The pending status indicates that an order batch is being prepared to be sent out. If it is not scheduled, it is being sent asynchronously. If it is scheduled, it will stay in pending state until the scheduled time is reached, at which point it will be processed and moved to complete. When it is in pending status, no orders are created yet. When the order batch is in complete status, all orders are created and available.

Available options:

pending,

complete,

failed,

canceled

data.from_name

string

required

The name of the sender. This is displayed on the order and notifications.

data.orders_count

integer

required

The total number of orders in this order batch. This might be blank if the order batch is scheduled for the future, or it could be fewer than the recipient count if the order batch is in the process of being sent.

data.orders_preview

object[]

required

A preview of the first 10 orders in this order batch. To paginate through all of the orders, use the /order_batches/:id/orders endpoint with ?page&per_page. If your use case never sends more than 10 orders in a single batch, you can use this field instead of calling /order_batches/:id/orders. For order batches with more than 10 recipients, this array will be empty while the orders are asynchronously created in the background.

Show child attributes

data.orders_preview.id

string<uuid>

required

data.orders_preview.recipient_first_name

string

required

data.orders_preview.status

enum<string>

required

Available options:

created,

notified,

opened,

accepted,

pending_payment,

paid,

ordered,

shipped,

delivered,

failed,

canceled

data.orders_preview.individual_gift_link

string

required

This gift link can be sent to the recipient or shared with the sender. For privacy reasons, this gift link does not display tracking information. A separate link, the recipient link, is sent directly to the recipient after they accept their gift, which does contain tracking information.

data.orders_preview.cart

object

required

The cart currently on this order. If the order is a gift that was swapped, cart displays the most recent products selected (i.e. post-swap).

Show child attributes

data.orders_preview.cart.id

string<uuid>

data.orders_preview.cart.items

object[]

Show child attributes

data.orders_preview.cart.items.id

string<uuid>

required

data.orders_preview.cart.items.product

object

required

Show child attributes

data.orders_preview.cart.items.product.id

string<uuid>

required

data.orders_preview.cart.items.product.name

string

required

data.orders_preview.cart.items.product.brand

object

required

The brand that this product is from.

Show child attributes

data.orders_preview.cart.items.product.brand.id

string<uuid>

required

data.orders_preview.cart.items.product.brand.name

string

required

data.orders_preview.cart.items.quantity

integer

required

data.orders_preview.shipments

object[]

required

A list of the shipments for the order.

Show child attributes

data.orders_preview.shipments.id

string<uuid>

required

data.orders_preview.shipments.status

enum<string>

required

Available options:

pending,

tracking,

shipped,

delivered,

delivered_override,

failed,

failed_unset_tracking,

failed_with_reship

data.orders_preview.shipments.brand_name

string

required

The name of the brand that this shipment is from.

data.orders_preview.shipments.tracking_carrier

string | null

The carrier for this shipment, e.g. UPS.

data.orders_preview.shipments.tracking_number

string | null

Only for approved distribution partners.

data.orders_preview.shipments.tracking_url

string | null

Only for approved distribution partners.

data.orders_preview.shipments.shipped_at

string<date-time> | null

ISO 8601

data.orders_preview.shipments.delivered_at

string<date-time> | null

ISO 8601

data.orders_preview.shipments.delivery_eta

string<date-time> | null

The estimated delivery time of this shipment.

data.orders_preview.amounts

object

required

Costs in USD cents (i.e. $1.00 = 100). If the order was swapped, amounts displays the most recent amounts (i.e. post-swap).

Show child attributes

data.orders_preview.amounts.amount_product

integer

required

Total cost of the products in this order.

data.orders_preview.amounts.amount_shipping

integer

required

Total cost of shipping for this order.

data.orders_preview.amounts.amount_pre_tax_total

integer

required

Total cost of the products, shipping, and processing fees in this order.

data.orders_preview.amounts.amount_processing_fee

integer | null

Total cost of processing fees for this order.

data.orders_preview.amounts.amount_credit_applied

integer | null

Total amount of credit applied to this order.

data.orders_preview.amounts.amount_tax

integer | null

Total tax for this order.

data.orders_preview.amounts.amount_total

integer | null

Total cost of the products, shipping, processing fees, tax, and global shipping costs in this order.

data.orders_preview.amounts.amount_global_relay_cost

integer | null

Total cost of global shipping for this order through the Global Relay service.

data.orders_preview.sender

object

required

The Goody user who sent this order.

Show child attributes

data.orders_preview.sender.first_name

string

required

data.orders_preview.sender.last_name

string

required

data.orders_preview.sender.email

string

required

data.orders_preview.reference_id

string

required

The reference ID displayed on receipts and other locations as the ID for this order.

data.orders_preview.recipient_last_name

string | null

data.orders_preview.recipient_email

string | null

data.orders_preview.cart_selections

object[] | null

Product variant selections for each cart product. Only for commerce app orders.

Show child attributes

data.orders_preview.cart_selections.id

string<uuid>

required

data.orders_preview.cart_selections.cart_item_id

string<uuid>

required

The cart item ID this selection belongs to. Match this with cart.items[].id.

data.orders_preview.cart_selections.quantity_index

integer

required

The index of this selection within multiple quantities of the same product. If a given cart product has multiple quantities, this will be 0 for the first unit, 1 for the second unit, etc.

data.orders_preview.cart_selections.variants

string[]

required

The selected variants for this product selection and quantity index.

data.orders_preview.workspace_id

string<uuid> | null

Organizations are sub-divided into workspaces. Orders are contained in workspaces, identified by this ID.

data.orders_preview.workspace_name

string | null

data.orders_preview.expires_at

string<date-time> | null

For gifts, the date and time the gift is set to expire.

data.orders_preview.card_id

string<uuid> | null

The digital greeting card on this gift.

data.orders_preview.message

string | null

The message in this gift, provided by the sender.

data.orders_preview.thank_you_note

string | null

A thank you note sent by the recipient.

data.orders_preview.view_count_recipient

integer

The number of times the recipient viewed the gift.

data.orders_preview.is_swapped

boolean

If this gift was swapped by the recipient. Swapping allows a recipient to select another product or products, which replaces the cart. The original products are saved to original_cart.

data.orders_preview.order_batch_id

string<uuid>

On Goody for Business, all orders are attached to a order batch, which is a collection of one or more orders.

data.orders_preview.event_times

object

Only provided when calling the /orders/:id endpoint.

Show child attributes

data.orders_preview.event_times.created_at

string<date-time>

required

ISO 8601

data.orders_preview.event_times.notified_at

string<date-time> | null

When the recipient was notified of the order.

data.orders_preview.event_times.opened_at

string<date-time> | null

For gifts, when the recipient opened the order.

data.orders_preview.event_times.accepted_at

string<date-time> | null

For gifts, when the recipient accepted the order.

data.orders_preview.event_times.pending_payment_at

string<date-time> | null

When the order entered pending payment status.

data.orders_preview.event_times.paid_at

string<date-time> | null

When the order was paid for.

data.orders_preview.event_times.shipped_at

string<date-time> | null

When the order was first shipped. If there are multiple shipments, this is when the first shipment shipped.

data.orders_preview.event_times.delivered_at

string<date-time> | null

When the order was delivered. If there are multiple shipments, this is when all shipments were delivered.

data.orders_preview.original_cart

object

If this order is a gift that was swapped, this displays the original cart that was sent to the recipient.

Show child attributes

data.orders_preview.original_cart.id

string<uuid>

data.orders_preview.original_cart.items

object[]

Show child attributes

data.orders_preview.original_cart.items.id

string<uuid>

required

data.orders_preview.original_cart.items.product

object

required

Show child attributes

data.orders_preview.original_cart.items.product.id

string<uuid>

required

data.orders_preview.original_cart.items.product.name

string

required

data.orders_preview.original_cart.items.product.brand

object

required

The brand that this product is from.

Show child attributes

data.orders_preview.original_cart.items.product.brand.id

string<uuid>

required

data.orders_preview.original_cart.items.product.brand.name

string

required

data.orders_preview.original_cart.items.quantity

integer

required

data.orders_preview.original_amounts

object

If this order is a gift that was swapped, this displays the original amounts of the cart that was sent to the recipient.

Show child attributes

data.orders_preview.original_amounts.original_amount_product

integer | null

data.orders_preview.original_amounts.original_amount_shipping

integer | null

data.orders_preview.original_amounts.original_amount_credit_applied

integer | null

data.orders_preview.original_amounts.original_amount_pre_tax_total

integer | null

data.orders_preview.payment_link

string | null

For commerce apps using Hosted Payment, the payment link for the gift with the credit card entry form. Available when the gift is in pending_payment status (after it has been accepted).

data.recipients_count

integer

required

The total number of recipients in this order batch.

data.recipients_preview

object[]

required

A preview of the first 10 recipients in this order batch. To see all of the recipients, use /order_batches/:id/recipients. Recipients contain the original contact information provided for each recipient when the order batch was created.

Show child attributes

data.recipients_preview.first_name

string

required

data.recipients_preview.last_name

string | null

data.recipients_preview.email

string | null

data.cart

object

required

The cart that was sent for this order batch. This is the original cart that was created for this order batch. If individual orders were swapped, this still remains the same, whereas orders' cart would change if they were swapped.

Show child attributes

data.cart.id

string<uuid>

data.cart.items

object[]

Show child attributes

data.cart.items.id

string<uuid>

required

data.cart.items.product

object

required

Show child attributes

data.cart.items.product.id

string<uuid>

required

data.cart.items.product.name

string

required

data.cart.items.product.brand

object

required

The brand that this product is from.

Show child attributes

data.cart.items.product.brand.id

string<uuid>

required

data.cart.items.product.brand.name

string

required

data.cart.items.quantity

integer

required

data.sender

object

required

The sender of the order batch.

Show child attributes

data.sender.first_name

string

required

data.sender.last_name

string

required

data.sender.email

string

required

data.reference_id

string

required

The reference ID displayed on receipts and other locations as the ID for this order batch.

data.message

string | null

The message in this order batch, provided by the sender.

data.is_scheduled_send

boolean

Whether this order batch was set up as a scheduled send. This stays as true after the scheduled send is complete. To determine if the order batch is scheduled to be sent for the future, check if status is pending and scheduled_send_on is in the future. When a order batch is scheduled, orders are only created on the scheduled send date.

data.scheduled_send_on

string<date-time> | null

The date and time the order batch is scheduled to be sent. This will be null if the order batch is not a scheduled send. This field remains after the scheduled send completes. ISO 8601, UTC.

data.expires_at

string<date-time> | null

The date and time the order batch is set to expire. ISO 8601, UTC.

data.send_method

enum<string> | null

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

data.batch_name

string | null

An internal name for the order batch, falling back to an auto-generated batch name. Not displayed to recipients.

data.card_id

string<uuid> | null

The digital greeting card on this order batch.

data.workspace_id

string<uuid> | null

Organizations are sub-divided into workspaces. Order batches are contained in workspaces, identified by this ID.

data.workspace_name

string | null

list_meta

object

Show child attributes

list_meta.total_count

integer

The total number of items in this list.

Retrieve an order batch

⌘I

List order batches

curl --request GET \
  --url https://api.ongoody.com/v1/order_batches \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "046cd5ae-f7cd-4ee5-9af9-6ee6bfcd5ff5",
      "send_status": "complete",
      "from_name": "Myron",
      "message": null,
      "orders_count": 2,
      "orders_preview": [
        {
          "id": "3032f143-71be-4af4-968e-c9a707cdfbaf",
          "status": "created",
          "individual_gift_link": "https://gifts.ongoody.com/gift/F2I99SL0LI8MCL0KHXPC13SV",
          "recipient_first_name": "Alena",
          "recipient_last_name": "Kenter",
          "recipient_email": "[email protected]",
          "card_id": "733d2231-1026-41dc-a830-305e7f4464d2",
          "message": "Test Message",
          "thank_you_note": null,
          "view_count_recipient": 0,
          "is_swapped": false,
          "order_batch_id": "046cd5ae-f7cd-4ee5-9af9-6ee6bfcd5ff5",
          "expires_at": null,
          "cart": {
            "id": "e3ac44ba-8521-44f5-9abe-295973256045",
            "items": [
              {
                "id": "93dabf0b-88f5-4dc4-aafe-a6a07fd4d727",
                "quantity": 1,
                "product": {
                  "id": "621e2bfc-be45-45bb-a26b-d5a1c9f05c08",
                  "name": "Cookies",
                  "brand": {
                    "id": "20d7df1f-125c-45c5-ab74-6de4c74f5d9e",
                    "name": "Cookie Company"
                  }
                }
              }
            ]
          },
          "shipments": [],
          "amounts": {
            "amount_product": 2000,
            "amount_shipping": 500,
            "amount_processing_fee": 0,
            "amount_pre_tax_total": 2500,
            "amount_tax": null,
            "amount_total": null,
            "amount_global_relay_cost": null
          },
          "sender": {
            "first_name": "Test",
            "last_name": "User",
            "email": "[email protected]"
          },
          "workspace_id": "a70d0225-d75f-4620-8467-25e7b7923e23",
          "workspace_name": "Test Team",
          "original_cart": null,
          "original_amounts": null,
          "reference_id": "UFIXHDFULQKNQHYYWFJA8DPF",
          "payment_link": null
        },
        {
          "id": "b0435662-ba90-4426-8da7-787ab599c629",
          "status": "created",
          "individual_gift_link": "https://gifts.ongoody.com/gift/YAKIHKEVCHDWSJ9ROC4XJI1I",
          "recipient_first_name": "Michael",
          "recipient_last_name": "Franci",
          "recipient_email": "[email protected]",
          "card_id": "733d2231-1026-41dc-a830-305e7f4464d2",
          "message": "Test Message",
          "thank_you_note": null,
          "view_count_recipient": 0,
          "is_swapped": false,
          "order_batch_id": "046cd5ae-f7cd-4ee5-9af9-6ee6bfcd5ff5",
          "expires_at": null,
          "cart": {
            "id": "e3ac44ba-8521-44f5-9abe-295973256045",
            "items": [
              {
                "id": "93dabf0b-88f5-4dc4-aafe-a6a07fd4d727",
                "quantity": 1,
                "product": {
                  "id": "621e2bfc-be45-45bb-a26b-d5a1c9f05c08",
                  "name": "Cookies",
                  "brand": {
                    "id": "20d7df1f-125c-45c5-ab74-6de4c74f5d9e",
                    "name": "Cookie Company"
                  }
                }
              }
            ]
          },
          "shipments": [],
          "amounts": {
            "amount_product": 2000,
            "amount_shipping": 500,
            "amount_processing_fee": 0,
            "amount_pre_tax_total": 2500,
            "amount_tax": null,
            "amount_total": null,
            "amount_global_relay_cost": null
          },
          "sender": {
            "first_name": "Test",
            "last_name": "User",
            "email": "[email protected]"
          },
          "workspace_id": "a70d0225-d75f-4620-8467-25e7b7923e23",
          "workspace_name": "Test Team",
          "original_cart": null,
          "original_amounts": null,
          "reference_id": "NFZKOAQY25WTAW497GINZYCX",
          "payment_link": null
        }
      ],
      "recipients_count": 2,
      "recipients_preview": [
        {
          "first_name": "Alena",
          "last_name": "Kenter",
          "email": "[email protected]"
        },
        {
          "first_name": "Michael",
          "last_name": "Franci",
          "email": "[email protected]"
        }
      ],
      "cart": {
        "id": "e3ac44ba-8521-44f5-9abe-295973256045",
        "items": [
          {
            "id": "93dabf0b-88f5-4dc4-aafe-a6a07fd4d727",
            "quantity": 1,
            "product": {
              "id": "621e2bfc-be45-45bb-a26b-d5a1c9f05c08",
              "name": "Cookies",
              "brand": {
                "id": "20d7df1f-125c-45c5-ab74-6de4c74f5d9e",
                "name": "Cookie Company"
              }
            }
          }
        ]
      },
      "is_scheduled_send": false,
      "scheduled_send_on": null,
      "expires_at": null,
      "send_method": null,
      "batch_name": "Thank You from Hill, Walker and Barton",
      "card_id": "733d2231-1026-41dc-a830-305e7f4464d2",
      "sender": {
        "first_name": "Test",
        "last_name": "User",
        "email": "[email protected]"
      },
      "workspace_id": "a70d0225-d75f-4620-8467-25e7b7923e23",
      "workspace_name": "Test Team",
      "reference_id": "JXX2IYUYRBZBORKZHT3EOIWW"
    },
    {
      "id": "60f1e518-3ab3-4388-ac9f-366be13f977a",
      "send_status": "complete",
      "from_name": "Eusebio",
      "message": null,
      "orders_count": 2,
      "orders_preview": [
        {
          "id": "5b53b89a-0f2d-4e77-8e9c-d24821b28410",
          "status": "created",
          "individual_gift_link": "https://gifts.ongoody.com/gift/HLSGY3PVVBZDNWGX5QCTWCI9",
          "recipient_first_name": "Alena",
          "recipient_last_name": "Kenter",
          "recipient_email": "[email protected]",
          "card_id": "733d2231-1026-41dc-a830-305e7f4464d2",
          "message": "Test Message",
          "thank_you_note": null,
          "view_count_recipient": 0,
          "is_swapped": false,
          "order_batch_id": "60f1e518-3ab3-4388-ac9f-366be13f977a",
          "expires_at": null,
          "cart": {
            "id": "6dc52b7c-c69d-4628-b338-83f90ab869a6",
            "items": [
              {
                "id": "0571a053-0287-4584-9362-57a3e347d18d",
                "quantity": 1,
                "product": {
                  "id": "a5645f2c-1dea-489d-b14f-149a9edebde8",
                  "name": "Cookies",
                  "brand": {
                    "id": "20d7df1f-125c-45c5-ab74-6de4c74f5d9e",
                    "name": "Cookie Company"
                  }
                }
              }
            ]
          },
          "shipments": [],
          "amounts": {
            "amount_product": 2000,
            "amount_shipping": 500,
            "amount_processing_fee": 0,
            "amount_pre_tax_total": 2500,
            "amount_tax": null,
            "amount_total": null,
            "amount_global_relay_cost": null
          },
          "sender": {
            "first_name": "Test",
            "last_name": "User",
            "email": "[email protected]"
          },
          "workspace_id": "a70d0225-d75f-4620-8467-25e7b7923e23",
          "workspace_name": "Test Team",
          "original_cart": null,
          "original_amounts": null,
          "reference_id": "KCRSFLWWCODWMXZCRPGCNXQZ",
          "payment_link": null
        },
        {
          "id": "ada453df-5e51-47fd-9e5e-7bcc594f8600",
          "status": "created",
          "individual_gift_link": "https://gifts.ongoody.com/gift/R2OIBM8I99CW983CRIB6VV9D",
          "recipient_first_name": "Michael",
          "recipient_last_name": "Franci",
          "recipient_email": "[email protected]",
          "card_id": "733d2231-1026-41dc-a830-305e7f4464d2",
          "message": "Test Message",
          "thank_you_note": null,
          "view_count_recipient": 0,
          "is_swapped": false,
          "order_batch_id": "60f1e518-3ab3-4388-ac9f-366be13f977a",
          "expires_at": null,
          "cart": {
            "id": "6dc52b7c-c69d-4628-b338-83f90ab869a6",
            "items": [
              {
                "id": "0571a053-0287-4584-9362-57a3e347d18d",
                "quantity": 1,
                "product": {
                  "id": "a5645f2c-1dea-489d-b14f-149a9edebde8",
                  "name": "Cookies",
                  "brand": {
                    "id": "20d7df1f-125c-45c5-ab74-6de4c74f5d9e",
                    "name": "Cookie Company"
                  }
                }
              }
            ]
          },
          "shipments": [],
          "amounts": {
            "amount_product": 2000,
            "amount_shipping": 500,
            "amount_processing_fee": 0,
            "amount_pre_tax_total": 2500,
            "amount_tax": null,
            "amount_total": null,
            "amount_global_relay_cost": null
          },
          "sender": {
            "first_name": "Test",
            "last_name": "User",
            "email": "[email protected]"
          },
          "workspace_id": "a70d0225-d75f-4620-8467-25e7b7923e23",
          "workspace_name": "Test Team",
          "original_cart": null,
          "original_amounts": null,
          "reference_id": "7IDP80VTVNB3DFWUNRBPACZU",
          "payment_link": null
        }
      ],
      "recipients_count": 2,
      "recipients_preview": [
        {
          "first_name": "Alena",
          "last_name": "Kenter",
          "email": "[email protected]"
        },
        {
          "first_name": "Michael",
          "last_name": "Franci",
          "email": "[email protected]"
        }
      ],
      "cart": {
        "id": "6dc52b7c-c69d-4628-b338-83f90ab869a6",
        "items": [
          {
            "id": "0571a053-0287-4584-9362-57a3e347d18d",
            "quantity": 1,
            "product": {
              "id": "a5645f2c-1dea-489d-b14f-149a9edebde8",
              "name": "Cookies",
              "brand": {
                "id": "20d7df1f-125c-45c5-ab74-6de4c74f5d9e",
                "name": "Cookie Company"
              }
            }
          }
        ]
      },
      "is_scheduled_send": false,
      "scheduled_send_on": null,
      "expires_at": null,
      "send_method": null,
      "batch_name": "Thank You from Barrows Inc",
      "card_id": "733d2231-1026-41dc-a830-305e7f4464d2",
      "sender": {
        "first_name": "Test",
        "last_name": "User",
        "email": "[email protected]"
      },
      "workspace_id": "a70d0225-d75f-4620-8467-25e7b7923e23",
      "workspace_name": "Test Team",
      "reference_id": "XXROJBTWMAYQS4RCEKI6VG4N"
    }
  ],
  "list_meta": {
    "total_count": 2
  }
}

Order Batches

Orders

Products

Payment Methods

Commerce User Payment Methods

Workspaces

Cards

Collections

Me

Schemas

List all order batches

Authorizations

Query Parameters

Response