---
title: "Update an order offer"
method: PATCH
path: "/order_offers/{order_offer_id}"
tags: ["Order Offers"]
---

# Update an order offer

`PATCH /order_offers/{order_offer_id}`

 

## Request body

- object
  - `status_type_id` 4 | 7 | 8 | 10, required — Available options : * `4` - Partial * `7` - Rejected * `8` - Removed *`10` - Expired
  - `order_offer_notes` string — Apply note to the history of this order offer.

## Response `200`

OK

- 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
    - `customer_address_billing` object
      - `customer_address_id` integer
      - `fname` string
      - `lname` string
      - `organization` string
      - `address1` string
      - `address2` string
      - `city` string
      - `country` string
      - `state` string
      - `zipcode` string
      - `address_valid` boolean
      - `date_created` string, date-time
      - `date_modified` string, date-time
      - `created_by` integer
      - `modified_by` integer
    - `customer_address_shipping` object
      - `customer_address_id` integer
      - `fname` string
      - `lname` string
      - `organization` string
      - `address1` string
      - `address2` string
      - `city` string
      - `country` string
      - `state` string
      - `zipcode` string
      - `address_valid` boolean
      - `date_created` string, date-time
      - `date_modified` string, date-time
      - `created_by` integer
      - `modified_by` integer
    - `campaign` object
      - `campaign_id` integer
      - `campaign_name` string
    - `connection` object, nullable
      - `connection_id` integer
      - `connection_name` string
    - `tracking_history` object[]
      - `tracking_history_id` integer
      - `carrier_id` integer, nullable
      - `date` string, date-time, nullable
      - `category_id` integer, nullable
      - `category_name` string, nullable
      - `status_id` integer, nullable
      - `status_text` string, nullable
    - `actions` object
      - `can_change_address` boolean
      - `can_process` boolean
      - `can_reschedule` boolean
      - `can_rma` boolean
      - `can_skip` boolean
      - `can_swap` boolean
      - `can_unskip` boolean
  - `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
    - `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
  - `discount` object
    - `discount_id` integer
    - `discount_name` string
    - `discount_type_id` 1 | 2 — * `1` - One Time Code * `2` - Recurring Code
    - `discount_application_type_id` 1 | 2 — * `1` - Offer Level * `2` - Cart Level
    - `shipping_only` boolean
    - `discount_category_id` integer, nullable
    - `discount_code` string
    - `discount_description` string, nullable
    - `discount_active` boolean
    - `discount_expiration_date` string, date-time, nullable
    - `discount_one_per_customer` boolean
    - `discount_notes` string, nullable
    - `discount_cycles` object[]
      - `discount_cycle_id` integer
      - `discount_cycle_weight` integer
      - `discount_cycle_type_id` 1 | 2 — * `1` - Percentage * `2` - Flat Rate
      - `discount_cycle_percentage` integer
      - `discount_cycle_flat_rate` string
      - `discount_cycle_final` boolean
      - `discount_cycle_active` boolean
    - `discount_offers` object[]
      - `offer_id` integer
      - `offer_name` string
      - `offer_title` string, nullable
      - `offer_code` string, nullable
      - `primary_offer_category_id` integer, nullable
      - `secondary_offer_category_id` integer, nullable
      - `offer_type_id` 1 | 2 — * `1` - One Time Sale * `2` - Recurring
      - `offer_configuration` string, nullable
      - `offer_price` string — Returns the price for the initial cycle of the offer. If null, then the offer has multiple items associated with it, to get full pricing for the offer, pass “with=offer_cycles”
      - `offer_description` string, nullable
      - `offer_global` boolean
      - `offer_url` string, nullable
      - `initial_item_id` integer, nullable
      - `offer_notes` string, nullable
      - `offer_active` boolean
      - `date_created` string, date-time
      - `created_by` integer
      - `date_modified` string, date-time
      - `modified_by` integer
      - `initial_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
      - `offer_cycles` object[]
        - `offer_cycle_id` integer
        - `offer_cycle_weight` integer
        - `offer_cycle_product_type_id` 1 | 2 | 3 | 4 | 5 | 6 — * `1` - Item Bundle * `2` - Item * `3` - Reward * `4` - Gift Card * `5` - Dynamic Item * `6` - Other (Used for Digital or Charge Only)
        - `item_bundle_id` integer, nullable
        - `item_id` integer, nullable
        - `offer_cycle_price` string
        - `offer_cycle_length` integer, nullable
        - `charge_timeframe_id` integer, nullable
        - `offer_cycle_trigger_type_id` null | 1 | 2, nullable — * `1` - Time of Charge * `2` - Delivered Package
        - `offer_cycle_trigger_hour` integer
        - `offer_cycle_multiple_shipments` boolean
        - `offer_cycle_multiple_shipments_count` integer
        - `offer_cycle_multiple_shipments_interval` integer
        - `fulfillment_delay` integer
        - `fulfillment_delay_timeframe_disable` boolean
        - `offer_cycle_reward_type_id` null | 1 | 2 | 3, nullable — * `1` - Flate Rate * `2` - Order Percentage * `3` - Flat Rate / Order Percentage
        - `offer_cycle_reward_flat_rate` string
        - `offer_cycle_reward_percentage` integer
        - `offer_cycle_reward_expiration` integer
        - `offer_cycle_gift_card_total` string
        - `offer_cycle_gift_card_expiration` integer
        - `offer_cycle_final` boolean
        - `offer_cycle_active` boolean
        - `quantity_discount_id` integer, nullable
        - `offer_cycle_price_minimum` string
        - `discount_calculation_total` boolean
        - `offer_cycle_shipping_price` string
        - `offer_cycle_shipment_skippable` boolean
        - `charge_responder_id_bypass` boolean
        - `offer_cycle_deliver_extend_value` integer
        - `offer_cycle_skippable` boolean
        - `offer_cycle_trial` boolean
        - `offer_cycle_auth_next_charge` boolean
        - `date_created` string, date-time
        - `created_by` integer
        - `date_modified` string, date-time
        - `modified_by` integer
        - `offer_cycle_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
          - `offer_cycle_item_variation_prices` object[]
            - `items_option_variation_id` integer
            - `items_option_variation_name` string
            - `items_option_variation_sku` string, nullable
            - `price` string, nullable
        - `quantity_discount_configs` object[]
          - `quantity_discount_cycle_id` integer
          - `quantity_discount_cycle_type_id` 1 | 2 — * `1` - Percentage * `2` - Flat Rate
          - `quantity_discount_cycle_weight` integer
          - `quantity_discount_cycle_percentage` string, nullable
          - `quantity_discount_cycle_flat_rate` string, nullable
          - `quantity_discount_cycle_name` string, nullable
          - `quantity_discount_cycle_active` boolean
        - `charge_timeframe` object, nullable
          - `timeframe_id` integer
          - `timeframe_name` string
          - `timeframe_frequency` boolean
          - `date_created` string, date-time, nullable
          - `created_by` integer, nullable
          - `date_modified` string, date-time, nullable
          - `modified_by` integer, nullable
      - `offer_timeframes` object[]
        - `timeframe_id` integer
        - `timeframe_name` string
        - `timeframe_frequency` boolean
        - `date_created` string, date-time, nullable
        - `created_by` integer, nullable
        - `date_modified` string, date-time, nullable
        - `modified_by` integer, nullable
      - `primary_offer_category` object, nullable
        - `offer_category_id` integer
        - `offer_category_name` string
      - `secondary_offer_category` object, nullable
        - `offer_category_id` integer
        - `offer_category_name` string
      - `offer_swap_options` object[]
        - `swap_offer_id` integer
        - `swap_offer_type_id` 1 | 2 | 3 — * `1` - In Cart Only * `2` - Ongoing Subscription * `3` - Both
        - `swap_offer_description` string, nullable
        - `created_by` integer
        - `modified_by` integer
        - `date_created` string, date-time
        - `date_modified` string, date-time
  - `order_offer_next_transactions` object[]
    - `transaction_id` integer
    - `connection_transaction_id` string, nullable
    - `customer_id` integer
    - `order_id` integer
    - `payment_method_id` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 — * `1` - Credit Card * `2` - Check * `3` - Google Pay * `4` - Apple Pay * `5` - Cash * `6` - Paypal * `7` - Alternative Payments Sofort * `8` - Alternative Payments POLi * `9` - Alternative Payments SEPA * `10` - ACH * `11` - Afterpay * `12` - Klarna * `13` - SEPA
    - `transaction_type_id` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 — * `1` - Sale * `2` - Refund * `3` - Void * `4` - Chargeback * `5` - Alert * `6` - Auth * `7` - Capture * `8` - COD * `9` - Chargeback Reversal * `10` - Returned Check
    - `transaction_cycle` integer
    - `transaction_attempt` integer
    - `transaction_declined` boolean
    - `merchant_id` integer
    - `transaction_merchant_descriptor` string
    - `response_code` integer, nullable
    - `transaction_3ds_verified_status` string, nullable
    - `gateway_response_id` string, nullable
    - `gateway_auth_code` string, nullable
    - `gateway_response_code` string, nullable
    - `gateway_response_description` string, nullable
    - `gateway_response_avs` string, nullable
    - `gateway_response_cvv` string, nullable
    - `processor_response_text` string, nullable
    - `currency_id` integer
    - `transaction_price` string
    - `transaction_discount_total` string
    - `transaction_shipping` string
    - `transaction_sub_total` string
    - `transaction_tax` string
    - `transaction_fee` string
    - `customer_balance_applied` string
    - `gift_card_applied` string
    - `transaction_total` string
    - `order_discount_total` string
    - `check_number` string, nullable
    - `check_amount` string
    - `dunning_cycle_id` integer, nullable
    - `dunning_cycle_total` string
    - `quantity_discount_cycle_id` integer, nullable
    - `quantity_discount_cycle_total` string
    - `discount_cycle_id` integer, nullable
    - `discount_cycle_total` string
    - `date_scheduled` string, date-time
    - `date_complete` string, date-time, nullable
    - `date_cancelled` string, date-time, nullable
    - `date_skip` string, date-time, nullable
    - `date_batch` string, date-time, nullable
    - `date_deposit` string, date-time, nullable
    - `date_request` string, date-time, nullable
    - `date_response` string, date-time, nullable
    - `rebill_date` string, date-time, nullable
    - `original_attempt_date` string, date-time, nullable
    - `transaction_parent_id` integer, nullable
    - `parent_date_complete` string, date-time, nullable
    - `transaction_initial_id` integer, nullable
    - `is_prepaid` boolean
    - `customer_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
    - `customer_card_bin` string
    - `chargeback_date` string, date-time, nullable
    - `chargeback_code` string, nullable
    - `chargeback_reference_id` string, nullable
    - `chargeback_case_id` string, nullable
    - `transaction_total_usd` string
    - `transaction_shipping_usd` string
    - `transaction_tax_usd` string
    - `transaction_price_usd` string
    - `transaction_discount_total_usd` string
    - `customer_balance_applied_usd` string
    - `transaction_fee_usd` string
    - `gift_card_applied_usd` string
    - `date_created` string, date-time
    - `created_by` integer
    - `modified_by` integer
    - `date_modified` string, date-time
    - `transaction_notes` string, nullable
    - `order` 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
    - `order_revisions` object[]
      - `order_revision_id` integer
      - `orders_revision_type_id` integer, nullable
      - `order_revision_value` string
      - `order_notes` string
      - `modified_by` integer
      - `date_modified` string, date-time
    - `customer` object
      - `customer_id` integer
      - `connection_customer_id` string, nullable
      - `connection_id` integer
      - `first_name` string
      - `last_name` string
      - `email` string
      - `ip_address` string
      - `phone` string
      - `birthday` string, date, nullable
      - `gender` string
      - `pronoun_id` null | 1 | 2 | 3 | 4, nullable — * `1` - he/him * `2` - she/her * `3` - they/them * `4` - rather not say
      - `active_subscriber` boolean
      - `is_blacklist` boolean
      - `is_fraud` boolean
      - `date_created` string, date-time
      - `date_modified` string, date-time
      - `created_by` integer
      - `modified_by` integer
      - `customer_notes` string, nullable
      - `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
      - `customer_cards` object[]
        - `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
      - `customer_addresses` object[]
        - `customer_address_id` integer
        - `fname` string
        - `lname` string
        - `organization` string
        - `address1` string
        - `address2` string
        - `city` string
        - `country` string
        - `state` string
        - `zipcode` string
        - `address_valid` boolean
        - `date_created` string, date-time
        - `date_modified` string, date-time
        - `created_by` integer
        - `modified_by` integer
    - `customer_card` object
      - `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
      - `customer_card_merchant_token` string, nullable
      - `date_created` string, date-time
      - `date_modified` string, date-time
      - `created_by` integer
      - `modified_by` integer
    - `customer_address_billing` object
      - `customer_address_id` integer
      - `fname` string
      - `lname` string
      - `organization` string
      - `address1` string
      - `address2` string
      - `city` string
      - `country` string
      - `state` string
      - `zipcode` string
      - `address_valid` boolean
      - `date_created` string, date-time
      - `date_modified` string, date-time
      - `created_by` integer
      - `modified_by` integer
    - `customer_address_shipping` object
      - `customer_address_id` integer
      - `fname` string
      - `lname` string
      - `organization` string
      - `address1` string
      - `address2` string
      - `city` string
      - `country` string
      - `state` string
      - `zipcode` string
      - `address_valid` boolean
      - `date_created` string, date-time
      - `date_modified` string, date-time
      - `created_by` integer
      - `modified_by` integer
    - `merchant` object
      - `merchant_id` integer
      - `merchant_name` string
      - `gateway_id` integer
      - `currency_id` integer — Default currency
      - `merchant_mid_id` string
      - `merchant_descriptor` string
      - `merchant_phone` string
      - `merchant_url` string
      - `merchant_active` boolean
      - `merchant_processor` string, nullable
      - `merchant_mcc_code` string, nullable
      - `merchant_processing_limit` string
      - `merchant_processing_inforce` boolean
      - `merchant_daily_rebills_limit` string
      - `merchant_state` string, nullable
      - `merchant_tax` string
      - `merchant_mtd_revenue` string
      - `merchant_mtd_transactions` integer
      - `merchant_mtd_initial` integer
      - `merchant_processing_perc` string
      - `primary_merchant_category_id` integer
      - `secondary_merchant_category_id` integer
      - `merchant_notes` string, nullable
      - `date_created` string, date-time
      - `created_by` integer
      - `date_modified` string, date-time
      - `modified_by` integer
      - `merchant_currencies` object[]
        - `currency_id` integer
        - `currency_value` string
      - `merchant_payment_methods` object[]
        - `payment_method_id` integer
        - `payment_method_name` string
      - `merchant_card_types` object[]
        - `card_type_id` integer
        - `card_type_name` string
      - `primary_merchant_category` object, nullable
        - `merchant_category_id` integer
        - `merchant_category_name` string
      - `secondary_merchant_category` object, nullable
        - `merchant_category_id` integer
        - `merchant_category_name` string
    - `campaign` object
      - `campaign_id` integer
      - `campaign_name` string
    - `sale` object
      - `sale_id` integer
      - `order_id` integer
      - `customer_id` integer
      - `customer_name` string
      - `status` string
      - `cycle` integer
      - `currency_id` integer
      - `price` string
      - `discount_total` string
      - `shipping` string
      - `sub_total` string
      - `tax` string
      - `gift_card_applied` string
      - `total` string
      - `date_sale` string, date-time, nullable
      - `date_attempt` string, date-time, nullable
    - `credits` object[]
      - `transaction_id` integer
      - `connection_transaction_id` string, nullable
      - `customer_id` integer
      - `order_id` integer
      - `payment_method_id` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 — * `1` - Credit Card * `2` - Check * `3` - Google Pay * `4` - Apple Pay * `5` - Cash * `6` - Paypal * `7` - Alternative Payments Sofort * `8` - Alternative Payments POLi * `9` - Alternative Payments SEPA * `10` - ACH * `11` - Afterpay * `12` - Klarna * `13` - SEPA
      - `transaction_type_id` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 — * `1` - Sale * `2` - Refund * `3` - Void * `4` - Chargeback * `5` - Alert * `6` - Auth * `7` - Capture * `8` - COD * `9` - Chargeback Reversal * `10` - Returned Check
      - `transaction_cycle` integer
      - `transaction_attempt` integer
      - `transaction_declined` boolean
      - `merchant_id` integer
      - `transaction_merchant_descriptor` string
      - `response_code` integer, nullable
      - `transaction_3ds_verified_status` string, nullable
      - `gateway_response_id` string, nullable
      - `gateway_auth_code` string, nullable
      - `gateway_response_code` string, nullable
      - `gateway_response_description` string, nullable
      - `gateway_response_avs` string, nullable
      - `gateway_response_cvv` string, nullable
      - `processor_response_text` string, nullable
      - `currency_id` integer
      - `transaction_price` string
      - `transaction_discount_total` string
      - `transaction_shipping` string
      - `transaction_sub_total` string
      - `transaction_tax` string
      - `transaction_fee` string
      - `customer_balance_applied` string
      - `gift_card_applied` string
      - `transaction_total` string
      - `order_discount_total` string
      - `check_number` string, nullable
      - `check_amount` string
      - `dunning_cycle_id` integer, nullable
      - `dunning_cycle_total` string
      - `quantity_discount_cycle_id` integer, nullable
      - `quantity_discount_cycle_total` string
      - `discount_cycle_id` integer, nullable
      - `discount_cycle_total` string
      - `date_scheduled` string, date-time
      - `date_complete` string, date-time, nullable
      - `date_cancelled` string, date-time, nullable
      - `date_skip` string, date-time, nullable
      - `date_batch` string, date-time, nullable
      - `date_deposit` string, date-time, nullable
      - `date_request` string, date-time, nullable
      - `date_response` string, date-time, nullable
      - `rebill_date` string, date-time, nullable
      - `original_attempt_date` string, date-time, nullable
      - `transaction_parent_id` integer, nullable
      - `parent_date_complete` string, date-time, nullable
      - `transaction_initial_id` integer, nullable
      - `is_prepaid` boolean
      - `customer_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
      - `customer_card_bin` string
      - `chargeback_date` string, date-time, nullable
      - `chargeback_code` string, nullable
      - `chargeback_reference_id` string, nullable
      - `chargeback_case_id` string, nullable
      - `transaction_total_usd` string
      - `transaction_shipping_usd` string
      - `transaction_tax_usd` string
      - `transaction_price_usd` string
      - `transaction_discount_total_usd` string
      - `customer_balance_applied_usd` string
      - `transaction_fee_usd` string
      - `gift_card_applied_usd` string
      - `date_created` string, date-time
      - `created_by` integer
      - `modified_by` integer
      - `date_modified` string, date-time
      - `transaction_notes` string, nullable
    - `line_items` object[]
      - `line_item_id` integer
      - `customer_id` integer
      - `order_id` integer
      - `order_offer_id` integer
      - `offer_id` integer
      - `offer_name` string
      - `offer_quantity` integer
      - `item_id` integer
      - `item_name` string
      - `item_quantity` integer
      - `campaign_id` integer
      - `campaign_name` string
      - `transaction_status` string
      - `line_item_cycle` integer
      - `currency_id` integer
      - `is_test` boolean
      - `is_upsell` boolean
      - `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
      - `discount_code` string, nullable
      - `line_item_price` string
      - `line_item_discount_total` string
      - `line_item_shipping` string
      - `line_item_sub_total` string
      - `line_item_tax` string
      - `customer_balance_applied` string
      - `gift_card_applied` string
      - `line_item_total` string
      - `line_item_price_usd` string
      - `line_item_discount_total_usd` string
      - `line_item_shipping_usd` string
      - `line_item_tax_usd` string
      - `customer_balance_applied_usd` string
      - `gift_card_applied_usd` string
      - `line_item_total_usd` string
      - `date_complete` string, date-time, nullable
      - `linked_order_offer_id` integer, nullable
      - `linked_transaction_cycle` integer, nullable
      - `linked_transaction_attempt` integer, nullable
      - `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
      - `linked_is_recurring` boolean, nullable
      - `line_item_shipments` 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
    - `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
      - `customer_address_billing` object
        - `customer_address_id` integer
        - `fname` string
        - `lname` string
        - `organization` string
        - `address1` string
        - `address2` string
        - `city` string
        - `country` string
        - `state` string
        - `zipcode` string
        - `address_valid` boolean
        - `date_created` string, date-time
        - `date_modified` string, date-time
        - `created_by` integer
        - `modified_by` integer
      - `customer_address_shipping` object
        - `customer_address_id` integer
        - `fname` string
        - `lname` string
        - `organization` string
        - `address1` string
        - `address2` string
        - `city` string
        - `country` string
        - `state` string
        - `zipcode` string
        - `address_valid` boolean
        - `date_created` string, date-time
        - `date_modified` string, date-time
        - `created_by` integer
        - `modified_by` integer
      - `campaign` object
        - `campaign_id` integer
        - `campaign_name` string
      - `connection` object, nullable
        - `connection_id` integer
        - `connection_name` string
      - `tracking_history` object[]
        - `tracking_history_id` integer
        - `carrier_id` integer, nullable
        - `date` string, date-time, nullable
        - `category_id` integer, nullable
        - `category_name` string, nullable
        - `status_id` integer, nullable
        - `status_text` string, nullable
      - `actions` object
        - `can_change_address` boolean
        - `can_process` boolean
        - `can_reschedule` boolean
        - `can_rma` boolean
        - `can_skip` boolean
        - `can_swap` boolean
        - `can_unskip` boolean
    - `route_logs` object[]
      - `route_log_id` integer
      - `route_id` integer
      - `order_id` integer
      - `merchant_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_type_name` string
      - `reason` string
      - `date_complete` string, date-time
      - `date_created` string, date-time
      - `created_by` integer
    - `actions` object
      - `can_process` boolean
      - `can_reorder` boolean
      - `can_reschedule` boolean
      - `can_skip` boolean
      - `can_unskip` boolean
  - `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_address_billing` object
    - `customer_address_id` integer
    - `fname` string
    - `lname` string
    - `organization` string
    - `address1` string
    - `address2` string
    - `city` string
    - `country` string
    - `state` string
    - `zipcode` string
    - `address_valid` boolean
    - `date_created` string, date-time
    - `date_modified` string, date-time
    - `created_by` integer
    - `modified_by` integer
  - `customer_address_shipping` object
    - `customer_address_id` integer
    - `fname` string
    - `lname` string
    - `organization` string
    - `address1` string
    - `address2` string
    - `city` string
    - `country` string
    - `state` string
    - `zipcode` string
    - `address_valid` boolean
    - `date_created` string, date-time
    - `date_modified` string, date-time
    - `created_by` integer
    - `modified_by` integer
  - `campaign` object
    - `campaign_id` integer
    - `campaign_name` string
  - `actions` object
    - `can_cancel` boolean
    - `can_change_frequency` boolean
    - `can_change_quantity` boolean
    - `can_edit_gift` boolean
    - `can_manage` boolean
    - `can_pause` boolean
    - `can_reactivate` boolean
    - `can_resend_gift` boolean
    - `can_swap` boolean
    - `can_unpause` boolean
    - `is_subscription` boolean

## 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)