{ "opencollection": "1.0.0", "info": { "name": "Addresses Introduction Account Addresses Shopper Catalog API API", "version": "25.1126.6886238" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Shopper Catalog API", "type": "folder" }, "items": [ { "info": { "name": "Get all Hierarchies", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalog/hierarchies", "headers": [ { "name": "accept-language", "value": "" }, { "name": "EP-Channel", "value": "" }, { "name": "EP-Context-Tag", "value": "" } ], "params": [ { "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 all hierarchies from a catalog.\n\nIf you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog is retrieved. For information about how rules are matched, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).\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|:--- " }, { "info": { "name": "Get a Hierarchy", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalog/hierarchies/:hierarchy_id", "headers": [ { "name": "accept-language", "value": "" }, { "name": "EP-Channel", "value": "" }, { "name": "EP-Context-Tag", "value": "" } ], "params": [ { "name": "hierarchy_id", "value": "", "type": "path", "description": "The catalog hierarchy ID." } ] }, "docs": "Returns a hierarchy from the catalog.\n\nIf you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog to retrieve. For information about how catalog rules are matched, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules).\n" }, { "info": { "name": "Get a Hierarchy's Nodes", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalog/hierarchies/:hierarchy_id/nodes", "headers": [ { "name": "EP-Channel", "value": "" }, { "name": "EP-Context-Tag", "value": "" }, { "name": "accept-language", "value": "" } ], "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." }, { "name": "hierarchy_id", "value": "", "type": "path", "description": "The catalog hierarchy ID." } ] }, "docs": "Returns all the nodes for the specified hierarchy.\n\nIf you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog is retrieved. For information about how rules are matched, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).\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 e" }, { "info": { "name": "Get a Hierarchy's Children", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalog/hierarchies/:hierarchy_id/children", "headers": [ { "name": "EP-Channel", "value": "" }, { "name": "EP-Context-Tag", "value": "" }, { "name": "accept-language", "value": "" } ], "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." }, { "name": "hierarchy_id", "value": "", "type": "path", "description": "The catalog hierarchy ID." } ] }, "docs": "Returns the parent nodes for the specified hierarchy.\n\n![Parent Nodes](/assets/rootnodes.PNG)\n\nIf you have multiple catalog rules defined, the rule that best matches the shopperʼs context is used to determine which catalog is retrieved. For information about how rules are matched, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).\n\nIn the `breadcrumbs` metadata, you can identify the parent nodes that a node is associated with. This is useful if you want to improv" }, { "info": { "name": "Get all Nodes", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalog/nodes", "headers": [ { "name": "EP-Channel", "value": "" }, { "name": "EP-Context-Tag", "value": "" }, { "name": "accept-language", "value": "" } ], "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": "Returns all nodes in the catalog.\n\nIf you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog is retrieved. For information about how rules are matched, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).\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 [P" }, { "info": { "name": "Get a Node", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalog/nodes/:node_id", "headers": [ { "name": "EP-Channel", "value": "" }, { "name": "EP-Context-Tag", "value": "" }, { "name": "accept-language", "value": "" } ], "params": [ { "name": "node_id", "value": "", "type": "path", "description": "The catalog node ID." } ] }, "docs": "Returns a node from the catalog.\n\nIf you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog is retrieved. For information about how rules are matched, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).\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 [Pr" }, { "info": { "name": "Get a Node's Children", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalog/nodes/:node_id/relationships/children", "headers": [ { "name": "EP-Channel", "value": "" }, { "name": "EP-Context-Tag", "value": "" }, { "name": "accept-language", "value": "" } ], "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." }, { "name": "node_id", "value": "", "type": "path", "description": "The catalog node ID." } ] }, "docs": "Returns the child nodes for a node in the catalog.\n\nIf you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog is retrieved. For information about how rules are matched, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).\n\nYou can see which 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, " }, { "info": { "name": "Get all Products", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalog/products", "headers": [ { "name": "accept-language", "value": "" }, { "name": "EP-Channel", "value": "" }, { "name": "EP-Context-Tag", "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": "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 the list of products from the catalog. Only the products in a live status are retrieved.\n\n### Catalog Rules\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 matched, see [Resolving Catalog Rules](/docs/api/pxm/catalog/rules#resolving-catalog-rules).\n\n### Product and Node Associations\n\n Y" }, { "info": { "name": "Get a Product", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalog/products/:product_id", "headers": [ { "name": "accept-language", "value": "" }, { "name": "EP-Channel", "value": "" }, { "name": "EP-Context-Tag", "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": "product_id", "value": "", "type": "path", "description": "The product ID." } ] }, "docs": "Returns the specified product from the catalog. The product 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. For information about how rules are matched, 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" }, { "info": { "name": "Get all Related Products of a Product", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalog/products/:product_id/relationships/:custom_relationship_slug/products", "headers": [ { "name": "accept-language", "value": "" }, { "name": "EP-Channel", "value": "" }, { "name": "EP-Context-Tag", "value": "" } ], "params": [ { "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." }, { "name": "product_id", "value": "", "type": "path", "description": "The product ID." }, { "name": "custom_relationship_slug", "value": "", "type": "path", "description": "The custom relationship slug." } ] }, "docs": "Returns related products of the provided product ID from a catalog.\n" }, { "info": { "name": "Get a Bundle's Component Products", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalog/products/:product_id/relationships/component_products", "headers": [ { "name": "EP-Channel", "value": "" }, { "name": "EP-Context-Tag", "value": "" } ], "params": [ { "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" }, { "info": { "name": "Get a Parent Product's Child Products", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalog/products/:product_id/relationships/children", "headers": [ { "name": "EP-Channel", "value": "" }, { "name": "EP-Context-Tag", "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": "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 shopperʼs 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 match" }, { "info": { "name": "Get a Hierarchy's Products", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalog/hierarchies/:hierarchy_id/products", "headers": [ { "name": "accept-language", "value": "" }, { "name": "EP-Channel", "value": "" }, { "name": "EP-Context-Tag", "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": "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." }, { "name": "hierarchy_id", "value": "", "type": "path", "description": "The catalog hierarchy ID." } ] }, "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 wa" }, { "info": { "name": "Get a Node's Products", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/catalog/nodes/:node_id/relationships/products", "headers": [ { "name": "accept-language", "value": "" }, { "name": "EP-Channel", "value": "" }, { "name": "EP-Context-Tag", "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": "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\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 rule" }, { "info": { "name": "Configure a Shopper Bundle", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/catalog/products/:product_id/configure", "headers": [ { "name": "accept-language", "value": "" }, { "name": "EP-Channel", "value": "" }, { "name": "EP-Context-Tag", "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": "product_id", "value": "", "type": "path", "description": "The product ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Once you have configured your product bundles, you can display them in your storefront in your published catalog. Depending on how you have configured the minimum and maximum values for the product options in your components, you can allow your shoppers to choose which products they want to select. For example, you can enable a shopper to select 1 or more product options from a list of 10, giving your shoppers greater flexibility when selecting products in your store front.\n\n- Products must be i" } ] } ], "bundled": true }