{
  "opencollection": "1.0.0",
  "info": {
    "name": "Pipedrive API v1 Activities DealProducts API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "DealProducts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get deal products of several deals",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/deals/products",
            "params": [
              {
                "name": "deal_ids",
                "value": "",
                "type": "query",
                "description": "An array of integers with the IDs of the deals for which the attached products will be returned. A maximum of 100 deal IDs can be provided."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "For pagination, the marker (an opaque string value) representing the first item on the next page"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed."
              },
              {
                "name": "sort_by",
                "value": "",
                "type": "query",
                "description": "The field to sort by. Supported fields: `id`, `deal_id`, `add_time`, `update_time`, `order_nr`."
              },
              {
                "name": "sort_direction",
                "value": "",
                "type": "query",
                "description": "The sorting direction. Supported values: `asc`, `desc`."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Returns data about products attached to deals"
        },
        {
          "info": {
            "name": "List products attached to a deal",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/deals/:id/products",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "For pagination, the marker (an opaque string value) representing the first item on the next page"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed."
              },
              {
                "name": "sort_by",
                "value": "",
                "type": "query",
                "description": "The field to sort by. Supported fields: `id`, `add_time`, `update_time`, `order_nr`."
              },
              {
                "name": "sort_direction",
                "value": "",
                "type": "query",
                "description": "The sorting direction. Supported values: `asc`, `desc`."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Lists products attached to a deal."
        },
        {
          "info": {
            "name": "Add a product to a deal",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.pipedrive.com/v1/deals/:id/products",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Adds a product to a deal, creating a new item called a deal-product."
        },
        {
          "info": {
            "name": "Delete many products from a deal",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.pipedrive.com/v1/deals/:id/products",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of deal product IDs to delete. If not provided, all deal products will be deleted up to 100 items. Maximum 100 IDs allowed."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Deletes multiple products from a deal. If no product IDs are specified, up to 100 products will be removed from the deal. A maximum of 100 product IDs can be provided per request."
        },
        {
          "info": {
            "name": "Update the product attached to a deal",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.pipedrive.com/v1/deals/:id/products/:product_attachment_id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              },
              {
                "name": "product_attachment_id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal-product (the ID of the product attached to the deal)"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Updates the details of the product that has been attached to a deal."
        },
        {
          "info": {
            "name": "Delete an attached product from a deal",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.pipedrive.com/v1/deals/:id/products/:product_attachment_id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              },
              {
                "name": "product_attachment_id",
                "value": "",
                "type": "path",
                "description": "The product attachment ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Deletes a product attachment from a deal, using the `product_attachment_id`."
        },
        {
          "info": {
            "name": "Add multiple products to a deal",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.pipedrive.com/v1/deals/:id/products/bulk",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the deal"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request."
        }
      ]
    }
  ],
  "bundled": true
}