Skip to content
ExtensionsStorefronts
extensions / Commerce extension
POST/__runtime/checkout/addresses

Create Checkout Address

Saves a new shipping address for the signed-in customer of a storefront project.

GETPOST

Authentication

Requirement
Not specified
Credential type
Not specified
Scopes
Not specified

Permissions

  • Requires an authenticated storefront customer session.

Headers

NameRequiredTypeDetails
HostYesNot specified
Description: Value used by this operation.
CookieYesNot specified
Description: Value used by this operation.
AuthorizationYesNot specified
Description: Bearer credential used to authenticate the request.

Path Parameters

This operation has no path parameters.

Query Parameters

This operation does not accept query parameters.

Request Body

Schema: SaveAddressRequest

FieldRequiredTypeDetails
labelNostring
Description: Human-readable label.
streetYesstring
Description: Text value.
cityYesstring
Description: Text value.
stateYesstring
Description: Text value.
zipYesstring
Description: Text value.
countryYesstring
Description: Text value.
phoneNostring
Description: Text value.
is_defaultNoboolean
Description: Boolean flag.

Response Body

Example 200 response

json
{
  "id": 1,
  "label": "Example",
  "street": "string",
  "city": "string",
  "state": "string",
  "zip": "string",
  "country": "string",
  "phone": "string",
  "is_default": true
}

Errors

400 BAD_REQUEST401 UNAUTHORIZED500 INTERNAL_SERVER_ERROR

Availability

Available in
v0.1.0
Available since
v0.1.0
Implementation
Available
Deprecation
Not specified
Rate limits
Not specified