job_requested_subscription_physical_good object parameter data
Name
Type
Description
product_identifier (mandatory based on conditions)
Product Identifier
The identifier of the physical good related with the requested subscription physical good. This is applicable and mandatory if the job type's fulfillment scope is not set to Swap Subscription Installed Items. The allowed physical good product identifier fields are the following:
Include Page
product_identifier
product_identifier
Tip
Job Type fulfillment scope Swap Subscription Installed Items is available from CRM.COM R9.0.0
installed_item_identifier
(mandatory based on conditions)
Installed Item Identifier
The identifier of the installed item which is requested to be swapped with another installed item. This is applicable and mandatory only if the job type fulfillment scope is set to Swap Subscription Installed Items. The allowed installed item identifier fields are the following:
Include Page
installed_item_identifier
installed_item_identifier
Tip
Available from CRM.COM R9.0.0
set_as_not_effective
(optional)
Boolean
Defines whether the installed item will be set as Not Effective. This is applicable only if the job type fulfillment scope is set to Swap Subscription Installed Items.
Tip
Available from CRM.COM R15.0.0
state_classification_identifier
(mandatory on conditions)
State Classification Identifier
Defines the state classification of a Not Effective installed item. Applicable and mandatory only if set_as_not_effective is set to True. This is applicable only if the job type fulfillment scope is set to Swap Subscription Installed Items. The allowed state classification identifier fields are the following:
Include Page
state_classification_identifier
state_classification_identifier
Tip
Available from CRM.COM R15.0.0
quantity (optional)
Number
The quantity of the requested subscription physical good. If not specified then it is set to 1
warranty_coverage_reason_identifier
(mandatory based on conditions)
Warranty Coverage Reason Identifier
The Warranty Coverage Reason which indicates if the requested to be swapped subscription installed item's warranty will eventually cover the replacement or not. This is applicable and mandatory in Swap Subscription Installed Items jobs and only if the requested to be swapped installed item is still under warranty.
Include Page
warranty_coverage_reason_identifier
warranty_coverage_reason_identifier
Tip
Available from CRM.COM R9.0.0
notes
(optional)
String
The notes of the job requested subscription physical goods