PUTSales · Magento 2.4.9 Admin · Magento_Sales::create
PUT /V1/orders/create
PUT /V1/orders/create is a Magento 2 REST endpoint in the Sales module. Performs persist operations for a specified order. Requires an admin Bearer token with ACL Magento_Sales::create.
Last verified: against Magento 2.4.9.
Returns
Magento\Sales\Api\Data\OrderInterface
Order interface.
Service contract
Magento\Sales\Api\OrderRepositoryInterface::save
Authorization
Admin Bearer token with ACL:
- Magento_Sales::create
Body parameters
entity Magento\Sales\Api\Data\OrderInterface Required
The order ID.
Example request
Auto-generated from the service contract — paste-ready against your store's /rest/default base. Replace the host, store code, ACL token, and any required values before running.
Headers
Path
/V1/orders/createBody
{
"entity": {
"adjustment_negative": 0,
"adjustment_positive": 0,
"applied_rule_ids": "",
"base_adjustment_negative": 0,
"base_adjustment_positive": 0,
"base_currency_code": "",
"base_discount_amount": 0,
"base_discount_canceled": 0,
"base_discount_invoiced": 0,
"base_discount_refunded": 0,
"base_discount_tax_compensation_amount": 0,
"base_discount_tax_compensation_invoiced": 0,
"base_discount_tax_compensation_refunded": 0,
"base_grand_total": 0,
"base_shipping_amount": 0,
"base_shipping_canceled": 0,
"base_shipping_discount_amount": 0,
"base_shipping_discount_tax_compensation_amnt": 0,
"base_shipping_incl_tax": 0,
"base_shipping_invoiced": 0,
"base_shipping_refunded": 0,
"base_shipping_tax_amount": 0,
"base_shipping_tax_refunded": 0,
"base_subtotal": 0,
"base_subtotal_canceled": 0,
"base_subtotal_incl_tax": 0,
"base_subtotal_invoiced": 0,
"base_subtotal_refunded": 0,
"base_tax_amount": 0,
"base_tax_canceled": 0,
"base_tax_invoiced": 0,
"base_tax_refunded": 0,
"base_to_global_rate": 0,
"base_to_order_rate": 0,
"base_total_canceled": 0,
"base_total_due": 0,
"base_total_invoiced": 0,
"base_total_invoiced_cost": 0,
"base_total_offline_refunded": 0,
"base_total_online_refunded": 0,
"base_total_paid": 0,
"base_total_qty_ordered": 0,
"base_total_refunded": 0,
"billing_address": {
"address_type": "",
"city": "",
"company": "",
"country_id": "",
"customer_address_id": 0,
"customer_id": 0,
"email": "",
"entity_id": 0,
"extension_attributes": {},
"fax": "",
"firstname": "",
"lastname": "",
"middlename": "",
"parent_id": 0,
"postcode": "",
"prefix": "",
"region": "",
"region_code": "",
"region_id": 0,
"street": [
{}
],
"suffix": "",
"telephone": "",
"vat_id": "",
"vat_is_valid": 0,
"vat_request_date": "",
"vat_request_id": "",
"vat_request_success": 0
},
"billing_address_id": 0,
"can_ship_partially": 0,
"can_ship_partially_item": 0,
"coupon_code": "",
"created_at": "",
"customer_dob": "",
"customer_email": "",
"customer_firstname": "",
"customer_gender": 0,
"customer_group_id": 0,
"customer_id": 0,
"customer_is_guest": 0,
"customer_lastname": "",
"customer_middlename": "",
"customer_note": "",
"customer_note_notify": 0,
"customer_prefix": "",
"customer_suffix": "",
"customer_taxvat": "",
"discount_amount": 0,
"discount_canceled": 0,
"discount_description": "",
"discount_invoiced": 0,
"discount_refunded": 0,
"discount_tax_compensation_amount": 0,
"discount_tax_compensation_invoiced": 0,
"discount_tax_compensation_refunded": 0,
"edit_increment": 0,
"email_sent": 0,
"entity_id": 0,
"ext_customer_id": "",
"ext_order_id": "",
"extension_attributes": {},
"forced_shipment_with_invoice": 0,
"global_currency_code": "",
"grand_total": 0,
"hold_before_state": "",
"hold_before_status": "",
"increment_id": "",
"is_virtual": 0,
"items": [
{
"additional_data": "",
"amount_refunded": 0,
"applied_rule_ids": "",
"base_amount_refunded": 0,
"base_cost": 0,
"base_discount_amount": 0,
"base_discount_invoiced": 0,
"base_discount_refunded": 0,
"base_discount_tax_compensation_amount": 0,
"base_discount_tax_compensation_invoiced": 0,
"base_discount_tax_compensation_refunded": 0,
"base_original_price": 0,
"base_price": 0,
"base_price_incl_tax": 0,
"base_row_invoiced": 0,
"base_row_total": 0,
"base_row_total_incl_tax": 0,
"base_tax_amount": 0,
"base_tax_before_discount": 0,
"base_tax_invoiced": 0,
"base_tax_refunded": 0,
"base_weee_tax_applied_amount": 0,
"base_weee_tax_applied_row_amnt": 0,
"base_weee_tax_disposition": 0,
"base_weee_tax_row_disposition": 0,
"created_at": "",
"description": "",
"discount_amount": 0,
"discount_invoiced": 0,
"discount_percent": 0,
"discount_refunded": 0,
"discount_tax_compensation_amount": 0,
"discount_tax_compensation_canceled": 0,
"discount_tax_compensation_invoiced": 0,
"discount_tax_compensation_refunded": 0,
"event_id": 0,
"ext_order_item_id": "",
"extension_attributes": {},
"free_shipping": 0,
"gw_base_price": 0,
"gw_base_price_invoiced": 0,
"gw_base_price_refunded": 0,
"gw_base_tax_amount": 0,
"gw_base_tax_amount_invoiced": 0,
"gw_base_tax_amount_refunded": 0,
"gw_id": 0,
"gw_price": 0,
"gw_price_invoiced": 0,
"gw_price_refunded": 0,
"gw_tax_amount": 0,
"gw_tax_amount_invoiced": 0,
"gw_tax_amount_refunded": 0,
"is_qty_decimal": 0,
"is_virtual": 0,
"item_id": 0,
"locked_do_invoice": 0,
"locked_do_ship": 0,
"name": "",
"no_discount": 0,
"order_id": 0,
"original_price": 0,
"parent_item": {},
"parent_item_id": 0,
"price": 0,
"price_incl_tax": 0,
"product_id": 0,
"product_option": {
"extension_attributes": {}
},
"product_type": "",
"qty_backordered": 0,
"qty_canceled": 0,
"qty_invoiced": 0,
"qty_ordered": 0,
"qty_refunded": 0,
"qty_returned": 0,
"qty_shipped": 0,
"quote_item_id": 0,
"row_invoiced": 0,
"row_total": 0,
"row_total_incl_tax": 0,
"row_weight": 0,
"sku": "",
"store_id": 0,
"tax_amount": 0,
"tax_before_discount": 0,
"tax_canceled": 0,
"tax_invoiced": 0,
"tax_percent": 0,
"tax_refunded": 0,
"updated_at": "",
"weee_tax_applied": "",
"weee_tax_applied_amount": 0,
"weee_tax_applied_row_amount": 0,
"weee_tax_disposition": 0,
"weee_tax_row_disposition": 0,
"weight": 0
}
],
"order_currency_code": "",
"original_increment_id": "",
"payment": {
"account_status": "",
"additional_data": "",
"additional_information": [
{}
],
"address_status": "",
"amount_authorized": 0,
"amount_canceled": 0,
"amount_ordered": 0,
"amount_paid": 0,
"amount_refunded": 0,
"anet_trans_method": "",
"base_amount_authorized": 0,
"base_amount_canceled": 0,
"base_amount_ordered": 0,
"base_amount_paid": 0,
"base_amount_paid_online": 0,
"base_amount_refunded": 0,
"base_amount_refunded_online": 0,
"base_shipping_amount": 0,
"base_shipping_captured": 0,
"base_shipping_refunded": 0,
"cc_approval": "",
"cc_avs_status": "",
"cc_cid_status": "",
"cc_debug_request_body": "",
"cc_debug_response_body": "",
"cc_debug_response_serialized": "",
"cc_exp_month": "",
"cc_exp_year": "",
"cc_last4": "",
"cc_number_enc": "",
"cc_owner": "",
"cc_secure_verify": "",
"cc_ss_issue": "",
"cc_ss_start_month": "",
"cc_ss_start_year": "",
"cc_status": "",
"cc_status_description": "",
"cc_trans_id": "",
"cc_type": "",
"echeck_account_name": "",
"echeck_account_type": "",
"echeck_bank_name": "",
"echeck_routing_number": "",
"echeck_type": "",
"entity_id": 0,
"extension_attributes": {},
"last_trans_id": "",
"method": "",
"parent_id": 0,
"po_number": "",
"protection_eligibility": "",
"quote_payment_id": 0,
"shipping_amount": 0,
"shipping_captured": 0,
"shipping_refunded": 0
},
"payment_auth_expiration": 0,
"payment_authorization_amount": 0,
"protect_code": "",
"quote_address_id": 0,
"quote_id": 0,
"relation_child_id": "",
"relation_child_real_id": "",
"relation_parent_id": "",
"relation_parent_real_id": "",
"remote_ip": "",
"shipping_amount": 0,
"shipping_canceled": 0,
"shipping_description": "",
"shipping_discount_amount": 0,
"shipping_discount_tax_compensation_amount": 0,
"shipping_incl_tax": 0,
"shipping_invoiced": 0,
"shipping_refunded": 0,
"shipping_tax_amount": 0,
"shipping_tax_refunded": 0,
"state": "",
"status": "",
"status_histories": [
{
"comment": "",
"created_at": "",
"entity_id": 0,
"entity_name": "",
"extension_attributes": {},
"is_customer_notified": 0,
"is_visible_on_front": 0,
"parent_id": 0,
"status": ""
}
],
"store_currency_code": "",
"store_id": 0,
"store_name": "",
"store_to_base_rate": 0,
"store_to_order_rate": 0,
"subtotal": 0,
"subtotal_canceled": 0,
"subtotal_incl_tax": 0,
"subtotal_invoiced": 0,
"subtotal_refunded": 0,
"tax_amount": 0,
"tax_canceled": 0,
"tax_invoiced": 0,
"tax_refunded": 0,
"total_canceled": 0,
"total_due": 0,
"total_invoiced": 0,
"total_item_count": 0,
"total_offline_refunded": 0,
"total_online_refunded": 0,
"total_paid": 0,
"total_qty_ordered": 0,
"total_refunded": 0,
"updated_at": "",
"weight": 0,
"x_forwarded_for": ""
}
}Related in Sales
Other endpoints shipped by the same module.
POST
/V1/creditmemo
Performs persist operations for a specified credit memo.
Sales · Magento\Sales\Api\CreditmemoRepositoryInterface::save
GET
/V1/creditmemo/:id
Loads a specified credit memo.
Sales · Magento\Sales\Api\CreditmemoRepositoryInterface::get
PUT
/V1/creditmemo/:id
Cancels a specified credit memo.
Sales · Magento\Sales\Api\CreditmemoManagementInterface::cancel
GET
/V1/creditmemo/:id/comments
Lists comments for a specified credit memo.
Sales · Magento\Sales\Api\CreditmemoManagementInterface::getCommentsList
POST
/V1/creditmemo/:id/comments
Performs persist operations for a specified entity.
Sales · Magento\Sales\Api\CreditmemoCommentRepositoryInterface::save
POST
/V1/creditmemo/:id/emails
Emails a user a specified credit memo.
Sales · Magento\Sales\Api\CreditmemoManagementInterface::notify
Every Magento dev tool, in one hosted workspace.
Free to sign up. Nothing to install. Drafts, audits, and projects saved across every tool.