Create address

post

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

Create an address for the customer on-session.

Query Params

site_id

int32

required

The unique identifier of the site associated with your account.

Body Params

country

string

required

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

line1

string

required

The first line of the address. Always required.

language

string

enum

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

The address's first name that belongs to the customer.

last_name

string

The address's last name that belongs to the customer.

line2

string

The second line of the address.

city

string

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

state

string

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

postal_code

string

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

Numeric phone number associated with the address. Must be preformatted and contain only numbers (length min: 5, length max: 20).

Headers

Authorization

string

required

Defaults to Bearer eyJ***

string

Defaults to application/json

Responses

Language

Credentials

Query

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400