Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titlejob_ordered_physical_goods object parameter data
new_installed_items

Name

Type

Description

action

(mandatory)

String

Defines if a new or existing information will be updated

The supported values are the following

  • ADD
  • UPDATE
  • REMOVE

job_physical_good_identifier

(mandatory and applicable only on update and remove based on conditions)

Job Physical Good identifier

The job physical good that will be updated

The allowed job physical good identifier fields are the following

Include Page
job_physical_good_identifier
job_physical_good_identifier

product_identifier
(mandatory and applicable only on add based on conditions)

Product Identifier

The identifier of the physical good related with the requested subscription physical goodThis is applicable and mandatory if the job type's fulfillment scope is not set to Swap Subscription Installed Itemsthat will be added in the ordered items

The allowed physical good product identifier fields are the following

Include Page
product_identifier
product_identifier

installed_item_identifier

(mandatory and applicable only on update based 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

that will be provided based on an ordered physical good

The allowed installed item identifier fields are the following

Include Page
installed_item_identifier
installed_item_identifier

Applicable only if the related job_physical_good_identifier is a traceable physical good

quantity
(optional and applicable only on add and update based on conditions)

Number

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

Applicable only if one of the following is specified

  • product_identifier (on add)
  • job_physical_good_identifier (on update)

replaced_by_installed_item_identifier

(mandatory and applicable only on update based on addconditions)

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:

Include Page
installed_item_identifier
installed_item_identifier

   

Applicable only if the installed_item identifier is specified and the related job_physical_good_identifier is owned by the account owner and is not used in any subscriptions

warranty_coverage_reason_identifier

(mandatory mandatory and applicable only on update based on conditions)

 

Warranty Coverage Reason Identifier

The Warranty Coverage Reason which indicates if the requested to be swapped subscription replaced 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.

The allowed warranty coverage reason identifier fields are the following

Include Page
warranty_coverage_reason_identifier
warranty_coverage_reason_identifier

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

provisioning_distributioncomponents_set

(optional and applicable on conditions and only on add)

Set of Subscription Physical Good Provisioning Distribution Product Components objects

The

distribution of the requested subscription physical good
Anchor

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

Anchor
new physical good referred objects parameters
new

_installed_items

physical good referred objects parameters
Referred Parameter Objects Data

Include Page
subscriptionnew_physicalproduct_goodcomponent_distribution_parametersubscription
new_physicalproduct_good_distributioncomponent_parameter