Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Name

Type

Description

id

String

The ID of the retrieved product

number

code

String

The

number

code of the retrieved product

alt

alternative_code

String

The alternative code of the retrieved product

description

String

The description of the retrieved product

balance_due_to_payment

Float

The balance due to payment of the retrieved accounts receivable

life_cycle_state

String

The life cycle state of the retrieved accounts receivable

verification_state

String

The verification state of the retrieved accounts receivable

primary_account

Boolean

Indicates if the accounts receivable is the primary accounts receivable for the specified customer or not
short_descriptionString

A short description of the retrieved product

Tip

Available from CRM.COM R16.3.0 and onwards


long_descriptionString

A long description of the retrieved product

Tip

Available from CRM.COM R12.3.0 and CRM.COM R13.1.0 onwards


priority_levelInteger

The priority level of the product

Tip

Available from CRM.COM R12.3.0


non_stockableBoolean

The flag shoes if the retrieved product is non-stockable

Tip

Available from CRM.COM R18.0.0


udf_string_1

String

User Defined Field of type String

udf_string_2

String

User Defined Field of type String

udf_string_3

String

User Defined Field of type String

udf_string_4

String

User Defined Field of type String

udf_string_5

String

User Defined Field of type String

udf_string_6

String

User Defined Field of type String

udf_string_7

String

User Defined Field of type String

udf_string_8

String

User Defined Field of type String

udf_string_9

String

User Defined Field of type String

udf_string_10

String

User Defined Field of type String

udf_string_11

String

User Defined Field of type String

udf_string_12

String

User Defined Field of type String

udf_string_13

String

User Defined Field of type String

udf_string_14

String

User Defined Field of type String

udf_string_15

String

User Defined Field of type String

udf_string_16

String

User Defined Field of type String

udf_float_1

Float

User Defined Field of type Float

udf_float_2

Float

User Defined Field of type Float

udf_float_3

Float

User Defined Field of type Float

udf_float_4

Float

User Defined Field of type Float

udf_date_1

Date

User Defined Field of type Date

udf_date_2

Date

User Defined Field of type Date

udf_date_3

Date

User Defined Field of type Date

udf_date_4

Date

User Defined Field of type Date

global_rateGlobal Rate Object

The global rate of the retrieved product

Tip

Available from CRM.COM R15.0.0


type

Product Type

object

Object

The type of the retrieved product

brand

Product Brand

objectThe tax code

Object

The brand of the retrieved product

tax_code

Tax Code object

family

Product Family Object            

The product family of the retrieved product

log_information

Log Information Object

The

log information related with

Log Information related with the retrieved product

bundle_restrictions

Bundle Restrictions Object

The bundle restrictions of the new product

This parameter is applicable only if the product is classified as a flexible bundle

Tip

Available from CRM.COM R14.0.0


price_plans_set

Set of Price Plans Object      

The Price Plans containing the retrieved product

categories

validity_set

Set of Product

Categories Object            

Validity Object     

The
product categories
Product validity of the retrieved product (If is empty then the product is always valid)
families

categories_set

Set of Product

Families Object            

to Product Category Object      

The

product families

Product Categories of the retrieved product

components_set

Set of

Products Object      

Product Components Object

The components of the retrieved product

price_plans

. This is applicable only if the product type composition method is set to fixed or flexible bundle


usage_service_catalogs_setSet of
Price Plans Object      
Usage Service Catalogs Object

The

Price Plans containing the retrieved productvalidity

Usage Service Catalogs containing the retrieved product. Available only when the retrieved product is a usage service.

Tip

Available from CRM.COM R9.0.0


tax_rate_setSet of Tax Rate Objects

The TAX Rate of the retrieved product

Tip

Available from CRM.COM R14.0.0


vat_rate_set

Set of

Product Validity Object     

Vat Rate Objects

The

Product validity

VAT Rate of the retrieved product

. (If is empty then the product is always valid )

...

Tip

Deprecate from CRM.COM R17.0.0


metadata_setSet of Metadata Attributes

The set of metadata attributes available for the retrieved product

Tip

Available from CRM.COM R15.0.0


allowed_metadata_setSet of Metadata Attributes

The allowed set of metadata attributes whose values will be set on the installed items.

Available only for traceable physical goods

Tip

Available from CRM.COM R15.0.0


Anchor
product referred objects
product referred objects
Referred Objects Response Data

...

Include Page
product_brand_short
product_brand_short

Include Page
product_family_short
product_family_short

Include Page
tax_coderate_short
tax_code_rate_short

Include Page
vat_rate_short
vat_rate_short

Include Page
global_rate_short
global_rate_short

Include Page
log_information_short
log_information_short

Include Page
price_plan_short
price_plan_short

Include Page
product_validity_short
product_validity_short

Include Page
product_to_product_category_short
product_to_product_category_short

Include Page
product_familycomponent_short
product_component_short

Include Page
product_bundle_restrictions_short
product_family_bundle_restrictions_short

Include Page
usage_service_catalog_short
usage_service_catalog_short

Include Page
upsells_short
upsells_short

Include Page
cross_sells_short
cross_sells_short

Include Page
metadata_attribute_value_short
metadata_attribute_value_short

Include Page
allowed_metadata_attribute_short
allowed_metadata_attribute_short