---
title: "Edit an order"
method: PATCH
path: "/orders/{order_id}"
tags: ["Orders"]
---

# Edit an order

`PATCH /orders/{order_id}`

Edit an existing order's information using the unique order ID

## Request body

- object
  - `customer_card_id` integer — Change the customer card that will be used for all charges for an order.
  - `email` string — Email address of the customer. This is what creates a unique customer ID. Note - if using the same email all orders will group to that customer. Only editable until the order is complete.
  - `first_name` string — Customer first name. If not passed, the bill_fname value will be used. Only editable until the order is complete.
  - `last_name` string — Customer last name. If not passed, the bill_lname value will be used. Only editable until the order is complete.
  - `phone` string — Customer telephone number. Only editable until the order is complete.
  - `customers_address_billing_id` integer — Change the customer billing address that will be used for an order.
  - `customers_address_shipping_id` integer — Change the customer shipping address that will be used for an order.
  - `bill_fname` string — Billing first name. Required when customers_address_billing_id is empty and passing any billing information for the order. Only editable until the order is complete.
  - `bill_lname` string — Billing last name. Required when customers_address_billing_id is empty and passing any billing information for the order. Only editable until the order is complete.
  - `bill_address1` string — Billing address line 1. Required when customers_address_billing_id is empty and passing any billing information for the order. Only editable until the order is complete.
  - `bill_address2` string — Billing address line 2. Only editable until the order is complete.
  - `bill_city` string — Billing city. Required when customers_address_billing_id is empty and passing any billing information for the order. Only editable until the order is complete.
  - `bill_country` string — Billing country code 2 letters (example : US). Required when customers_address_billing_id is empty and passing any billing information for the order. Only editable until the order is complete.
  - `bill_organization` string — Billing organization. Only editable until the order is complete.
  - `bill_state` string — Billing state. Required when customers_address_billing_id is empty and bill_county is US or CA and passing any billing information for the order. Only editable until the order is complete.
  - `bill_zipcode` string — Billing zipcode. Required when customers_address_billing_id is empty and passing any billing information for the order. Only editable until the order is complete.
  - `same_address` boolean — Pass as true to use the same address for billing and shipping. Only one of those is required in that case. Only editable until the order is complete.
  - `ship_fname` string — Shipping first name. Required when customers_address_shipping_id is empty and order has shippable items and passing any shipping information for the order. Only editable until the order is complete.
  - `ship_lname` string — Shipping last name. Required when customers_address_shipping_id is empty and order has shippable items and passing any shipping information for the order. Only editable until the order is complete.
  - `ship_address1` string — Shipping address line 1. Required when customers_address_shipping_id is empty and order has shippable items and passing any shipping information for the order. Only editable until the order is complete.
  - `ship_address2` string — Shipping address line 2. Only editable until the order is complete.
  - `ship_city` string — Shipping city. Required when customers_address_shipping_id is empty and order has shippable items and passing any shipping information for the order. Only editable until the order is complete.
  - `ship_country` string — Shipping country code, 2 letters (example : US). Required when customers_address_shipping_id is empty and order has shippable items and passing any shipping information for the order. Only editable until the order is complete.
  - `ship_organization` string — Shipping organization. Only editable until the order is complete.
  - `ship_state` string — Shipping state. Required when customers_address_shipping_id is empty and order has shippable items and ship_country is US or CA and passing any shipping information for the order. Only editable until the order is complete.
  - `ship_zipcode` string — Shipping zipcode. Required when customers_address_shipping_id is empty and order has shippable items and passing any shipping information for the order. Only editable until the order is complete.
  - `discount_code` string — Apply a discount code to the order. Only editable until the order is complete.
  - `shipping_profile_id` integer — Shipping profile to be used to determine shipping logic. Required if shipping profiles are setup on the campaign and there are shippable items on the order and passing any shipping information for the order. Only editable until the order is complete.
  - `order_discount` string — Apply a discount percentage to an order that will be used for all recurring charges.
  - `date_auto_capture` string, date-time — Auto capture date (2025-08-17 00:00:00) in EST.
  - `create_cart` boolean — Create and associate a cart, if none currently set.
  - `tracking1` string — Custom Tracking Variable Option 1
  - `tracking2` string — Custom Tracking Variable Option 2
  - `tracking3` string — Custom Tracking Variable Option 3
  - `tracking4` string — Custom Tracking Variable Option 4
  - `tracking5` string — Custom Tracking Variable Option 5
  - `tracking6` string — Custom Tracking Variable Option 6
  - `tracking7` string — Custom Tracking Variable Option 7
  - `tracking8` string — Custom Tracking Variable Option 8
  - `tracking9` string — Custom Tracking Variable Option 9
  - `tracking10` string — Custom Tracking Variable Option 10
  - `tracking11` string — Custom Tracking Variable Option 11
  - `tracking12` string — Custom Tracking Variable Option 12
  - `tracking13` string — Custom Tracking Variable Option 13
  - `tracking14` string — Custom Tracking Variable Option 14
  - `tracking15` string — Custom Tracking Variable Option 15
  - `tracking16` string — Custom Tracking Variable Option 16
  - `tracking17` string — Custom Tracking Variable Option 17
  - `tracking18` string — Custom Tracking Variable Option 18
  - `tracking19` string — Custom Tracking Variable Option 19
  - `tracking20` string — Custom Tracking Variable Option 20
  - `is_test` boolean — Flag an order as a Test Order. Orders will always be flagged as test when using a test credit card.
  - `order_notes` string — Apply note to the history of this order.

## Response `200`

OK

- object
  - `order_id` integer
  - `connection_order_id` string, nullable
  - `campaign_id` integer
  - `status_type_id` null | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10, nullable — * `1` - Active * `2` - Cancelled * `3` - Complete * `4` - Partial * `5` - Declined * `6` - Archive * `7` - Rejected * `8` - Removed * `9` - Paused * `10` - Expired
  - `customer_card_id` integer, nullable
  - `customer_id` integer
  - `customers_address_billing_id` integer, nullable
  - `customers_address_shipping_id` integer, nullable
  - `date_created` string, date-time, nullable
  - `date_modified` string, date-time, nullable
  - `date_authorized` string, date-time, nullable
  - `date_auto_capture` string, date-time, nullable
  - `date_ordered` string, date-time, nullable
  - `date_capture` string, date-time, nullable
  - `is_test` boolean
  - `ip_address` string, nullable
  - `order_discount` string
  - `order_pixel` boolean
  - `cart_token` string, nullable
  - `order_pixel_block` string, nullable
  - `order_notes` string, nullable
  - `created_by` integer
  - `modified_by` integer
  - `tracking1` string, nullable
  - `tracking2` string, nullable
  - `tracking3` string, nullable
  - `tracking4` string, nullable
  - `tracking5` string, nullable
  - `tracking6` string, nullable
  - `tracking7` string, nullable
  - `tracking8` string, nullable
  - `tracking9` string, nullable
  - `tracking10` string, nullable
  - `tracking11` string, nullable
  - `tracking12` string, nullable
  - `tracking13` string, nullable
  - `tracking14` string, nullable
  - `tracking15` string, nullable
  - `tracking16` string, nullable
  - `tracking17` string, nullable
  - `tracking18` string, nullable
  - `tracking19` string, nullable
  - `tracking20` string, nullable
  - `user_agent` string, nullable
  - `cart` object, nullable
    - `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_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[]
              - …
          - `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_variations` 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_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[]
              - …
          - `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_variations` object[]
              - …
          - `connection` object, nullable
            - `connection_id` integer
            - `connection_name` string
        - `terms` object
          - `optional` string[]
  - `order_offers` object[]
    - `order_offer_id` integer
    - `connection_order_offer_id` string, nullable
    - `status_type_id` null | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10, nullable — * `1` - Active * `2` - Cancelled * `3` - Complete * `4` - Partial * `5` - Declined * `6` - Archive * `7` - Rejected * `8` - Removed * `9` - Paused * `10` - Expired
    - `linked_status_type_id` null | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10, nullable — * `1` - Active * `2` - Cancelled * `3` - Complete * `4` - Partial * `5` - Declined * `6` - Archive * `7` - Rejected * `8` - Removed * `9` - Paused * `10` - Expired
    - `date_cancel` string, date-time, nullable
    - `date_created` string, date-time, nullable
    - `date_modified` string, date-time, nullable
    - `date_ordered` string, date-time, nullable
    - `date_reactivate` string, date-time, nullable
    - `date_pause` string, date-time, nullable
    - `date_unpause` string, date-time, nullable
    - `is_gift` boolean
    - `is_recurring` boolean
    - `is_test` boolean
    - `offer_id` integer
    - `offer_name` string
    - `order_id` integer
    - `order_offer_price` string
    - `order_offer_quantity` integer
    - `cancel_type_id` integer, nullable
    - `cancel_by` integer, nullable
    - `discount_id` integer, nullable
    - `order_offer_upsell` boolean
    - `parent_order_offer_id` integer, nullable
    - `charge_timeframe_id` integer, nullable
    - `charge_timeframe_name` string, nullable
    - `offer_cycle_multiple_shipments_count` integer
    - `fulfillment_delay_timeframe_id` integer, nullable
    - `total_shipments_count` integer
    - `shipped_shipments_count` integer
    - `current_shipment_prepaid_cycle` integer, nullable
    - `current_shipment_id` integer, nullable
    - `connection_status_type_name` string
    - `last_recurring_date` string, date-time, nullable
    - `last_recurring_amount` string
    - `next_recurring_date` string, date-time, nullable
    - `next_recurring_amount` string
    - `next_recurring_price` string
    - `next_recurring_charge` integer, nullable
    - `next_recurring_last_four` string, nullable
    - `extra_fields` string, nullable
    - `order_offer_notes` string, nullable
    - `order_offer_shipments` object[]
      - `shipment_id` integer
      - `connection_shipment_id` string, nullable
      - `customer_id` integer
      - `order_id` integer
      - `shipment_prepaid_cycle` integer
      - `shipment_status_id` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 — * `1` - Pending Post * `2` - Pending Tracking * `3` - Cancelled * `4` - Shipped * `5` - Error * `6` - Delivered * `7` - Declined * `8` - Pending Transaction * `9` - Skipped
      - `transaction_charge_id` integer
      - `connection_id` integer, nullable
      - `fulfillment_id` string, nullable
      - `shipment_tracking_id` string, nullable
      - `carrier_id` null | 1 | 2 | 3 | 4 | 5 | 6 | 8 | 9, nullable — * `1` - USPS * `2` - UPS * `3` - FedEx * `4` - DHL eCommerce * `5` - UPS Mail Innovations * `6` - Canada Post * `8` - Australia Post * `9` - Hermes
      - `shipping_profile_id` integer, nullable
      - `date_cancel` string, date-time, nullable
      - `date_scheduled` string, date-time
      - `date_complete` string, date-time, nullable
      - `date_scan` string, date-time, nullable
      - `date_deliver` string, date-time, nullable
      - `date_return` string, date-time, nullable
      - `date_skip` string, date-time, nullable
      - `date_rma` string, date-time, nullable
      - `shipment_rma` string, nullable
      - `cancel_type_id` integer, nullable
      - `skip_type_id` integer, nullable
      - `shipping_reship_type_id` null | 1 | 2 | 3 | 4, nullable — * `1` - Did not receive package * `2` - Damaged Items * `3` - Items Incorrect * `4` - Quantity Incorrect
      - `shipment_parent_type_id` null | 1 | 2 | 3 | 4, nullable — * `1` - Reship * `2` - Reward * `3` - Gift * `4` - Free
      - `date_created` string, date-time
      - `created_by` integer
      - `date_modified` string, date-time
      - `modified_by` integer
      - `shipment_notes` string, nullable
      - `connection_request_text` string, nullable
      - `connection_response_text` string, nullable
      - `shipment_items` object[]
        - `shipment_item_id` integer
        - `quantity` integer
        - `item_id` integer
        - `item_name` string
        - `item_description` string, nullable
        - `item_additional_description` string, nullable
        - `item_image` string, nullable
        - `shipment_item_sku` string, nullable
        - `items_option_variation_id` integer, nullable
    - `order_offer_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
    - `order_offer_gifts` object[]
      - `order_offer_id` integer
      - `gift_card_code` string, nullable
      - `gift_name` string, nullable
      - `gift_message` string, nullable
      - `gift_email` string, nullable
      - `gift_phone` string, nullable
      - `gift_date` string, date-time, nullable
      - `gift_date_sent` string, date-time, nullable
      - `gift_status` string
  - `customer_card` object, nullable
    - `customer_card_id` integer
    - `card_type_id` null | 1 | 2 | 3 | 4 | 5 | 6 | 7, nullable — * `1` - Mastercard * `2` - Visa * `3` - Discover * `4` - American Express * `5` - Digital Wallet * `6` - ACH * `7` - SEPA
    - `card_number` string
    - `card_exp_month` integer
    - `card_exp_year` integer
    - `card_prepaid` boolean
    - `date_created` string, date-time
    - `date_modified` string, date-time
    - `created_by` integer
    - `modified_by` integer

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