Create address

post

https://www.pelcro.com/api/v1/core/addresses

Create a new address for a customer.

Query Params

site_id

int32

required

The unique identifier of the site associated with your account.

Body 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 which must be associated to the site and related account.

type

string

enum

required

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

Allowed:

line1

string

required

length ≤ 255

The first line of the address, typically containing the street number and street name.

country

string

required

length ≤ 2

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

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, which can be used for apartment number, suite number, etc.

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. Required for CA, US, AU.

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

An optional field that may be used to store the identifier of the address on a previous system. Must be unique under the account.

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.

customer_old_provider_id

string

The old_provider_id unique identifier that was added to customer who owns this address.

update_subscriptions_shipping_address

boolean

Defaults to false

If provided and set to true, the default shipping address for all of the customer's active subscriptions will be updated. This process will only trigger if is_default is also provided and set to true.

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

201Created.

400Invalid request.

401Unauthenticated.

500Server error.