Public
Documentation Settings

Integration API

Address API

API for addresses.

POSTAdd new address for a user

http://localhost:3000/api/v1/addresses
HEADERS
Content-Type

application/vnd.api+json

Authorization

Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJzbml0Y2hfYXBpIiwiZXhwIjoxNTM4Mzg3NTIwLCJpYXQiOjE1MzgxMjgzMjAsImlzcyI6InNuaXRjaF9hcGkiLCJqdGkiOiI2MTc1Yjc4Ny02ZTcyLTQ3MTAtYmEzYS00Y2VhY2Q5MTlkMjYiLCJuYmYiOjE1MzgxMjgzMTksInN1YiI6IjUiLCJ0eXAiOiJhY2Nlc3MifQ.yCNWkxL3udv8JjIs1Ru3s_4xKPKOlBOJ8FwIs5kSUyn-eLkdfGb0EUhEizo0qnyd41R5RZdAfv_XrYgd97QCOA

Bodyraw
{
  "data": {
    "type": "address", 
    "attributes": { 
        "address_line_1": "4 Privet Drive",
        "address_line_2": "Little Whinging",
        "first_name": "Harry",
        "last_name": "Potter",
        "zip_code": "123456",
        "state_id": 1493,
        "country_id": 80,
        "city": "Surrey",
        "phone": "1212121212",
        "alternate_phone": "1212121212"
  
    },
    "relationships": {
      "user": {
       "data": {
       "id": 4
       }
      }
    }
  }
}
Example Request
curl
curl --location 'http://localhost:3000/api/v1/addresses' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJzbml0Y2hfYXBpIiwiZXhwIjoxNTM4Mzg3NTIwLCJpYXQiOjE1MzgxMjgzMjAsImlzcyI6InNuaXRjaF9hcGkiLCJqdGkiOiI2MTc1Yjc4Ny02ZTcyLTQ3MTAtYmEzYS00Y2VhY2Q5MTlkMjYiLCJuYmYiOjE1MzgxMjgzMTksInN1YiI6IjUiLCJ0eXAiOiJhY2Nlc3MifQ.yCNWkxL3udv8JjIs1Ru3s_4xKPKOlBOJ8FwIs5kSUyn-eLkdfGb0EUhEizo0qnyd41R5RZdAfv_XrYgd97QCOA' \
--data '{
  "data": {
    "type": "address", 
    "attributes": { 
        "address_line_1": "4 Privet Drive",
        "address_line_2": "Little Whinging",
        "first_name": "Harry",
        "last_name": "Potter",
        "zip_code": "123456",
        "state_id": 1493,
        "country_id": 80,
        "city": "Surrey",
        "phone": "1212121212",
        "alternate_phone": "1212121212"
  
    },
    "relationships": {
      "user": {
       "data": {
       "id": 4
       }
      }
    }
  }
}'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

GETList user's addresses

localhost:3000/api/v1/addresses
HEADERS
Content-Type

application/vnd.api+json

Authorization

Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJzbml0Y2hfYXBpIiwiZXhwIjoxNTM4Mzg3NTIwLCJpYXQiOjE1MzgxMjgzMjAsImlzcyI6InNuaXRjaF9hcGkiLCJqdGkiOiI2MTc1Yjc4Ny02ZTcyLTQ3MTAtYmEzYS00Y2VhY2Q5MTlkMjYiLCJuYmYiOjE1MzgxMjgzMTksInN1YiI6IjUiLCJ0eXAiOiJhY2Nlc3MifQ.yCNWkxL3udv8JjIs1Ru3s_4xKPKOlBOJ8FwIs5kSUyn-eLkdfGb0EUhEizo0qnyd41R5RZdAfv_XrYgd97QCOA

Example Request
curl
curl --location 'localhost:3000/api/v1/addresses' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJzbml0Y2hfYXBpIiwiZXhwIjoxNTM4Mzg3NTIwLCJpYXQiOjE1MzgxMjgzMjAsImlzcyI6InNuaXRjaF9hcGkiLCJqdGkiOiI2MTc1Yjc4Ny02ZTcyLTQ3MTAtYmEzYS00Y2VhY2Q5MTlkMjYiLCJuYmYiOjE1MzgxMjgzMTksInN1YiI6IjUiLCJ0eXAiOiJhY2Nlc3MifQ.yCNWkxL3udv8JjIs1Ru3s_4xKPKOlBOJ8FwIs5kSUyn-eLkdfGb0EUhEizo0qnyd41R5RZdAfv_XrYgd97QCOA'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers