Appearance

create-address ​

Method: POST
Path: /customers/{user_id}/addresses

Tags: Customers

Summary ​

Create address

Description ​

Add new address

Storefront SDK Usage ​

SDK Method: sdk.customer.createAddress()

Example:

typescript
const { data, error } = await sdk.customer.createAddress(
  { user_id: "user_456" },
  {
    address_line1: "123 Main Street",
    address_line2: "Apt 4B",
    city: "New York",
    state: "NY",
    country: "US",
    pincode: "10001",
    is_default_billing: true,
    is_default_shipping: false
  }
);

if (error) {
  console.error("Failed to create address:", error);
  return;
}

console.log("Address created:", data.address);

TypeScript Definition ​

typescript
"create-address": {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description User id */
                user_id: string;
            };
            cookie?: never;
        };
        /** @description payload for new address */
        requestBody: {
            content: {
                "application/json": components["schemas"]["CustomerAddress"] & {
                    is_default_billing?: boolean;
                    is_default_shipping?: boolean;
                };
            };
        };
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message?: string;
                        success?: boolean;
                        content?: {
                            address?: components["schemas"]["CustomerAddress"];
                        };
                    };
                };
            };
            400: components["responses"]["BadRequest"];
            401: components["responses"]["Unauthorized"];
        };
    };

Component References ​

ReferenceResolves To
components["schemas"]["CustomerAddress"]CustomerAddress
components["responses"]["BadRequest"]BadRequest
components["responses"]["Unauthorized"]Unauthorized

Parameters ​

  • user_id (path): User id

Request Body ​

payload for new address

Content Types: application/json

Responses ​

200 ​

OK

400 ​

Bad request

401 ​

Not authorized for given operation on the Resource

OpenAPI Definition ​

json
{
  "tags": [
    "Customers"
  ],
  "operationId": "create-address",
  "summary": "Create address",
  "description": "Add new address",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/create-address",
    "description": "API reference for the create-address operation"
  },
  "parameters": [
    {
      "name": "user_id",
      "in": "path",
      "description": "User id",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "description": "payload for new address",
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "allOf": [
            {
              "$ref": "#/components/schemas/CustomerAddress"
            },
            {
              "type": "object",
              "properties": {
                "is_default_billing": {
                  "type": "boolean"
                },
                "is_default_shipping": {
                  "type": "boolean"
                }
              }
            }
          ]
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "properties": {
                  "address": {
                    "$ref": "#/components/schemas/CustomerAddress"
                  }
                },
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "$ref": "#/components/responses/BadRequest"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "x-speakeasy-group": "customers",
  "x-speakeasy-ignore": false,
  "x-speakeasy-name-override": "createAddress"
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: