Skip to main content
POST
Create Address

Authorizations

X-API-Key
string
header
required

API Key for authentication

Path Parameters

customer_id
string
required

customer_id

Body

application/json

request

reference_id
string
required
Maximum string length: 255
Example:

"ADDR123"

address_line_1
string
required
Maximum string length: 255
Example:

"123 Main St"

city
string
required
Maximum string length: 50
Example:

"Anytown"

type
enum<string>
required
Available options:
billing,
shipping
Example:

"billing"

first_name
string
Maximum string length: 50
Example:

"John"

last_name
string
Maximum string length: 50
Example:

"Doe"

phone
string
Example:

"+14155552671"

email
string
Example:

"john.doe@example.com"

address_line_2
string
Maximum string length: 255
Example:

"Apt 101"

state
string
Maximum string length: 50
Example:

"CA"

country
string
Example:

"US"

zip_code
string
Maximum string length: 50
Example:

"12345"

is_default
boolean

When true, this becomes the default address for its type.

attributes
object[]

Response

Created

data
object