{ "opencollection": "1.0.0", "info": { "name": "commercetools Change History Carts Products API", "version": "1.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Products", "type": "folder" }, "items": [ { "info": { "name": "List products", "type": "http" }, "http": { "method": "GET", "url": "https://history.{region}.commercetools.com/:projectKey/products", "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 products in the project. Supports filtering, sorting, and field expansion via query parameters. Use the Product Projections endpoint for storefront display queries." }, { "info": { "name": "Create a product", "type": "http" }, "http": { "method": "POST", "url": "https://history.{region}.commercetools.com/:projectKey/products", "params": [ { "name": "projectKey", "value": "", "type": "path", "description": "The unique key identifying the commercetools project." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new product with the given draft. The product type reference in the draft determines which attributes are valid. The product is created with a staged version and requires publication to become visible in product projections." }, { "info": { "name": "Get a product by ID", "type": "http" }, "http": { "method": "GET", "url": "https://history.{region}.commercetools.com/:projectKey/products/: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 product by its system-generated ID. The response includes both the current (published) and staged versions of the product data." }, { "info": { "name": "Update a product by ID", "type": "http" }, "http": { "method": "POST", "url": "https://history.{region}.commercetools.com/:projectKey/products/: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 one or more update actions to the product identified by the given ID. The request must include the current version to enable optimistic concurrency control. Supported actions include changing names, setting attributes, adding variants, and publishing." }, { "info": { "name": "Delete a product by ID", "type": "http" }, "http": { "method": "DELETE", "url": "https://history.{region}.commercetools.com/:projectKey/products/: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 product with the given ID. The current version must be provided as a query parameter for concurrency control. Deletion cannot be undone." }, { "info": { "name": "Import products", "type": "http" }, "http": { "method": "POST", "url": "https://history.{region}.commercetools.com/:projectKey/products/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 product import requests to the specified container for asynchronous processing. Each request can contain up to 20 product resources. Products are matched by their user-defined key for upsert behavior." } ] } ], "bundled": true }