---
title: "Get order upsells"
method: GET
path: "/orders/{order_id}/upsells"
tags: ["Orders"]
---

# Get order upsells

`GET /orders/{order_id}/upsells`

Get upsells available for an order.

## Query parameters

- `upsell_type` 'in_cart' | 'post_cart'
- `exclude` boolean

## Response `200`

OK

- object
  - `total` integer
  - `upsells` object[]
    - `offer_id` integer
    - `offer_type_id` 1 | 2 — * `1` - One Time Sale * `2` - Recurring
    - `offer_name` string
    - `offer_image` string, nullable
    - `offer_upsell_title` string, nullable
    - `offer_upsell_description` string, nullable
    - `offer_url` string, nullable
    - `parent_offer_id` integer
    - `parent_order_offer_id` integer
    - `offer_price` string
    - `subtotal` string
    - `total` string
    - `discount_label` string, nullable
    - `offer_options` object[]
      - `item_option_id` integer
      - `item_option_name` string
      - `item_option_values` object[]
        - `item_option_value_id` integer
        - `item_option_value_name` string
    - `restricted_quantities` object[]
      - `quantity` integer
      - `label` string
    - `items` object[]
      - `item_id` integer
      - `item_name` string
      - `item_category_id` integer, nullable
      - `item_description` string, nullable
      - `item_image` string, nullable
      - `item_active` boolean
      - `item_price` string, nullable
      - `item_msrp` string, nullable
      - `item_cost` string, nullable
      - `item_shippable` boolean
      - `item_sku` string, nullable
      - `item_weight` string, nullable
      - `item_upc` string, nullable
      - `item_slug` string, nullable
      - `item_quantity` integer
      - `connection_id` integer, nullable
      - `out_of_stock_block` boolean
      - `item_turnaround_time` integer
      - `item_additional_description` string, nullable
      - `item_ingredients` string, nullable
      - `item_video` string, nullable
      - `item_sales_page` string, nullable
      - `item_perishable` boolean
      - `item_tax_code` string, nullable
      - `item_additional_details_1` string, nullable
      - `item_additional_details_2` string, nullable
      - `item_additional_details_3` string, nullable
      - `item_additional_details_4` string, nullable
      - `item_additional_details_5` string, nullable
      - `date_created` string, date-time
      - `created_by` integer
      - `date_modified` string, date-time
      - `modified_by` integer
      - `item_notes` string, nullable
      - `item_options` object[], nullable
        - `item_option_id` integer
        - `item_option_name` string
        - `item_option_values` object[]
          - `item_option_value_id` integer
          - `item_option_value_name` string
      - `item_option_variations` object[], nullable
        - `items_option_variation_id` integer
        - `items_option_variation_key` string
        - `items_option_variation_name` string
        - `items_option_variation_quantity` integer
        - `items_option_variation_sku` string, nullable
        - `items_option_variation_price` string
        - `items_option_variation_msrp` string
        - `items_option_variation_cost` string, nullable
        - `items_option_variation_weight` string, nullable
        - `items_option_variation_upc` string, nullable
        - `items_option_variation_image` string, nullable
        - `items_option_variation_images` object[]
          - `image_id` integer
          - `image_url` string
      - `item_images` object[], nullable
        - `image_id` integer
        - `image_url` string
      - `item_tags` object[], nullable
        - `tag_id` integer
        - `tag_name` string
        - `tag_slug` string
        - `tag_image` string, nullable
      - `item_swap_options` object[], nullable
        - `swap_item_id` integer
        - `swap_item_name` string
        - `swap_item_image` string, nullable
        - `swap_item_type_id` integer
        - `swap_item_description` string, nullable
        - `item_options` object[]
          - `item_option_id` integer
          - `item_option_name` string
          - `item_option_values` object[]
            - `item_option_value_id` integer
            - `item_option_value_name` string
        - `item_option_variations` object[]
          - `items_option_variation_id` integer
          - `items_option_variation_key` string
          - `items_option_variation_name` string
          - `items_option_variation_quantity` integer
          - `items_option_variation_sku` string, nullable
          - `items_option_variation_price` string
          - `items_option_variation_msrp` string
          - `items_option_variation_cost` string, nullable
          - `items_option_variation_weight` string, nullable
          - `items_option_variation_upc` string, nullable
          - `items_option_variation_image` string, nullable
          - `items_option_variation_images` object[]
            - `image_id` integer
            - `image_url` string
      - `connection` object, nullable
        - `connection_id` integer
        - `connection_name` string
    - `terms` object
      - `optional` string[]
  - `order` object, nullable
    - `order_id` integer
    - `customer_card_id` integer, nullable
    - `shipping_profile_id` integer, nullable
    - `payment_method_id` integer, nullable

## Other responses

- `400` — Error response
- `401` — Unauthorized response
- `403` — Forbidden response
- `500` — Error response

---

[API](https://skmtc.net/vrio/apis/crm-configuration.md) · [All operations](https://skmtc.net/vrio/apis/crm-configuration/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vrio/crm-configuration/revisions/62037010356e/schema)