Retrieve a list of addresses from a profile
Retrieve a list of addresses from a profile.
Authorizations:Token, JWT
Query Parameters
profile_id required | integer |
page | integerDefault: 1 The collection page number |
itemsPerPage | integer[0 .. true]Default: 30 The number of items per page |
pagination | booleanEnable or disable pagination |
Query Parameters
profile_id required | integer |
page | integerDefault: 1 The collection page number |
itemsPerPage | integer[0 .. true]Default: 30 The number of items per page |
pagination | booleanEnable or disable pagination |
Responses
200Address collection
Response schema:
Address collection Array
id | integer>= 0 | ||||
is_billing | boolean | ||||
is_shipping | boolean | ||||
is_work | boolean | ||||
type | string | ||||
title | string | ||||
firstname | string | ||||
lastname | string | ||||
phone | string | ||||
address1 | string | ||||
address2 | string | ||||
address3 | string | ||||
zipcode | string<= 32 characters | ||||
city | string | ||||
country_code | string2 characters | ||||
state | integer | ||||
state_name | string | ||||
custom_fields | Array of objects | ||||
Array
|
401Unauthorized
Response schema:
Unauthorized type | string |
title | string |
detail | string or null |
instance | string or null |
500Internal error
Response schema:
Internal error type | string |
title | string |
detail | string or null |
instance | string or null |