Update an address

PUT

/api/v1/business/website/addresses/{address_id}/

Send only the fields you want to change.

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)

Parameters

Path Parameters

address_id*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"label": "string",

  

"receiver_name": "string",

  

"phone": "string",

  

"address_line1": "string",

  

"address_line2": "string",

  

"city": "string",

  

"area": "string",

  

"postal_code": "string",

  

"is_default": true

}

Responses

Address updated.

Content-Type

application/json

"string"

PUT

/api/v1/business/website/addresses/{address_id}/

Playground

Server

Authorization

apiKey

shopperToken

Variables

Key

Value

address_id*

Body

Samples

Powered by VitePress OpenAPI