Update address

put

https://www.pelcro.com/api/v1/core/addresses/{id}

Update an existing address.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

Query Params

site_id

int32

required

The unique identifier of the site associated with your account.

customer_id

int32

required

The unique identifier of the customer.

Body Params

first_name

string

length ≤ 255

The address's first name that belongs to the customer

last_name

string

length ≤ 255

The address's last name that belongs to the customer

type

string

enum

required

The address type, one of either "shipping" or "billing"

Allowed:

line1

string

required

length ≤ 255

The first line of the address.

line2

string

length ≤ 255

The second line of the address.

city

string

length ≤ 255

The name of a city, town, village, etc.

state

string

length ≤ 255

The two-letter code of the state, region, or province. Learn more here.

country

string

required

length ≤ 2

The two-letter country codes as specified by ISO3166 alpha-2. Learn more here.

postal_code

string

length ≤ 45

Postal code or zip associated with the address.

phone

string

Numeric phone number associated with the address.

old_provider_id

string

length ≤ 191

The old id for the customer if it is migrated.

is_default

boolean

Defaults to false

Set this address as the new default. Only one default address of the same type can be set at all times.

title

string

length ≤ 255

The customer's title within the company.

salutation

string

length ≤ 255

A salutation for the address, such as Mr., Ms., Dr.

company

string

length ≤ 255

The company name associated with the address.

department

string

length ≤ 255

The department associated with the address.

bypass_address_cleansing

boolean

A boolean to bypass the address cleansing feature if enabled.

delivery_instructions

string

length ≤ 500

Optional delivery notes associated with this address.

delivery_sequence_number

integer

≥ 1

Optional integer representing the driver delivery order for the address

vendor_id

int32

The vendor associated with this address if any

Headers

Authorization

string

required

Defaults to Bearer eyJ***

Responses

200Success.

400Invalid request.

401Unauthenticated.

404Not found.