job_requested_subscription_physical_goods_update_parameters

 job_requested_subscription_physical_good object parameter data

Name

Type

Description

action

(mandatory)

String

Defines if a new or existing information will be updated.The supported values are the following:

ADD or REMOVE

job_requested_subscription_physical_good_identifier

(mandatory and applicable only on remove)

Job Requested Subscription Physical Good Identifier

The identifier of the job requested subscription physical good that will be updated. The allowed job requested subscription physical good identifier fields are the following:

Name

Type

Description

id

(mandatory)

String

The ID of the job requested subscription physical good

product_identifier
(mandatory and applicable only on add)

Product Identifier

The identifier of the physical good related with the requested subscription physical good. This information is not mandatory for jobs with fulfillment scope Swap Subscription Installed 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

Swap Subscription Installed Items job type fulfillment scope available from CRM.COM R9.0.0

installed_item_identifier

(mandatory and applicable only on add based on conditions)

Installed Item Identifier

The identifier of the traceable physical good related with the requested subscription physical good. This information is available and mandatory but only for Swap Subscription Installed Item jobs. The allowed traceable physical good 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

Available from CRM.COM R9.0.0

warranty_coverage_reason_identifier

(mandatory and applicable on add and based on conditions)

 

The identifier of the warranty coverage reason that provides reasoning for the traceable physical good's swap. This information is available and mandatory for Swap Subscription Installed Item jobs but only if the job requested physical good to be replaced is still under warranty.

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

Available from CRM.COM R9.0.0

quantity
(optional and applicable only on add)

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

notes

(optional and applicable only on add)

String

The notes of the job requested subscription physical goods

Available form CRM.COM R12.3.0

provisioning_distribution_set

(optional and applicable only on add)

Set of Subscription Physical Good Provisioning Distribution objectsThe distribution of the requested subscription physical good

Referred Parameter Objects Data

 subscription_physical_good_distribution object parameter data
Name
Type
Description

provisioning_distributor_identifier

(mandatory)

Provisioning distributor identifier  

The identifier of the provisioning distributor. The allowed provisioning distributor identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the provisioning distributor

name

(semi-optional)

String

The name of the provisioning distributor

alternative_code

(semi-optional)

String

The alternative code of  the provisioning distributor