{ "opencollection": "1.0.0", "info": { "name": "Addresses Introduction Account Addresses Administrator Latest Releases Catalog API API", "version": "25.1126.6886238" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Administrator Latest Releases Catalog API", "type": "folder" }, "items": [ { "info": { "name": "Get all Hierarchies", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalogs/:catalog_id/releases/:release_id/hierarchies", "headers": [ { "name": "accept-language", "value": "" } ], "params": [ { "name": "catalog_id", "value": "", "type": "path", "description": "The catalog ID." }, { "name": "release_id", "value": "", "type": "path", "description": "The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version." }, { "name": "filter", "value": "", "type": "query", "description": "\nThis endpoints 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": "Returns the hierarchies from a published catalog.\n\n:::note\n\nCurrently, published catalogs are limited to the current release and two releases prior to the current release.\n\n:::\n\n### Filtering\n\nThis endpoint supports filtering. For general syntax, see [Filtering](/guides/Getting-Started/filtering).\n\n| Operator | Description | Supported Attributes | Example |\n|:--- |:--- |:--- |:--- |\n| `Eq` | Checks if the values of two operands are equal. If they are, the condition is true. | `name`, `slug`| `fi" }, { "info": { "name": "Get a Hierarchy", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalogs/:catalog_id/releases/:release_id/hierarchies/:hierarchy_id", "headers": [ { "name": "accept-language", "value": "" } ], "params": [ { "name": "catalog_id", "value": "", "type": "path", "description": "The catalog ID." }, { "name": "release_id", "value": "", "type": "path", "description": "The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version." }, { "name": "hierarchy_id", "value": "", "type": "path", "description": "The catalog hierarchy ID." } ] }, "docs": "Returns the specified hierarchy from a published catalog.\n\n:::note\n\nCurrently, published catalogs are limited to the current release and two releases prior to the current release.\n\n:::\n" }, { "info": { "name": "Get a Hierarchy's Nodes", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalogs/:catalog_id/releases/:release_id/hierarchies/:hierarchy_id/nodes", "headers": [ { "name": "accept-language", "value": "" } ], "params": [ { "name": "catalog_id", "value": "", "type": "path", "description": "The catalog ID." }, { "name": "release_id", "value": "", "type": "path", "description": "The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version." }, { "name": "hierarchy_id", "value": "", "type": "path", "description": "The catalog hierarchy ID." }, { "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": "Returns all nodes for the specified hierarchy from a published catalog.\n\n:::note\n\nCurrently, published catalogs are limited to the current release and two releases prior to the current release.\n\n:::\n\nIn the `breadcrumbs` metadata, you can identify the parent nodes that a node is associated with. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).\n\n### Filtering\n\nTh" }, { "info": { "name": "Get a Hierarchy's Children", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalogs/:catalog_id/releases/:release_id/hierarchies/:hierarchy_id/children", "headers": [ { "name": "accept-language", "value": "" } ], "params": [ { "name": "catalog_id", "value": "", "type": "path", "description": "The catalog ID." }, { "name": "release_id", "value": "", "type": "path", "description": "The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version." }, { "name": "hierarchy_id", "value": "", "type": "path", "description": "The catalog hierarchy ID." }, { "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": "Returns the parent nodes for the specified hierarchy from a published catalog.\n\n![Parent Nodes](/assets/rootnodes.PNG)\n\n:::note\n\nCurrently, published catalogs are limited to the current release and two releases prior to the current release.\n\n:::\n\nIn the `breadcrumbs` metadata, you can identify the parent nodes that a node is associated with. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/H" }, { "info": { "name": "Get all Nodes", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalogs/:catalog_id/releases/:release_id/nodes", "headers": [ { "name": "accept-language", "value": "" } ], "params": [ { "name": "catalog_id", "value": "", "type": "path", "description": "The catalog ID." }, { "name": "release_id", "value": "", "type": "path", "description": "The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version." }, { "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": "Returns the child nodes from a published catalog.\n\n:::note\n\nCurrently, published catalogs are limited to the current release and two releases prior to the current release.\n\n:::\n\nYou can see the parent nodes a node is associated with in the `breadcrumbs` metadata for each node. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).\n\nIn a catalog, you can use a filter t" }, { "info": { "name": "Get a Node", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalogs/:catalog_id/releases/:release_id/nodes/:node_id", "headers": [ { "name": "accept-language", "value": "" } ], "params": [ { "name": "catalog_id", "value": "", "type": "path", "description": "The catalog ID." }, { "name": "release_id", "value": "", "type": "path", "description": "The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version." }, { "name": "node_id", "value": "", "type": "path", "description": "The catalog node ID." } ] }, "docs": "Returns a node from a published catalog.\n\n:::note\n\nCurrently, published catalogs are limited to the current release and two releases prior to the current release.\n\n:::\n\nYou can see the parent nodes a node is associated with in the `breadcrumbs` metadata for each node. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).\n\nThe response lists the products associated wi" }, { "info": { "name": "Get a Node's Children", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalogs/:catalog_id/releases/:release_id/nodes/:node_id/relationships/children", "headers": [ { "name": "accept-language", "value": "" } ], "params": [ { "name": "catalog_id", "value": "", "type": "path", "description": "The catalog ID." }, { "name": "release_id", "value": "", "type": "path", "description": "The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version." }, { "name": "node_id", "value": "", "type": "path", "description": "The catalog node ID." }, { "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": "Returns the child nodes for a node from a published catalog.\n\n:::note\n\nCurrently, published catalogs are limited to the current release and two releases prior to the current release.\n\n:::\n\nYou can see the parent nodes a node is associated with in the `breadcrumbs` metadata for each node. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/How-To/Catalogs/breadcrumbs).\n\nIn a catalog, you can use" }, { "info": { "name": "Get all Products", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalogs/:catalog_id/releases/:release_id/products", "headers": [ { "name": "accept-language", "value": "" }, { "name": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "" }, { "name": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "" } ], "params": [ { "name": "include", "value": "", "type": "query", "description": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n" }, { "name": "filter", "value": "", "type": "query", "description": "This endpoints support filtering. See [Filtering](#filtering).\n" }, { "name": "catalog_id", "value": "", "type": "path", "description": "The catalog ID." }, { "name": "release_id", "value": "", "type": "path", "description": "The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version." }, { "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": "Returns the products from a published catalog. Only the products in a `live` status are retrieved. Currently, published catalogs are limited to the current release and two releases prior to the current release.\n\nYou can see the parent nodes a product is associated with in the `bread_crumbs` and `bread_crumb_nodes` metadata for each product. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associations in Breadcrumb Metadata](/guides/Ho" }, { "info": { "name": "Get a Product", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalogs/:catalog_id/releases/:release_id/products/:product_id", "headers": [ { "name": "accept-language", "value": "" }, { "name": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "" }, { "name": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "" } ], "params": [ { "name": "include", "value": "", "type": "query", "description": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n" }, { "name": "catalog_id", "value": "", "type": "path", "description": "The catalog ID." }, { "name": "release_id", "value": "", "type": "path", "description": "The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version." }, { "name": "product_id", "value": "", "type": "path", "description": "The product ID." } ] }, "docs": "Returns a product from a published catalog. The product must be in `live` status. Currently, published catalogs are limited to the current release and two releases prior to the current release.\n\n### Product and Node Associations in Breadcrumb Metadata\n\nYou can see the parent nodes a product is associated with in the `bread_crumbs` and `bread_crumb_nodes` metadata for each product. This is useful if you want to improve how your shoppers search your store, for example. See [Product and Node Associ" }, { "info": { "name": "Get all Related Products of a Product", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalogs/:catalog_id/releases/:release_id/products/:product_id/relationships/:custom_relationship_slug/products", "headers": [ { "name": "accept-language", "value": "" }, { "name": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "" }, { "name": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "This endpoints support filtering. See [Filtering](#filtering).\n" }, { "name": "catalog_id", "value": "", "type": "path", "description": "The catalog ID." }, { "name": "release_id", "value": "", "type": "path", "description": "The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version." }, { "name": "product_id", "value": "", "type": "path", "description": "The product ID." }, { "name": "custom_relationship_slug", "value": "", "type": "path", "description": "The custom relationship slug." }, { "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": "Returns related products of the provided product ID from a published catalog.\n" }, { "info": { "name": "Get a Bundle's Component Products", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalogs/:catalog_id/releases/:release_id/products/:product_id/relationships/component_products", "headers": [ { "name": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "" }, { "name": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "" } ], "params": [ { "name": "include", "value": "", "type": "query", "description": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n" }, { "name": "catalog_id", "value": "", "type": "path", "description": "The catalog ID." }, { "name": "release_id", "value": "", "type": "path", "description": "The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version." }, { "name": "product_id", "value": "", "type": "path", "description": "The product ID." }, { "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": "With Product Experience Manager, you can [create](/docs/api/pxm/products/create-product) and manage bundles. A bundle is a purchasable product, comprising of one or more products that you want to sell together. \n\nYou can create multiple components within a bundle. Each component must have at least one or more options. Each option is a product and a quantity.\n\nThis endpoint returns a list of component product IDs for the specified bundle.\n\n### Including Resources\n\nUsing the `include` parameter, y" }, { "info": { "name": "Get a Parent Product's Child Products", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalogs/:catalog_id/releases/:release_id/products/:product_id/relationships/children", "headers": [ { "name": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "" }, { "name": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "" }, { "name": "accept-language", "value": "" } ], "params": [ { "name": "include", "value": "", "type": "query", "description": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n" }, { "name": "catalog_id", "value": "", "type": "path", "description": "The catalog ID." }, { "name": "release_id", "value": "", "type": "path", "description": "The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version." }, { "name": "product_id", "value": "", "type": "path", "description": "The product ID." }, { "name": "filter", "value": "", "type": "query", "description": "This endpoints support 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": "For a specified product and catalog release, retrieves a list of child products from a parent product. Any product other than a base product results in a `422 Unprocessable Entity` response. Only the products in a `live` status are retrieved.\n\nIf you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog is retrieved. If no catalog rules are configured, the first catalog found is returned. For information about how rules are matche" }, { "info": { "name": "Get a Hierarchy's Products", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalogs/:catalog_id/releases/:release_id/hierarchies/:hierarchy_id/products", "headers": [ { "name": "accept-language", "value": "" }, { "name": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "" }, { "name": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "" } ], "params": [ { "name": "include", "value": "", "type": "query", "description": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n" }, { "name": "catalog_id", "value": "", "type": "path", "description": "The catalog ID." }, { "name": "release_id", "value": "", "type": "path", "description": "The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version." }, { "name": "hierarchy_id", "value": "", "type": "path", "description": "The catalog hierarchy ID." }, { "name": "filter", "value": "", "type": "query", "description": "This endpoints support 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": "Returns the products associated with the specified hierarchy in the catalog. The products must be in the `live` status.\n\nIf you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog is retrieved. See [Resolving catalog rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).\n\nYou can see the parent nodes a product is associated with in the `bread_crumbs` and `bread_crumb_nodes` metadata for each product. This is useful if you " }, { "info": { "name": "Get a Node's Products", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalogs/:catalog_id/releases/:release_id/nodes/:node_id/relationships/products", "headers": [ { "name": "accept-language", "value": "" }, { "name": "EP-Pricebook-IDs-For-Price-Segmentation-Preview", "value": "" }, { "name": "EP-Pricebook-IDs-Of-Available-Prices-To-Show", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "This endpoints support filtering. See [Filtering](#filtering).\n" }, { "name": "include", "value": "", "type": "query", "description": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n" }, { "name": "catalog_id", "value": "", "type": "path", "description": "The catalog ID." }, { "name": "release_id", "value": "", "type": "path", "description": "The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version." }, { "name": "node_id", "value": "", "type": "path", "description": "The catalog node ID." }, { "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": "Returns the products associated with the specified hierarchy node in the catalog. The products must be in the `live` status. If the products have been curated, then the products are returned in the order specified in the `curated_products` attribute. A product that is curated has the `\"curated_product\": true` attribute displayed.\n\n:::note\n\nCurrently, published catalogs are limited to the current release and two releases prior to the current release.\n\n:::\n\nIf you have multiple catalog rules defin" } ] } ], "bundled": true }