v1

latestOpenAPI 3.0.12026-07-2412502.6 MB

Orders

Edit an order

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

patch/orders/{order_id}

Request body

customer_card_idinteger

Change the customer card that will be used for all charges for an order.

emailstring

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_namestring

Customer first name. If not passed, the bill_fname value will be used. Only editable until the order is complete.

last_namestring

Customer last name. If not passed, the bill_lname value will be used. Only editable until the order is complete.

phonestring

Customer telephone number. Only editable until the order is complete.

customers_address_billing_idinteger

Change the customer billing address that will be used for an order.

customers_address_shipping_idinteger

Change the customer shipping address that will be used for an order.

bill_fnamestring

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_lnamestring

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_address1string

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_address2string

Billing address line 2. Only editable until the order is complete.

bill_citystring

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_countrystring

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_organizationstring

Billing organization. Only editable until the order is complete.

bill_statestring

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_zipcodestring

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_addressboolean

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_fnamestring

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_lnamestring

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_address1string

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_address2string

Shipping address line 2. Only editable until the order is complete.

ship_citystring

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_countrystring

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_organizationstring

Shipping organization. Only editable until the order is complete.

ship_statestring

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_zipcodestring

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_codestring

Apply a discount code to the order. Only editable until the order is complete.

shipping_profile_idinteger

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_discountstring

Apply a discount percentage to an order that will be used for all recurring charges.

date_auto_capturestring date-time

Auto capture date (2025-08-17 00:00:00) in EST.

create_cartboolean

Create and associate a cart, if none currently set.

tracking1string

Custom Tracking Variable Option 1

tracking2string

Custom Tracking Variable Option 2

tracking3string

Custom Tracking Variable Option 3

tracking4string

Custom Tracking Variable Option 4

tracking5string

Custom Tracking Variable Option 5

tracking6string

Custom Tracking Variable Option 6

tracking7string

Custom Tracking Variable Option 7

tracking8string

Custom Tracking Variable Option 8

tracking9string

Custom Tracking Variable Option 9

tracking10string

Custom Tracking Variable Option 10

tracking11string

Custom Tracking Variable Option 11

tracking12string

Custom Tracking Variable Option 12

tracking13string

Custom Tracking Variable Option 13

tracking14string

Custom Tracking Variable Option 14

tracking15string

Custom Tracking Variable Option 15

tracking16string

Custom Tracking Variable Option 16

tracking17string

Custom Tracking Variable Option 17

tracking18string

Custom Tracking Variable Option 18

tracking19string

Custom Tracking Variable Option 19

tracking20string

Custom Tracking Variable Option 20

is_testboolean

Flag an order as a Test Order. Orders will always be flagged as test when using a test credit card.

order_notesstring

Apply note to the history of this order.

Response

order_idinteger

connection_order_idstring nullable

campaign_idinteger

status_type_idnull | 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_idinteger nullable

customer_idinteger

customers_address_billing_idinteger nullable

customers_address_shipping_idinteger nullable

date_createdstring date-time nullable

date_modifiedstring date-time nullable

date_authorizedstring date-time nullable

date_auto_capturestring date-time nullable

date_orderedstring date-time nullable

date_capturestring date-time nullable

is_testboolean

ip_addressstring nullable

order_discountstring

order_pixelboolean

cart_tokenstring nullable

order_pixel_blockstring nullable

order_notesstring nullable

created_byinteger

modified_byinteger

tracking1string nullable

tracking2string nullable

tracking3string nullable

tracking4string nullable

tracking5string nullable

tracking6string nullable

tracking7string nullable

tracking8string nullable

tracking9string nullable

tracking10string nullable

tracking11string nullable

tracking12string nullable

tracking13string nullable

tracking14string nullable

tracking15string nullable

tracking16string nullable

tracking17string nullable

tracking18string nullable

tracking19string nullable

tracking20string nullable

user_agentstring nullable

Example response

{
  "date_created": "2023-04-01 00:00:00",
  "date_modified": "2023-04-01 00:00:00",
  "date_authorized": "2023-04-01 00:00:00",
  "date_auto_capture": "2023-04-01 00:00:00",
  "date_ordered": "2023-04-01 00:00:00",
  "date_capture": "2023-04-01 00:00:00",
  "cart": {
    "campaign": {
      "campaign_checkout_upsell": {
        "items": [
          {
            "date_created": "2023-04-01 00:00:00",
            "date_modified": "2023-04-01 00:00:00"
          }
        ]
      }
    },
    "order": {
      "date_authorized": "2023-04-01 00:00:00",
      "date_ordered": "2023-04-01 00:00:00"
    },
    "offers": [
      {
        "gift_date": "2023-04-01 00:00:00",
        "upsells": [
          {
            "items": [
              {
                "date_created": "2023-04-01 00:00:00",
                "date_modified": "2023-04-01 00:00:00"
              }
            ]
          }
        ]
      }
    ]
  },
  "order_offers": [
    {
      "date_cancel": "2023-04-01 00:00:00",
      "date_created": "2023-04-01 00:00:00",
      "date_modified": "2023-04-01 00:00:00",
      "date_ordered": "2023-04-01 00:00:00",
      "date_reactivate": "2023-04-01 00:00:00",
      "date_pause": "2023-04-01 00:00:00",
      "date_unpause": "2023-04-01 00:00:00",
      "last_recurring_date": "2023-04-01 00:00:00",
      "next_recurring_date": "2023-04-01 00:00:00",
      "order_offer_shipments": [
        {
          "date_cancel": "2023-04-01 00:00:00",
          "date_scheduled": "2023-04-01 00:00:00",
          "date_complete": "2023-04-01 00:00:00",
          "date_scan": "2023-04-01 00:00:00",
          "date_deliver": "2023-04-01 00:00:00",
          "date_return": "2023-04-01 00:00:00",
          "date_skip": "2023-04-01 00:00:00",
          "date_rma": "2023-04-01 00:00:00",
          "date_created": "2023-04-01 00:00:00",
          "date_modified": "2023-04-01 00:00:00"
        }
      ],
      "order_offer_items": [
        {
          "date_created": "2023-04-01 00:00:00",
          "date_modified": "2023-04-01 00:00:00"
        }
      ],
      "order_offer_gifts": [
        {
          "gift_date": "2023-04-01 00:00:00",
          "gift_date_sent": "2023-04-01 00:00:00"
        }
      ]
    }
  ],
  "customer_card": {
    "date_created": "2023-04-01 00:00:00",
    "date_modified": "2023-04-01 00:00:00"
  }
}