Appearance

update-customer ​

Method: PUT
Path: /customers/{id}

Tags: Customers

Summary ​

Update customer detail

Description ​

Update customer detail

Storefront SDK Usage ​

SDK Method: sdk.customer.updateCustomer()

Example:

typescript
const { data, error } = await sdk.customer.updateCustomer(
  { id: "customer_123" },
  {
    first_name: "John",
    last_name: "Smith",
    email: "john.smith@example.com"
  }
);

if (error) {
  console.error("Failed to update customer:", error);
  return;
}

console.log("Customer updated:", data.customer_detail);

TypeScript Definition ​

typescript
"update-customer": {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description Customer id */
                id: string;
            };
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": components["schemas"]["UpdateCustomer"];
            };
        };
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message?: string;
                        success?: boolean;
                        content?: {
                            customer_detail?: components["schemas"]["CustomerDetail"];
                        };
                    };
                };
            };
            400: components["responses"]["BadRequest"];
            401: components["responses"]["Unauthorized"];
        };
    };

Component References ​

ReferenceResolves To
components["schemas"]["UpdateCustomer"]UpdateCustomer
components["schemas"]["CustomerDetail"]CustomerDetail
components["responses"]["BadRequest"]BadRequest
components["responses"]["Unauthorized"]Unauthorized

Parameters ​

  • id (path): Customer id

Request Body ​

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": "update-customer",
  "summary": "Update customer detail",
  "description": "Update customer detail",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/update-customer",
    "description": "API reference for the update-customer operation"
  },
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "Customer id",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "description": "",
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/UpdateCustomer"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "properties": {
                  "customer_detail": {
                    "$ref": "#/components/schemas/CustomerDetail"
                  }
                },
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "$ref": "#/components/responses/BadRequest"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "x-speakeasy-group": "customers",
  "x-speakeasy-ignore": true,
  "x-speakeasy-name-override": "updateCustomer"
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: