Skip to main content
Version: 8.0.x

Items

An item is a purchasable good like a T-shirt, a movie, a song, a subscription, etc. The Items resource’s responsibility is to simply identify an item. This should not be confused with itemdefinitions, which are descriptions of the item.

Items can be discovered by using the following resources:

Lookup Item By Code​

Look up an item by item code.

Workflow​

  1. Start with lookups
  2. GET the link with rel: itemlookupform
  3. Fill out the form
  4. POST the form using the link with rel: itemlookupaction

Request Fields​

Type: items.code​

NameDescriptionType
codeThe sku code.string

Lookup Batch Items​

Look up a batch of items with a list of codes.

Workflow​

  1. Start with lookups
  2. GET the link with rel: batchitemslookupform
  3. Fill out the form
  4. POST the form using the link with rel: batchlookupaction

Request Fields​

Type: items.codes​

NameDescriptionType
codesA list of item SKU codes.array

Read Code For Item​

Read the code of an item.

Workflow​

  1. Start with item
  2. GET the link with rel: code
  3. Render the response

Response Fields​

Type: items.code​

NameDescriptionType
codeThe sku code.string