Sign in
orders

Set an order shipping address (synchronous)

Sets the shipping (SHIPPING) address of an existing order — edits it when present, or creates it when the order was created without one (e.g. store pickup). accountCode comes from the JWT; a reason is required and recorded in the narrative log.

patch/api/v1/orders/{id}/addresses

Path parameters

idstring uuid required
Example:01920000-0000-7000-8000-000000000000

Order identifier (UUID).

Request body

reasonstring required

Response

Order shipping address set.

idstring required
updated_atstring required

Changes

Changed in 2 of the 9 revisions of this API.24

  • a3b4750a505f23See the full diff
    • ▲

      added the new required request property reason

      new-required-request-property

    • ▲

      added the new required request property shipping_address

      new-required-request-property

    • ○

      added the required property id to the response with the 200 status

      response-required-property-added

    • ○

      added the required property shipping_address to the response with the 200 status

      response-required-property-added

    • ○

      added the required property updated_at to the response with the 200 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 84194c31ab851See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog