{ "opencollection": "1.0.0", "info": { "name": "commercetools Change History Carts Customers API", "version": "1.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Customers", "type": "folder" }, "items": [ { "info": { "name": "List customers", "type": "http" }, "http": { "method": "GET", "url": "https://history.{region}.commercetools.com/:projectKey/customers", "params": [ { "name": "projectKey", "value": "", "type": "path", "description": "The unique key identifying the commercetools project." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return. Defaults to 20, maximum 500." }, { "name": "offset", "value": "", "type": "query", "description": "Number of results to skip for pagination. Maximum 10000." }, { "name": "where", "value": "", "type": "query", "description": "Query predicate string for filtering results. Uses commercetools predicate syntax (e.g., 'customerEmail = \"user@example.com\"')." }, { "name": "sort", "value": "", "type": "query", "description": "Sort expression string (e.g., 'createdAt desc'). Multiple sort expressions can be provided as separate parameters." }, { "name": "expand", "value": "", "type": "query", "description": "Reference expansion path to inline referenced resources in the response (e.g., 'productType', 'categories[*]')." } ] }, "docs": "Returns a paginated list of all customers in the project. Supports filtering by email, customer group, and other predicates. For large customer bases use the Customer Search endpoint for improved performance." }, { "info": { "name": "Create a customer", "type": "http" }, "http": { "method": "POST", "url": "https://history.{region}.commercetools.com/:projectKey/customers", "params": [ { "name": "projectKey", "value": "", "type": "path", "description": "The unique key identifying the commercetools project." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new customer account. The email address must be unique within the project (or store if store-scoped). Optionally assigns the customer to a customer group and pre-verifies the email address." }, { "info": { "name": "Get a customer by ID", "type": "http" }, "http": { "method": "GET", "url": "https://history.{region}.commercetools.com/:projectKey/customers/:id", "params": [ { "name": "projectKey", "value": "", "type": "path", "description": "The unique key identifying the commercetools project." }, { "name": "id", "value": "", "type": "path", "description": "The system-generated unique identifier of the resource." }, { "name": "expand", "value": "", "type": "query", "description": "Reference expansion path to inline referenced resources in the response (e.g., 'productType', 'categories[*]')." } ] }, "docs": "Retrieves a single customer by their system-generated ID, including addresses, customer group assignments, store assignments, and custom fields." }, { "info": { "name": "Update a customer by ID", "type": "http" }, "http": { "method": "POST", "url": "https://history.{region}.commercetools.com/:projectKey/customers/:id", "params": [ { "name": "projectKey", "value": "", "type": "path", "description": "The unique key identifying the commercetools project." }, { "name": "id", "value": "", "type": "path", "description": "The system-generated unique identifier of the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Applies update actions to the customer with the given ID. Supported actions include adding addresses, changing email, setting customer group, adding store assignments, and setting custom fields." }, { "info": { "name": "Delete a customer by ID", "type": "http" }, "http": { "method": "DELETE", "url": "https://history.{region}.commercetools.com/:projectKey/customers/:id", "params": [ { "name": "projectKey", "value": "", "type": "path", "description": "The unique key identifying the commercetools project." }, { "name": "id", "value": "", "type": "path", "description": "The system-generated unique identifier of the resource." }, { "name": "version", "value": "", "type": "query", "description": "Current version of the resource for optimistic concurrency control." } ] }, "docs": "Permanently deletes the customer with the given ID. The current version must be provided. Associated carts, orders, and payment records are not deleted." }, { "info": { "name": "Import customers", "type": "http" }, "http": { "method": "POST", "url": "https://history.{region}.commercetools.com/:projectKey/customers/import-containers/:importContainerKey", "params": [ { "name": "projectKey", "value": "", "type": "path", "description": "The unique key of the commercetools project." }, { "name": "importContainerKey", "value": "", "type": "path", "description": "The user-defined key of the import container." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Submits a batch of customer import requests for asynchronous processing. Customers are matched by key for upsert behavior. Each request accepts up to 20 customer resources." } ] } ], "bundled": true }