Catalog models

Current version: 10.2

The following table describes the models available with the Catalog service:

Model

Description

BundleItem

A relationship model to specify sellable items associated with the bundle and the required quantity for each.

Properties:

  • SellableItemId: the unique identifier of the sellable item associated with the bundle (string)

  • Quantity: the quantity of the sellable item required to form the bundle (integer)

CustomerReview

A return model providing customer review information.

Properties:

  • Name: name of user authoring the review (string)

  • UsersLocation: location of user authoring the review (string)

  • CommentTitle: title of the user’s comment (string)

  • Comment: user’s comment price (string)

  • Approved: approval status of comment (boolean: true or false)

  • NumFoundHelpful: number of users who found review helpful

  • NumFoundUnHelpful: number of users who did not find review helpful

CustomIdentifier

A return model providing a key/value pair for a custom identifier.

Properties:

  • Key: name of the custom identifier

  • Value: value of the custom identifier

DigitalProperty

A return model providing information on a digital product.

Properties:

  • SizeOnDisk: number indicating the size of the digital product

  • UnitOfMeasure: unit of measurement (e.g., MB) for the size of the digital product

SellableItemPricing

A return model providing bulk pricing.

Properties:

  • Name: name of SellableItem (string).

  • ItemId: identifier of the SellableItem (string).

  • ListPrice: the SellableItem’s list price (string)

  • SellPrice: the SellableItem’s sell price (string)

  • Variations: a list of pricing variations (list<string>)

SellableItemReference

A return model providing a sellable item reference.

Size

A return model providing information on the size of a sellable item.

Properties:

  • Length: number that defines the length dimension of the item

  • Width: number that defines the width dimension of the item

  • Height: number that defines the height dimension of the item

  • UnitOfMeasure: unit of measurement for the item (e.g., cm)

VariationPricing

A return model providing bulk pricing at the variation level.

Properties:

  • Name: name of SellableItem (string)

  • ItemId: identifier of the SellableItem (string)

  • ListPrice: the SellableItem’s list price (string)

  • SellPrice: the SellableItem’s sell price (string)

WeightOfItem

A return model providing information on the weight of a sellable item.

Properties:

  • Value: number that defines the weight of the item

  • UnitOfMeasure: unit of measurement for the item (e.g., kilogram)

Do you have some feedback for us?

If you have suggestions for improving this article,