{ "opencollection": "1.0.0", "info": { "name": "Addresses Introduction Account Addresses Catalogs API", "version": "25.1126.6886238" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Catalogs", "type": "folder" }, "items": [ { "info": { "name": "Gets all authorized catalogs", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalogs", "params": [ { "name": "filter", "value": "", "type": "query", "description": "This endpoint supports filtering, see [Filtering](#filtering).\n" }, { "name": "page[limit]", "value": "", "type": "query", "description": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used." }, { "name": "page[offset]", "value": "", "type": "query", "description": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results." } ] }, "docs": "Retrieves a list of all the catalogs that you are authorized to view. Currently, published catalogs are limited to the current release and two releases prior to the current release. You can see the differences between the last 2 consecutive catalog releases using the delta link returned in the response of a [publish a catalog](/docs/api/pxm/catalog/publish-release) endpoint.\n\nYou can use the `is_full_delta` attribute returned from the `get a release of a catalog` endpoint to determine if you nee" }, { "info": { "name": "Creates a new catalog", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/catalogs", "body": { "type": "json", "data": "{}" } }, "docs": "Before you create a catalog, you must define the following resources:\n\n- Hierarchies - hierarchies and nodes to categorize the products.\n- Products - product information, associated assets, and links to hierarchy nodes.\n- Price Books - prices for the products associated with the hierarchies. You can create multiple price books for different scenarios, such as seasonal sales, business versus retail customer pricing, and reward programs. When creating a catalog, you can specify up to five price bo" }, { "info": { "name": "Get a catalog by ID", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalogs/:catalog_id", "params": [ { "name": "catalog_id", "value": "", "type": "path", "description": "The catalog ID." } ] }, "docs": "Retrieves the specified catalog." }, { "info": { "name": "Updates a catalog", "type": "http" }, "http": { "method": "PUT", "url": "https://useast.api.elasticpath.com/catalogs/:catalog_id", "params": [ { "name": "catalog_id", "value": "", "type": "path", "description": "The catalog ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the catalog is not updated." }, { "info": { "name": "Deletes a catalog", "type": "http" }, "http": { "method": "DELETE", "url": "https://useast.api.elasticpath.com/catalogs/:catalog_id", "params": [ { "name": "catalog_id", "value": "", "type": "path", "description": "The catalog ID." } ] }, "docs": "Deletes an unpublished catalog. Use [**Delete a Release**](/docs/api/pxm/catalog/delete-release-by-id) and [**Delete All Releases**](/docs/api/pxm/catalog/delete-releases) to delete releases of a catalog. If the catalog is associated with any catalog rules, you must first update the catalog rules to remove the catalog." } ] } ], "bundled": true }