{
  "opencollection": "1.0.0",
  "info": {
    "name": "Addresses Introduction Account Addresses Product Relationships API",
    "version": "25.1126.6886238"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Product Relationships",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get all Custom Relationships attached to a Product",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/pcm/products/:productID/custom-relationships",
            "params": [
              {
                "name": "productID",
                "value": "",
                "type": "path",
                "description": "A unique identifier for the product."
              },
              {
                "name": "page[offset]",
                "value": "",
                "type": "query",
                "description": "The number of records to offset the results by."
              },
              {
                "name": "page[limit]",
                "value": "",
                "type": "query",
                "description": "The number of records per page. The maximum limit is 100."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "### Prerequisites\n  - Custom Relationships have been attached to a product, see [Attach Custom Relationships to a Product](/docs/api/pxm/products/attach-custom-relationships)\n  - **OR** Products have been related to one another, see [Create a Relationship between a product with one or more products](/docs/api/pxm/products/product-association-id)\n"
        },
        {
          "info": {
            "name": "Attach Custom Relationships to a Product",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://useast.api.elasticpath.com/pcm/products/:productID/custom-relationships",
            "params": [
              {
                "name": "productID",
                "value": "",
                "type": "path",
                "description": "A unique identifier for the product."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "You can attach up to 5 custom relationships to a product.  \n\nOnce you have attached a custom relationship to a product, you can then create relationships from a product to one or many other products. See [Associate a product to one or more products using a custom relationship](/docs/api/pxm/products/product-association-id). \n\nSee [Custom Relationships](/guides/key-concepts/product-experience-manager/custom-relationships/).\n\n### Prerequisites\n  - A Custom Relationship has been created, see [creat"
        },
        {
          "info": {
            "name": "Delete Custom Relationships from a Product",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://useast.api.elasticpath.com/pcm/products/:productID/custom-relationships",
            "params": [
              {
                "name": "productID",
                "value": "",
                "type": "path",
                "description": "A unique identifier for the product."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Delete Custom Relationships from a Product. Multiple Custom Relationships can be deleted from a product in one request.\n"
        },
        {
          "info": {
            "name": "Get all Related Product IDs of a Products' attached Custom Relationship",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/pcm/products/:productID/custom-relationships/:customRelationshipSlug",
            "params": [
              {
                "name": "page[offset]",
                "value": "",
                "type": "query",
                "description": "The number of records to offset the results by."
              },
              {
                "name": "page[limit]",
                "value": "",
                "type": "query",
                "description": "The number of records per page. The maximum limit is 100."
              },
              {
                "name": "productID",
                "value": "",
                "type": "path",
                "description": "A unique identifier for the product."
              },
              {
                "name": "customRelationshipSlug",
                "value": "",
                "type": "path",
                "description": "A custom relationship slug."
              }
            ]
          },
          "docs": "### Prerequisites\n  - Relationships have been created between Products, see [Create a Relationship between a product with one or more products](/docs/api/pxm/products/product-association-id).\n"
        },
        {
          "info": {
            "name": "Create a Relationship between a Product with one or more Products",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://useast.api.elasticpath.com/pcm/products/:productID/custom-relationships/:customRelationshipSlug",
            "params": [
              {
                "name": "productID",
                "value": "",
                "type": "path",
                "description": "A unique identifier for the product."
              },
              {
                "name": "customRelationshipSlug",
                "value": "",
                "type": "path",
                "description": "A custom relationship slug."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "- You can associate a product with up to 2000 other products. \n- You do not need to attach a custom relationship to products beforehand, this will be done automatically by this endpoint. \n- This is a partial update, so if you make a request to this endpoint multiple times with different products in each request, they will not be overwritten but will be appended to the related products list. \n\nIf you want to remove a relationship between products, see [Delete a Relationship between a product with"
        },
        {
          "info": {
            "name": "Delete a Relationship between a product with one or more products",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://useast.api.elasticpath.com/pcm/products/:productID/custom-relationships/:customRelationshipSlug",
            "params": [
              {
                "name": "productID",
                "value": "",
                "type": "path",
                "description": "A unique identifier for the product."
              },
              {
                "name": "customRelationshipSlug",
                "value": "",
                "type": "path",
                "description": "A custom relationship slug."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Delete a Relationship between a product with one or more products"
        },
        {
          "info": {
            "name": "Get all Related Products of a Products' attached Custom Relationship",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/pcm/products/:productID/custom-relationships/:customRelationshipSlug/products",
            "params": [
              {
                "name": "page[offset]",
                "value": "",
                "type": "query",
                "description": "The number of records to offset the results by."
              },
              {
                "name": "page[limit]",
                "value": "",
                "type": "query",
                "description": "The number of records per page. The maximum limit is 100."
              },
              {
                "name": "productID",
                "value": "",
                "type": "path",
                "description": "A unique identifier for the product."
              },
              {
                "name": "customRelationshipSlug",
                "value": "",
                "type": "path",
                "description": "A custom relationship slug."
              }
            ]
          },
          "docs": "### Prerequisites\n  - Relationships have been created between Products, see [Create a Relationship between a product with one or more products](/docs/api/pxm/products/product-association-id).\n"
        }
      ]
    }
  ],
  "bundled": true
}