Update address - customer context

Using this endpoint, a customer can update their own address through the storefront UI based on addressId.

Authorizations

Authorization

string

header

required

The access token.

Headers

x-fabric-tenant-id

string

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

x-fabric-request-id

string

A UUID of the request.

Path Parameters

addressId

string

required

A 24-character system-generated ID of the customer's address.

Body

application/json

address

object

required

The address details.

Show child attributes

address.type

enum<string>

required

The address type.

Available options:

BILLING,

SHIPPING

address.addressLine1

string

The first line of the address.

address.addressLine2

string

The second line of the address.

address.addressLine3

string

The third line of the address.

address.addressLine4

string

The fourth line of the address.

address.city

string

The city name in the address.

address.country

string

The country code, which can be a full name, or an ISO 3166-1 alpha-2 or alpha-3 code.

address.county

string

The administrative division or county within a country or state.

address.latitude

number

The geographical latitude used with longitude to locate the exact address. The coordinates are provided in decimal degrees format, with negative values indicating locations to the west.

address.longitude

number

The geographical longitude used with latitude to locate the exact address. The coordinates are provided in decimal degrees format, with negative values indicating locations to the west.

address.postalCode

string

The postal or ZIP code of the address.

address.region

string

The region or state name in the address.

additionalAttributes

object

A placeholder for additional info, in key-value pairs.

isDefault

boolean

A flag indicating whether the address is the default one. true indicates the address is the default address and false indicates otherwise.

Response

200 - application/json

address

object

required

The address details.

Show child attributes

address.type

enum<string>

required

The address type.

Available options:

BILLING,

SHIPPING

address.addressLine1

string

The first line of the address.

address.addressLine2

string

The second line of the address.

address.addressLine3

string

The third line of the address.

address.addressLine4

string

The fourth line of the address.

address.city

string

The city name in the address.

address.country

string

The country code, which can be a full name, or an ISO 3166-1 alpha-2 or alpha-3 code.

address.county

string

The administrative division or county within a country or state.

address.latitude

number

The geographical latitude used with longitude to locate the exact address. The coordinates are provided in decimal degrees format, with negative values indicating locations to the west.

address.longitude

number

The geographical longitude used with latitude to locate the exact address. The coordinates are provided in decimal degrees format, with negative values indicating locations to the west.

address.postalCode

string

The postal or ZIP code of the address.

address.region

string

The region or state name in the address.

createdAt

string

required

The time when the address was created, in UTC format.

id

string

required

A 24-character system-generated ID of the address.

isDeleted

boolean

required

A flag indicating whether the address is deleted. true indicates the address is deleted and false indicates otherwise.

updatedAt

string | null

required

The time when the address was the last updated, in UTC format.

additionalAttributes

object

A placeholder for additional info, in key-value pairs.

deletedAt

string | null

The time when the address was deleted, in UTC format.

isDefault

boolean

A flag indicating whether the address is the default one.true indicates the given address is the default address and false indicates otherwise.