---
title: "Preview a cart"
method: GET
path: "/carts/{cart_token}/preview"
tags: ["Carts"]
---

# Preview a cart

`GET /carts/{cart_token}/preview`

Preview a cart by token. This allows you to pass a zipcode, state, country, and shipping profile ID to get shipping profiles and tax/shipping price without editing yet.

## Query parameters

- `ship_zipcode` string
- `ship_state` string
- `ship_country` string
- `shipping_profile_id` string

## Response `200`

OK

- object
  - `cart_token` string
  - `editable` boolean
  - `checkout_url` string, nullable
  - `total_items` string — Total for items with discount
  - `total_offer_shipping` string — Total offer level shipping with shipping
  - `total_campaign_shipping` string — Total campaign level shipping with shipping discount
  - `total_shipping` string — Total shipping including discount
  - `total_offer_shipping_discount` string — Total offer shipping discount
  - `total_campaign_shipping_discount` string — Total campaign shipping discount
  - `total_shipping_discount` string — Total shipping discount
  - `total_tax` string
  - `total_discount` string
  - `total_gift_cards` string
  - `subtotal_items` string — Total for items pre discount
  - `subtotal_offer_shipping` string — Total offer level shipping pre shipping discount
  - `subtotal_campaign_shipping` string — Total campaign level shipping pre shipping discount
  - `subtotal_shipping` string — Total shipping pre shipping discount
  - `subtotal` string — Order total pre tax
  - `total` string — Order Total with tax
  - `discount_label` string, nullable
  - `currency_label` string
  - `currency_value` string
  - `campaign` object
    - `connection_id` integer
    - `campaign_id` integer
    - `countries_with_states` object[]
      - `code` string
      - `name` string
      - `states` object[]
        - `code` string
        - `name` string
    - `campaign_storefront_url` string, nullable
    - `campaign_cart_url` string, nullable
    - `campaign_checkout_confirm_url` string, nullable
    - `campaign_company_name` string, nullable
    - `campaign_logo_primary` string, nullable
    - `campaign_logo_secondary` string, nullable
    - `campaign_logo_icon` string, nullable
    - `campaign_checkout_title` string, nullable
    - `campaign_checkout_privacy_policy_url` string, nullable
    - `campaign_checkout_contact_url` string, nullable
    - `campaign_checkout_opt_in_text` string, nullable
    - `campaign_auto_check_terms` boolean
    - `campaign_checkout_terms_url` string, nullable
    - `campaign_phone_required` boolean
    - `campaign_checkout_mobile_cart_display` boolean
    - `campaign_primary_font` string, nullable
    - `campaign_primary_font_color` string, nullable
    - `campaign_secondary_font` string, nullable
    - `campaign_secondary_font_color` string, nullable
    - `campaign_primary_color` string, nullable
    - `campaign_secondary_color` string, nullable
    - `campaign_checkout_header_color` string, nullable
    - `campaign_checkout_footer_color` string, nullable
    - `campaign_checkout_google_tag_manager` string, nullable
    - `campaign_checkout_type_id` integer, nullable
    - `campaign_checkout_style` string, nullable
    - `campaign_checkout_upsell` object, nullable
      - `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_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[]
              - …
        - `connection` object, nullable
          - `connection_id` integer
          - `connection_name` string
      - `terms` object
        - `optional` string[]
    - `campaign_auto_capture_trigger_id` integer, nullable
    - `terms` object
      - `optional` string[]
    - `payment_method_ids` integer[]
    - `card_type_ids` integer[]
    - `merchants` object
      - `stripe` object[]
        - `merchant_id` integer
        - `gateway_id` integer
        - `gateway_variable_2` string, nullable
        - `gateway_variable_4` string, nullable
        - `gateway_variable_5` string, nullable
        - `client_token` string, nullable
        - `payment_method_id` integer
      - `braintree` object[]
        - `merchant_id` integer
        - `gateway_id` integer
        - `gateway_variable_2` string, nullable
        - `gateway_variable_4` string, nullable
        - `gateway_variable_5` string, nullable
        - `client_token` string, nullable
        - `payment_method_id` integer
      - `other` object[]
        - `merchant_id` integer
        - `gateway_id` integer
        - `gateway_variable_2` string, nullable
        - `gateway_variable_4` string, nullable
        - `gateway_variable_5` string, nullable
        - `client_token` string, nullable
        - `payment_method_id` integer
  - `order` object
    - `order_id` integer, nullable
    - `date_authorized` string, date-time, nullable
    - `date_ordered` string, date-time, nullable
    - `default_shipping_country` string, nullable
    - `default_shipping_profile_id` integer, nullable
    - `customers_address_billing_id` integer, nullable
    - `customers_address_shipping_id` integer, nullable
    - `customer_card_id` integer, nullable
    - `shipping_profile_id` integer, nullable
    - `discount_code` string, nullable
    - `gift_cards` object[]
      - `gift_card_code` string
    - `referral_token` string, nullable
    - `is_recurring` boolean
    - `shipping_information_required` boolean
    - `shipping_profile_required` boolean
    - `shipping_profiles` object[]
      - `shipping_profile_id` integer
      - `shipping_profile_name` string
      - `shipping_profile_description` string
      - `shipping_profile_price` string
      - `carrier_name` string
    - `tracking9` string, nullable
    - `tracking10` string, nullable
    - `order_pixel_block` string, nullable
    - `transaction_id` integer, nullable
    - `gateway_transaction_id` string, nullable
    - `auto_capture_trigger_id` integer, nullable
  - `customer` object, nullable
    - `customer_id` integer
    - `email` string
    - `phone` string
    - `first_name` string
    - `last_name` string
    - `optout` boolean
    - `same_address` boolean
    - `bill_fname` string
    - `bill_lname` string
    - `bill_organization` string
    - `bill_address1` string
    - `bill_address2` string
    - `bill_zipcode` string
    - `bill_city` string
    - `bill_state` string
    - `bill_country` string
    - `ship_fname` string
    - `ship_lname` string
    - `ship_organization` string
    - `ship_address1` string
    - `ship_address2` string
    - `ship_zipcode` string
    - `ship_city` string
    - `ship_state` string
    - `ship_country` string
  - `offers` object[]
    - `id` string
    - `order_offer_id` integer, nullable
    - `campaign_item_id` integer, nullable
    - `offer_id` integer
    - `offer_name` string
    - `offer_title` string, nullable
    - `formatted_name` string
    - `item_id` integer, nullable
    - `item_name` string
    - `item_slug` string, nullable
    - `items_option_variation_name` string, nullable
    - `item_image` string, nullable
    - `item_price` string
    - `order_offer_price` string, nullable
    - `item_description` string, nullable
    - `item_category_id` integer, nullable
    - `item_category_name` string, nullable
    - `order_offer_quantity` integer
    - `order_offer_item_options` object[]
      - `item_option_id` integer — The option to be applied to the item.
      - `item_option_name` string
      - `item_option_value_id` integer — The value to be used for the item option ID passed.
      - `item_option_value_name` string
    - `override_initial_item_id` integer, nullable
    - `override_initial_item_name` string, nullable
    - `override_initial_item_slug` string, nullable
    - `override_initial_item_image` string, nullable
    - `override_initial_item_option_variation_name` string, nullable
    - `override_initial_item_options` object[]
      - `item_option_id` integer — The option to be applied to the item.
      - `item_option_name` string
      - `item_option_value_id` integer — The value to be used for the item option ID passed.
      - `item_option_value_name` string
    - `is_gift` boolean
    - `gift_message` string, nullable
    - `gift_name` string, nullable
    - `gift_email` string, nullable
    - `gift_phone` string, nullable
    - `gift_date` string, date-time, nullable
    - `discount_code` string, nullable
    - `discount_label` string, nullable
    - `discount` string
    - `shipping_discount` string
    - `subtotal_shipping` string — Offer level shipping cost pre shipping discount
    - `shipping` string — Offer level shipping cost with shipping discount
    - `subtotal_offer` string — Offer total pre discount
    - `total_offer` string — Offer total
    - `subtotal` string — Offer total with shipping pre discount
    - `total` string — Offer total with shipping and discount
    - `order_offer_upsell` boolean
    - `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_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[]
              - …
        - `connection` object, nullable
          - `connection_id` integer
          - `connection_name` string
      - `terms` object
        - `optional` string[]

## Other responses

- `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/versions/62037010356e/schema)