Performs persist operations for a specified order address

PUT /V1/orders/{parent_id}

Performs persist operations for a specified order address.

Path parameters

  • parent_id string Required

Body

  • entity object Required

    Order address interface. An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as a purchase order, is emailed to the customer.

    Hide entity attributes Show entity attributes object
    • address_type string Required

      Address type.

    • city string Required

      City.

    • company string

      Company.

    • country_id string Required

      Country ID.

    • customer_address_id integer

      Country address ID.

    • customer_id integer

      Customer ID.

    • email string

      Email address.

    • entity_id integer

      Order address ID.

    • fax string

      Fax number.

    • firstname string Required

      First name.

    • lastname string Required

      Last name.

    • middlename string

      Middle name.

    • parent_id integer

      Parent ID.

    • postcode string Required

      Postal code.

    • prefix string

      Prefix.

    • region string

      Region.

    • region_code string

      Region code.

    • region_id integer

      Region ID.

    • street array[string]

      Array of any street values. Otherwise, null.

    • suffix string

      Suffix.

    • telephone string Required

      Telephone number.

    • vat_id string

      VAT ID.

    • vat_is_valid integer

      VAT-is-valid flag value.

    • vat_request_date string

      VAT request date.

    • vat_request_id string

      VAT request ID.

    • vat_request_success integer

      VAT-request-success flag value.

    • extension_attributes object

      ExtensionInterface class for @see \Magento\Sales\Api\Data\OrderAddressInterface

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
    • address_type string Required

      Address type.

    • city string Required

      City.

    • company string

      Company.

    • country_id string Required

      Country ID.

    • customer_address_id integer

      Country address ID.

    • customer_id integer

      Customer ID.

    • email string

      Email address.

    • entity_id integer

      Order address ID.

    • fax string

      Fax number.

    • firstname string Required

      First name.

    • lastname string Required

      Last name.

    • middlename string

      Middle name.

    • parent_id integer

      Parent ID.

    • postcode string Required

      Postal code.

    • prefix string

      Prefix.

    • region string

      Region.

    • region_code string

      Region code.

    • region_id integer

      Region ID.

    • street array[string]

      Array of any street values. Otherwise, null.

    • suffix string

      Suffix.

    • telephone string Required

      Telephone number.

    • vat_id string

      VAT ID.

    • vat_is_valid integer

      VAT-is-valid flag value.

    • vat_request_date string

      VAT request date.

    • vat_request_id string

      VAT request ID.

    • vat_request_success integer

      VAT-request-success flag value.

    • extension_attributes object

      ExtensionInterface class for @see \Magento\Sales\Api\Data\OrderAddressInterface

  • 401

    401 Unauthorized

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Error details

      Error details

      Hide errors attributes Show errors attributes object
      • message string

        Error message

      • parameters array[object]

        Error parameters item

        Error parameters item

        Hide parameters attributes Show parameters attributes object
        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

  • default

    Unexpected error

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Error details

      Error details

      Hide errors attributes Show errors attributes object
      • message string

        Error message

      • parameters array[object]

        Error parameters item

        Error parameters item

        Hide parameters attributes Show parameters attributes object
        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

PUT /V1/orders/{parent_id}
curl \
 --request PUT 'https://magento2.winkelstraat.mac/rest/all/V1/orders/{parent_id}' \
 --data '{"entity":{"address_type":"string","city":"string","company":"string","country_id":"string","customer_address_id":42,"customer_id":42,"email":"string","entity_id":42,"fax":"string","firstname":"string","lastname":"string","middlename":"string","parent_id":42,"postcode":"string","prefix":"string","region":"string","region_code":"string","region_id":42,"street":["string"],"suffix":"string","telephone":"string","vat_id":"string","vat_is_valid":42,"vat_request_date":"string","vat_request_id":"string","vat_request_success":42,"extension_attributes":{}}}'
Request examples
{
  "entity": {
    "address_type": "string",
    "city": "string",
    "company": "string",
    "country_id": "string",
    "customer_address_id": 42,
    "customer_id": 42,
    "email": "string",
    "entity_id": 42,
    "fax": "string",
    "firstname": "string",
    "lastname": "string",
    "middlename": "string",
    "parent_id": 42,
    "postcode": "string",
    "prefix": "string",
    "region": "string",
    "region_code": "string",
    "region_id": 42,
    "street": [
      "string"
    ],
    "suffix": "string",
    "telephone": "string",
    "vat_id": "string",
    "vat_is_valid": 42,
    "vat_request_date": "string",
    "vat_request_id": "string",
    "vat_request_success": 42,
    "extension_attributes": {}
  }
}
Response examples (200)
{
  "address_type": "string",
  "city": "string",
  "company": "string",
  "country_id": "string",
  "customer_address_id": 42,
  "customer_id": 42,
  "email": "string",
  "entity_id": 42,
  "fax": "string",
  "firstname": "string",
  "lastname": "string",
  "middlename": "string",
  "parent_id": 42,
  "postcode": "string",
  "prefix": "string",
  "region": "string",
  "region_code": "string",
  "region_id": 42,
  "street": [
    "string"
  ],
  "suffix": "string",
  "telephone": "string",
  "vat_id": "string",
  "vat_is_valid": 42,
  "vat_request_date": "string",
  "vat_request_id": "string",
  "vat_request_success": 42,
  "extension_attributes": {}
}
Response examples (401)
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (default)
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}