What parameters does PUT /V1/orders/:parent_id accept?

This endpoint accepts 1 parameter: entity (Magento\Sales\Api\Data\OrderAddressInterface) required.

What does PUT /V1/orders/:parent_id return?

The endpoint returns Magento\Sales\Api\Data\OrderAddressInterface.

Does PUT /V1/orders/:parent_id require authentication?

This endpoint requires an admin Bearer token with ACL: Magento_Sales::create.

MageSmith

PUTSales · Magento 2.4.9 Admin · Magento_Sales::create

PUT /V1/orders/:parent_id

Q: What does the PUT /V1/orders/:parent_id endpoint do in Magento 2?

PUT /V1/orders/:parent_id is a Magento 2 REST endpoint in the Sales module. Performs persist operations for a specified order address. Requires an admin Bearer token with ACL Magento_Sales::create.

PUT /V1/orders/:parent_id is a Magento 2 REST endpoint in the Sales module. Performs persist operations for a specified order address. Requires an admin Bearer token with ACL Magento_Sales::create.

Last verified: 2026-05-23 against Magento 2.4.9.

Returns

Magento\Sales\Api\Data\OrderAddressInterface

Order address interface.

Service contract

Magento\Sales\Api\OrderAddressRepositoryInterface::save

Authorization

Admin Bearer token with ACL:

Magento_Sales::create

Body parameters

entity Magento\Sales\Api\Data\OrderAddressInterface Required

The order address.

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

application/json

Content-Type

application/json

Authorization

Bearer <ACCESS_TOKEN> admin token with ACL: Magento_Sales::create

Path

/V1/orders/:parent_id

Body

{
  "entity": {
    "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
  }
}