Retrieve orders for an order batch

GET

order_batches

{id}

orders

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

{
  "data": [
    {
      "id": "45cc590e-f3a1-4159-bf3a-75b5069014dd",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/FDDAQEY7N0O6WY9Z5PPXU4IY",
      "recipient_first_name": "Alena",
      "recipient_last_name": "Kenter",
      "recipient_email": "[email protected]",
      "card_id": "74b67d4d-ec46-4f3e-b682-9f1e0dfa3617",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "74b152ce-189a-4c76-8933-ee5446fbccbb",
      "expires_at": null,
      "cart": {
        "id": "4325520a-692c-42c3-a9cb-6efd53acace2",
        "items": [
          {
            "id": "53d648c1-f04f-4cf5-b4b2-7b12cae5b22f",
            "quantity": 1,
            "product": {
              "id": "eaf264ab-c962-4371-9f61-5201d329d597",
              "name": "Cookies",
              "brand": {
                "id": "3d3f2041-1af8-4288-9100-59b97059b1ee",
                "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": "3f23b0ae-a9f7-4a2b-8994-78d32bd66bda",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "F55TTQD5CBI37KPC1ZI7S9EY",
      "payment_link": null
    },
    {
      "id": "fa525bd8-9883-435a-a80c-0ef812b8ff80",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/6OH2ICRYLPNDD8BBBDWDKVAA",
      "recipient_first_name": "Michael",
      "recipient_last_name": "Franci",
      "recipient_email": "[email protected]",
      "card_id": "74b67d4d-ec46-4f3e-b682-9f1e0dfa3617",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "74b152ce-189a-4c76-8933-ee5446fbccbb",
      "expires_at": null,
      "cart": {
        "id": "4325520a-692c-42c3-a9cb-6efd53acace2",
        "items": [
          {
            "id": "53d648c1-f04f-4cf5-b4b2-7b12cae5b22f",
            "quantity": 1,
            "product": {
              "id": "eaf264ab-c962-4371-9f61-5201d329d597",
              "name": "Cookies",
              "brand": {
                "id": "3d3f2041-1af8-4288-9100-59b97059b1ee",
                "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": "3f23b0ae-a9f7-4a2b-8994-78d32bd66bda",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "RGAGBWX8WWYNP0W1MMRJJTQO",
      "payment_link": null
    }
  ],
  "list_meta": {
    "total_count": 2
  }
}

Authorizations

Authorization

string

header

required

Your Goody API key.

Path Parameters

string

required

Order batch ID

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

Orders retrieved with pagination

data

object[]

Show child attributes

data.id

string<uuid>

required

data.recipient_first_name

string

required

data.status

enum<string>

required

Available options:

created,

notified,

opened,

accepted,

pending_payment,

paid,

ordered,

shipped,

delivered,

failed,

canceled

data.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.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.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.shipments

object[]

required

A list of the shipments for the order.

Show child attributes

data.shipments.id

string<uuid>

required

data.shipments.status

enum<string>

required

Available options:

pending,

tracking,

shipped,

delivered,

delivered_override,

failed,

failed_unset_tracking,

failed_with_reship

data.shipments.brand_name

string

required

The name of the brand that this shipment is from.

data.shipments.tracking_carrier

string | null

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

data.shipments.tracking_number

string | null

Only for approved distribution partners.

data.shipments.tracking_url

string | null

Only for approved distribution partners.

data.shipments.shipped_at

string<date-time> | null

ISO 8601

data.shipments.delivered_at

string<date-time> | null

ISO 8601

data.shipments.delivery_eta

string<date-time> | null

The estimated delivery time of this shipment.

data.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.amounts.amount_product

integer

required

Total cost of the products in this order.

data.amounts.amount_shipping

integer

required

Total cost of shipping for this order.

data.amounts.amount_pre_tax_total

integer

required

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

data.amounts.amount_processing_fee

integer | null

Total cost of processing fees for this order.

data.amounts.amount_credit_applied

integer | null

Total amount of credit applied to this order.

data.amounts.amount_tax

integer | null

Total tax for this order.

data.amounts.amount_total

integer | null

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

data.amounts.amount_global_relay_cost

integer | null

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

data.sender

object

required

The Goody user who sent this order.

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.

data.recipient_last_name

string | null

data.recipient_email

string | null

data.cart_selections

object[] | null

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

Show child attributes

data.cart_selections.id

string<uuid>

required

data.cart_selections.cart_item_id

string<uuid>

required

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

data.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.cart_selections.variants

string[]

required

The selected variants for this product selection and quantity index.

data.workspace_id

string<uuid> | null

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

data.workspace_name

string | null

data.expires_at

string<date-time> | null

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

data.card_id

string<uuid> | null

The digital greeting card on this gift.

data.message

string | null

The message in this gift, provided by the sender.

data.thank_you_note

string | null

A thank you note sent by the recipient.

data.view_count_recipient

integer

The number of times the recipient viewed the gift.

data.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.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.event_times

object

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

Show child attributes

data.event_times.created_at

string<date-time>

required

ISO 8601

data.event_times.notified_at

string<date-time> | null

When the recipient was notified of the order.

data.event_times.opened_at

string<date-time> | null

For gifts, when the recipient opened the order.

data.event_times.accepted_at

string<date-time> | null

For gifts, when the recipient accepted the order.

data.event_times.pending_payment_at

string<date-time> | null

When the order entered pending payment status.

data.event_times.paid_at

string<date-time> | null

When the order was paid for.

data.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.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.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.original_cart.id

string<uuid>

data.original_cart.items

object[]

Show child attributes

data.original_cart.items.id

string<uuid>

required

data.original_cart.items.product

object

required

Show child attributes

data.original_cart.items.product.id

string<uuid>

required

data.original_cart.items.product.name

string

required

data.original_cart.items.product.brand

object

required

The brand that this product is from.

Show child attributes

data.original_cart.items.product.brand.id

string<uuid>

required

data.original_cart.items.product.brand.name

string

required

data.original_cart.items.quantity

integer

required

data.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.original_amounts.original_amount_product

integer | null

data.original_amounts.original_amount_shipping

integer | null

data.original_amounts.original_amount_credit_applied

integer | null

data.original_amounts.original_amount_pre_tax_total

integer | null

data.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).

list_meta

object

Show child attributes

list_meta.total_count

integer

The total number of items in this list.

Retrieve recipients for an order batch

⌘I

Retrieve orders for an order batch

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

{
  "data": [
    {
      "id": "45cc590e-f3a1-4159-bf3a-75b5069014dd",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/FDDAQEY7N0O6WY9Z5PPXU4IY",
      "recipient_first_name": "Alena",
      "recipient_last_name": "Kenter",
      "recipient_email": "[email protected]",
      "card_id": "74b67d4d-ec46-4f3e-b682-9f1e0dfa3617",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "74b152ce-189a-4c76-8933-ee5446fbccbb",
      "expires_at": null,
      "cart": {
        "id": "4325520a-692c-42c3-a9cb-6efd53acace2",
        "items": [
          {
            "id": "53d648c1-f04f-4cf5-b4b2-7b12cae5b22f",
            "quantity": 1,
            "product": {
              "id": "eaf264ab-c962-4371-9f61-5201d329d597",
              "name": "Cookies",
              "brand": {
                "id": "3d3f2041-1af8-4288-9100-59b97059b1ee",
                "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": "3f23b0ae-a9f7-4a2b-8994-78d32bd66bda",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "F55TTQD5CBI37KPC1ZI7S9EY",
      "payment_link": null
    },
    {
      "id": "fa525bd8-9883-435a-a80c-0ef812b8ff80",
      "status": "created",
      "individual_gift_link": "https://gifts.ongoody.com/gift/6OH2ICRYLPNDD8BBBDWDKVAA",
      "recipient_first_name": "Michael",
      "recipient_last_name": "Franci",
      "recipient_email": "[email protected]",
      "card_id": "74b67d4d-ec46-4f3e-b682-9f1e0dfa3617",
      "message": "Test Message",
      "thank_you_note": null,
      "view_count_recipient": 0,
      "is_swapped": false,
      "order_batch_id": "74b152ce-189a-4c76-8933-ee5446fbccbb",
      "expires_at": null,
      "cart": {
        "id": "4325520a-692c-42c3-a9cb-6efd53acace2",
        "items": [
          {
            "id": "53d648c1-f04f-4cf5-b4b2-7b12cae5b22f",
            "quantity": 1,
            "product": {
              "id": "eaf264ab-c962-4371-9f61-5201d329d597",
              "name": "Cookies",
              "brand": {
                "id": "3d3f2041-1af8-4288-9100-59b97059b1ee",
                "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": "3f23b0ae-a9f7-4a2b-8994-78d32bd66bda",
      "workspace_name": "Test Team",
      "original_cart": null,
      "original_amounts": null,
      "reference_id": "RGAGBWX8WWYNP0W1MMRJJTQO",
      "payment_link": null
    }
  ],
  "list_meta": {
    "total_count": 2
  }
}

Order Batches

Orders

Products

Payment Methods

Commerce User Payment Methods

Workspaces

Cards

Collections

Me

Schemas

Retrieve orders for an order batch

Authorizations

Path Parameters

Query Parameters

Response