Orders

Processes a order

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.

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Request Body schema: application/json

The order that you would like to be saved.

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this order
number	integer (Number) The number of the order
duplicate_prevention_key	string (Duplicate Prevention Key) Temporary value used to prevent duplicate submissions
batch_id	string (Batch) The batch the order should be in
override_order_date	boolean (Override Order Date) If true, the system should override the order date
date	string (Date) The date of the order
submission_date	string <date-time> (Submission Date) The date and time the order was actually submitted
preview_id	string (Preview) The caching key to use during preview
copy_shipping_info_from_billing_info	boolean (Copy Shipping Info From Billing Info) Indicates that the shipping information was copied from the billing info. For reporting use only
pay_for_credit_card_processing_fees	boolean (Pay For Credit Card Processing Fees) If set, this order should be charged credit card processing fees
ship_to_type required	string (Ship To Type) The type of customer being shipped to Enum: "organization" "contact"
installment_schedule_id	string (Installment Schedule) If this is tied to an installment schedule
ship_to_contact_id required	string (Ship To Contact) The contact being shipped to
ship_to_organization_id required	string (Ship To Organization) The organization being shipped to
bill_to_type required	string (Bill To Type) The type of customer being billed Enum: "organization" "contact"
bill_to_contact_id required	string (Bill To Contact) The contact being billed
bill_to_organization_id required	string (Bill To Organization) The organization being billed
bill_parent_organization	boolean (Bill Parent Organization) If true, the parent organization is billed
send_email_confirmation_to_customer	boolean (Send Email Confirmation To Customer) Whether or not to send an email confirmation to the bill to and ship to
additional_email_confirmation_recipients	Array of strings (Additional Email Confirmation Recipients) Additional emails to send confirmation
type	string (Type) The type of order Enum: "preview" "online store" "membership" "group membership" "event registration" "exhibitor registration" "certification application" "certification exam registration" "certification course registration" "award application" "advertising insertion order" "subscription" "sponsorship" "fundraising gift" "fundraising pledge" "career center" "donation form" "legacy"
store_id required	string (Store) The online store
event_id required	string (Event) The event
memo	string (Memo) Additional information for the order
balance_due required	number <double> (Balance Due) Balance due on the order
amount_paid required	number <double> (Amount Paid) Amount paid on the order
amount_pending_capture required	number <double> (Amount Pending Capture) The amount that has been authorized, but not yet captured
amount_refunded required	number <double> (Amount Refunded) Amount refunded on the order
subtotal required	number <double> (Subtotal) Order subtotal before taxes/shipping/discounts
taxes required	number <double> (Taxes) Taxes associated with the order
shipping_charges required	number <double> (Shipping Charges) Shipping charges for the order
discounts required	number <double> (Discounts) Amount of discounts for the order
total required	number <double> (Total) Total amount of the order
total_in_base_currency required	number <double> (Total In Base Currency) Total amount of the order
base_currency_code	string (Base Currency Code)
base_currency_symbol	string (Base Currency Symbol)
expiration_date	string <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
billing_run_service	string (Billing Run Service) If this order was generated by a billing run, the service that initiated it
billing_run_id	string (Billing Run) If this is part of a billing run, the ID
billing_run_action_id	string (Billing Run Action) The billing run action that created this order; we track it here only to pass it back through the billing service
success_notice_id	string (Success Notice) The billing notice to run when this order succeeds; we track it here only to pass it back through the billing service
failure_notice_id	string (Failure Notice) The billing notice to run when this order succeeds; we track it here only to pass it back through the billing service
	object (Address) A complete address
ship_to_name	string (Ship To Name) The addressee
	object (Address) A complete address
status required	string (Status) The order status Enum: "awaiting payment" "awaiting shipping" "awaiting pickup" "partially shipped" "shipped" "completed" "cancelled" "disputed" "open" "returned" "void"
use_pro_forma_invoices	boolean (Use Pro Forma Invoices) Set if the invoices for the order should be pro forma
purchase_order_number	string (Purchase Order Number) The customer P.O. number
exchange_rate	number <double> (Exchange Rate) The exchange rate, if applicable
currency_code	string (Currency Code) 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"
currency_symbol	string (Currency Symbol) The currency symbol
invoice_terms_id	string (Invoice Terms) The terms to be used for generating the invoice
business_unit_id	string (Business Unit) The business unit of the order
process_id	string (Process) If a process was used to create this order, that process ID is listed here
default_merchant_account_id	string (Default Merchant Account) The default, calculated merchant account id
	Array of objects
payload	object (Payload) Any optional order payload for processing; used by some fulfillment processes (like fundraising) to support transient objects
shipping_zone_id	string (Shipping Zone) The id of the shipping zone
shipping_method_type	string (Shipping Method Type) The type of shipping method Enum: "free" "flat rate" "ship by" "pickup" "ups"
shipping_method_id	string (Shipping Method) The ID of the shipping method for this order
shipping_method_name	string (Shipping Method Name) The name of the shipping method for this order
do_not_apply_open_credits	boolean (Do Not Apply Open Credits) If set, open credits are not applied to this order
	Array of objects Credits to use when paying the invoices on this order
pay_using_multiple_methods	boolean (Pay Using Multiple Methods) If set, the order will be paid using more than one payment method
payment_method	string (Payment Method) For reporting use only, the payment method of this order Enum: "credit card" "electronic check" "cash" "check" "cashiers check" "money order" "purchase order" "payroll deduction" "wire transfer" "ach" "offline credit card" "store credit" "none"
	object (Payment Info)
required	Array of objects non-empty
shippable	boolean (Shippable) Whether or not this order needs to be shipped
total_weight	number <double> (Total Weight) The total weight of the order
required	Array of objects non-empty
notes	string (Notes) Notes on the order
special_instructions	string (Special Instructions) Any special instructions for this order
	Array of objects (Custom Field Values)
sys_shippable_status	string (Sys Shippable Status) System property - do not use
sys_deleted_by_id	string (Sys Deleted By) The ID of the user that deleted (or last tried to delete) this object
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_pk	string (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_at	string (Sys Bulk Load At) If this record was loaded via bulk, the timestamp when the record was processed
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_last_bulk_data_operation_id	string (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_version	string (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_directive	string (Sys Directive) Means for passing directive information into an object processing logic
sys_calculated_field_error	string (Sys Calculated Field Error) The error associated with the calculated field
sys_snapshot_base_version	number <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_has_files_in_s3	boolean (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_configuration_snapshot_id	string (Sys Configuration Snapshot) If a snapshot was restored/applies to this record, the ID of the snapshot
sys_last_security_context	object (Sys Last Security Context) The security context of the last insert, modify, or delete performed on this item
	Array of objects

Responses

200The order process was started

400The order you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

409The order could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add order based on tenant limits.

500General server error.

post/orders/{tenantId}

Request samples

application/json

{"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

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

Gets all of the orders in the system.

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

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned.
exclusiveStartKey	string The start key, if you're making a subsequent request

Responses

200The orderswere retrieved successfully.

400The request was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

429Limit exceeded... unable to add contact role based on tenant limits.

500General server error.

get/orders/{tenantId}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/orders/:tenantId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

[{"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": null,
"token": null
}
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
]

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

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed

Request Body schema: application/json

The order that you would like to be saved.

	object (Order)
	object (OrderOverrideManifest)

Responses

200The order preview was successful

400The order record you supplied was invalid.

401Unauthorized

403Forbidden

404The resource could not be found

409The order could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add order based on tenant limits.

500General server error

post/orders/{tenantId}/processWithOverride

Request samples

application/json

{"order": {"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": null,
"token": null
}
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
},
"override_manifest": {"line_items": [{"order_line_item_id": "string",
"override_unit_price": 0,
"override_quantity": 0,
"override_total": 0
}
]
}
}

Response samples

application/json

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

Applies a coupon to an existing order

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

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed

Request Body schema: application/json

The order that you would like to be saved.

order_id required	string (Order)
coupon_code_id required	string (Coupon Code)
	object (Options)

Responses

200The order preview was successful

400The order record you supplied was invalid.

401Unauthorized

403Forbidden

404The resource could not be found

409The order could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add order based on tenant limits.

500General server error

post/orders/{tenantId}/retroactivelyApplyCoupon

Request samples

application/json

{"order_id": "string",
"coupon_code_id": "string",
"options": {"batch_id": "string",
"action": "refund",
"ignore_payment_gateway_errors": true,
"do_not_perform_electronic_refund": true
}
}

Response samples

application/json

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

Returns a order from the system by its ID.

This method will look up a order by the specified ID and return it back.

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the order to return.

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned.
consistentRead	string Indicates the API should force a consistent read on the data source.

Responses

200The order was retrieved successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The order could not be found.

429Limit exceeded... unable to retrieve order based on tenant limits.

500General server error.

get/orders/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/orders/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Updates a order with the specified ID.

This method will update an existing order with the specified ID.

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the order to update.

Request Body schema: application/json

The updated order that will be saved.

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this order
number	integer (Number) The number of the order
duplicate_prevention_key	string (Duplicate Prevention Key) Temporary value used to prevent duplicate submissions
batch_id	string (Batch) The batch the order should be in
override_order_date	boolean (Override Order Date) If true, the system should override the order date
date	string (Date) The date of the order
submission_date	string <date-time> (Submission Date) The date and time the order was actually submitted
preview_id	string (Preview) The caching key to use during preview
copy_shipping_info_from_billing_info	boolean (Copy Shipping Info From Billing Info) Indicates that the shipping information was copied from the billing info. For reporting use only
pay_for_credit_card_processing_fees	boolean (Pay For Credit Card Processing Fees) If set, this order should be charged credit card processing fees
ship_to_type required	string (Ship To Type) The type of customer being shipped to Enum: "organization" "contact"
installment_schedule_id	string (Installment Schedule) If this is tied to an installment schedule
ship_to_contact_id required	string (Ship To Contact) The contact being shipped to
ship_to_organization_id required	string (Ship To Organization) The organization being shipped to
bill_to_type required	string (Bill To Type) The type of customer being billed Enum: "organization" "contact"
bill_to_contact_id required	string (Bill To Contact) The contact being billed
bill_to_organization_id required	string (Bill To Organization) The organization being billed
bill_parent_organization	boolean (Bill Parent Organization) If true, the parent organization is billed
send_email_confirmation_to_customer	boolean (Send Email Confirmation To Customer) Whether or not to send an email confirmation to the bill to and ship to
additional_email_confirmation_recipients	Array of strings (Additional Email Confirmation Recipients) Additional emails to send confirmation
type	string (Type) The type of order Enum: "preview" "online store" "membership" "group membership" "event registration" "exhibitor registration" "certification application" "certification exam registration" "certification course registration" "award application" "advertising insertion order" "subscription" "sponsorship" "fundraising gift" "fundraising pledge" "career center" "donation form" "legacy"
store_id required	string (Store) The online store
event_id required	string (Event) The event
memo	string (Memo) Additional information for the order
balance_due required	number <double> (Balance Due) Balance due on the order
amount_paid required	number <double> (Amount Paid) Amount paid on the order
amount_pending_capture required	number <double> (Amount Pending Capture) The amount that has been authorized, but not yet captured
amount_refunded required	number <double> (Amount Refunded) Amount refunded on the order
subtotal required	number <double> (Subtotal) Order subtotal before taxes/shipping/discounts
taxes required	number <double> (Taxes) Taxes associated with the order
shipping_charges required	number <double> (Shipping Charges) Shipping charges for the order
discounts required	number <double> (Discounts) Amount of discounts for the order
total required	number <double> (Total) Total amount of the order
total_in_base_currency required	number <double> (Total In Base Currency) Total amount of the order
base_currency_code	string (Base Currency Code)
base_currency_symbol	string (Base Currency Symbol)
expiration_date	string <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
billing_run_service	string (Billing Run Service) If this order was generated by a billing run, the service that initiated it
billing_run_id	string (Billing Run) If this is part of a billing run, the ID
billing_run_action_id	string (Billing Run Action) The billing run action that created this order; we track it here only to pass it back through the billing service
success_notice_id	string (Success Notice) The billing notice to run when this order succeeds; we track it here only to pass it back through the billing service
failure_notice_id	string (Failure Notice) The billing notice to run when this order succeeds; we track it here only to pass it back through the billing service
	object (Address) A complete address
ship_to_name	string (Ship To Name) The addressee
	object (Address) A complete address
status required	string (Status) The order status Enum: "awaiting payment" "awaiting shipping" "awaiting pickup" "partially shipped" "shipped" "completed" "cancelled" "disputed" "open" "returned" "void"
use_pro_forma_invoices	boolean (Use Pro Forma Invoices) Set if the invoices for the order should be pro forma
purchase_order_number	string (Purchase Order Number) The customer P.O. number
exchange_rate	number <double> (Exchange Rate) The exchange rate, if applicable
currency_code	string (Currency Code) 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"
currency_symbol	string (Currency Symbol) The currency symbol
invoice_terms_id	string (Invoice Terms) The terms to be used for generating the invoice
business_unit_id	string (Business Unit) The business unit of the order
process_id	string (Process) If a process was used to create this order, that process ID is listed here
default_merchant_account_id	string (Default Merchant Account) The default, calculated merchant account id
	Array of objects
payload	object (Payload) Any optional order payload for processing; used by some fulfillment processes (like fundraising) to support transient objects
shipping_zone_id	string (Shipping Zone) The id of the shipping zone
shipping_method_type	string (Shipping Method Type) The type of shipping method Enum: "free" "flat rate" "ship by" "pickup" "ups"
shipping_method_id	string (Shipping Method) The ID of the shipping method for this order
shipping_method_name	string (Shipping Method Name) The name of the shipping method for this order
do_not_apply_open_credits	boolean (Do Not Apply Open Credits) If set, open credits are not applied to this order
	Array of objects Credits to use when paying the invoices on this order
pay_using_multiple_methods	boolean (Pay Using Multiple Methods) If set, the order will be paid using more than one payment method
payment_method	string (Payment Method) For reporting use only, the payment method of this order Enum: "credit card" "electronic check" "cash" "check" "cashiers check" "money order" "purchase order" "payroll deduction" "wire transfer" "ach" "offline credit card" "store credit" "none"
	object (Payment Info)
required	Array of objects non-empty
shippable	boolean (Shippable) Whether or not this order needs to be shipped
total_weight	number <double> (Total Weight) The total weight of the order
required	Array of objects non-empty
notes	string (Notes) Notes on the order
special_instructions	string (Special Instructions) Any special instructions for this order
	Array of objects (Custom Field Values)
sys_shippable_status	string (Sys Shippable Status) System property - do not use
sys_deleted_by_id	string (Sys Deleted By) The ID of the user that deleted (or last tried to delete) this object
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_pk	string (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_at	string (Sys Bulk Load At) If this record was loaded via bulk, the timestamp when the record was processed
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_last_bulk_data_operation_id	string (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_version	string (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_directive	string (Sys Directive) Means for passing directive information into an object processing logic
sys_calculated_field_error	string (Sys Calculated Field Error) The error associated with the calculated field
sys_snapshot_base_version	number <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_has_files_in_s3	boolean (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_configuration_snapshot_id	string (Sys Configuration Snapshot) If a snapshot was restored/applies to this record, the ID of the snapshot
sys_last_security_context	object (Sys Last Security Context) The security context of the last insert, modify, or delete performed on this item
	Array of objects

Responses

200The order was updated successfully.

400The order supplied was not valid.

401Unauthorized.

403Forbidden.

404The order could not be found.

409The order could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve order based on tenant limits.

500General server error.

put/orders/{tenantId}/{id}

Request samples

application/json

{"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Partially updates a order with the specified ID.

This method will patch an existing order with the specified ID, using the HTTP PATCH specification.

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the order to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array

op required	string (Op) The operation Enum: "add" "remove" "replace" "move" "copy" "test"
path required	string (Path) The JSON path
value	string (Value)

Responses

200The order was patched successfully.

400The JSON patch directive you supplied was not valid.

401Unauthorized.

403Forbidden.

404The order could not be found.

409The order could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve order based on tenant limits.

500General server error.

patch/orders/{tenantId}/{id}

Request samples

application/json

[{"op": "add",
"path": "string",
"value": "string"
}
]

Response samples

application/json

{"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Returns a order from the system by its ID.

This method will delete a order with the specified ID.

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the order to delete.

Responses

200The order was deleted successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The order could not be found.

409The order could not be deleted because other objects refers to/depends on this one.

429Limit exceeded... unable to delete order based on tenant limits.

500General server error.

delete/orders/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X DELETE \
  https://commerce.api.756794052567.rhythmsoftware.com/orders/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

"string"

Searches for orders using predefined parameters

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

query Parameters

exclusiveStartKey	string The start key for the search, for paging support
fieldsToReturn	string The fields that you want to retrieve; if omitted, the entire object is returned

Request Body schema: application/json

The order that you would like to be saved.

date	Array of strings (Date) 2 items
number	Array of numbers <float> (Number) 2 items
total	Array of numbers <float> (Total) 2 items
id	Array of strings (ID)
type	Array of strings (Type)
status	Array of strings (Status)
purchase_order_number	Array of strings (Purchase Order Number)
shipping_method_name	Array of strings (Shipping Method Name)
amount_paid	Array of numbers <float> (Amount Paid) 2 items
discounts	Array of numbers <float> (Discounts) 2 items
total_weight	Array of numbers <float> (Total Weight) 2 items
bill_to_type	string (Bill To Type) Enum: "contact" "organization"
ship_to_type	string (Ship To Type) Enum: "contact" "organization"
bill_to_contact_id	string (Bill To Contact)
bill_to_organization_id	string (Bill To Organization)
ship_to_contact_id	string (Ship To Contact)
ship_to_organization_id	string (Ship To Organization)
balance_due	Array of numbers <float> (Balance Due) 2 items

Responses

200The order search was saved successfully.

400The order you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

409The order could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add order based on tenant limits.

500General server error.

post/orders/{tenantId}/search

Request samples

application/json

{"date": ["string",
"string"
],
"number": [0,
0
],
"total": [0,
0
],
"id": ["string"
],
"type": ["string"
],
"status": ["string"
],
"purchase_order_number": ["string"
],
"shipping_method_name": ["string"
],
"amount_paid": [0,
0
],
"discounts": [0,
0
],
"total_weight": [0,
0
],
"bill_to_type": "contact",
"ship_to_type": "contact",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"balance_due": [0,
0
]
}

Response samples

application/json

{"Items": [{"ids": "string",
"date": "string",
"number": 0,
"total": 0,
"id": "string",
"type": "string",
"status": "string",
"purchase_order_number": "string",
"shipping_method_name": "string",
"amount_paid": 0,
"discounts": 0,
"total_weight": 0,
"bill_to_type": "contact",
"ship_to_type": "contact",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"balance_due": 0
}
],
"LastEvaluatedKey": "string"
}

Preview an order

This method takes in an order that has not yet been placed, and returns information about order pricing and available options

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed

Request Body schema: application/json

The order that you would like to be saved.

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this order
number	integer (Number) The number of the order
duplicate_prevention_key	string (Duplicate Prevention Key) Temporary value used to prevent duplicate submissions
batch_id	string (Batch) The batch the order should be in
override_order_date	boolean (Override Order Date) If true, the system should override the order date
date	string (Date) The date of the order
submission_date	string <date-time> (Submission Date) The date and time the order was actually submitted
preview_id	string (Preview) The caching key to use during preview
copy_shipping_info_from_billing_info	boolean (Copy Shipping Info From Billing Info) Indicates that the shipping information was copied from the billing info. For reporting use only
pay_for_credit_card_processing_fees	boolean (Pay For Credit Card Processing Fees) If set, this order should be charged credit card processing fees
ship_to_type required	string (Ship To Type) The type of customer being shipped to Enum: "organization" "contact"
installment_schedule_id	string (Installment Schedule) If this is tied to an installment schedule
ship_to_contact_id required	string (Ship To Contact) The contact being shipped to
ship_to_organization_id required	string (Ship To Organization) The organization being shipped to
bill_to_type required	string (Bill To Type) The type of customer being billed Enum: "organization" "contact"
bill_to_contact_id required	string (Bill To Contact) The contact being billed
bill_to_organization_id required	string (Bill To Organization) The organization being billed
bill_parent_organization	boolean (Bill Parent Organization) If true, the parent organization is billed
send_email_confirmation_to_customer	boolean (Send Email Confirmation To Customer) Whether or not to send an email confirmation to the bill to and ship to
additional_email_confirmation_recipients	Array of strings (Additional Email Confirmation Recipients) Additional emails to send confirmation
type	string (Type) The type of order Enum: "preview" "online store" "membership" "group membership" "event registration" "exhibitor registration" "certification application" "certification exam registration" "certification course registration" "award application" "advertising insertion order" "subscription" "sponsorship" "fundraising gift" "fundraising pledge" "career center" "donation form" "legacy"
store_id required	string (Store) The online store
event_id required	string (Event) The event
memo	string (Memo) Additional information for the order
balance_due required	number <double> (Balance Due) Balance due on the order
amount_paid required	number <double> (Amount Paid) Amount paid on the order
amount_pending_capture required	number <double> (Amount Pending Capture) The amount that has been authorized, but not yet captured
amount_refunded required	number <double> (Amount Refunded) Amount refunded on the order
subtotal required	number <double> (Subtotal) Order subtotal before taxes/shipping/discounts
taxes required	number <double> (Taxes) Taxes associated with the order
shipping_charges required	number <double> (Shipping Charges) Shipping charges for the order
discounts required	number <double> (Discounts) Amount of discounts for the order
total required	number <double> (Total) Total amount of the order
total_in_base_currency required	number <double> (Total In Base Currency) Total amount of the order
base_currency_code	string (Base Currency Code)
base_currency_symbol	string (Base Currency Symbol)
expiration_date	string <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
billing_run_service	string (Billing Run Service) If this order was generated by a billing run, the service that initiated it
billing_run_id	string (Billing Run) If this is part of a billing run, the ID
billing_run_action_id	string (Billing Run Action) The billing run action that created this order; we track it here only to pass it back through the billing service
success_notice_id	string (Success Notice) The billing notice to run when this order succeeds; we track it here only to pass it back through the billing service
failure_notice_id	string (Failure Notice) The billing notice to run when this order succeeds; we track it here only to pass it back through the billing service
	object (Address) A complete address
ship_to_name	string (Ship To Name) The addressee
	object (Address) A complete address
status required	string (Status) The order status Enum: "awaiting payment" "awaiting shipping" "awaiting pickup" "partially shipped" "shipped" "completed" "cancelled" "disputed" "open" "returned" "void"
use_pro_forma_invoices	boolean (Use Pro Forma Invoices) Set if the invoices for the order should be pro forma
purchase_order_number	string (Purchase Order Number) The customer P.O. number
exchange_rate	number <double> (Exchange Rate) The exchange rate, if applicable
currency_code	string (Currency Code) 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"
currency_symbol	string (Currency Symbol) The currency symbol
invoice_terms_id	string (Invoice Terms) The terms to be used for generating the invoice
business_unit_id	string (Business Unit) The business unit of the order
process_id	string (Process) If a process was used to create this order, that process ID is listed here
default_merchant_account_id	string (Default Merchant Account) The default, calculated merchant account id
	Array of objects
payload	object (Payload) Any optional order payload for processing; used by some fulfillment processes (like fundraising) to support transient objects
shipping_zone_id	string (Shipping Zone) The id of the shipping zone
shipping_method_type	string (Shipping Method Type) The type of shipping method Enum: "free" "flat rate" "ship by" "pickup" "ups"
shipping_method_id	string (Shipping Method) The ID of the shipping method for this order
shipping_method_name	string (Shipping Method Name) The name of the shipping method for this order
do_not_apply_open_credits	boolean (Do Not Apply Open Credits) If set, open credits are not applied to this order
	Array of objects Credits to use when paying the invoices on this order
pay_using_multiple_methods	boolean (Pay Using Multiple Methods) If set, the order will be paid using more than one payment method
payment_method	string (Payment Method) For reporting use only, the payment method of this order Enum: "credit card" "electronic check" "cash" "check" "cashiers check" "money order" "purchase order" "payroll deduction" "wire transfer" "ach" "offline credit card" "store credit" "none"
	object (Payment Info)
required	Array of objects non-empty
shippable	boolean (Shippable) Whether or not this order needs to be shipped
total_weight	number <double> (Total Weight) The total weight of the order
required	Array of objects non-empty
notes	string (Notes) Notes on the order
special_instructions	string (Special Instructions) Any special instructions for this order
	Array of objects (Custom Field Values)
sys_shippable_status	string (Sys Shippable Status) System property - do not use
sys_deleted_by_id	string (Sys Deleted By) The ID of the user that deleted (or last tried to delete) this object
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_pk	string (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_at	string (Sys Bulk Load At) If this record was loaded via bulk, the timestamp when the record was processed
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_last_bulk_data_operation_id	string (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_version	string (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_directive	string (Sys Directive) Means for passing directive information into an object processing logic
sys_calculated_field_error	string (Sys Calculated Field Error) The error associated with the calculated field
sys_snapshot_base_version	number <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_has_files_in_s3	boolean (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_configuration_snapshot_id	string (Sys Configuration Snapshot) If a snapshot was restored/applies to this record, the ID of the snapshot
sys_last_security_context	object (Sys Last Security Context) The security context of the last insert, modify, or delete performed on this item
	Array of objects

Responses

200The order preview was successful

400The order record you supplied was invalid.

401Unauthorized

403Forbidden

404The resource could not be found

409The order could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add order based on tenant limits.

500General server error

post/orders/{tenantId}/preview

Request samples

application/json

{"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"manifest": {"errors": [{"code": "NO_DEFAULT_SHIPPING_PRODUCT",
"order_line_item_id": "string",
"message": "string"
}
],
"open_credits": [{"id": "string",
"date": "2019-08-24",
"number": 0,
"amount_available": 0,
"currency_code": "string"
}
],
"open_credit_balance": 0,
"shipping_options": [{"id": "string",
"name": "string",
"cost": 0,
"display_order": 0,
"do_not_show_in_portal": true
}
],
"product_availability": [{"order_line_item_id": "string",
"status": "SOLD_OUT"
}
],
"payments_due": [{"merchant_account_id": "string",
"amount_due": 0
}
],
"total_amount_due_at_checkout": 0,
"primary_amount_due_at_checkout": 0,
"additional_payments_due_at_checkout": 0
},
"order": {"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": null,
"token": null
}
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
},
"products": [{ }
],
"line_item_mappings": { }
}

Closes an Order

Closes an order

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed
id required	string The id of the order

Responses

200The order preview was successful

400The order record you supplied was invalid.

401Unauthorized

403Forbidden

404The resource could not be found

409The order could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add order based on tenant limits.

500General server error

post/orders/{tenantId}/close/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X POST \
  https://commerce.api.756794052567.rhythmsoftware.com/orders/:tenantId/close/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Preview an order

This method takes in an order that has not yet been placed, and returns information about order pricing and available options

Request

path Parameters

tenantId

required

string

The id of the tenant being accessed

Request Body schema: application/json

The products you want to describe

customer_type	string (Customer Type) Enum: "contact" "organization"
customer_id	string (Customer)
business_unit_id required	string (Business Unit)
	Array of objects

Responses

200The order preview was successful

400The order record you supplied was invalid.

401Unauthorized

403Forbidden

404The resource could not be found

409The order could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add order based on tenant limits.

500General server error

post/orders/{tenantId}/public/describeProducts

Request samples

application/json

{"customer_type": "contact",
"customer_id": "string",
"business_unit_id": "string",
"products": [{"type": "string",
"id": "string",
"variant_options": [{"option_id": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"value": "string"
}
]
}
]
}

Response samples

application/json

{"products": [{"type": "string",
"id": "string",
"price": 0,
"ineligible": true,
"availability": "OK"
}
]
}

Gets the availability of merchandise

Takes in merchandise and determines it's availability

Request

path Parameters

tenantId

required

string

The id of the tenant being accessed

Request Body schema: application/json

The order that you would like to be saved.

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this order
number	integer (Number) The number of the order
duplicate_prevention_key	string (Duplicate Prevention Key) Temporary value used to prevent duplicate submissions
batch_id	string (Batch) The batch the order should be in
override_order_date	boolean (Override Order Date) If true, the system should override the order date
date	string (Date) The date of the order
submission_date	string <date-time> (Submission Date) The date and time the order was actually submitted
preview_id	string (Preview) The caching key to use during preview
copy_shipping_info_from_billing_info	boolean (Copy Shipping Info From Billing Info) Indicates that the shipping information was copied from the billing info. For reporting use only
pay_for_credit_card_processing_fees	boolean (Pay For Credit Card Processing Fees) If set, this order should be charged credit card processing fees
ship_to_type required	string (Ship To Type) The type of customer being shipped to Enum: "organization" "contact"
installment_schedule_id	string (Installment Schedule) If this is tied to an installment schedule
ship_to_contact_id required	string (Ship To Contact) The contact being shipped to
ship_to_organization_id required	string (Ship To Organization) The organization being shipped to
bill_to_type required	string (Bill To Type) The type of customer being billed Enum: "organization" "contact"
bill_to_contact_id required	string (Bill To Contact) The contact being billed
bill_to_organization_id required	string (Bill To Organization) The organization being billed
bill_parent_organization	boolean (Bill Parent Organization) If true, the parent organization is billed
send_email_confirmation_to_customer	boolean (Send Email Confirmation To Customer) Whether or not to send an email confirmation to the bill to and ship to
additional_email_confirmation_recipients	Array of strings (Additional Email Confirmation Recipients) Additional emails to send confirmation
type	string (Type) The type of order Enum: "preview" "online store" "membership" "group membership" "event registration" "exhibitor registration" "certification application" "certification exam registration" "certification course registration" "award application" "advertising insertion order" "subscription" "sponsorship" "fundraising gift" "fundraising pledge" "career center" "donation form" "legacy"
store_id required	string (Store) The online store
event_id required	string (Event) The event
memo	string (Memo) Additional information for the order
balance_due required	number <double> (Balance Due) Balance due on the order
amount_paid required	number <double> (Amount Paid) Amount paid on the order
amount_pending_capture required	number <double> (Amount Pending Capture) The amount that has been authorized, but not yet captured
amount_refunded required	number <double> (Amount Refunded) Amount refunded on the order
subtotal required	number <double> (Subtotal) Order subtotal before taxes/shipping/discounts
taxes required	number <double> (Taxes) Taxes associated with the order
shipping_charges required	number <double> (Shipping Charges) Shipping charges for the order
discounts required	number <double> (Discounts) Amount of discounts for the order
total required	number <double> (Total) Total amount of the order
total_in_base_currency required	number <double> (Total In Base Currency) Total amount of the order
base_currency_code	string (Base Currency Code)
base_currency_symbol	string (Base Currency Symbol)
expiration_date	string <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
billing_run_service	string (Billing Run Service) If this order was generated by a billing run, the service that initiated it
billing_run_id	string (Billing Run) If this is part of a billing run, the ID
billing_run_action_id	string (Billing Run Action) The billing run action that created this order; we track it here only to pass it back through the billing service
success_notice_id	string (Success Notice) The billing notice to run when this order succeeds; we track it here only to pass it back through the billing service
failure_notice_id	string (Failure Notice) The billing notice to run when this order succeeds; we track it here only to pass it back through the billing service
	object (Address) A complete address
ship_to_name	string (Ship To Name) The addressee
	object (Address) A complete address
status required	string (Status) The order status Enum: "awaiting payment" "awaiting shipping" "awaiting pickup" "partially shipped" "shipped" "completed" "cancelled" "disputed" "open" "returned" "void"
use_pro_forma_invoices	boolean (Use Pro Forma Invoices) Set if the invoices for the order should be pro forma
purchase_order_number	string (Purchase Order Number) The customer P.O. number
exchange_rate	number <double> (Exchange Rate) The exchange rate, if applicable
currency_code	string (Currency Code) 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"
currency_symbol	string (Currency Symbol) The currency symbol
invoice_terms_id	string (Invoice Terms) The terms to be used for generating the invoice
business_unit_id	string (Business Unit) The business unit of the order
process_id	string (Process) If a process was used to create this order, that process ID is listed here
default_merchant_account_id	string (Default Merchant Account) The default, calculated merchant account id
	Array of objects
payload	object (Payload) Any optional order payload for processing; used by some fulfillment processes (like fundraising) to support transient objects
shipping_zone_id	string (Shipping Zone) The id of the shipping zone
shipping_method_type	string (Shipping Method Type) The type of shipping method Enum: "free" "flat rate" "ship by" "pickup" "ups"
shipping_method_id	string (Shipping Method) The ID of the shipping method for this order
shipping_method_name	string (Shipping Method Name) The name of the shipping method for this order
do_not_apply_open_credits	boolean (Do Not Apply Open Credits) If set, open credits are not applied to this order
	Array of objects Credits to use when paying the invoices on this order
pay_using_multiple_methods	boolean (Pay Using Multiple Methods) If set, the order will be paid using more than one payment method
payment_method	string (Payment Method) For reporting use only, the payment method of this order Enum: "credit card" "electronic check" "cash" "check" "cashiers check" "money order" "purchase order" "payroll deduction" "wire transfer" "ach" "offline credit card" "store credit" "none"
	object (Payment Info)
required	Array of objects non-empty
shippable	boolean (Shippable) Whether or not this order needs to be shipped
total_weight	number <double> (Total Weight) The total weight of the order
required	Array of objects non-empty
notes	string (Notes) Notes on the order
special_instructions	string (Special Instructions) Any special instructions for this order
	Array of objects (Custom Field Values)
sys_shippable_status	string (Sys Shippable Status) System property - do not use
sys_deleted_by_id	string (Sys Deleted By) The ID of the user that deleted (or last tried to delete) this object
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_pk	string (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_at	string (Sys Bulk Load At) If this record was loaded via bulk, the timestamp when the record was processed
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_last_bulk_data_operation_id	string (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_version	string (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_directive	string (Sys Directive) Means for passing directive information into an object processing logic
sys_calculated_field_error	string (Sys Calculated Field Error) The error associated with the calculated field
sys_snapshot_base_version	number <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_has_files_in_s3	boolean (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_configuration_snapshot_id	string (Sys Configuration Snapshot) If a snapshot was restored/applies to this record, the ID of the snapshot
sys_last_security_context	object (Sys Last Security Context) The security context of the last insert, modify, or delete performed on this item
	Array of objects

Responses

200The order preview was successful

400The order record you supplied was invalid.

401Unauthorized

403Forbidden

404The resource could not be found

409The order could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add order based on tenant limits.

500General server error

post/orders/{tenantId}/public/checkAvailability

Request samples

application/json

{"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Void an order

This method voids an order

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed
id required	string The id of the order that you would like to be voided.

Responses

200The order void was successful

400The order record you supplied was invalid.

401Unauthorized

403Forbidden

404The resource could not be found

409The order could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add order based on tenant limits.

500General server error

post/orders/{tenantId}/void/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X POST \
  https://commerce.api.756794052567.rhythmsoftware.com/orders/:tenantId/void/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Previews an order with line item overrides

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

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed

Request Body schema: application/json

The order that you would like to be saved.

	object (Order)
	object (OrderOverrideManifest)

Responses

200The order preview was successful

400The order record you supplied was invalid.

401Unauthorized

403Forbidden

404The resource could not be found

409The order could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add order based on tenant limits.

500General server error

post/orders/{tenantId}/previewWithOverride

Request samples

application/json

{"order": {"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": null,
"token": null
}
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
},
"override_manifest": {"line_items": [{"order_line_item_id": "string",
"override_unit_price": 0,
"override_quantity": 0,
"override_total": 0
}
]
}
}

Response samples

application/json

{"manifest": {"errors": [{"code": "NO_DEFAULT_SHIPPING_PRODUCT",
"order_line_item_id": "string",
"message": "string"
}
],
"open_credits": [{"id": "string",
"date": "2019-08-24",
"number": 0,
"amount_available": 0,
"currency_code": "string"
}
],
"open_credit_balance": 0,
"shipping_options": [{"id": "string",
"name": "string",
"cost": 0,
"display_order": 0,
"do_not_show_in_portal": true
}
],
"product_availability": [{"order_line_item_id": "string",
"status": "SOLD_OUT"
}
],
"payments_due": [{"merchant_account_id": "string",
"amount_due": 0
}
],
"total_amount_due_at_checkout": 0,
"primary_amount_due_at_checkout": 0,
"additional_payments_due_at_checkout": 0
},
"order": {"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": null,
"token": null
}
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
},
"products": [{ }
],
"line_item_mappings": { }
}

Returns a order from the system by its ID for a given contact.

This method will look up a order by the specified ID and return it back (for a portal contact)

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
portalContactId required	string The contact to use
id required	string The ID of the order to return.

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned.
consistentRead	string Indicates the API should force a consistent read on the data source.

Responses

200The order was retrieved successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The order could not be found.

429Limit exceeded... unable to retrieve order based on tenant limits.

500General server error.

get/orders/{tenantId}/portal/contact/{portalContactId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/orders/:tenantId/portal/contact/:portalContactId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Gets all of the orders in the system for a given contact.

This method will scan all orders and and return them to the caller for a given contact.

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
portalContactId required	string The contact to use

query Parameters

fields

string

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

Responses

200The orderswere retrieved successfully.

400The request was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

429Limit exceeded... unable to add contact role based on tenant limits.

500General server error.

get/orders/{tenantId}/portal/contact/{portalContactId}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/orders/:tenantId/portal/contact/:portalContactId?fields=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{ }
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Gets all of the orders in the system for a given organization.

This method will scan all orders and and return them to the caller for a given organization.

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
portalOrganizationId required	string The organization to use

query Parameters

fields

string

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

Responses

200The orderswere retrieved successfully.

400The request was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

429Limit exceeded... unable to add organization role based on tenant limits.

500General server error.

get/orders/{tenantId}/portal/organization/{portalOrganizationId}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/orders/:tenantId/portal/organization/:portalOrganizationId?fields=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{ }
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Returns a order from the system by its ID for a given organization.

This method will look up a order by the specified ID and return it back (for a portal organization)

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
portalOrganizationId required	string The organization to use
id required	string The ID of the order to return.

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned.
consistentRead	string Indicates the API should force a consistent read on the data source.

Responses

200The order was retrieved successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The order could not be found.

429Limit exceeded... unable to retrieve order based on tenant limits.

500General server error.

get/orders/{tenantId}/portal/organization/{portalOrganizationId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/orders/:tenantId/portal/organization/:portalOrganizationId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Previews an order publicly

This method takes in an order that has not yet been placed, and returns information about order pricing and available options

Request

path Parameters

tenantId

required

string

The id of the tenant being accessed

Request Body schema: application/json

The order that you would like to be saved.

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this order
number	integer (Number) The number of the order
duplicate_prevention_key	string (Duplicate Prevention Key) Temporary value used to prevent duplicate submissions
batch_id	string (Batch) The batch the order should be in
override_order_date	boolean (Override Order Date) If true, the system should override the order date
date	string (Date) The date of the order
submission_date	string <date-time> (Submission Date) The date and time the order was actually submitted
preview_id	string (Preview) The caching key to use during preview
copy_shipping_info_from_billing_info	boolean (Copy Shipping Info From Billing Info) Indicates that the shipping information was copied from the billing info. For reporting use only
pay_for_credit_card_processing_fees	boolean (Pay For Credit Card Processing Fees) If set, this order should be charged credit card processing fees
ship_to_type required	string (Ship To Type) The type of customer being shipped to Enum: "organization" "contact"
installment_schedule_id	string (Installment Schedule) If this is tied to an installment schedule
ship_to_contact_id required	string (Ship To Contact) The contact being shipped to
ship_to_organization_id required	string (Ship To Organization) The organization being shipped to
bill_to_type required	string (Bill To Type) The type of customer being billed Enum: "organization" "contact"
bill_to_contact_id required	string (Bill To Contact) The contact being billed
bill_to_organization_id required	string (Bill To Organization) The organization being billed
bill_parent_organization	boolean (Bill Parent Organization) If true, the parent organization is billed
send_email_confirmation_to_customer	boolean (Send Email Confirmation To Customer) Whether or not to send an email confirmation to the bill to and ship to
additional_email_confirmation_recipients	Array of strings (Additional Email Confirmation Recipients) Additional emails to send confirmation
type	string (Type) The type of order Enum: "preview" "online store" "membership" "group membership" "event registration" "exhibitor registration" "certification application" "certification exam registration" "certification course registration" "award application" "advertising insertion order" "subscription" "sponsorship" "fundraising gift" "fundraising pledge" "career center" "donation form" "legacy"
store_id required	string (Store) The online store
event_id required	string (Event) The event
memo	string (Memo) Additional information for the order
balance_due required	number <double> (Balance Due) Balance due on the order
amount_paid required	number <double> (Amount Paid) Amount paid on the order
amount_pending_capture required	number <double> (Amount Pending Capture) The amount that has been authorized, but not yet captured
amount_refunded required	number <double> (Amount Refunded) Amount refunded on the order
subtotal required	number <double> (Subtotal) Order subtotal before taxes/shipping/discounts
taxes required	number <double> (Taxes) Taxes associated with the order
shipping_charges required	number <double> (Shipping Charges) Shipping charges for the order
discounts required	number <double> (Discounts) Amount of discounts for the order
total required	number <double> (Total) Total amount of the order
total_in_base_currency required	number <double> (Total In Base Currency) Total amount of the order
base_currency_code	string (Base Currency Code)
base_currency_symbol	string (Base Currency Symbol)
expiration_date	string <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
billing_run_service	string (Billing Run Service) If this order was generated by a billing run, the service that initiated it
billing_run_id	string (Billing Run) If this is part of a billing run, the ID
billing_run_action_id	string (Billing Run Action) The billing run action that created this order; we track it here only to pass it back through the billing service
success_notice_id	string (Success Notice) The billing notice to run when this order succeeds; we track it here only to pass it back through the billing service
failure_notice_id	string (Failure Notice) The billing notice to run when this order succeeds; we track it here only to pass it back through the billing service
	object (Address) A complete address
ship_to_name	string (Ship To Name) The addressee
	object (Address) A complete address
status required	string (Status) The order status Enum: "awaiting payment" "awaiting shipping" "awaiting pickup" "partially shipped" "shipped" "completed" "cancelled" "disputed" "open" "returned" "void"
use_pro_forma_invoices	boolean (Use Pro Forma Invoices) Set if the invoices for the order should be pro forma
purchase_order_number	string (Purchase Order Number) The customer P.O. number
exchange_rate	number <double> (Exchange Rate) The exchange rate, if applicable
currency_code	string (Currency Code) 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"
currency_symbol	string (Currency Symbol) The currency symbol
invoice_terms_id	string (Invoice Terms) The terms to be used for generating the invoice
business_unit_id	string (Business Unit) The business unit of the order
process_id	string (Process) If a process was used to create this order, that process ID is listed here
default_merchant_account_id	string (Default Merchant Account) The default, calculated merchant account id
	Array of objects
payload	object (Payload) Any optional order payload for processing; used by some fulfillment processes (like fundraising) to support transient objects
shipping_zone_id	string (Shipping Zone) The id of the shipping zone
shipping_method_type	string (Shipping Method Type) The type of shipping method Enum: "free" "flat rate" "ship by" "pickup" "ups"
shipping_method_id	string (Shipping Method) The ID of the shipping method for this order
shipping_method_name	string (Shipping Method Name) The name of the shipping method for this order
do_not_apply_open_credits	boolean (Do Not Apply Open Credits) If set, open credits are not applied to this order
	Array of objects Credits to use when paying the invoices on this order
pay_using_multiple_methods	boolean (Pay Using Multiple Methods) If set, the order will be paid using more than one payment method
payment_method	string (Payment Method) For reporting use only, the payment method of this order Enum: "credit card" "electronic check" "cash" "check" "cashiers check" "money order" "purchase order" "payroll deduction" "wire transfer" "ach" "offline credit card" "store credit" "none"
	object (Payment Info)
required	Array of objects non-empty
shippable	boolean (Shippable) Whether or not this order needs to be shipped
total_weight	number <double> (Total Weight) The total weight of the order
required	Array of objects non-empty
notes	string (Notes) Notes on the order
special_instructions	string (Special Instructions) Any special instructions for this order
	Array of objects (Custom Field Values)
sys_shippable_status	string (Sys Shippable Status) System property - do not use
sys_deleted_by_id	string (Sys Deleted By) The ID of the user that deleted (or last tried to delete) this object
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_pk	string (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_at	string (Sys Bulk Load At) If this record was loaded via bulk, the timestamp when the record was processed
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_last_bulk_data_operation_id	string (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_version	string (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_directive	string (Sys Directive) Means for passing directive information into an object processing logic
sys_calculated_field_error	string (Sys Calculated Field Error) The error associated with the calculated field
sys_snapshot_base_version	number <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_has_files_in_s3	boolean (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_configuration_snapshot_id	string (Sys Configuration Snapshot) If a snapshot was restored/applies to this record, the ID of the snapshot
sys_last_security_context	object (Sys Last Security Context) The security context of the last insert, modify, or delete performed on this item
	Array of objects

Responses

200The order preview was successful

400The order record you supplied was invalid.

401Unauthorized

403Forbidden

404The resource could not be found

409The order could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add order based on tenant limits.

500General server error

post/orders/{tenantId}/public/preview

Request samples

application/json

{"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"manifest": {"errors": [{"code": "NO_DEFAULT_SHIPPING_PRODUCT",
"order_line_item_id": "string",
"message": "string"
}
],
"open_credits": [{"id": "string",
"date": "2019-08-24",
"number": 0,
"amount_available": 0,
"currency_code": "string"
}
],
"open_credit_balance": 0,
"shipping_options": [{"id": "string",
"name": "string",
"cost": 0,
"display_order": 0,
"do_not_show_in_portal": true
}
],
"product_availability": [{"order_line_item_id": "string",
"status": "SOLD_OUT"
}
],
"payments_due": [{"merchant_account_id": "string",
"amount_due": 0
}
],
"total_amount_due_at_checkout": 0,
"primary_amount_due_at_checkout": 0,
"additional_payments_due_at_checkout": 0
},
"order": {"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": null,
"token": null
}
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
},
"products": [{ }
],
"line_item_mappings": { }
}

Checks to see whether or not a person is eligible based on specified criteria

This method takes in an order that has not yet been placed, and returns information about order pricing and available options

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed
customerType required	string The type of customer
contactOrOrganizationId required	string The contact or organization ID

Request Body schema: application/json

The order that you would like to be saved.

object

Responses

200The order preview was successful

400The order record you supplied was invalid.

401Unauthorized

403Forbidden

404The resource could not be found

409The order could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add order based on tenant limits.

500General server error

post/orders/{tenantId}/checkEligibility/{customerType}/{contactOrOrganizationId}

Request samples

application/json

{ }

Response samples

application/json

{"eligible": true,
"reason": "string"
}

Checks to see whether or not a person is eligible based on specified criteria

This method takes in an order that has not yet been placed, and returns information about order pricing and available options

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed
customerType required	string The type of customer
billToId required	string The bill to contact ID

Request Body schema: application/json

The order that you would like to be saved.

object

Responses

200The order preview was successful

400The order record you supplied was invalid.

401Unauthorized

403Forbidden

404The resource could not be found

409The order could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add order based on tenant limits.

500General server error

post/orders/{tenantId}/checkPrice/{customerType}/{billToId}

Request samples

application/json

{ }

Response samples

application/json

{"price": 0
}

Returns a list of shippable orders with the specified status

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
status required	string The status to use to for record lookup

query Parameters

fields

string

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

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/orders/{tenantId}/shippable/status/{status}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/orders/:tenantId/shippable/status/:status?fields=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{ }
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

List orders by customer

Includes orders where ship to

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
customerType required	string The bill_to_contact_id to use to for record lookup
customerId required	string The customer id

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/orders/{tenantId}/customer/{customerType}/{customerId}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/orders/:tenantId/customer/:customerType/:customerId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{ }
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Returns a list of records with the specified bill_to_contact_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
bill_to_contact_id required	string The bill_to_contact_id to use to for record lookup

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/orders/{tenantId}/billToContact/{bill_to_contact_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/orders/:tenantId/billToContact/:bill_to_contact_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{ }
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Returns a list of records with the specified bill_to_organization_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
bill_to_organization_id required	string The bill_to_organization_id to use to for record lookup

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/orders/{tenantId}/billToOrganization/{bill_to_organization_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/orders/:tenantId/billToOrganization/:bill_to_organization_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{ }
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Returns a list of records with the specified coupon_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
coupon_type required	string The type of coupon
coupon_id required	string The coupon_id to use to for record lookup

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/orders/{tenantId}/coupon/{coupon_type}/{coupon_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/orders/:tenantId/coupon/:coupon_type/:coupon_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{ }
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Returns a list of records with the specified shippable_status

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
shippable_status required	string The shippable_status to use to for record lookup

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/orders/{tenantId}/shippableStatus/{shippable_status}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/orders/:tenantId/shippableStatus/:shippable_status?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{ }
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Returns a list of records with the specified coupon_code_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
coupon_code_id required	string The coupon_code_id to use to for record lookup

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/orders/{tenantId}/couponCodeUsages/{coupon_code_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/orders/:tenantId/couponCodeUsages/:coupon_code_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"order_id": "string",
"date": "2019-08-24T14:15:22Z",
"customer_id": "string",
"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"contact_id": "string",
"organization_id": "string",
"discount": 0,
"order_total": 0,
"order_number": 0
}
],
"LastEvaluatedKey": "string"
}

Returns a list of records with the specified coupon id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
coupon_type required	string The coupon_type to use to for record lookup
coupon_id required	string The coupon_id to use to for record lookup

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/orders/{tenantId}/couponUsages/{coupon_type}/{coupon_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/orders/:tenantId/couponUsages/:coupon_type/:coupon_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"order_id": "string",
"date": "2019-08-24T14:15:22Z",
"customer_id": "string",
"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"contact_id": "string",
"organization_id": "string",
"discount": 0,
"order_total": 0,
"order_number": 0
}
],
"LastEvaluatedKey": "string"
}

Sends out a preview of the CRC notification email

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The tenant

Request Body schema: application/json

The domain_name to use to for record lookup

order_id required	string (Order)
order_item_line_number	number <float> (Order Item Line Number) >= 1
	object (Email Template)
destination_email_address required	string (Destination Email Address)

Responses

200The record was retrieved successfully

400The request was not valid.

401Unauthorized

403Forbidden

404Unable to locate any organizations with the specified domain

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

post/orders/{tenantId}/previewProductConfirmationEmail

Request samples

application/json

{"order_id": "string",
"order_item_line_number": 1,
"email_template": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
},
"destination_email_address": "string"
}

Sends out a preview of the CRC notification email

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The tenant

Request Body schema: application/json

The domain_name to use to for record lookup

order_id required	string (Order)
	object (Email Template)
destination_email_address required	string (Destination Email Address)

Responses

200The record was retrieved successfully

400The request was not valid.

401Unauthorized

403Forbidden

404Unable to locate any organizations with the specified domain

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

post/orders/{tenantId}/previewOrderConfirmationEmail

Request samples

application/json

{"order_id": "string",
"email_template": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
},
"destination_email_address": "string"
}

Returns a list of records with the specified ship_to_contact_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
ship_to_contact_id required	string The ship_to_contact_id to use to for record lookup

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/orders/{tenantId}/shipToContact/{ship_to_contact_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/orders/:tenantId/shipToContact/:ship_to_contact_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{ }
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Returns a list of records with the specified ship_to_organization_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
ship_to_organization_id required	string The ship_to_organization_id to use to for record lookup

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/orders/{tenantId}/shipToOrganization/{ship_to_organization_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/orders/:tenantId/shipToOrganization/:ship_to_organization_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{ }
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Execute Batch Operations

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

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Request Body schema: application/json

The batch request

Array of objects

Responses

200Request completed successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The order could not be found.

429Limit exceeded... unable to retrieve order based on tenant limits.

500General server error.

post/orders/{tenantId}/batch

Request samples

application/json

{"operations": [{"operation": "create",
"id": "string",
"patch_directives": [{"op": "add",
"path": "string",
"value": "string"
}
],
"object": { }
}
]
}

Response samples

application/json

{"success_count": 0,
"error_count": 0,
"results": [{"operation": "create",
"id": "string",
"outcome": "success",
"error_message": "string",
"object": { }
}
]
}

Returns a list of records with the specified installment_schedule_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
installment_schedule_id required	string The installment_schedule_id to use to for record lookup

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/orders/{tenantId}/installmentSchedule/{installment_schedule_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/orders/:tenantId/installmentSchedule/:installment_schedule_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"number": 0,
"duplicate_prevention_key": "string",
"batch_id": "string",
"override_order_date": true,
"date": "string",
"submission_date": "2019-08-24T14:15:22Z",
"preview_id": "string",
"copy_shipping_info_from_billing_info": true,
"pay_for_credit_card_processing_fees": true,
"ship_to_type": "organization",
"installment_schedule_id": "string",
"ship_to_contact_id": "string",
"ship_to_organization_id": "string",
"bill_to_type": "organization",
"bill_to_contact_id": "string",
"bill_to_organization_id": "string",
"bill_parent_organization": true,
"send_email_confirmation_to_customer": true,
"additional_email_confirmation_recipients": ["string"
],
"type": "preview",
"store_id": "string",
"event_id": "string",
"memo": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"subtotal": 0,
"taxes": 0,
"shipping_charges": 0,
"discounts": 0,
"total": 0,
"total_in_base_currency": 0,
"base_currency_code": "string",
"base_currency_symbol": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"billing_run_service": "string",
"billing_run_id": "string",
"billing_run_action_id": "string",
"success_notice_id": "string",
"failure_notice_id": "string",
"billing_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"ship_to_name": "string",
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"country_name": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"status": "awaiting payment",
"use_pro_forma_invoices": true,
"purchase_order_number": "string",
"exchange_rate": 0,
"currency_code": "AED",
"currency_symbol": "string",
"invoice_terms_id": "string",
"business_unit_id": "string",
"process_id": "string",
"default_merchant_account_id": "string",
"coupons": [{"coupon_code_id": "string",
"coupon_type": "string",
"coupon_id": "string",
"discount": 0,
"retroactive_application_date": "2019-08-24T14:15:22Z",
"order_line_item_ids": ["string"
]
}
],
"payload": { },
"shipping_zone_id": "string",
"shipping_method_type": "free",
"shipping_method_id": "string",
"shipping_method_name": "string",
"do_not_apply_open_credits": true,
"credit_usages": [{"credit_id": "string",
"amount_to_use": 0
}
],
"pay_using_multiple_methods": true,
"payment_method": "credit card",
"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"merchant_account_id": "string"
}
},
"additional_payments": [{"payment_info": {"type": "credit card",
"non_electronic_payment_info": {"bank_account_id": "string",
"reference_number": "string"
},
"electronic_payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "2019-08-24",
"merchant_account_tokens": [{ }
],
"merchant_account_id": "string"
}
},
"line_item_ids": ["string"
]
}
],
"shippable": true,
"total_weight": 0,
"line_items": [{"product_type": "string",
"parent_order_line_item_id": "string",
"product_id": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"quantity_to_be_shipped": 0,
"quantity_shipped": 0,
"quantity_cancelled": 0,
"quantity_pending_return": 0,
"quantity_returned": 0,
"quantity_available_for_cancellation": 0,
"quantity_available_for_return": 0,
"override_ship_to_type": "organization",
"override_ship_to_contact_id": "string",
"override_ship_to_organization_id": "string",
"optional": true,
"type": "item",
"status": "awaiting payment",
"order_line_item_id": "string",
"parent_line_item_id": "string",
"balance_due": 0,
"amount_paid": 0,
"amount_to_pay_upon_creation": 0,
"amount_pending_capture": 0,
"amount_refunded": 0,
"total": 0,
"total_in_base_currency": 0,
"discounts": 0,
"taxes": 0,
"related_record_type": "string",
"related_record_id": "string",
"related_transactions": [{"type": "payment",
"transaction_id": "string",
"transaction_number": 0,
"transaction_line_item_id": "string",
"amount": 0,
"date": "2019-08-24T14:15:22Z"
}
],
"weight": 0,
"payload_id": "string",
"payload": { },
"installment_schedule_type": "based on installment plan",
"installment_plan_id": "string",
"perpetual_installment_schedule_options": {"number_of_units": 1,
"unit_of_time": "weeks",
"end_date": "string"
},
"shippable": true,
"special_instructions": "string",
"variant_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"modifier_options": [{"option_id": "string",
"option_name": "string",
"value": "string"
}
],
"sku": "string"
}
],
"notes": "string",
"special_instructions": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_shippable_status": "string",
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}