Item

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.

This object contains the following attributes:

Field	Type	Description
id	string, core	(Read-only) A unique identifier for the item.
name	string, core	The name of the item.
description	string	A description of the item.
externalIds	object	Represents the externalIds object. Example: { "vendor": "ven-1233-3222", "operations": "op-322-322", }
terms	object	Terms for the items, as defined in the terms object. Example: { "period": "1m", "commitment": "1y" }
quantityNotApplicable	boolean, core	Indicates if the quantity isn't applicable or relevant to the product item being sold.
status	string	The status of the item. Allowed values are: Draft Published Unpublished
parameters	object	Captures any additional information required for a product item and is defined by item configuration parameters. Example: { "id": "PRM-1234-1234-1234", "externalId": "SKU", "value": "65272478BB01A12" }
group	object	The itemGroup to which the item has been assigned.
unit	object	The unitOfMeasure assigned to item.
product	object	The product to which item is assigned.
audit	object	(Read-only) Represents the audit object.

Parameter object

The parameter object contains the given parameter's value and additional information, like Constraints.

Field	Type	Description
id	string	(Read-only) The identifier of the parameter definition this value refers to.
externalId	string	The ID of the parameter in the external system.
name	string	The display name for the parameter.
value	string	(Optional) The value of the parameter.

External Ids object

Field	Type	Description
vendor	string	A vendor-recognizable item identifier used to ensure the correct item is supplied when an order is placed.

Example

ITEM OBJECT

{
    "id": "ITM-0690-0539-0001",    
    "name": "Microsoft 365 Online Services for Charity",
    "description": "Explore Microsoft 365 nonprofit solutions and technology to help your organization",
    "terms":{
      "model": "quantity",
      "period": "1m",
      "commitment": "1y"
    }, 
    "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": { } }
    }
}