POST
/
api
/
v2
/
platform
/
addresses
curl --request POST \
  --url http://{defaultHost}/api/v2/platform/addresses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "address": {
    "country_id": "224",
    "state_id": "516",
    "state_name": "New York",
    "address1": "5th ave",
    "address2": "1st suite",
    "city": "NY",
    "zipcode": "10001",
    "phone": "+1 123 456 789",
    "alternative_phone": "<string>",
    "firstname": "John",
    "lastname": "Snow",
    "label": "My home address",
    "company": "Vendo Cloud Inc",
    "user_id": "<string>",
    "public_metadata": {
      "distance_from_nearest_city_in_km": 10,
      "location_type": "building"
    },
    "private_metadata": {
      "close_to_shop": true
    }
  }
}'
{
  "data": {
    "id": "5",
    "type": "address",
    "attributes": {
      "firstname": "John",
      "lastname": "Doe",
      "address1": "5 Lovely Street",
      "address2": "Northwest",
      "city": "Herndon",
      "zipcode": "35005",
      "phone": "555-555-0199",
      "state_name": null,
      "alternative_phone": "555-555-0199",
      "company": "Company",
      "created_at": "2022-11-08T19:33:51.471Z",
      "updated_at": "2022-11-08T19:33:51.471Z",
      "deleted_at": null,
      "label": null,
      "public_metadata": {},
      "private_metadata": {}
    },
    "relationships": {
      "country": {
        "data": {
          "id": "4",
          "type": "country"
        }
      },
      "state": {
        "data": {
          "id": "5",
          "type": "state"
        }
      },
      "user": {
        "data": {
          "id": "1",
          "type": "user"
        }
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
include
string

Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>

Body

application/json
​
address
object
required

Response

201
application/vnd.api+json
Record created
​
data
object
required

Was this page helpful?

Suggest editsRaise issue
Return a list of AddressesReturn an Address