---
title: "GET /upsells/{id}/orders"
method: GET
path: "/upsells/{id}/orders"
tags: ["Upsells"]
---

# GET /upsells/{id}/orders

`GET /upsells/{id}/orders`

Retrieve all orders associated with a specific upsell

## Path parameters

- `id` integer, required

## Query parameters

- `created_at_min` string, date-time
- `created_at_max` string, date-time
- `test_mode` boolean
- `offset` integer
- `limit` integer
- `dir` 'next' | 'prev'

## Response `200`

Successful operation. Response will return an array of 0 or more orders

- object
  - `data` OrderService[]
    - `id` integer — The SamCart ID of the order
    - `customer_id` integer — The SamCart ID of the customer
    - `affiliate_id` integer, nullable — The SamCart ID of the affiliate credited for the order
    - `funnel_id` integer, nullable — The funnel ID associated with this order. Null if the order was not placed through a funnel.
    - `upsell_id` integer, nullable — The upsell ID if this order contains upsell purchases. Null if the order has no upsell items. For orders with multiple upsells, returns the first upsell ID.
    - `test_mode` boolean — Indicates whether the transaction was done while the product was in test mode
    - `order_date` string, date-time — The UTC date and time for when the order was created
    - `cart_items` object[] — A list of cart items on the order
      - `id` integer — The ID for the specific cart item
      - `product_id` integer — The SamCart ID for the product
      - `subscription_id` integer, nullable — The subscription ID for the product. If the cart item is for a non-subscription product the value will be null
      - `upsell_id` integer, nullable — The SamCart ID for the upsell. If the cart item is not from an upsell the value will be null
      - `sku` string, nullable — The optional product SKU of the cart item purchased
      - `internal_product_name` string, nullable — An optional product name displayed on the marketplace dashboard
      - `product_name` string, nullable — The product name displayed to customers
      - `charge_id` integer, nullable — The SamCart ID for the charge
      - `pricing_type` 'one_time' | 'recurring_subscription' | 'limited_subscription' | 'pwyw_onetime' | 'pwyw_recurring_subscription' | 'pwyw_limited_subscription', nullable — Indicates how the product is priced
      - `processor_transaction_id` string, nullable — The processor ID generated for the charge
      - `currency` string — The 3 letter identifier for the currency for the charge on the cart item
      - `quantity` integer — The quantity of the cart item purchased
      - `status` 'pending' | 'charged' | 'declined' | 'refunded' | 'fulfilled' | 'reversed' | 'partially_refunded' — The current status of the charge on the cart item
      - `upgraded` boolean — Indicates if the item was upgraded to another item in the cart
      - `initial_price` object — The pricing structure for one-time purchases and for the first charge on subscription products
        - `subtotal` integer — The price for the cart item (in cents) excluding discount, taxes and shipping fees
        - `taxes` integer — The tax fees (in cents) for the cart item
        - `shipping` integer — The shipping fees (in cents) for the cart item
        - `total` integer — The price for the cart item (in cents) including discount, taxes and shipping fees
      - `recurring_price` object — The pricing structure for limited and recurring subscription products. This structure could differ from the initial price.
        - `subtotal` integer — The recurring price for the cart item (in cents) excluding discount, taxes and shipping fees
        - `taxes` integer — The recurring tax fees (in cents) for the cart item
        - `shipping` integer — The recurring shipping fees (in cents) for the cart item
        - `total` integer — The recurring price for the cart item (in cents) including discount, taxes and shipping fees
      - `coupon` object — An optional coupon that was applied to the cart item
        - `id` integer — The ID of the coupon that was used on the cart item
        - `charge_instance` 'one_time' | 'recurring' — Whether the coupon applies only once or for recurring charges also
        - `code` string — The code of the coupon used
        - `type` 'flat_rate' | 'percentage' — The type of discount applied
        - `discount_amount` integer, nullable — The flat_rate discount amount (in cents) on the cart item
        - `discount_percentage` integer, nullable — The percentage discount on the cart item
    - `subtotal` integer — The total price of the order (in cents) excluding discount, shipping and tax fees
    - `discount` integer — The total discount (in cents) on the order
    - `taxes` integer — The total of tax fees (in cents) of the order
    - `shipping` integer — The total of shipping fees (in cents) of the order
    - `shipping_address` AddressService — Address
      - `type` 'shipping' | 'billing' — The type of address for the customer
      - `street` string — The street for the customer
      - `postal_code` string — The postal code for the customer
      - `city` string — The city name for the customer
      - `state` string, nullable — The 2-letter state code for US customers. For non-US addresses this value will be null.
      - `region` string, nullable — The optional sub-divided area of a country for international customers. For US addresses this value will be null.
      - `country` string — The country for the customer
    - `total` integer — The total price of the order (in cents) including discount, shipping and tax fees
    - `card_used` string, nullable — The last 4 digits of the card that was used. PayPal charges will have a null value.
    - `processor_name` 'Stripe' | 'Braintree' | 'Authorize.net' | 'PayPal' — The name of the processor for the order
    - `custom_fields` object — Optional custom fields applied to the order
      - `Name` object — This will return the name given to this custom field
        - `value` string — The value of this custom field
        - `slug` string — The slug associated with this custom field
    - `upsell_custom_fields` object — Optional custom fields applied to the upsells for the order
    - `utm_parameters` object — UTM Parameters
      - `medium` string — UTM Medium
      - `source` string — UTM Source
      - `campaign` string — UTM Campaign
      - `content` string — UTM Content
      - `lead_source` string — UTM Lead Source
    - `custom_parameters` object — Custom Parameters
      - `key` string — Custom Paramater Key
  - `pagination` Pagination — Optional information for paginating large data sets.
    - `next` string, uri, nullable — A URL to the next page of data to be retrieve. If current page is the last page this value will be null.
    - `prev` string, uri, nullable — A URL to the previous page of data to be retrieve. If current page is the first page this value will be null.

## Other responses

- `400` — Bad request. Validation error on provided parameters
- `404` — Upsell could not be found

---

[API](https://skmtc.dev/samcart/apis/samcart-public-api.md) · [All operations](https://skmtc.dev/samcart/apis/samcart-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/samcart/samcart-public-api/revisions/80296f7a00d0/schema)