Skip to end of banner
Go to start of banner

product_parameters

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

 product parameter object data
NameType Description

code

(mandatory)

String

The code of the product

alternative_code

(mandatory)

StringThe alternative code of the product. If not specified then it is generated automatically based on the specified product code

type

(mandatory)

Product Type Identifier

The identifier of the product type. The allowed product type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product type

name

(semi-optional)

String

The name of the product type

alternative_code

(semi-optional)

String

The alternative code of  a product type

vat_rate_identifier

(mandatory)

VAT Rate Identifier

The identifier of the VAT rate that will be applicable on the product. The allowed VAT rate identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the VAT rate

name

(semi-optional)

String

The name of the VAT rate

alternative_code

(semi-optional)

String

The alternative code of  the VAT rate

brand_identifier

(optional)

Product Brand Identifier

The identifier of the product brand. The allowed product brand identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product brand

name

(semi-optional)

String

The name of the product brand

alternative_code

(semi-optional)

String

The alternative code of  a product brand

family

(optional)

Product Family Identifier

The identifier of the product family. The allowed product family identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product family

name

(semi-optional)

String

The name of the product family

code

(semi-optional)

String

The code of  a product family

description

(optional)

StringThe description of the product 

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

validity_set

(optional)

Set of Product Validity ObjectsThe  time periods during which the product will be available to be used. If not specified then the product will be always be available

categories_set

(optional)

Set of Product Category Objects The categories related with the product. More than one categories can be specified. Each category can be specified just once.

Referred Parameter Objects Data

 product_validity parameter object data
NameType Description

valid_from

(mandatory)

Date

The date that the product will become valid

valid_to

(optional)

Date

The date that the product will become invalid. This is optional as a product can be valid for ever, starting from a specific date

 product_categories parameter object data
NameType Description

category_identifier

(mandatory)

Product Category Identifier

The identifier of the product category. The allowed product categories identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product category

name

(semi-optional)

String

The name of the product category

code

(semi-optional)

String

The code of  a product category

     

  • No labels