Orderwise Update Sales Order Delivery Address
Changes the delivery address on an existing Orderwise sales order, using the Orderwise module connection.
What it does
- Changes the delivery address on an Orderwise sales order itself.
- Sends only the address fields, so Orderwise keeps the order's existing delivery name.
- Use this action when an order is already in Orderwise. Updating the customer's address book doesn't change the address on an existing order.
- Returns whether the update succeeded and the response from Orderwise.
Inputs
| Name | Type | Required | Description |
|---|---|---|---|
| Orderwise Order ID | String | Yes | The Orderwise order ID (the order header ID). |
| New Delivery Object | Object | Yes | The new address, with address1, address2, city, province, zip, country_name and country_code. address1 is required. |
| Safe Mode | Boolean | No | If on, errors are returned in the outputs instead of stopping the flow. Defaults to off. |
Outputs
| Name | Type | Description |
|---|---|---|
| Success | Boolean | Whether Orderwise updated the order's delivery address. |
| Response | Object | The response body from Orderwise. |
| Error Message | String | Error details when Safe Mode is on and the action fails. |
Notes
- The action requires an Orderwise module connection and has no credential inputs. The connection supplies the Orderwise login (basic auth) and the
base_urlof the Orderwise API, for examplehttps://example.orderwisecloud.com/OWAPI. - The
base_urlmust be anhttpsURL. Otherwise, the action fails before it calls Orderwise. - At the start of every run, the action exchanges the connection's login for a bearer token, then uses that token to update the order. It doesn't cache the token.
- The action maps the New Delivery Object fields to Orderwise as follows:
| New Delivery Object field | Orderwise field |
|---|---|
address1 | deliveryAddress1 |
address2 | deliveryAddress2 |
city | deliveryTown |
province | deliveryCounty |
zip | deliveryPostcode |
country_name | deliveryCountry |
country_code | deliveryCountryCode |
- If
address1is missing or empty, the action sends nothing to Orderwise. This prevents an empty address from overwriting the order's address. - The action sends missing or null address fields as empty text. Each address field must be text, not an object or list.
- The Orderwise Order ID can contain only letters, digits,
-and_. A whole number such as1001.0is read as1001. - Each request times out after 3 seconds to connect and 10 seconds to read. The action doesn't retry failed requests or follow redirects.
- When Orderwise returns an error, the error message includes the status code and Orderwise's own message, capped at 200 characters. For example:
RuntimeError: Orderwise request failed with status 409: Order is locked. Error messages never include the connection's credentials or the token. - Safe Mode: when off, a failure stops the flow. When on, the action returns
Success = falsewith the details inError Message, and the flow continues. - If no Orderwise connection is set up, the action fails with a "Missing Orderwise connection" error.
API reference
PUT {base_url}/sales/order/{order ID}/delivery-address
Updated 1 day ago
Did this page help you?
