{
  "opencollection": "1.0.0",
  "info": {
    "name": "Addresses Introduction Account Addresses Custom Relationships API",
    "version": "25.1126.6886238"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Custom Relationships",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get all custom relationships",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/pcm/custom-relationships",
            "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": "filter",
                "value": "",
                "type": "query",
                "description": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n"
              }
            ]
          },
          "docs": "Gets all Custom Relationships. \n\nTo see a list of custom relationships a product is attached to, see [Get all Custom Relationships attached to a Product](/docs/api/pxm/products/list-attached-custom-relationship).\n\nTo see a list of products that a product is related to, see [Get all Related Products of a Products' attached Custom Relationship](/docs/api/pxm/products/get-related-products-of-a-product-id).\n\n### Filtering\n\n Many Commerce API endpoints support filtering. The general syntax is describ"
        },
        {
          "info": {
            "name": "Create a custom relationship",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://useast.api.elasticpath.com/pcm/custom-relationships",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Custom relationships can either be bi-directional or uni-directional.\n  - **Uni-Directional**: By setting `bi_directional` to `false` (or omitted from request) a uni-directional custom relationship will be created. \n  Within a uni-directional relationship, if Product A links to Product B, Product B will not link back to Product A. \n  This is ideal when one product (e.g., a base product) recommends another (e.g., an upsell), but the reverse \n  recommendation is unnecessary.\n \n - **Bi-Directional*"
        },
        {
          "info": {
            "name": "Get a custom relationship",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/pcm/custom-relationships/:customRelationshipSlug",
            "params": [
              {
                "name": "customRelationshipSlug",
                "value": "",
                "type": "path",
                "description": "A custom relationship slug."
              }
            ]
          },
          "docs": "Gets a Custom Relationship.\n\nTo see a list of custom relationships a product is attached to, see [Get all Custom Relationships attached to a Product](/docs/api/pxm/products/list-attached-custom-relationship).\n\nTo see a list of products that a product is related to, see [Get all Related Products of a Products' attached Custom Relationship](/docs/api/pxm/products/get-related-products-of-a-product-id).\n"
        },
        {
          "info": {
            "name": "Update a custom relationship",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://useast.api.elasticpath.com/pcm/custom-relationships/:customRelationshipSlug",
            "params": [
              {
                "name": "customRelationshipSlug",
                "value": "",
                "type": "path",
                "description": "A custom relationship slug."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a custom relationship. \n\nA partial update can be performed, where you specify only the fields that need to be changed.\n\nThe custom relationship slug cannot be updated.\n"
        },
        {
          "info": {
            "name": "Delete a custom relationship",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://useast.api.elasticpath.com/pcm/custom-relationships/:customRelationshipSlug",
            "params": [
              {
                "name": "customRelationshipSlug",
                "value": "",
                "type": "path",
                "description": "A custom relationship slug."
              }
            ]
          },
          "docs": "Deletes the specified custom relationship.\n\nCustom Relationships cannot be deleted if they are in use.\n"
        }
      ]
    }
  ],
  "bundled": true
}