Create address

post

https://www.pelcro.com/api/v1/sdk/address

Add an address for the authenticated customer.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Overview

Add an address for the authenticated customer. Returns the updated customer (the new address appears under data.addresses) plus a meta block. Requires a bearer token.

Example: A customer adds a shipping address during checkout; send country and line1 (plus name, city, state, and postal code).

📘
Authentication required
Send a bearer token as Authorization: Bearer <token>. Defaults type to shipping when omitted. See Authentication.

Conditional Requirements

Condition	Required Fields
Always	`country`, `line1`
AvaTax address validation enabled, and `country` is `US` or `CA`	`postal_code`

Query Params

site_id

int32

required

The unique identifier of the site associated with your account.

Body Params

country

string

required

length ≤ 2

The two-letter code of the country, as specified by ISO 3166 alpha-2 standard. Always required.

line1

string

required

length ≤ 255

The first line of the address. Always required.

language

string

enum

length ≤ 2

Defaults to en

The customer’s preferred language as a two-letter code, defined by ISO 639-1 standard. If not specified, it will be set from Accept-Language header, or from the default language defined in your site settings as a fallback.

Allowed:

type

string

Defaults to shipping

The address type, one of either "shipping" or "billing". Always defaults to "shipping" if not provided.

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.

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.

postal_code

string

length ≤ 45

Postal code or zip associated with the address.

is_default

boolean

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

phone

string

length between 5 and 20

Numeric phone number associated with the address. Must be preformatted and contain only numbers.

company

string | null

Company name for the address.

title

string | null

Title for the address.

department

string | null

Department for the address.

delivery_instructions

string | null

Delivery instructions for the address (max 500 characters).

delivery_sequence_number

integer | null

≥ 1

Delivery sequence number for the address.

Headers

Authorization

string

required

Defaults to Bearer <token>

Required. Bearer authentication with the customer's JWT — Authorization: Bearer <token>. Obtained from the register, login, or passwordless-login response and renewed via the refresh endpoint.

Responses

Overview

Authentication required

Conditional Requirements

200Success.

400Invalid request.

401Unauthorized.