Create Address

Beta
POST/v1/sales/addresses

Idempotent with Idempotency-Key header. Learn more

Creates an address for the targeted account.

namestring

Display name of the address.

phoneoptional stringnullable

Phone number associated with the address.

emailoptional stringnullable

Email address associated with the address.

typeoptional stringenumValues:standarddrop_ship

Address type. Defaults to standard.

street_line_1optional stringnullable

First line of the street address.

street_line_2optional stringnullable

Second line of the street address.

localityoptional stringnullable

City or locality.

stateoptional stringnullable

State or administrative area.

postal_codeoptional stringnullable

Postal or ZIP code.

countrystring

Two-letter country code.

idstring

Address ID.

objectstringenumValues:address

Resource type identifier.

namestring

Display name of the address.

phonestringnullable

Phone number associated with the address.

emailstringnullable

Email address associated with the address.

typestringenumValues:standarddrop_ship

Address type.

geolocationobjectnullable

Geolocation details for the address.

idstring

Geolocation ID.

objectstringenumValues:geolocation

Resource type identifier.

street_line_1stringnullable

First line of the street address.

street_line_2stringnullable

Second line of the street address.

localitystringnullable

City or locality.

statestringnullable

State or administrative area.

postal_codestringnullable

Postal or ZIP code.

countrystring

Two-letter country code.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

201

Successful response for Create Address