Products.create - PipelinerCRM

Creates new Product

Request

Query Params

validation-level

integer <int32>

optional

Specify validation level of Product on create. Use them as bit mask: 0 - validate each field on entity,
2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,
16 - allows to set entity on deleted relationship.

Body Params application / json

picture

object

optional

Relation to CloudObject, see: 'createCloudObjectInput' object for properties.

string <uri>

optional

allowed_pipelines

enum<integer>

optional

Integer enum value: 1 - All, 2 - Selected

Allowed values:

Example:

currency_exchange_rates_list_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

description

string

optional

Multi-line text input field.

Example:

string

name

string

required

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

picture_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

product_category_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

product_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

sku

string

optional

Simple text input field.

Example:

string

unit_symbol

string

optional

Simple text input field.

Example:

string

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

product_pipeline_relations

array [object {1}]

optional

Relations to Pipelines.

string <uri>

optional

product_pipelines

object

optional

Configuration of Pipelines where the Product can be used.

pipelines

array[string <uuid>]

required

allowed_pipelines

enum<integer>

required

Integer enum value: 1 - All, 2 - Selected

Allowed values:

Example:

picture_source_url

string

optional

Source url of picture. If filled url is loaded and checked content. Currently supports only pictures!!

Example:

string

Example

{
    "picture": {
        "id": "http://example.com"
    },
    "allowed_pipelines": 1,
    "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
    "description": "string",
    "name": "string",
    "picture_id": "01234567-abcd-dcba-ffff-000000000000",
    "product_category_id": "01234567-abcd-dcba-ffff-000000000000",
    "product_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "sku": "string",
    "unit_symbol": "string",
    "revision": 1,
    "product_pipeline_relations": [
        {
            "id": "http://example.com"
        }
    ],
    "product_pipelines": {
        "pipelines": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "allowed_pipelines": 1
    },
    "picture_source_url": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Creation confirmation. Returns created Product

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (Product)

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

currency_exchange_rates_list

string <uri>

optional

Relation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRatesList' object for properties.

picture

string <uri>

optional

Relation to CloudObject. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObject' object for properties.

product_category

string <uri>

optional

Relation to ProductCategory. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProductCategory' object for properties.

product_type

string <uri>

required

Relation to ProductType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProductType' object for properties.

allowed_pipelines

enum<integer>

optional

Integer enum value: 1 - All, 2 - Selected

Allowed values:

Example:

currency_exchange_rates_list_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

description

string

optional

Multi-line text input field.

Example:

string

name

string

required

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

picture_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

product_category_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

product_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

sku

string

optional

Simple text input field.

Example:

string

unit_symbol

string

optional

Simple text input field.

Example:

string

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

product_pipeline_relations

array[string <uri>]

optional

Relations to Pipelines.

product_pipelines

object

optional

Configuration of Pipelines where the Product can be used.

formatted_name

string

required

Example:

string

oppty_product_relation_type_id

string <uuid>

required

Example:

01234567-abcd-dcba-ffff-000000000000

Example

{
    "success": true,
    "data": {
        "is_delete_protected": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "currency_exchange_rates_list": "http://example.com",
        "picture": "http://example.com",
        "product_category": "http://example.com",
        "product_type": "http://example.com",
        "allowed_pipelines": 1,
        "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
        "description": "string",
        "name": "string",
        "picture_id": "01234567-abcd-dcba-ffff-000000000000",
        "product_category_id": "01234567-abcd-dcba-ffff-000000000000",
        "product_type_id": "01234567-abcd-dcba-ffff-000000000000",
        "sku": "string",
        "unit_symbol": "string",
        "revision": 1,
        "product_pipeline_relations": [
            "http://example.com"
        ],
        "product_pipelines": {
            "pipelines": [
                "497f6eca-6276-4993-bfeb-53cbbbba6f08"
            ],
            "allowed_pipelines": 1
        },
        "formatted_name": "string",
        "oppty_product_relation_type_id": "01234567-abcd-dcba-ffff-000000000000"
    }
}

🔴500Server Error