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 3
Next »
job_ordered_physical_goods 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 |
job_physical_good_identifier (mandatory and applicable only on remove) | Job Physical Good identifier | The job physical good that will be updated The allowed job physical good identifier fields are the following Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the job physical good | installed_item_identifier (semi-optional) | Installed Item Identifier | The identifier of the installed item related with the Job 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 |
| product_identifier (semi-optional) | Product Identifier | The identifier of the physical good product related with the Job Physical Good. 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 |
|
|
| | | |
| | | |
product_identifier
(mandatory 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 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 (mandatory on conditions) | Installed Item Identifier | The identifier of the installed item which is requested to be replaced 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 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 only 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 |
replaced_by_installed_item_identifier (mandatory and applicable only on add) | Installed Item Identifier | The identifier of the installed item that will replace the Job Physical Good Replacement. 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 |
|
| | | |
warranty_coverage_reason_identifier (mandatory and applicable only on add 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. 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 |
|
notes (optional) | String | The notes of the job requested subscription physical goods |
components_set (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
| | |
|---|
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 |
|