Rpipedrive (version 0.1.1)

products.add: Add a product

Description

Function to Add a product on pipedrive.

Usage

products.add(name, code = NULL, unit = NULL, tax = NULL,
  active_flag = NULL, visible_to = NULL, owner_id = NULL,
  prices = NULL, customList = NULL, api_token = NULL,
  company_domain = "api", return_type = c("complete", "boolean"))

Arguments

name

Name of the product.

code

Product code.

unit

Unit in which this product is sold

tax

Tax percentage

active_flag

Whether this product will be made active or not. This field has the following domains: (0; 1)

visible_to

Visibility of the product. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.1 = Owner & followers (private); 3 = Entire company (shared) This field has the following domains: (1; 3)

owner_id

ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used.

prices

Array of objects, each containing: currency (string), price (number), cost (number, optional), overhead_cost (number, optional). Note that there can only be one price per product per currency. When 'prices' is omitted altogether, no prices will be set up for the product. this field must be a JSON.

customList

List with custom fields. Example: list(`custom_field` = abc)

api_token

To validate your requests, you'll need your api_token - this means that our system will need to know who you are and be able to connect all actions you do with your chosen Pipedrive account. Have in mind that a user has a different api_token for each company. Please access the following link for more information: <https://pipedrive.readme.io/docs/how-to-find-the-api-token?utm_source=api_reference>

company_domain

How to get the company domain: <https://pipedrive.readme.io/docs/how-to-get-the-company-domain>

return_type

the default return is an object List with all informations of process, or you can set boolean (TRUE = success, FALSE = error)

Value

customizable return, the default is an object List

Examples

# NOT RUN {
products.add(name='e.g.',api_token='token',company_domain='exp')
# }