Items
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 properties:
id
string
A unique identifier for the item.
Example: ITM-0690-0539-0001
href
string
The resource URI of the Item.
Example: /product-items/ITM-0690-0539-0001
name
string
The name of the item.
Example: Microsoft 365 Apps for Business
description
string
A description of the item.
Example: Best for businesses that need Office apps across devices and cloud file storage. For businesses with up to 300 employees.
externalIds
A reference to the External Id object.
Example:
{
"vendor": "ven-1233-3222",
"operations": "op-322-322",
}
terms
Terms for the items, as defined in the Terms object.
Example:
{
"period": "1m",
"commitment": "1y"
}
quantityNotApplicable
boolean
Indicates if the quantity isn't applicable or relevant to the product item being sold.
Example: true
parameters
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"
}
unit
unitOfMeasure
The unit of measure assigned to item.
audit
A reference to the audit object. Possible entries include: Created, Updated, Activated, or Terminated.
Parameter
The parameter object contains the given parameter's value and additional information, like Constraints.
id
string
The identifier of the parameter definition this value refers to.
Example: PDF-1234-1234-1234
externalId
string
The ID of the parameter in the external system.
Example: SKU
name
string
The display name for the parameter.
Example: Stock keeping unit
value
string
The value of the parameter.
Example: 65272478BB01A12
ExternalIds
vendor
string
A vendor-recognizable item identifier used to ensure the correct item is supplied when an order is placed.
Example
{
"id": "ITM-0690-0539-0001",
"name": "Microsoft 365 Online Services for Charity",
"description": "TestTeam",
"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": { } }
}
}
Last updated
Was this helpful?