# Processes an order with line item overrides

This is designed to be run by administrators; allows an order to e processed but have prices or quantities overridden

Endpoint: POST /orders/{tenantId}/processWithOverride/sync
Version: v1-2025-04-18
Security: knox-authorizer

## Path parameters:

  - `tenantId` (string, required)
    The id of the tenant being accessed

## Request fields (application/json):

  - `order` (object)

  - `order.additional_email_confirmation_recipients` (array)
    Additional emails to send confirmation

  - `order.additional_payments` (array, required)

  - `order.additional_payments.line_item_ids` (array)
    The order line items that this additional payment should apply to

  - `order.additional_payments.payment_info` (object)

  - `order.additional_payments.payment_info.electronic_payment_info` (object)
    The electronic payment/card info

  - `order.additional_payments.payment_info.electronic_payment_info.card_expiration` (string)
    The card expiration

  - `order.additional_payments.payment_info.electronic_payment_info.card_type` (string)
    The type of card being used, or CHECK if electronic check
    Enum: "american express", "discover", "electronic check", "mastercard", "other", "visa"

  - `order.additional_payments.payment_info.electronic_payment_info.merchant_account_id` (string)
    The merchant account to use for this payment

  - `order.additional_payments.payment_info.electronic_payment_info.merchant_account_tokens` (array)

  - `order.additional_payments.payment_info.electronic_payment_info.merchant_account_tokens.merchant_account_id` (string, required)
    The merchant account id

  - `order.additional_payments.payment_info.electronic_payment_info.merchant_account_tokens.token` (string, required)
    The token representing the card/electronic check info

  - `order.additional_payments.payment_info.electronic_payment_info.payment_account` (string)
    The masked payment account information

  - `order.additional_payments.payment_info.electronic_payment_info.payment_origin` (string, required)
    Whether or not this is a saved payment method
    Enum: "ad hoc", "saved", "single token"

  - `order.additional_payments.payment_info.electronic_payment_info.token` (string)
    For integrated payments, the single token

  - `order.additional_payments.payment_info.non_electronic_payment_info` (object)
    Payment info for non-electronic payments

  - `order.additional_payments.payment_info.non_electronic_payment_info.bank_account_id` (string)
    The bank account being used for the order

  - `order.additional_payments.payment_info.non_electronic_payment_info.reference_number` (string)
    The reference number for the payment, if applicable

  - `order.additional_payments.payment_info.type` (string, required)
    The type of payment
    Enum: "ach", "cash", "cashiers check", "check", "credit card", "electronic check", "money order", "offline credit card", "payroll deduction", "purchase order", "store credit", "wire transfer"

  - `order.amount_paid` (number, required)
    Amount paid on the order

  - `order.amount_pending_capture` (number, required)
    The amount that has been authorized, but not yet captured

  - `order.amount_refunded` (number, required)
    Amount refunded on the order

  - `order.balance_due` (number, required)
    Balance due on the order

  - `order.base_currency_code` (string)

  - `order.base_currency_symbol` (string)

  - `order.batch_id` (string)
    The batch the order should be in

  - `order.bill_parent_organization` (boolean)
    If true, the parent organization is billed

  - `order.bill_to_contact_id` (string, required)
    The contact being billed

  - `order.bill_to_organization_id` (string, required)
    The organization being billed

  - `order.bill_to_type` (string, required)
    The type of customer being billed
    Enum: "contact", "organization"

  - `order.billing_address` (object)
    A complete address

  - `order.billing_address.city` (string)
    The city of the address

  - `order.billing_address.country` (string)
    The country ISO code

  - `order.billing_address.country_name` (string)
    The full name of hte country

  - `order.billing_address.county` (string)
    The county

  - `order.billing_address.latitude` (number)

  - `order.billing_address.line1` (string)
    The first line of the address

  - `order.billing_address.line2` (string)
    The second line of the address

  - `order.billing_address.line3` (string)
    The third line of the address

  - `order.billing_address.longitude` (number)

  - `order.billing_address.postal_code` (string)
    The zip/postal code

  - `order.billing_address.state` (string)
    The state/province of the address

  - `order.billing_address.time_zone_id` (string)

  - `order.billing_run_action_id` (string)
    The billing run action that created this order; we track it here only to pass it back through the billing service

  - `order.billing_run_id` (string)
    If this is part of a billing run, the ID

  - `order.billing_run_service` (string)
    If this order was generated by a billing run, the service that initiated it

  - `order.business_unit_id` (string)
    The business unit of the order

  - `order.copy_shipping_info_from_billing_info` (boolean)
    Indicates that the shipping information was copied from the billing info. For reporting use only

  - `order.coupons` (array)

  - `order.coupons.coupon_code_id` (string, required)
    The coupon code

  - `order.coupons.coupon_id` (string)
    The ID of the coupon backing the coupon code

  - `order.coupons.coupon_type` (string)
    The type of coupon represented by the coupon code

  - `order.coupons.discount` (number)
    The amount that was discounted

  - `order.coupons.order_line_item_ids` (array)
    The line items that the coupon acted on

  - `order.coupons.retroactive_application_date` (string)
    If applied retroactively, the date of application

  - `order.credit_usages` (array)
    Credits to use when paying the invoices on this order

  - `order.credit_usages.amount_to_use` (number, required)
    The amount of credit to apply

  - `order.credit_usages.credit_id` (string, required)
    The ID of the credit to use

  - `order.currency_code` (string)
    The order currency
    Enum: "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR"

  - `order.currency_symbol` (string)
    The currency symbol

  - `order.custom_field_values` (array)

  - `order.custom_field_values.boolean_value` (boolean)
    The boolean value

  - `order.custom_field_values.custom_field_id` (string)
    The unique identifier of the custom field

  - `order.custom_field_values.file_url_value` (string)
    The pointer to a file value

  - `order.custom_field_values.list_value` (array)
    The list value

  - `order.custom_field_values.numeric_value` (number)
    The numeric value

  - `order.custom_field_values.string_value` (string)
    The string value of the custom field

  - `order.custom_field_values.table_value` (array)
    A list of objects (a table)

  - `order.custom_metadata` (object)
    Custom metadata that can be used by custom order generation processes for hyper-customized order & invoice forms

  - `order.date` (string)
    The date of the order

  - `order.default_merchant_account_id` (string)
    The default, calculated merchant account id

  - `order.discounts` (number, required)
    Amount of discounts for the order

  - `order.do_not_apply_open_credits` (boolean)
    If set, open credits are not applied to this order

  - `order.duplicate_prevention_key` (string)
    Temporary value used to prevent duplicate submissions

  - `order.event_id` (string, required)
    The event

  - `order.exchange_rate` (number)
    The exchange rate, if applicable

  - `order.expiration_date` (string)
    The deadline after which this order is no longer valid. Used by generateOrder routines to restrict how long before this order can not longer be processes. Example: exhibitor-registration.generateOrder

  - `order.failure_notice_id` (string)
    The billing notice to run when this order succeeds; we track it here only to pass it back through the billing service

  - `order.id` (string, required)
    The unique, string identifier of this order

  - `order.installment_schedule_id` (string)
    If this is tied to an installment schedule

  - `order.invoice_terms_id` (string)
    The terms to be used for generating the invoice

  - `order.line_items` (array, required)

  - `order.line_items.amount_paid` (number)
    Amount paid on the order item

  - `order.line_items.amount_pending_capture` (number)
    The amount that has been authorized, but not yet captured on this item

  - `order.line_items.amount_refunded` (number)
    Amount refunded on the order  item

  - `order.line_items.amount_to_pay_upon_creation` (number)
    The amount of this item that should be paid immediately

  - `order.line_items.balance_due` (number)
    Balance due on the order item

  - `order.line_items.bundled_product_1` (object)

  - `order.line_items.bundled_product_1.amount` (number, required)
    The amount of the bundled product

  - `order.line_items.bundled_product_1.product_id` (string, required)
    The bundled product ID

  - `order.line_items.bundled_product_1.product_type` (string, required)
    The bundled product type

  - `order.line_items.bundled_product_2` (object)

  - `order.line_items.description` (string)
    Optional description of the line item

  - `order.line_items.discounts` (number)
    Any discounts set on the order item

  - `order.line_items.has_inline_bundled_products` (boolean)
    If true, this line item has inline products bundled with it

  - `order.line_items.inline_bundled_products` (array)

  - `order.line_items.installment_plan_id` (string)
    The installment plan to use for this item

  - `order.line_items.installment_schedule_type` (string)
    If creating an installment plan, the type to create
    Enum: "based on installment plan", "perpetual"

  - `order.line_items.modifier_options` (array)

  - `order.line_items.modifier_options.option_id` (string, required)
    The modifier option ID

  - `order.line_items.modifier_options.option_name` (string)

  - `order.line_items.modifier_options.value` (string)
    The value of the option

  - `order.line_items.optional` (boolean)
    Whether or not this is an "optional" item

  - `order.line_items.order_line_item_id` (string)
    A unique identifier for the order item

  - `order.line_items.override_ship_to_contact_id` (string)
    The contact being shipped to

  - `order.line_items.override_ship_to_organization_id` (string)
    The organization being shipped to

  - `order.line_items.override_ship_to_type` (string)
    The type of customer being shipped to
    Enum: "contact", "organization"

  - `order.line_items.parent_line_item_id` (string)
    If this is a linked item, the parent linkage

  - `order.line_items.parent_order_line_item_id` (string)
    The parent item, if applicable

  - `order.line_items.payload` (object)
    Any optional order payload for processing; used by some fulfillment processes (like event registration modification) to support transient objects

  - `order.line_items.payload_id` (string)
    Product specific payload used by the product service to process/fulfill the order

  - `order.line_items.perpetual_installment_schedule_options` (object)

  - `order.line_items.perpetual_installment_schedule_options.end_date` (string)
    Optional end date

  - `order.line_items.perpetual_installment_schedule_options.number_of_units` (number, required)
    Number of units

  - `order.line_items.perpetual_installment_schedule_options.unit_of_time` (string, required)
    Enum: "months", "quarters", "weeks", "years"

  - `order.line_items.product_id` (string, required)
    The id of the product

  - `order.line_items.product_type` (string, required)
    The type of product

  - `order.line_items.quantity` (integer)
    The quantity of the order item

  - `order.line_items.quantity_available_for_cancellation` (integer)
    The quantity of the order item that can be cancelled

  - `order.line_items.quantity_available_for_return` (integer)
    The quantity of the order item that can be returned

  - `order.line_items.quantity_cancelled` (integer)
    The quantity of the order item that has been cancelled

  - `order.line_items.quantity_pending_return` (integer)
    The quantity of the order item that is pending return

  - `order.line_items.quantity_returned` (integer)
    The quantity of the order item that has been returned

  - `order.line_items.quantity_shipped` (integer)
    The quantity of the order item that has been shipped

  - `order.line_items.quantity_to_be_shipped` (integer)
    The quantity that is available to be shipped

  - `order.line_items.related_record_id` (string)
    The record related to this order

  - `order.line_items.related_record_type` (string)
    If theres a record related to this order, list it here

  - `order.line_items.related_transactions` (array)

  - `order.line_items.related_transactions.amount` (number, required)
    The amount applied

  - `order.line_items.related_transactions.date` (string, required)
    The date/time of the transaction

  - `order.line_items.related_transactions.transaction_id` (string, required)
    The id of the transaction

  - `order.line_items.related_transactions.transaction_line_item_id` (string, required)
    The line item id of the transaction

  - `order.line_items.related_transactions.transaction_number` (number, required)
    The number of the transaction

  - `order.line_items.related_transactions.type` (string)
    Enum: "cancellation", "credit", "credit memo", "credit usage", "debit memo", "invoice", "payment", "refund", "return", "shipment", "write off"

  - `order.line_items.shippable` (boolean)
    Whether or not this item needs to be shipped

  - `order.line_items.sku` (string)
    The SKU of the product, if applicable

  - `order.line_items.special_instructions` (string)
    Any special instructions for this item

  - `order.line_items.status` (string)
    The order item status
    Enum: "awaiting payment", "awaiting pickup", "awaiting shipping", "cancelled", "completed", "disputed", "open", "partially shipped", "returned", "shipped", "void"

  - `order.line_items.taxes` (number)
    Any taxes set on the order item

  - `order.line_items.total` (number)
    Total amount of the order  item

  - `order.line_items.total_in_base_currency` (number)
    Total amount of the order

  - `order.line_items.type` (string)
    The type of order item
    Enum: "bundled product", "cancellation", "credit card processing fee", "discount", "inline bundled product", "item", "shipping", "taxes"

  - `order.line_items.unit_price` (number)
    The unit price of the item

  - `order.line_items.variant_options` (array)

  - `order.line_items.variant_options.option_id` (string, required)
    The variant option ID

  - `order.line_items.weight` (number)
    The weight of this item

  - `order.memo` (string)
    Additional information for the order

  - `order.notes` (string)
    Notes on the order

  - `order.number` (integer)
    The number of the order

  - `order.override_order_date` (boolean)
    If true, the system should override the order date

  - `order.pay_for_credit_card_processing_fees` (boolean)
    If set, this order should be charged credit card processing fees

  - `order.pay_using_multiple_methods` (boolean)
    If set, the order will be paid using more than one payment method

  - `order.payload` (object)
    Any optional order payload for processing; used by some fulfillment processes (like fundraising) to support transient objects

  - `order.payment_method` (string)
    For reporting use only, the payment method of this order
    Enum: "ach", "cash", "cashiers check", "check", "credit card", "electronic check", "money order", "none", "offline credit card", "payroll deduction", "purchase order", "store credit", "wire transfer"

  - `order.preview_id` (string)
    The caching key to use during preview

  - `order.process_id` (string)
    If a process was used to create this order, that process ID is listed here

  - `order.purchase_order_number` (string)
    The customer P.O. number

  - `order.send_email_confirmation_to_customer` (boolean)
    Whether or not to send an email confirmation to the bill to and ship to

  - `order.ship_to_contact_id` (string, required)
    The contact being shipped to

  - `order.ship_to_name` (string)
    The addressee

  - `order.ship_to_organization_id` (string, required)
    The organization being shipped to

  - `order.ship_to_type` (string, required)
    The type of customer being shipped to
    Enum: "contact", "organization"

  - `order.shippable` (boolean)
    Whether or not this order needs to be shipped

  - `order.shipping_address` (object)
    A complete address

  - `order.shipping_charges` (number, required)
    Shipping charges for the order

  - `order.shipping_method_id` (string)
    The ID of the shipping method for this order

  - `order.shipping_method_name` (string)
    The name of the shipping method for this order

  - `order.shipping_method_type` (string)
    The type of shipping method
    Enum: "flat rate", "free", "pickup", "ship by", "ups"

  - `order.shipping_zone_id` (string)
    The id of the shipping zone

  - `order.special_instructions` (string)
    Any special instructions for this order

  - `order.status` (string, required)
    The order status
    Enum: "awaiting payment", "awaiting pickup", "awaiting shipping", "cancelled", "completed", "disputed", "open", "partially shipped", "returned", "shipped", "void"

  - `order.store_id` (string, required)
    The online store

  - `order.submission_date` (string)
    The date and time the order was actually submitted

  - `order.subtotal` (number, required)
    Order subtotal before taxes/shipping/discounts

  - `order.success_notice_id` (string)
    The billing notice to run when this order succeeds; we track it here only to pass it back through the billing service

  - `order.sys_bulk_load_at` (string)
    If this record was loaded via bulk, the timestamp when the record was processed

  - `order.sys_bulk_load_id` (string)
    If this record was loaded via bulk, the ID of the bulk load process

  - `order.sys_bulk_load_pk` (string)
    If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

  - `order.sys_bulk_load_record_no` (number)
    If this record was loaded via bulk, the record number in the source file

  - `order.sys_bulk_load_source_file` (string)
    If this record was loaded via bulk, the source file

  - `order.sys_calculated_field_error` (string)
    The error associated with the calculated field

  - `order.sys_calculated_field_errors` (array)

  - `order.sys_calculated_field_errors.error` (string)

  - `order.sys_calculated_field_errors.field` (string)

  - `order.sys_configuration_snapshot_id` (string)
    If a snapshot was restored/applies to this record, the ID of the snapshot

  - `order.sys_created_at` (string, required)
    The date/time that this record was created, expressed in ISO-8601 date format

  - `order.sys_created_by_id` (string, required)
    The ID of the user that created this record

  - `order.sys_deleted_by_id` (string)
    The ID of the user that deleted (or last tried to delete) this object

  - `order.sys_directive` (string)
    Means for passing directive information into an object processing logic

  - `order.sys_external_id` (string)
    The ID that a record has from an external system or data import

  - `order.sys_has_files_in_s3` (boolean)
    If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

  - `order.sys_last_bulk_data_operation_id` (string)
    If this record was last touched by a bulk data operation, the ID of that operation

  - `order.sys_last_bulk_data_operation_sys_version` (string)
    If this record was last touched by a bulk data operation, the sys_version at the time of that operation

  - `order.sys_last_modified_at` (string, required)
    The date/time that this record record was last modified, expressed in ISO-8601 date format

  - `order.sys_last_modified_by_id` (string, required)
    The ID of the user that last modified this record

  - `order.sys_last_security_context` (object)
    The security context of the last insert, modify, or delete performed on this item

  - `order.sys_locked` (boolean)
    If set, this record is locked and cannot be changed via the API

  - `order.sys_shippable_status` (string)
    System property - do not use

  - `order.sys_snapshot_base_version` (number)
    The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

  - `order.sys_version` (number)
    A number representing the version of this record in the database

  - `order.taxes` (number, required)
    Taxes associated with the order

  - `order.total` (number, required)
    Total amount of the order

  - `order.total_weight` (number)
    The total weight of the order

  - `order.type` (string)
    The type of order
    Enum: "advertising insertion order", "award application", "career center", "certification application", "certification course registration", "certification exam registration", "donation form", "event registration", "exhibitor registration", "fundraising gift", "fundraising pledge", "group membership", "legacy", "membership", "online store", "preview", "sponsorship", "subscription"

  - `order.use_pro_forma_invoices` (boolean)
    Set if the invoices for the order should be pro forma

  - `override_manifest` (object)

## Response 200 fields (application/json):

  - `executionArn` (string, required)
    The arn of the execution

  - `notification_channel` (string)
    The id of the channel where progress updates will be posted

  - `notification_publishKey` (string)
    The publish key for the channel where progress updates will be posted

  - `notification_subscribeKey` (string)
    The subscribe key for the channel where progress updates will be posted

  - `start_date` (string)
    The start date of the execution


## Response 400 fields

## Response 401 fields

## Response 403 fields

## Response 404 fields

## Response 409 fields

## Response 429 fields

## Response 500 fields