latestSwagger 2.02026-08-10143234301.7 KB

dc2736850e42

Rest

Get inventory items

get/Products/Inventory

Query parameters

request.subscriberIdinteger

Subscriber ID to retrieve the inventory for

request.itemTypestring

Item type to filter. Possible values: Retail AccountCredit GiftCard ServicePricingOption Tip ContractDeposit ContractRegistrationFee Package Contract

request.itemIdinteger

Item ID to filter for specific item

request.availableOnlineboolean

Filter for only online products

request.introductoryOfferboolean

Filter for only intro offer pricing options

request.includeContractPricingOptionsboolean

When true, includes pricing options that are only available in contracts and packages. Default is false.

request.serviceCategoryIdinteger

Filter by service category ID. The results include items whose service category is related to the specified service category ID.

request.locationIdinteger

Filter by location ID that the item is sold at

request.lastUpdatedDatestring date-time

Filter by last updated date

request.revenueCategoryIdinteger

Filter by revenue category ID.

request.orderBystring

Value to order inventory by (ascending). Possible Values: Name, Default, [null] Default/null sort is by Elastic SortOrder (ServiceCategoryId, then Name)

request.limitinteger

Number of results to return, defaults to 100

request.offsetinteger

Number of results to skip, defaults to 0

Headers

SiteIdinteger required

Site ID

Response

OK

ErrorMessagestring

Error