v1

latestOpenAPI 3.0.02026-07-14455376855.8 KB
orders/

orders/

Performs persist operations for a specified order.

post/V1/orders/

Request body

Response

200 Success.

adjustment_negativenumber

Negative adjustment value.

adjustment_positivenumber

Positive adjustment value.

applied_rule_idsstring

Applied rule IDs.

base_adjustment_negativenumber

Base negative adjustment value.

base_adjustment_positivenumber

Base positive adjustment value.

base_currency_codestring

Base currency code.

base_discount_amountnumber

Base discount amount.

base_discount_cancelednumber

Base discount canceled.

base_discount_invoicednumber

Base discount invoiced.

base_discount_refundednumber

Base discount refunded.

base_discount_tax_compensation_amountnumber

Base discount tax compensation amount.

base_discount_tax_compensation_invoicednumber

Base discount tax compensation invoiced.

base_discount_tax_compensation_refundednumber

Base discount tax compensation refunded.

base_grand_totalnumber required

Base grand total.

base_shipping_amountnumber

Base shipping amount.

base_shipping_cancelednumber

Base shipping canceled.

base_shipping_discount_amountnumber

Base shipping discount amount.

base_shipping_discount_tax_compensation_amntnumber

Base shipping discount tax compensation amount.

base_shipping_incl_taxnumber

Base shipping including tax.

base_shipping_invoicednumber

Base shipping invoiced.

base_shipping_refundednumber

Base shipping refunded.

base_shipping_tax_amountnumber

Base shipping tax amount.

base_shipping_tax_refundednumber

Base shipping tax refunded.

base_subtotalnumber

Base subtotal.

base_subtotal_cancelednumber

Base subtotal canceled.

base_subtotal_incl_taxnumber

Base subtotal including tax.

base_subtotal_invoicednumber

Base subtotal invoiced.

base_subtotal_refundednumber

Base subtotal refunded.

base_tax_amountnumber

Base tax amount.

base_tax_cancelednumber

Base tax canceled.

base_tax_invoicednumber

Base tax invoiced.

base_tax_refundednumber

Base tax refunded.

base_to_global_ratenumber

Base-to-global rate.

base_to_order_ratenumber

Base-to-order rate.

base_total_cancelednumber

Base total canceled.

base_total_duenumber

Base total due.

base_total_invoicednumber

Base total invoiced.

base_total_invoiced_costnumber

Base total invoiced cost.

base_total_offline_refundednumber

Base total offline refunded.

base_total_online_refundednumber

Base total online refunded.

base_total_paidnumber

Base total paid.

base_total_qty_orderednumber

Base total quantity ordered.

base_total_refundednumber

Base total refunded.

billing_address_idinteger

Billing address ID.

can_ship_partiallyinteger

Can-ship-partially flag value.

can_ship_partially_iteminteger

Can-ship-partially-item flag value.

coupon_codestring

Coupon code.

created_atstring

Created-at timestamp.

customer_dobstring

Customer date-of-birth (DOB).

customer_emailstring required

Customer email address.

customer_firstnamestring

Customer first name.

customer_genderinteger

Customer gender.

customer_group_idinteger

Customer group ID.

customer_idinteger

Customer ID.

customer_is_guestinteger

Customer-is-guest flag value.

customer_lastnamestring

Customer last name.

customer_middlenamestring

Customer middle name.

customer_notestring

Customer note.

customer_note_notifyinteger

Customer-note-notify flag value.

customer_prefixstring

Customer prefix.

customer_suffixstring

Customer suffix.

customer_taxvatstring

Customer value-added tax (VAT).

discount_amountnumber

Discount amount.

discount_cancelednumber

Discount canceled.

discount_descriptionstring

Discount description.

discount_invoicednumber

Discount invoiced.

discount_refundednumber

Discount refunded amount.

discount_tax_compensation_amountnumber

Discount tax compensation amount.

discount_tax_compensation_invoicednumber

Discount tax compensation invoiced amount.

discount_tax_compensation_refundednumber

Discount tax compensation refunded amount.

edit_incrementinteger

Edit increment value.

email_sentinteger

Email-sent flag value.

entity_idinteger

Order ID.

ext_customer_idstring

External customer ID.

ext_order_idstring

External order ID.

forced_shipment_with_invoiceinteger

Forced-shipment-with-invoice flag value.

global_currency_codestring

Global currency code.

grand_totalnumber required

Grand total.

hold_before_statestring

Hold before state.

hold_before_statusstring

Hold before status.

increment_idstring

Increment ID.

is_virtualinteger

Is-virtual flag value.

order_currency_codestring

Order currency code.

original_increment_idstring

Original increment ID.

payment_auth_expirationinteger

Payment authorization expiration date.

payment_authorization_amountnumber

Payment authorization amount.

protect_codestring

Protect code.

quote_address_idinteger

Quote address ID.

quote_idinteger

Quote ID.

relation_child_idstring

Relation child ID.

relation_child_real_idstring

Relation child real ID.

relation_parent_idstring

Relation parent ID.

relation_parent_real_idstring

Relation parent real ID.

remote_ipstring

Remote IP address.

shipping_amountnumber

Shipping amount.

shipping_cancelednumber

Shipping canceled amount.

shipping_descriptionstring

Shipping description.

shipping_discount_amountnumber

Shipping discount amount.

shipping_discount_tax_compensation_amountnumber

Shipping discount tax compensation amount.

shipping_incl_taxnumber

Shipping including tax amount.

shipping_invoicednumber

Shipping invoiced amount.

shipping_refundednumber

Shipping refunded amount.

shipping_tax_amountnumber

Shipping tax amount.

shipping_tax_refundednumber

Shipping tax refunded amount.

statestring

State.

statusstring

Status.

store_currency_codestring

Store currency code.

store_idinteger

Store ID.

store_namestring

Store name.

store_to_base_ratenumber

Store-to-base rate.

store_to_order_ratenumber

Store-to-order rate.

subtotalnumber

Subtotal.

subtotal_cancelednumber

Subtotal canceled amount.

subtotal_incl_taxnumber

Subtotal including tax amount.

subtotal_invoicednumber

Subtotal invoiced amount.

subtotal_refundednumber

Subtotal refunded amount.

tax_amountnumber

Tax amount.

tax_cancelednumber

Tax canceled amount.

tax_invoicednumber

Tax invoiced amount.

tax_refundednumber

Tax refunded amount.

total_cancelednumber

Total canceled.

total_duenumber

Total due.

total_invoicednumber

Total invoiced amount.

total_item_countinteger

Total item count.

total_offline_refundednumber

Total offline refunded amount.

total_online_refundednumber

Total online refunded amount.

total_paidnumber

Total paid.

total_qty_orderednumber

Total quantity ordered.

total_refundednumber

Total amount refunded.

updated_atstring

Updated-at timestamp.

weightnumber

Weight.

x_forwarded_forstring

X-Forwarded-For field value.