Sign in

v1

latestOpenAPI 3.0.22026-07-2441902.6 MB
Retail Experience Cloud Bridge

Change Order Shipping Address

Change the shipping address of a customer's order.

Required fields:

  • customer_id
  • order_id

A successful request updates the shipping address and returns the order with the new address.

post/erc/ecommerce/customers/{customer_id}/orders/{order_id}/change-shipping-address

Path parameters

customer_idstring required
Example:customer123

The customer id

order_idstring required
Example:order123

The order id

Query parameters

brandstring
Example:Brand A

The brand of the provider you want to filter by. If the account is multi-brand, this parameter is required.

Request body

first_namestring

The first name of the person associated with the address

last_namestring

The last name of the person associated with the address

phone_numberstring

The phone number of the person associated with the address

addressstring

The first line of the address

zip_codestring

The zip-code of the address

citystring

The city of the address

region_codestring

The region (country subdivision) code according to ISO 3166-2 standard

country_codestring

The country code of the address, according to the ISO 3166-1 alpha-2 codes

idstring

The ID of the address

defaultboolean

Whether this is the default address

Example request

{
  "first_name": "John",
  "last_name": "Doe",
  "phone_number": "+351910000000",
  "address": "Lisbon",
  "zip_code": "20000000",
  "city": "Lisbon",
  "region_code": "PT-11",
  "country_code": "PT",
  "id": "address123"
}

Response

The order information updated with the new shipping_address

idstring required

The ID of the order

order_numberstring required

The number of the order (usually the order identifier that the customer knows)

customer_idstring

The ID of the customer that created this order

brandstring

The brand associated with the order

purchase_datetimestring date-time

The timestamp date when the order was created

delivery_type'UNKNOWN' | 'LOCAL_DELIVERY' | 'LOCAL_PICKUP' | 'SHIPPING'

Represents the type of delivery for a given order

items_numberinteger

The number of order items

statusstring

The status of the order. Each integration has its own set of possible status values

cancellation_statusstring

The cancellation status of the order

fulfillment_statusstring

The fulfillment status of the order

payment_statusstring

The payment status of the order

delivery_statusstring

The delivery status of the order

return_statusstring

The return status of the order

custom_fieldsobject

The custom fields associated with the provider

is_refundableboolean

Indicates whether the current order is refundable

is_returnableboolean

Indicates whether the current order is returnable

is_cancellableboolean

Indicates whether the current order can be cancelled

is_change_shipping_address_allowedboolean

Indicates whether the shipping address of the order can be changed

Example response

{
  "id": "order456",
  "order_number": "#Y34DHR",
  "customer_id": "customer123",
  "brand": "brand",
  "purchase_datetime": "2021-09-14T12:16:50.078Z",
  "delivery_type": "SHIPPING",
  "shipping_address": {
    "first_name": "John",
    "last_name": "Doe",
    "phone_number": "+351910000000",
    "address": "Lisbon",
    "zip_code": "20000000",
    "city": "Lisbon",
    "region_code": "PT-11",
    "country_code": "PT"
  },
  "billing_address": {
    "first_name": "John",
    "last_name": "Doe",
    "phone_number": "+351910000000",
    "address": "Lisbon",
    "zip_code": "20000000",
    "city": "Lisbon",
    "region_code": "PT-11",
    "country_code": "PT"
  },
  "items_number": 3,
  "price_summary": {
    "original_total_amount": {
      "value": 10.5,
      "currency": "EUR"
    },
    "discounts_amount": {
      "value": 10.5,
      "currency": "EUR"
    },
    "shipping_amount": {
      "value": 10.5,
      "currency": "EUR"
    },
    "taxes_amount": {
      "value": 10.5,
      "currency": "EUR"
    },
    "final_total_amount": {
      "value": 10.5,
      "currency": "EUR"
    },
    "net_payment_amount": {
      "value": 10.5,
      "currency": "EUR"
    },
    "total_outstanding_amount": {
      "value": 10.5,
      "currency": "EUR"
    },
    "total_refunded_amount": {
      "value": 10.5,
      "currency": "EUR"
    }
  },
  "payment_details": {
    "card_brand": "Visa",
    "card_brand_image_url": "https://external-integration.url.com/payment_card_brand_icon.svg",
    "card_number": "**** **** **** *567"
  },
  "order_extra_info": {
    "highlighted_item_image_url": "https://external-integration.url.com/payment_card_brand_icon.jpg"
  },
  "status": "CONFIRMED",
  "cancellation_status": "CANCELLATION_REQUESTED",
  "fulfillment_status": "FULFILLED",
  "payment_status": "PAID",
  "delivery_status": "DELIVERED",
  "return_status": "RETURN_IN_PROGRESS",
  "is_refundable": true,
  "is_returnable": true,
  "is_cancellable": true
}