Shipping Address


  • HD / SFS: It’s allowed to change the shipping address information during the order flow cycle until one of the lines is part of a shipment request notified to the logistic provide (In case of you want add a UI restriction you could use the search repository of shipment request to check it)
  • ISPU: not allowed

IMPORTANT: In the case that the SI would like to modify shipping address when the order is already in logistics stage will need to cancel the shipment request before change it.


This feature is enabled/disabled by configuration, both integration and the own UI will be configurable.

For UI privileges the Roles and permission will bring the granularity to enable / disable this functionality for a certain role.

Roles & Permissions


The command to initiate the change of the shipping address is the made with the command update_shipping_address

    "shipping_address_modification": {
        "new_shipping_address": {
            “reference”: “Reference-1”,
            "address1": "Llacuna 56",
            "address2": "",
            "city": "Barcelona",
            “state”: “Barcelona”,
            “zip”: “08007”,
            "company_name": "",
            "country_code": "US",
            "custom_attributes": [],
            "email": "",
            "first_name": "New Name",
            "last_name": "New Surname",
            "phone": "600000000",
            "state": "MI",
            "zip": "49628-7978",
            “latitude”: “41,3851”,
            “longitude”: “2,1734”,
            “custom_attributes”: [
                  “name”: “delivery_note”,
                  “value”: “next door”
        "order_id": "000000029",
        "sales_channel_id": "ST1",
        "user": "UserName"

When the action will be performed successfully our system will generate and event that could be consumed by whatever interested integration with the name shipping_address_updated with exactly the same content that the previous one.

As this request in a synchronous one, in a case of a failure you will receive the reason of the non-expected behavior in the response message. Please find below one example of failure response

    "error": {
        "message":"Feature with name \u0027updateShippingAddress\u0027, is not enabled.",