job_physical_goods_parameters

 job_physical_goods object parameter data

Name

Type

Description

product_identifier
(semi-optional)

Product Identifier

The identifier of the physical good that will be added in the ordered items

The allowed physical good product identifier fields are the following

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of  the product

installed_item_identifier

(semi-optional)

Installed Item Identifier

The identifier of the installed item that will be provided based on an ordered physical good

The allowed installed item identifier fields are the following

Name

Type

Description

id

(semi-optional)

String

The ID of the installed item

serial_number

(semi-optional)

String

The serial number of the installed item

alternative_code

(semi-optional)

String

The alternative code of  a installed item

quantity
(optional and applicable on conditions)

Number

The quantity of the requested subscription physical good. If not specified then it is set to 1

Applicable only if the product_identifier is specified

warranty_coverage_reason_identifier

(mandatory and applicable on conditions)

 

Warranty Coverage Reason Identifier

The Warranty Coverage Reason which indicates if the requested to be replaced installed item's warranty will eventually cover the replacement or not

The allowed warranty coverage reason identifier fields are the following

Name

Type

Description

id

(semi-optional)

String

The ID of the warranty coverage reason

name

(semi-optional)

String

The name of the warranty coverage reason

alternative_code

(semi-optional)

String

The alternative code of the warranty coverage reason

Applicable and mandatory only if the related physical good is an installed item that was requested to be replaced and is still under warranty

notes

(optional)

String

The notes of the job requested subscription physical goods

components_set

(optional and applicable on conditions and only on add)

Set of Product Components objects

The physical good components that should be composing the specified physical good

This information is applicable only if the specified physical good is classified as a flexible product bundle

Referred Parameter Objects Data

 product component object parameter data
Name
Type
Description
product_identifier

(mandatory)

Product identifier  

The identifier of the product component. Only products that are allowed to be added on the related flexible product bundle are retrieved. The allowed product identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of  the product