Items

Item object

The Item object represents a “product item” as a transactable element of a product that, for example, in a created order, is represented as a “line item” of that order.

Field	Type	Description
id	string	Platform generated Id. Example: "ITM-0690-0539-0001"
href	string	The resource URI of the Item. Example: "/product-items/ITM-0690-0539-0001"
name	string	Name of the item. Example: "Microsoft 365 Apps for Business"
description	string	Item description. Example: "Best for businesses that need Office apps across devices and cloud file storage. For businesses with up to 300 employees."
externalIds	ExternalIds	Example: { "vendor": "ven-1233-3222", "operations": "op-322-322", }
terms	Terms	Terms for the Items, as defined in Terms object. Example: { "period": "1m", "commitment": "1y" }
quantityNotApplicable	boolean	Is quantity is not applicable or relevant to the product item being sold. Example: "true"
status	See Item States.	Status of the item. Example: "Draft"
parameters	ParameterValue	Captures any additional information required for a product item and is defined by item configuration parameters. Only item configuration parameters are available on this list. Example: { "id": "PRM-1234-1234-1234", "externalId": "SKU", "value": "65272478BB01A12" }
group	ItemGroup	Item group to wich item is assigned.
unit	UnitOfMeasure	Unit of measure assigned to item.
product	Product	Product to which item is assigned.
audit	AuditObject	Audit object with possible entries: created, updated, activated, terminated, according to lifecycle of the object. Possible audit events: created, updated. Example: { "created": { "at": "...", "by": { } }, "updated": { "at": "...", "by": { } } }

Parameter

The parameter object contains the value of the given parameter along with additional information like constraints.

Field	Parameter	Description
id	string	Identifier of parameter definition this value refers to. Example: "PDF-1234-1234-1234"
externalId	string	Id of the parameter in external system. Example: "SKU"
name	string	Parameter display name. Example: "Stock keeping unit"
value	string	Value of the parameter. Example: "65272478BB01A12"

ExternalIds

ExternalIds contain any external identifier

Field	Type	Description
vendor	string	A vendor identifier is item identifier recognizable by vendor, so when an order is placed they will easily understand which item is to be provisioned.

Example

ITEM OBJECT

{
    "id": "ITM-0690-0539-0001",
    "href": "/product-items/ITM-0690-0539-0001",
    "name": "Microsoft 365 Online Services for Charity",
    "description": "mashaTestTajfunTeam",
    "state": "Draft",
    "parameters": [
      {
        "id": "PRM-0690-0539-0001",
        "externalId": "SKU",
        "name": "Stock keeping unit",
        "value": "65272478BB01A12"
      },
      {
        "id": "PRM-0690-0539-0004",
        "externalId": "countries",
        "name": "Countries (checkboxes)",
        "value": [
          "us",
          "eu",
          "jp"
        ]
      },
      {
        "id": "PRM-0690-0539-0004",
        "externalId": "countries",
        "name": "Countries (checkboxes)",
        "value": {
          "addressLine1": "123 Main Street",
          "addressLine2": "Apt 4B",
          "postCode": "12345",
          "city": "Cityville",
          "state": "S",
          "country": "ST"
        }
      },            
      {
        "id": "PRM-0690-0539-0002",
        "externalId": "JSON_data",
        "name": "Information stored by vendor integration",      
        "value": { ...data... }
      }    
    ],
    "group": {
        "id": "IGR-0690-0539-0001",
    },
    "unit": {
        "id": "UNT-7362",
    },
    "product": {
        "id": "PRD-0690-0539",
    },
    "audit": {
        "created": { "at": "...", "by": { } },
        "updated": { "at": "...", "by": { } }
    }
}