Skip to end of banner
Go to start of banner

job_ordered_physical_goods_parameters

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

Version 1 Next »

 job_ordered_physical_goods 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
  • UPDATE
  • REMOVE

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)

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

warranty_coverage_reason_identifier

(mandatory 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

provisioning_distribution_set

(optional)

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

  • No labels