{
  "opencollection": "1.0.0",
  "info": {
    "name": "Helpcenter Product API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Product",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get product",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/products/:productId",
            "params": [
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Key that fetches secondary information related to the product. Values allowed are: @departments@ and @owner@. You can pass multiple values by separating them with commas."
              },
              {
                "name": "productId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API fetches a single product from your helpdesk."
        },
        {
          "info": {
            "name": "Update product",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v1/products/:productId",
            "params": [
              {
                "name": "productId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API updates details of a product in your help desk portal."
        },
        {
          "info": {
            "name": "List Products",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/products",
            "params": [
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Secondary information related to the contact.Value supported is @owner@."
              },
              {
                "name": "viewId",
                "value": "",
                "type": "query",
                "description": "Custom view Id"
              },
              {
                "name": "departmentId",
                "value": "",
                "type": "query",
                "description": "ID of the department from which the products count must be computed. If you want to count of the products configured in all accessible departments, pass the value 0."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "No. of products to fetch"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Index number, starting from which the products must be fetched"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Sort by a specific attribute : @productName@, @productCode@, @unitPrice@, @createdTime@ or @modifiedTime@. The default sorting order is ascending. A @-@ prefix denotes descending order of sorting."
              },
              {
                "name": "ownerId",
                "value": "",
                "type": "query",
                "description": "Displays the number of products of only a particular owner"
              }
            ]
          },
          "docs": "This API lists a specific number of products from your help desk portal, based on the limit defined. (Note: The departmentIds key will soon be deprecated and not included in API responses.)"
        },
        {
          "info": {
            "name": "Create product",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/products",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API adds a product to your helpdesk."
        },
        {
          "info": {
            "name": "Move Products to trash",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/products/moveToTrash",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API moves products to the Recycle Bin of your help desk portal."
        },
        {
          "info": {
            "name": "Associate accounts with a product",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/products/:productId/associateAccounts",
            "params": [
              {
                "name": "productId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API associates accounts with a product. Only a maximum of 10 accounts can be associated with a product through a single API request."
        },
        {
          "info": {
            "name": "Associate contacts with a product",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/products/:productId/associateContacts",
            "params": [
              {
                "name": "productId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API associates contacts with a product. Only a maximum of 10 contacts can be associated with a product through a single API request."
        },
        {
          "info": {
            "name": "Search for duplicate records",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/products/searchDuplicates",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "No. of products to fetch"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Index number, starting from which the products must be fetched"
              },
              {
                "name": "productName",
                "value": "",
                "type": "query",
                "description": "Name of the product, used as the keyword for the search"
              }
            ]
          },
          "docs": "This API searches for duplicate records of a product."
        },
        {
          "info": {
            "name": "List products by account",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/accounts/:accountId/products",
            "params": [
              {
                "name": "departmentId",
                "value": "",
                "type": "query",
                "description": "ID of the department from which the products count must be computed. If you want to count of the products configured in all accessible departments, pass the value 0."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "No. of products to fetch"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Index number, starting from which the products must be fetched"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API lists products associated for a specific account."
        },
        {
          "info": {
            "name": "List products by contact",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/contacts/:contactId/products",
            "params": [
              {
                "name": "departmentId",
                "value": "",
                "type": "query",
                "description": "ID of the department from which the products count must be computed. If you want to count of the products configured in all accessible departments, pass the value 0."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "No. of products to fetch"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Index number, starting from which the products must be fetched"
              },
              {
                "name": "contactId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API lists products associated for a specific contact."
        }
      ]
    }
  ],
  "bundled": true
}