Skip to content

Create an address

POST
/api/v1/business/website/addresses/

Authorizations

apiKey

Your business API key (sb_live_*) — identifies which store the request is for. Required on every /api/v1/business/website/ request.

Type
API Key (header: X-Periscale-Key)
+
shopperToken

The shopper's access token from the shopper authentication endpoints. Required for cart, checkout, orders, and account actions.

Type
HTTP (bearer)

Request Body

application/json
JSON
{
  
"label": "HOME",
  
"receiver_name": "string",
  
"phone": "string",
  
"address_line1": "string",
  
"address_line2": "string",
  
"city": "string",
  
"area": "string",
  
"postal_code": "string",
  
"is_default": false
}

Responses

Address created.

application/json
JSON
{
  
"status": true,
  
"status_code": 0,
  
"message": "string",
  
"data": {
  
  
"id": "string"
  
}
}

Playground

Server
Authorization
Body

Samples

Powered by VitePress OpenAPI

© Periscale