Commerce
/
Orders

Commerce (Orders & Inventory) (v1-2025-04-18)

The Orders & Inventory, or Commerce, API is focused on the processing and fulfillment of Orders. Additionally, you can use this API to manage your inventory, merchandise, and online store.

Like most of the other Rhythm apps, the Commerce API includes endpoints for Query Definitions. These endpoints are commonly used to retrieve saved queries, which can then be executed using the Query endpoints of the System API.

Download OpenAPI description
commerce-v1.json
commerce-v1.yaml
Languages
Servers
Mock server

https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/

https://commerce.api.rhythmsoftware.com/

Cancellation Fees

Cancellation Fees

Operations

Cancellations

Cancellations

Operations

Carts

Carts

Operations

Coupon Code Gen Processes

Coupon Code Gen Processes

Operations

Coupon Codes

Coupon Codes

Operations

Coupons

Coupons

Operations

Discount Products

Discount Products

Operations

Entitlement Types

Entitlement Types

Operations

Entitlements

Entitlements

Operations

Inventory Transactions

Inventory Transactions

Operations

Merchandise

Merchandise

Operations

Orders

Orders

Operations

Gets all of the orders in the system.

Request

This method will scan all orders and and return them to the caller.

Path
tenantIdstringrequired

The id of the tenant being accessed.

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned.

exclusiveStartKeystring

The start key, if you're making a subsequent request

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/orders/{tenantId}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The orderswere retrieved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/jsonArray [
additional_email_confirmation_recipientsArray of strings(Additional Email Confirmation Recipients)

Additional emails to send confirmation

additional_paymentsArray of objectsnon-emptyrequired
additional_payments[].​line_item_idsArray of strings(Line Items)

The order line items that this additional payment should apply to

additional_payments[].​payment_infoobject(Payment Info)
amount_paidnumber(double)(Amount Paid)required

Amount paid on the order

amount_pending_capturenumber(double)(Amount Pending Capture)required

The amount that has been authorized, but not yet captured

amount_refundednumber(double)(Amount Refunded)required

Amount refunded on the order

balance_duenumber(double)(Balance Due)required

Balance due on the order

base_currency_codestring(Base Currency Code)
base_currency_symbolstring(Base Currency Symbol)
batch_idstring(Batch)

The batch the order should be in

bill_parent_organizationboolean(Bill Parent Organization)

If true, the parent organization is billed

bill_to_contact_idstring(Bill To Contact)required

The contact being billed

bill_to_organization_idstring(Bill To Organization)required

The organization being billed

bill_to_typestring(Bill To Type)required

The type of customer being billed

Enum"contact""organization"
billing_addressobject(Address)

A complete address

billing_run_action_idstring(Billing Run Action)

The billing run action that created this order; we track it here only to pass it back through the billing service

billing_run_idstring(Billing Run)

If this is part of a billing run, the ID

billing_run_servicestring(Billing Run Service)

If this order was generated by a billing run, the service that initiated it

business_unit_idstring(Business Unit)

The business unit of the order

copy_shipping_info_from_billing_infoboolean(Copy Shipping Info From Billing Info)

Indicates that the shipping information was copied from the billing info. For reporting use only

couponsArray of objects
credit_usagesArray of objects

Credits to use when paying the invoices on this order

currency_codestring(Currency Code)

The order currency

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
currency_symbolstring(Currency Symbol)

The currency symbol

custom_field_valuesArray of objects(Custom Field Values)
custom_metadataobject(Custom Metadata)

Custom metadata that can be used by custom order generation processes for hyper-customized order & invoice forms

datestring(Date)

The date of the order

default_merchant_account_idstring(Default Merchant Account)

The default, calculated merchant account id

discountsnumber(double)(Discounts)required

Amount of discounts for the order

do_not_apply_open_creditsboolean(Do Not Apply Open Credits)

If set, open credits are not applied to this order

duplicate_prevention_keystring(Duplicate Prevention Key)

Temporary value used to prevent duplicate submissions

event_idstring(Event)required

The event

exchange_ratenumber(double)(Exchange Rate)

The exchange rate, if applicable

expiration_datestring(date-time)(Expiration Date)

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

failure_notice_idstring(Failure Notice)

The billing notice to run when this order succeeds; we track it here only to pass it back through the billing service

idstring(ID)^[\w|-]+$required

The unique, string identifier of this order

installment_schedule_idstring(Installment Schedule)

If this is tied to an installment schedule

invoice_terms_idstring(Invoice Terms)

The terms to be used for generating the invoice

line_itemsArray of objectsnon-emptyrequired
line_items[].​amount_paidAmount Paid (number)(double)(Amount Paid)

Amount paid on the order item

One of:

Amount paid on the order item

number(double)(Amount Paid)

Amount paid on the order item

line_items[].​amount_pending_captureAmount Pending Capture (number)(double)(Amount Pending Capture)

The amount that has been authorized, but not yet captured on this item

One of:

The amount that has been authorized, but not yet captured on this item

number(double)(Amount Pending Capture)

The amount that has been authorized, but not yet captured on this item

line_items[].​amount_refundedAmount Refunded (number)(double)(Amount Refunded)

Amount refunded on the order item

One of:

Amount refunded on the order item

number(double)(Amount Refunded)

Amount refunded on the order item

line_items[].​amount_to_pay_upon_creationAmount To Pay Upon Creation (number)(double)(Amount To Pay Upon Creation)

The amount of this item that should be paid immediately

One of:

The amount of this item that should be paid immediately

number(double)(Amount To Pay Upon Creation)

The amount of this item that should be paid immediately

line_items[].​balance_dueBalance Due (number)(double)(Balance Due)

Balance due on the order item

One of:

Balance due on the order item

number(double)(Balance Due)

Balance due on the order item

line_items[].​bundled_product_1object(Bundled Product 1)
line_items[].​bundled_product_2object(Bundled Product 2)
line_items[].​descriptionstring(Description)

Optional description of the line item

line_items[].​discountsDiscounts (number)(double)(Discounts)

Any discounts set on the order item

One of:

Any discounts set on the order item

number(double)(Discounts)

Any discounts set on the order item

line_items[].​has_inline_bundled_productsboolean(Has Inline Bundled Products)

If true, this line item has inline products bundled with it

line_items[].​inline_bundled_productsArray of objectsnon-empty
One of:
non-empty
line_items[].​installment_plan_idInstallment Plan (string)(Installment Plan)

The installment plan to use for this item

One of:

The installment plan to use for this item

string(Installment Plan)

The installment plan to use for this item

line_items[].​installment_schedule_typestring(Installment Schedule Type)

If creating an installment plan, the type to create

Enum"based on installment plan""perpetual"
line_items[].​modifier_optionsArray of objects
line_items[].​optionalboolean(Optional)

Whether or not this is an "optional" item

line_items[].​order_line_item_idOrder Line Item (string)(Order Line Item)

A unique identifier for the order item

One of:

A unique identifier for the order item

string(Order Line Item)

A unique identifier for the order item

line_items[].​override_ship_to_contact_idOverride Ship To Contact (string)(Override Ship To Contact)

The contact being shipped to

One of:

The contact being shipped to

string(Override Ship To Contact)

The contact being shipped to

line_items[].​override_ship_to_organization_idOverride Ship To Organization (string)(Override Ship To Organization)

The organization being shipped to

One of:

The organization being shipped to

string(Override Ship To Organization)

The organization being shipped to

line_items[].​override_ship_to_typestring(Override Ship To Type)

The type of customer being shipped to

Enum"contact""organization"
line_items[].​parent_line_item_idstring(Parent Line Item)

If this is a linked item, the parent linkage

line_items[].​parent_order_line_item_idstring(Parent Order Line Item)

The parent item, if applicable

line_items[].​payloadobject(Payload)

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

line_items[].​payload_idstring(Payload)

Product specific payload used by the product service to process/fulfill the order

line_items[].​perpetual_installment_schedule_optionsPerpetual Installment Schedule Options (object)(Perpetual Installment Schedule Options)
One of:
line_items[].​product_idstring(Product)required

The id of the product

line_items[].​product_typestring(Product Type)required

The type of product

line_items[].​quantityinteger(Quantity)

The quantity of the order item

line_items[].​quantity_available_for_cancellationQuantity Available For Cancellation (integer)(Quantity Available For Cancellation)

The quantity of the order item that can be cancelled

One of:

The quantity of the order item that can be cancelled

integer(Quantity Available For Cancellation)

The quantity of the order item that can be cancelled

line_items[].​quantity_available_for_returnQuantity Available For Return (integer)(Quantity Available For Return)

The quantity of the order item that can be returned

One of:

The quantity of the order item that can be returned

integer(Quantity Available For Return)

The quantity of the order item that can be returned

line_items[].​quantity_cancelledQuantity Cancelled (integer)(Quantity Cancelled)

The quantity of the order item that has been cancelled

One of:

The quantity of the order item that has been cancelled

integer(Quantity Cancelled)

The quantity of the order item that has been cancelled

line_items[].​quantity_pending_returnQuantity Pending Return (integer)(Quantity Pending Return)

The quantity of the order item that is pending return

One of:

The quantity of the order item that is pending return

integer(Quantity Pending Return)

The quantity of the order item that is pending return

line_items[].​quantity_returnedQuantity Returned (integer)(Quantity Returned)

The quantity of the order item that has been returned

One of:

The quantity of the order item that has been returned

integer(Quantity Returned)

The quantity of the order item that has been returned

line_items[].​quantity_shippedQuantity Shipped (integer)(Quantity Shipped)

The quantity of the order item that has been shipped

One of:

The quantity of the order item that has been shipped

integer(Quantity Shipped)

The quantity of the order item that has been shipped

line_items[].​quantity_to_be_shippedinteger(Quantity To Be Shipped)

The quantity that is available to be shipped

line_items[].​related_record_idstring(Related Record)

The record related to this order

line_items[].​related_record_typestring(Related Record Type)

If theres a record related to this order, list it here

line_items[].​related_transactionsArray of objects
line_items[].​shippableboolean(Shippable)

Whether or not this item needs to be shipped

line_items[].​skustring(Sku)

The SKU of the product, if applicable

line_items[].​special_instructionsstring(Special Instructions)

Any special instructions for this item

line_items[].​statusStatus (string)(Status)

The order item status

Enum"awaiting payment""awaiting pickup""awaiting shipping""cancelled""completed""disputed""open""partially shipped""returned""shipped"
One of:

The order item status

string(Status)

The order item status

Enum"awaiting payment""awaiting pickup""awaiting shipping""cancelled""completed""disputed""open""partially shipped""returned""shipped"
line_items[].​taxesTaxes (number)(double)(Taxes)

Any taxes set on the order item

One of:

Any taxes set on the order item

number(double)(Taxes)

Any taxes set on the order item

line_items[].​totalTotal (number)(double)(Total)

Total amount of the order item

One of:

Total amount of the order item

number(double)(Total)

Total amount of the order item

line_items[].​total_in_base_currencyTotal In Base Currency (number)(double)(Total In Base Currency)

Total amount of the order

One of:

Total amount of the order

number(double)(Total In Base Currency)

Total amount of the order

line_items[].​typeType (string)(Type)

The type of order item

Enum"bundled product""cancellation""credit card processing fee""discount""inline bundled product""item""shipping""taxes"
One of:

The type of order item

string(Type)

The type of order item

Enum"bundled product""cancellation""credit card processing fee""discount""inline bundled product""item""shipping""taxes"
line_items[].​unit_priceUnit Price (number)(double)(Unit Price)

The unit price of the item

One of:

The unit price of the item

number(double)(Unit Price)

The unit price of the item

line_items[].​variant_optionsArray of objects
line_items[].​weightnumber(double)(Weight)

The weight of this item

memostring(Memo)

Additional information for the order

notesstring(Notes)

Notes on the order

numberinteger(Number)

The number of the order

override_order_dateboolean(Override Order Date)

If true, the system should override the order date

pay_for_credit_card_processing_feesboolean(Pay For Credit Card Processing Fees)

If set, this order should be charged credit card processing fees

pay_using_multiple_methodsboolean(Pay Using Multiple Methods)

If set, the order will be paid using more than one payment method

payloadobject(Payload)

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

payment_infoobject(Payment Info)
payment_methodstring(Payment Method)

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"
preview_idstring(Preview)

The caching key to use during preview

process_idstring(Process)

If a process was used to create this order, that process ID is listed here

purchase_order_numberstring(Purchase Order Number)

The customer P.O. number

send_email_confirmation_to_customerboolean(Send Email Confirmation To Customer)

Whether or not to send an email confirmation to the bill to and ship to

ship_to_contact_idstring(Ship To Contact)required

The contact being shipped to

ship_to_namestring(Ship To Name)

The addressee

ship_to_organization_idstring(Ship To Organization)required

The organization being shipped to

ship_to_typestring(Ship To Type)required

The type of customer being shipped to

Enum"contact""organization"
shippableboolean(Shippable)

Whether or not this order needs to be shipped

shipping_addressobject(Address)

A complete address

shipping_chargesnumber(double)(Shipping Charges)required

Shipping charges for the order

shipping_method_idstring(Shipping Method)

The ID of the shipping method for this order

shipping_method_namestring(Shipping Method Name)

The name of the shipping method for this order

shipping_method_typestring(Shipping Method Type)

The type of shipping method

Enum"flat rate""free""pickup""ship by""ups"
shipping_zone_idstring(Shipping Zone)

The id of the shipping zone

special_instructionsstring(Special Instructions)

Any special instructions for this order

statusstring(Status)required

The order status

Enum"awaiting payment""awaiting pickup""awaiting shipping""cancelled""completed""disputed""open""partially shipped""returned""shipped"
store_idstring(Store)required

The online store

submission_datestring(date-time)(Submission Date)

The date and time the order was actually submitted

subtotalnumber(double)(Subtotal)required

Order subtotal before taxes/shipping/discounts

success_notice_idstring(Success Notice)

The billing notice to run when this order succeeds; we track it here only to pass it back through the billing service

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_shippable_statusstring(Sys Shippable Status)

System property - do not use

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

taxesnumber(double)(Taxes)required

Taxes associated with the order

totalnumber(double)(Total)required

Total amount of the order

total_in_base_currencynumber(double)(Total In Base Currency)required

Total amount of the order

total_weightnumber(double)(Total Weight)

The total weight of the order

typestring(Type)

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"
use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

Set if the invoices for the order should be pro forma

]
Response
application/json
[
  {
    "additional_email_confirmation_recipients": [ … ],
    "additional_payments": [ … ],
    "amount_paid": 0.1,
    "amount_pending_capture": 0.1,
    "amount_refunded": 0.1,
    "balance_due": 0.1,
    "base_currency_code": "string",
    "base_currency_symbol": "string",
    "batch_id": "string",
    "bill_parent_organization": true,
    "bill_to_contact_id": "string",
    "bill_to_organization_id": "string",
    "bill_to_type": "contact",
    "billing_address": { … },
    "billing_run_action_id": "string",
    "billing_run_id": "string",
    "billing_run_service": "string",
    "business_unit_id": "string",
    "copy_shipping_info_from_billing_info": true,
    "coupons": [ … ],
    "credit_usages": [ … ],
    "currency_code": "AED",
    "currency_symbol": "string",
    "custom_field_values": [ … ],
    "custom_metadata": {},
    "date": "string",
    "default_merchant_account_id": "string",
    "discounts": 0.1,
    "do_not_apply_open_credits": true,
    "duplicate_prevention_key": "string",
    "event_id": "string",
    "exchange_rate": 0.1,
    "expiration_date": "2019-08-24T14:15:22Z",
    "failure_notice_id": "string",
    "id": "string",
    "installment_schedule_id": "string",
    "invoice_terms_id": "string",
    "line_items": [ … ],
    "memo": "string",
    "notes": "string",
    "number": 0,
    "override_order_date": true,
    "pay_for_credit_card_processing_fees": true,
    "pay_using_multiple_methods": true,
    "payload": {},
    "payment_info": { … },
    "payment_method": "ach",
    "preview_id": "string",
    "process_id": "string",
    "purchase_order_number": "string",
    "send_email_confirmation_to_customer": true,
    "ship_to_contact_id": "string",
    "ship_to_name": "string",
    "ship_to_organization_id": "string",
    "ship_to_type": "contact",
    "shippable": true,
    "shipping_address": { … },
    "shipping_charges": 0.1,
    "shipping_method_id": "string",
    "shipping_method_name": "string",
    "shipping_method_type": "flat rate",
    "shipping_zone_id": "string",
    "special_instructions": "string",
    "status": "awaiting payment",
    "store_id": "string",
    "submission_date": "2019-08-24T14:15:22Z",
    "subtotal": 0.1,
    "success_notice_id": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [ … ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_shippable_status": "string",
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "taxes": 0.1,
    "total": 0.1,
    "total_in_base_currency": 0.1,
    "total_weight": 0.1,
    "type": "advertising insertion order",
    "use_pro_forma_invoices": true
  }
]

Processes a order

Request

This method will auto-generate an ID and create a new order. If an ID is specified for the order, an error will be thrown.

Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The order that you would like to be saved.

additional_email_confirmation_recipientsArray of strings(Additional Email Confirmation Recipients)

Additional emails to send confirmation

additional_paymentsArray of objectsnon-emptyrequired
additional_payments[].​line_item_idsArray of strings(Line Items)

The order line items that this additional payment should apply to

additional_payments[].​payment_infoobject(Payment Info)
amount_paidnumber(double)(Amount Paid)required

Amount paid on the order

amount_pending_capturenumber(double)(Amount Pending Capture)required

The amount that has been authorized, but not yet captured

amount_refundednumber(double)(Amount Refunded)required

Amount refunded on the order

balance_duenumber(double)(Balance Due)required

Balance due on the order

base_currency_codestring(Base Currency Code)
base_currency_symbolstring(Base Currency Symbol)
batch_idstring(Batch)

The batch the order should be in

bill_parent_organizationboolean(Bill Parent Organization)

If true, the parent organization is billed

bill_to_contact_idstring(Bill To Contact)required

The contact being billed

bill_to_organization_idstring(Bill To Organization)required

The organization being billed

bill_to_typestring(Bill To Type)required

The type of customer being billed

Enum"contact""organization"
billing_addressobject(Address)

A complete address

billing_run_action_idstring(Billing Run Action)

The billing run action that created this order; we track it here only to pass it back through the billing service

billing_run_idstring(Billing Run)

If this is part of a billing run, the ID

billing_run_servicestring(Billing Run Service)

If this order was generated by a billing run, the service that initiated it

business_unit_idstring(Business Unit)

The business unit of the order

copy_shipping_info_from_billing_infoboolean(Copy Shipping Info From Billing Info)

Indicates that the shipping information was copied from the billing info. For reporting use only

couponsArray of objects
credit_usagesArray of objects

Credits to use when paying the invoices on this order

currency_codestring(Currency Code)

The order currency

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
currency_symbolstring(Currency Symbol)

The currency symbol

custom_field_valuesArray of objects(Custom Field Values)
custom_metadataobject(Custom Metadata)

Custom metadata that can be used by custom order generation processes for hyper-customized order & invoice forms

datestring(Date)

The date of the order

default_merchant_account_idstring(Default Merchant Account)

The default, calculated merchant account id

discountsnumber(double)(Discounts)required

Amount of discounts for the order

do_not_apply_open_creditsboolean(Do Not Apply Open Credits)

If set, open credits are not applied to this order

duplicate_prevention_keystring(Duplicate Prevention Key)

Temporary value used to prevent duplicate submissions

event_idstring(Event)required

The event

exchange_ratenumber(double)(Exchange Rate)

The exchange rate, if applicable

expiration_datestring(date-time)(Expiration Date)

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

failure_notice_idstring(Failure Notice)

The billing notice to run when this order succeeds; we track it here only to pass it back through the billing service

idstring(ID)^[\w|-]+$required

The unique, string identifier of this order

installment_schedule_idstring(Installment Schedule)

If this is tied to an installment schedule

invoice_terms_idstring(Invoice Terms)

The terms to be used for generating the invoice

line_itemsArray of objectsnon-emptyrequired
line_items[].​amount_paidAmount Paid (number)(double)(Amount Paid)

Amount paid on the order item

One of:

Amount paid on the order item

number(double)(Amount Paid)

Amount paid on the order item

line_items[].​amount_pending_captureAmount Pending Capture (number)(double)(Amount Pending Capture)

The amount that has been authorized, but not yet captured on this item

One of:

The amount that has been authorized, but not yet captured on this item

number(double)(Amount Pending Capture)

The amount that has been authorized, but not yet captured on this item

line_items[].​amount_refundedAmount Refunded (number)(double)(Amount Refunded)

Amount refunded on the order item

One of:

Amount refunded on the order item

number(double)(Amount Refunded)

Amount refunded on the order item

line_items[].​amount_to_pay_upon_creationAmount To Pay Upon Creation (number)(double)(Amount To Pay Upon Creation)

The amount of this item that should be paid immediately

One of:

The amount of this item that should be paid immediately

number(double)(Amount To Pay Upon Creation)

The amount of this item that should be paid immediately

line_items[].​balance_dueBalance Due (number)(double)(Balance Due)

Balance due on the order item

One of:

Balance due on the order item

number(double)(Balance Due)

Balance due on the order item

line_items[].​bundled_product_1object(Bundled Product 1)
line_items[].​bundled_product_2object(Bundled Product 2)
line_items[].​descriptionstring(Description)

Optional description of the line item

line_items[].​discountsDiscounts (number)(double)(Discounts)

Any discounts set on the order item

One of:

Any discounts set on the order item

number(double)(Discounts)

Any discounts set on the order item

line_items[].​has_inline_bundled_productsboolean(Has Inline Bundled Products)

If true, this line item has inline products bundled with it

line_items[].​inline_bundled_productsArray of objectsnon-empty
One of:
non-empty
line_items[].​installment_plan_idInstallment Plan (string)(Installment Plan)

The installment plan to use for this item

One of:

The installment plan to use for this item

string(Installment Plan)

The installment plan to use for this item

line_items[].​installment_schedule_typestring(Installment Schedule Type)

If creating an installment plan, the type to create

Enum"based on installment plan""perpetual"
line_items[].​modifier_optionsArray of objects
line_items[].​optionalboolean(Optional)

Whether or not this is an "optional" item

line_items[].​order_line_item_idOrder Line Item (string)(Order Line Item)

A unique identifier for the order item

One of:

A unique identifier for the order item

string(Order Line Item)

A unique identifier for the order item

line_items[].​override_ship_to_contact_idOverride Ship To Contact (string)(Override Ship To Contact)

The contact being shipped to

One of:

The contact being shipped to

string(Override Ship To Contact)

The contact being shipped to

line_items[].​override_ship_to_organization_idOverride Ship To Organization (string)(Override Ship To Organization)

The organization being shipped to

One of:

The organization being shipped to

string(Override Ship To Organization)

The organization being shipped to

line_items[].​override_ship_to_typestring(Override Ship To Type)

The type of customer being shipped to

Enum"contact""organization"
line_items[].​parent_line_item_idstring(Parent Line Item)

If this is a linked item, the parent linkage

line_items[].​parent_order_line_item_idstring(Parent Order Line Item)

The parent item, if applicable

line_items[].​payloadobject(Payload)

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

line_items[].​payload_idstring(Payload)

Product specific payload used by the product service to process/fulfill the order

line_items[].​perpetual_installment_schedule_optionsPerpetual Installment Schedule Options (object)(Perpetual Installment Schedule Options)
One of:
line_items[].​product_idstring(Product)required

The id of the product

line_items[].​product_typestring(Product Type)required

The type of product

line_items[].​quantityinteger(Quantity)

The quantity of the order item

line_items[].​quantity_available_for_cancellationQuantity Available For Cancellation (integer)(Quantity Available For Cancellation)

The quantity of the order item that can be cancelled

One of:

The quantity of the order item that can be cancelled

integer(Quantity Available For Cancellation)

The quantity of the order item that can be cancelled

line_items[].​quantity_available_for_returnQuantity Available For Return (integer)(Quantity Available For Return)

The quantity of the order item that can be returned

One of:

The quantity of the order item that can be returned

integer(Quantity Available For Return)

The quantity of the order item that can be returned

line_items[].​quantity_cancelledQuantity Cancelled (integer)(Quantity Cancelled)

The quantity of the order item that has been cancelled

One of:

The quantity of the order item that has been cancelled

integer(Quantity Cancelled)

The quantity of the order item that has been cancelled

line_items[].​quantity_pending_returnQuantity Pending Return (integer)(Quantity Pending Return)

The quantity of the order item that is pending return

One of:

The quantity of the order item that is pending return

integer(Quantity Pending Return)

The quantity of the order item that is pending return

line_items[].​quantity_returnedQuantity Returned (integer)(Quantity Returned)

The quantity of the order item that has been returned

One of:

The quantity of the order item that has been returned

integer(Quantity Returned)

The quantity of the order item that has been returned

line_items[].​quantity_shippedQuantity Shipped (integer)(Quantity Shipped)

The quantity of the order item that has been shipped

One of:

The quantity of the order item that has been shipped

integer(Quantity Shipped)

The quantity of the order item that has been shipped

line_items[].​quantity_to_be_shippedinteger(Quantity To Be Shipped)

The quantity that is available to be shipped

line_items[].​related_record_idstring(Related Record)

The record related to this order

line_items[].​related_record_typestring(Related Record Type)

If theres a record related to this order, list it here

line_items[].​related_transactionsArray of objects
line_items[].​shippableboolean(Shippable)

Whether or not this item needs to be shipped

line_items[].​skustring(Sku)

The SKU of the product, if applicable

line_items[].​special_instructionsstring(Special Instructions)

Any special instructions for this item

line_items[].​statusStatus (string)(Status)

The order item status

Enum"awaiting payment""awaiting pickup""awaiting shipping""cancelled""completed""disputed""open""partially shipped""returned""shipped"
One of:

The order item status

string(Status)

The order item status

Enum"awaiting payment""awaiting pickup""awaiting shipping""cancelled""completed""disputed""open""partially shipped""returned""shipped"
line_items[].​taxesTaxes (number)(double)(Taxes)

Any taxes set on the order item

One of:

Any taxes set on the order item

number(double)(Taxes)

Any taxes set on the order item

line_items[].​totalTotal (number)(double)(Total)

Total amount of the order item

One of:

Total amount of the order item

number(double)(Total)

Total amount of the order item

line_items[].​total_in_base_currencyTotal In Base Currency (number)(double)(Total In Base Currency)

Total amount of the order

One of:

Total amount of the order

number(double)(Total In Base Currency)

Total amount of the order

line_items[].​typeType (string)(Type)

The type of order item

Enum"bundled product""cancellation""credit card processing fee""discount""inline bundled product""item""shipping""taxes"
One of:

The type of order item

string(Type)

The type of order item

Enum"bundled product""cancellation""credit card processing fee""discount""inline bundled product""item""shipping""taxes"
line_items[].​unit_priceUnit Price (number)(double)(Unit Price)

The unit price of the item

One of:

The unit price of the item

number(double)(Unit Price)

The unit price of the item

line_items[].​variant_optionsArray of objects
line_items[].​weightnumber(double)(Weight)

The weight of this item

memostring(Memo)

Additional information for the order

notesstring(Notes)

Notes on the order

numberinteger(Number)

The number of the order

override_order_dateboolean(Override Order Date)

If true, the system should override the order date

pay_for_credit_card_processing_feesboolean(Pay For Credit Card Processing Fees)

If set, this order should be charged credit card processing fees

pay_using_multiple_methodsboolean(Pay Using Multiple Methods)

If set, the order will be paid using more than one payment method

payloadobject(Payload)

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

payment_infoobject(Payment Info)
payment_methodstring(Payment Method)

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"
preview_idstring(Preview)

The caching key to use during preview

process_idstring(Process)

If a process was used to create this order, that process ID is listed here

purchase_order_numberstring(Purchase Order Number)

The customer P.O. number

send_email_confirmation_to_customerboolean(Send Email Confirmation To Customer)

Whether or not to send an email confirmation to the bill to and ship to

ship_to_contact_idstring(Ship To Contact)required

The contact being shipped to

ship_to_namestring(Ship To Name)

The addressee

ship_to_organization_idstring(Ship To Organization)required

The organization being shipped to

ship_to_typestring(Ship To Type)required

The type of customer being shipped to

Enum"contact""organization"
shippableboolean(Shippable)

Whether or not this order needs to be shipped

shipping_addressobject(Address)

A complete address

shipping_chargesnumber(double)(Shipping Charges)required

Shipping charges for the order

shipping_method_idstring(Shipping Method)

The ID of the shipping method for this order

shipping_method_namestring(Shipping Method Name)

The name of the shipping method for this order

shipping_method_typestring(Shipping Method Type)

The type of shipping method

Enum"flat rate""free""pickup""ship by""ups"
shipping_zone_idstring(Shipping Zone)

The id of the shipping zone

special_instructionsstring(Special Instructions)

Any special instructions for this order

statusstring(Status)required

The order status

Enum"awaiting payment""awaiting pickup""awaiting shipping""cancelled""completed""disputed""open""partially shipped""returned""shipped"
store_idstring(Store)required

The online store

submission_datestring(date-time)(Submission Date)

The date and time the order was actually submitted

subtotalnumber(double)(Subtotal)required

Order subtotal before taxes/shipping/discounts

success_notice_idstring(Success Notice)

The billing notice to run when this order succeeds; we track it here only to pass it back through the billing service

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_shippable_statusstring(Sys Shippable Status)

System property - do not use

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

taxesnumber(double)(Taxes)required

Taxes associated with the order

totalnumber(double)(Total)required

Total amount of the order

total_in_base_currencynumber(double)(Total In Base Currency)required

Total amount of the order

total_weightnumber(double)(Total Weight)

The total weight of the order

typestring(Type)

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"
use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

Set if the invoices for the order should be pro forma

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/orders/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "additional_email_confirmation_recipients": [
      "string"
    ],
    "additional_payments": [
      {
        "line_item_ids": [
          "string"
        ],
        "payment_info": {
          "electronic_payment_info": {
            "card_expiration": "2019-08-24",
            "card_type": "american express",
            "merchant_account_id": "string",
            "merchant_account_tokens": [
              {
                "merchant_account_id": "string",
                "token": "string"
              }
            ],
            "payment_account": "string",
            "payment_origin": "ad hoc",
            "token": "string"
          },
          "non_electronic_payment_info": {
            "bank_account_id": "string",
            "reference_number": "string"
          },
          "type": "ach"
        }
      }
    ],
    "amount_paid": 0.1,
    "amount_pending_capture": 0.1,
    "amount_refunded": 0.1,
    "balance_due": 0.1,
    "base_currency_code": "string",
    "base_currency_symbol": "string",
    "batch_id": "string",
    "bill_parent_organization": true,
    "bill_to_contact_id": "string",
    "bill_to_organization_id": "string",
    "bill_to_type": "contact",
    "billing_address": {
      "city": "string",
      "country": "string",
      "country_name": "string",
      "county": "string",
      "latitude": 0.1,
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "longitude": 0.1,
      "postal_code": "string",
      "state": "string",
      "time_zone_id": "string"
    },
    "billing_run_action_id": "string",
    "billing_run_id": "string",
    "billing_run_service": "string",
    "business_unit_id": "string",
    "copy_shipping_info_from_billing_info": true,
    "coupons": [
      {
        "coupon_code_id": "string",
        "coupon_id": "string",
        "coupon_type": "string",
        "discount": 0.1,
        "order_line_item_ids": [
          "string"
        ],
        "retroactive_application_date": "2019-08-24T14:15:22Z"
      }
    ],
    "credit_usages": [
      {
        "amount_to_use": 0.1,
        "credit_id": "string"
      }
    ],
    "currency_code": "AED",
    "currency_symbol": "string",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "custom_metadata": {},
    "date": "string",
    "default_merchant_account_id": "string",
    "discounts": 0.1,
    "do_not_apply_open_credits": true,
    "duplicate_prevention_key": "string",
    "event_id": "string",
    "exchange_rate": 0.1,
    "expiration_date": "2019-08-24T14:15:22Z",
    "failure_notice_id": "string",
    "id": "string",
    "installment_schedule_id": "string",
    "invoice_terms_id": "string",
    "line_items": [
      {
        "amount_paid": null,
        "amount_pending_capture": null,
        "amount_refunded": null,
        "amount_to_pay_upon_creation": null,
        "balance_due": null,
        "bundled_product_1": {
          "amount": 0.1,
          "product_id": "string",
          "product_type": "string"
        },
        "bundled_product_2": {
          "amount": 0.1,
          "product_id": "string",
          "product_type": "string"
        },
        "description": "string",
        "discounts": null,
        "has_inline_bundled_products": true,
        "inline_bundled_products": {
          "0": {
            "amount": 0.1,
            "product_id": "string",
            "product_type": "string"
          }
        },
        "installment_plan_id": null,
        "installment_schedule_type": "based on installment plan",
        "modifier_options": [
          {
            "option_id": "string",
            "option_name": "string",
            "value": "string"
          }
        ],
        "optional": true,
        "order_line_item_id": null,
        "override_ship_to_contact_id": null,
        "override_ship_to_organization_id": null,
        "override_ship_to_type": "contact",
        "parent_line_item_id": "string",
        "parent_order_line_item_id": "string",
        "payload": {},
        "payload_id": "string",
        "perpetual_installment_schedule_options": {
          "end_date": "string",
          "number_of_units": 1,
          "unit_of_time": "months"
        },
        "product_id": "string",
        "product_type": "string",
        "quantity": 0,
        "quantity_available_for_cancellation": null,
        "quantity_available_for_return": null,
        "quantity_cancelled": null,
        "quantity_pending_return": null,
        "quantity_returned": null,
        "quantity_shipped": null,
        "quantity_to_be_shipped": 0,
        "related_record_id": "string",
        "related_record_type": "string",
        "related_transactions": [
          {
            "amount": 0.1,
            "date": "2019-08-24T14:15:22Z",
            "transaction_id": "string",
            "transaction_line_item_id": "string",
            "transaction_number": 0.1,
            "type": "cancellation"
          }
        ],
        "shippable": true,
        "sku": "string",
        "special_instructions": "string",
        "status": "awaiting payment",
        "taxes": null,
        "total": null,
        "total_in_base_currency": null,
        "type": "bundled product",
        "unit_price": null,
        "variant_options": [
          {
            "option_id": "string",
            "option_name": "string",
            "value": "string"
          }
        ],
        "weight": 0.1
      }
    ],
    "memo": "string",
    "notes": "string",
    "number": 0,
    "override_order_date": true,
    "pay_for_credit_card_processing_fees": true,
    "pay_using_multiple_methods": true,
    "payload": {},
    "payment_info": {
      "electronic_payment_info": {
        "card_expiration": "2019-08-24",
        "card_type": "american express",
        "merchant_account_id": "string",
        "merchant_account_tokens": [
          {
            "merchant_account_id": "string",
            "token": "string"
          }
        ],
        "payment_account": "string",
        "payment_origin": "ad hoc",
        "token": "string"
      },
      "non_electronic_payment_info": {
        "bank_account_id": "string",
        "reference_number": "string"
      },
      "type": "ach"
    },
    "payment_method": "ach",
    "preview_id": "string",
    "process_id": "string",
    "purchase_order_number": "string",
    "send_email_confirmation_to_customer": true,
    "ship_to_contact_id": "string",
    "ship_to_name": "string",
    "ship_to_organization_id": "string",
    "ship_to_type": "contact",
    "shippable": true,
    "shipping_address": {
      "city": "string",
      "country": "string",
      "country_name": "string",
      "county": "string",
      "latitude": 0.1,
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "longitude": 0.1,
      "postal_code": "string",
      "state": "string",
      "time_zone_id": "string"
    },
    "shipping_charges": 0.1,
    "shipping_method_id": "string",
    "shipping_method_name": "string",
    "shipping_method_type": "flat rate",
    "shipping_zone_id": "string",
    "special_instructions": "string",
    "status": "awaiting payment",
    "store_id": "string",
    "submission_date": "2019-08-24T14:15:22Z",
    "subtotal": 0.1,
    "success_notice_id": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_shippable_status": "string",
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "taxes": 0.1,
    "total": 0.1,
    "total_in_base_currency": 0.1,
    "total_weight": 0.1,
    "type": "advertising insertion order",
    "use_pro_forma_invoices": true
  }'

Responses

The order process was started

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
executionArnstring(Executionarn)required

The arn of the execution

notification_channelstring(Notification Channel)

The id of the channel where progress updates will be posted

notification_publishKeystring(Notification Publishkey)

The publish key for the channel where progress updates will be posted

notification_subscribeKeystring(Notification Subscribekey)

The subscribe key for the channel where progress updates will be posted

start_datestring(date-time)(Start Date)

The start date of the execution

Response
application/json
{
  "executionArn": "string",
  "notification_channel": "string",
  "notification_publishKey": "string",
  "notification_subscribeKey": "string",
  "start_date": "2019-08-24T14:15:22Z"
}

Execute Batch Operations

Request

TAllows you to perform up to 100 parallel patch/delete operations

Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The batch request

operationsArray of objects
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/orders/{tenantId}/batch' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "operations": [
      {
        "id": null,
        "object": {},
        "operation": "create",
        "patch_directives": {
          "0": {
            "op": "add",
            "path": "string",
            "value": "string"
          }
        }
      }
    ]
  }'

Responses

Request completed successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
error_countnumber(float)(Error Count)

Number of error results

resultsArray of objects
success_countnumber(float)(Success Count)

Number of successful results

Response
application/json
{
  "error_count": 0.1,
  "results": [
    { … }
  ],
  "success_count": 0.1
}

Product Categories

Product Categories

Operations

Product Confirmation Emails

Product Confirmation Emails

Operations

Product Inventories

Product Inventories

Operations

Query Definitions

Query Definitions

Operations

Returns

Returns

Operations

Settings

Settings

Operations

Shared Modifier Options

Shared Modifier Options

Operations

Shared Variant Options

Shared Variant Options

Operations

Shipments

Shipments

Operations

Shipping Configurations

Shipping Configurations

Operations

Shipping Products

Shipping Products

Operations

Statistics

Statistics

Operations

Stores

Stores

Operations

Tax Classes

Tax Classes

Operations

Tax Configurations

Tax Configurations

Operations

Tax Products

Tax Products

Operations

Warehouse Bins

Warehouse Bins

Operations

Warehouses

Warehouses

Operations