Catalog Service API (2.17)

Download OpenAPI specification:Download

Catalog Service Concepts

Browse Tags

Every catalog item can have zero to many browse tags that indicate how the item is classified and grouped in relation to other items. For instance, a particular catalog item may have the following browse tags associated with it: "Motorola," to indicate that it is manufactured by Motorola; "Handset," to indicate that it is a Handset opposed to a battery; "Warranty," to indicate that the item does have an available warranty. By assigning these browse tags to the catalog item, it will be considered similar to other items that have similar tags -- and the more browse tags that it has in common with another item, the closer that similarity becomes.

Note: Any catalog item that is not associated with a browse tag will not be able to be browsed.

Browsing the Catalog

When browsing the catalog to find a particular item, browse tags are used to help filter the available items down to a smaller, more manageable set that the user cares about. The Venn diagram below shows how a typical system may be set up in such a way to allow a user to browse the catalog.

From this example, if a user wanted to search for a Motorola handset that came with a warranty, they could accomplish this in a variety of ways. One way to search for this item would be to start at the browse tag Motorola. This browse tag would filter out all the items that did not pertain to Motorola products (e.g., all Nokia products) and would leave the user with 10 items, some of which are handsets. From this list they could then further filter the available items by specifying additional browse tags such as the Handsets browse tag which would filter the list of items to only Motorola handsets, some of which did not have Warranties. With the addition of a final browse tag of Warranties, the user could then see all 5 of the Motorola handsets that have warranties. Alternately this same list of items could be derived by starting at the Warranties or Handsets browse tags and then adding the other tags one by one. The only difference would be that the initial lists in these cases would include Nokia items until the Motorola tag was applied.

Catalog Search Summaries

As part of searching the catalog, a summary of the result set may be requested as part of the return values. The summary information will contain a list of browse tags that the result set belonged to, excluding the requested browse tags if any. Each browse tag listed will contain a CatalogItemCount element which will be populated with number of times that the browse tag was linked to the items contained within the result set. This summary information can then be used to provide the user a way to further filter down the result set by adding one of the returned CatalogBrowseTags to the initial search values. Using the example from above, if the user started their search by specifying the Handsets browse tag, they would be presented with the following summary information: Motorola 5; Warranties 10; Nokia 2. From here they could then pick one of the browse tags supplied to further filter down the result set. Alternatively if the user had started their search from the Motorola tag they would be presented with the following summary information instead: Warranties 5; Handsets 5. In this scenario the Nokia browse tag is not returned because there are no overlaps in the items that are contained tagged with Motorola and those items that are tagged with Nokia.

Paging

The amount of information retrieved from an operation may require that the resulting response be broken down into smaller sets of data. If this is the case, then a PagingInformation element can be used to specify which piece of the information the caller wants. For example, a call to a search operation may yield 100 results. If, however, the search operation only allows a maximum amount of 20 results to be returned, then only the first 20 results will be returned to the caller. To retrieve the remaining results, the caller could then use PagingInformation element to specify the next sequential page to retrieve the next 20 results until all the data is retrieved or the correct value is found.

Operations

Assignment Template Lookup

Provides the ability to retrieve information on a particular assignment template. [Rev 1.01]

header Parameters

Content-Type

required

string

Example: application/soap+xml; action="https://localhost:8081/CatalogService1/AssignmentTemplateLookup

Request Body schema: application/soap+xml

required

object (AssignmentTemplateLookup)

Provides the ability to retrieve information on a particular assignment template. [Rev 1.01]

Responses

Catalog Item Lookup

Provides the ability to retrieve information on a particular catalog item contained within the catalog.

header Parameters

Content-Type

required

string

Example: application/soap+xml; action="https://localhost:8081/CatalogService1/CatalogItemLookup

Request Body schema: application/soap+xml

required

object (CatalogItemLookup)

Provides the ability to retrieve information on a particular catalog item contained within the catalog.

Responses

Catalog Search

Provides the ability to find information for a set of particular products.

header Parameters

Content-Type

required

string

Example: application/soap+xml; action="https://localhost:8081/CatalogService1/CatalogSearch

Request Body schema: application/soap+xml

required

object (CatalogSearch)

Provides the ability to find information for a set of particular products.

Responses

Root Catalog Browse Tags Lookup

Provides the ability to get a list of the browse tags defined at the root level.

header Parameters

Content-Type

required

string

Example: application/soap+xml; action="https://localhost:8081/CatalogService1/RootCatalogBrowseTagsLookup

Request Body schema: application/soap+xml

required

object (RootCatalogBrowseTagsLookup)

Provides the ability to get a list of the browse tags defined at the root level.

Responses

Core Data Service

Note

The CoreDataService endpoint was added to the Catalog service in [Rev 1.03].

Abstract

The purpose of the CoreDataService endpoint is to supply a set of search capabilities that can be used for data retrieval.

Authorization

In order to retrieve information from a data service, proper authorization credentials must be included in a header of the request. To do this, first find the Simple Web Token claim (ClaimType = "http://idibilling.com/SWT") within the Request Security Token returned to you from the 'Issue' call to the Security Token Service. Once found, the Simple Web Token must be submitted with each request in an "Authorization" header with a value in exactly the following format: WRAP access_token="<Simple Web Token>" where <Simple Web Token> between double quotes is replaced with the SWT claim string value between double quotes.

Catalog Group

List of all the catalog groups in the system [Rev 1.18]

Authorizations:

SWT

query Parameters

$count	number Example: $count=3 Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=Name eq 'Value' A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=Name A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=Name A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	number Example: $skip=10 Number of search results to skip.
$skiptoken	number Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	number Example: $top=1 Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type

application/json

{"CatalogGroupClass": "CatalogGroupClass",
"CatalogGroupClassID": 235,
"CatalogGroupID": 562,
"Description": "My Description",
"KeyName": "KeyName Name",
"Name": "Catalog Group Name"
}

Catalog Group Member

List of all the catalog group members by catalog group. [Rev 1.19]

Authorizations:

SWT

query Parameters

$count	number Example: $count=3 Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=Name eq 'Value' A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=Name A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=Name A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	number Example: $skip=10 Number of search results to skip.
$skiptoken	number Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	number Example: $top=1 Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type

application/json

{"Catalog": "12 Month Contract",
"CatalogID": 12,
"CatalogGroup": "Catalog Group Name",
"CatalogGroupID": 562
}

Contract

A list of details about items in the product catalog that are contracts. [Rev 1.09]

Authorizations:

SWT

query Parameters

$count	number Example: $count=3 Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=Name eq 'Value' A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=Name A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=Name A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	number Example: $skip=10 Number of search results to skip.
$skiptoken	number Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	number Example: $top=1 Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type

application/json

{"AlternateDescription": "My AlternateDescription",
"AlternateInvoiceDescription": "My AlternateInvoiceDescription",
"AutoRenew": true,
"CatalogID": 1,
"Description": "My Description",
"Duration": 10,
"DurationType": "My DurationType Description",
"DurationTypeID": 2,
"EndDate": "2019-08-24T14:15:22Z",
"ProductCatalogCategory": "My Product Category",
"ProductCatalogCategoryID": 5,
"RenewalBlackoutFromDays": 10,
"RenewalBlackoutToDays": false,
"ServiceAgreement": "My ServiceAgreement Description",
"ServiceAgreementID": 624,
"StartDate": "2008-10-27T16:03:36.443-04:00",
"UseWithPriceMatrix": true
}

Contract Term

A list of terms for all contracts configured in the product catalog. [Rev 1.09]

Authorizations:

SWT

query Parameters

$count	number Example: $count=3 Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=Name eq 'Value' A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=Name A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=Name A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	number Example: $skip=10 Number of search results to skip.
$skiptoken	number Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	number Example: $top=1 Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type

application/json

{"BillPeriodsToEvaluate": 676,
"CatalogID": 1,
"ContractTermID": 65,
"ContractTermType": "My ContractTermType Description",
"ContractTermTypeID": 4,
"GraceDays": 6,
"IncludeChildren": false,
"NumberOfUnits": 0.5,
"ProrateUsage": true,
"RampUpDays": 7,
"UnitsType": "My Units Type",
"UnitsTypeID": 55
}

Contract Term Penalty

A list of all penalties associated with terms of contracts configured in the product catalog. [Rev 1.09]

Authorizations:

SWT

query Parameters

$count	number Example: $count=3 Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=Name eq 'Value' A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=Name A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=Name A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	number Example: $skip=10 Number of search results to skip.
$skiptoken	number Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	number Example: $top=1 Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type

application/json

{"AlternateInvoiceDescription": "My AlternateInvoiceDescription",
"Amount": 0.5,
"CalculationType": "My CalculationType Description",
"CalculationTypeID": 201,
"ChargeTaxClass": "My ChargeTaxClass Description",
"ChargeTaxClassID": 72,
"ContractCatalogID": 667,
"ContractTermID": 65,
"Description": "My Description",
"PenaltyCatalogID": 790
}

Discount

A list of details about items in the product catalog which are discounts.

Authorizations:

SWT

query Parameters

$count	number Example: $count=3 Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=Name eq 'Value' A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=Name A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=Name A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	number Example: $skip=10 Number of search results to skip.
$skiptoken	number Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	number Example: $top=1 Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type

application/json

{"AlternateDescription": "My AlternateDescription",
"AlternateInvoiceDescription": "My AlternateInvoiceDescription",
"AssociativeType": "My Associative Type",
"AssociativeTypeID": 3,
"CatalogID": 1,
"Configuration": "My serialized Configuration",
"Description": "My Description",
"DiscountCategory": "My Discount Category",
"DiscountCategoryID": 6,
"FavoriteNumbersEndUserEditable": false,
"FavoriteNumbersEndUserViewable": true,
"ForceLast": true,
"IncludeChildren": false,
"MaximumAllowedFavoriteNumbers": 10,
"NumberOfUnits": 0.5,
"NumberOfUnitsUnlimited": 0.5,
"ProcessingOrder": 1,
"Registry": "My Registry",
"RegistryID": 1,
"SKU": "KS944RUR",
"TieredGroupDiscount": true,
"UnitsType": "My Units Type",
"UnitsTypeID": 55,
"WebName": "Bob Ross"
}

Extended Information Item

A list of keys and values for all extended information items associated with any objects of the types shown. [Rev 1.04]

Authorizations:

SWT

query Parameters

$count	number Example: $count=3 Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=Name eq 'Value' A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=Name A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=Name A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	number Example: $skip=10 Number of search results to skip.
$skiptoken	number Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	number Example: $top=1 Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type

application/json

{"Key": "My Key",
"ObjectID": 14,
"ObjectType": "My ObjectType",
"Value": "My value"
}

Installment Plan Profile Overview

Describes retail installment plan assignment restrictions for installment plan profile rule and credit class combinations. [Rev 1.13]

Authorizations:

SWT

query Parameters

$count	number Example: $count=3 Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=Name eq 'Value' A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=Name A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=Name A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	number Example: $skip=10 Number of search results to skip.
$skiptoken	number Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	number Example: $top=1 Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type

application/json

{"BillingFeature": "Billing Feature Description",
"BillingFeatureCatalogID": 13,
"BillingFeatureSKU": "KAGK323AJG",
"EndDate": "2008-10-27T16:03:36.443-04:00",
"InstallmentAgreement": "InstallmentAgreement Name",
"InstallmentAgreementID": 353,
"InstallmentPlanProfileID": 33,
"Name": "InstallmentPlanProfile Name",
"RetailItem": "RetailItem Description",
"RetailItemCatalogID": 25,
"RetailItemSKU": "AJG3883HG",
"StartDate": "2008-10-27T16:03:36.443-04:00"
}

Installment Plan Profile Rule Expanded

Describes retail installment plan assignment restrictions for installment plan profile rule and credit class combinations. [Rev 1.13]

Authorizations:

SWT

query Parameters

$count	number Example: $count=3 Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=Name eq 'Value' A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=Name A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=Name A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	number Example: $skip=10 Number of search results to skip.
$skiptoken	number Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	number Example: $top=1 Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type

application/json

{"AccountType": "AccountType Name",
"AccountTypeID": 25,
"CreditClass": "CreditClass Name",
"CreditClassID": 535,
"InstallmentPlanProfileID": 52,
"InstallmentPlanProfileRuleID": 253,
"IsDownPaymentAsPercentage": true,
"IsDownPaymentRequired": false,
"IsFirstPaymentRequired": true,
"IsInstallmentPlanRequired": false,
"MaximumDownPayment": 44,
"MaximumNumberOfInstallments": 23,
"MinimumDownPayment": 22,
"MinimumNumberOfInstallments": 235,
"Rank": 25,
"RestrictionLevel": "RestrictionLevel Description",
"RestrictionLevelID": 2
}

Pricing Plan Rate Plan

List of the rate plans that are associated with pricing plans. [Rev 1.12]

Authorizations:

SWT

query Parameters

$count	number Example: $count=3 Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=Name eq 'Value' A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=Name A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=Name A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	number Example: $skip=10 Number of search results to skip.
$skiptoken	number Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	number Example: $top=1 Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type

application/json

{"ALegAdditionalIncrement": 99,
"ALegInitialIncrement": 88,
"ALegRatePlan": "My Rate Plan",
"ALegRatePlanID": 8251,
"ALegSurchargeAmount": 7.3,
"BLegAdditionalIncrement": 72,
"BLegInitialIncrement": 64,
"BLegRatePlan": "My BLegRatePlan",
"BLegRatePlanID": 678,
"BLegSurchargeAmount": 854.4,
"Catalog": "My Pricing Plan Name",
"CatalogDisplay": "Web Name",
"CatalogID": 1,
"EffectiveDate": "2008-10-27T16:03:36.443-04:00",
"SKU": "KS944RUR",
"TimeOfDayGroup": "My TimeOfDayGroup",
"TimeOfDayGroupID": 457,
"UsageType": "My UsageType Description",
"UsageTypeID": 262
}

Product Catalog Class

A list of all the product types configured in the system. [Rev 1.16]

Authorizations:

SWT

query Parameters

$count	number Example: $count=3 Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=Name eq 'Value' A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=Name A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=Name A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	number Example: $skip=10 Number of search results to skip.
$skiptoken	number Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	number Example: $top=1 Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type

application/json

{"Name": "",
"ProductCatalogClassID": 2,
"ProductType": "My Product Type",
"ProductTypeID": 1
}

Product Catalog Tree Deprecated

A list of details about items in the product catalog by location including availability information and their hierarchical relationship to other items.

Authorizations:

SWT

query Parameters

$count	number Example: $count=3 Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=Name eq 'Value' A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=Name A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=Name A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	number Example: $skip=10 Number of search results to skip.
$skiptoken	number Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	number Example: $top=1 Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type

application/json

{"ALECount": 0.5,
"Alias": "My Alias",
"AllowAccountCodes": "",
"AllowDirectInvoicing": true,
"AllowInstallmentPlan": true,
"AlternateDescription": "My AlternateDescription",
"AlternateInvoiceDescription": "My AlternateInvoiceDescription",
"AssignmentTemplateID": 10,
"AttributePropertyDisplay": "My property",
"AttributePropertyID": 55,
"CatalogID": 1,
"Charge": 1.5,
"Choose_N": 1,
"ClassOfService": "My Class of Service",
"ClassOfServiceID": 1,
"Cost": 0.5,
"Description": "My Description",
"EndDate": "2008-10-27T16:03:36.443-04:00",
"ExclusiveGroup": "My exclusive group",
"ExclusiveGroupID": 1,
"GLByComponent": false,
"IsAvailable": true,
"IsDiscontinued": false,
"IsRestricted": true,
"LastModifiedDate": "2008-10-27T16:03:36.443-04:00",
"LastModifiedUser": "Adam",
"LimitToInfoScriptID": 5,
"LocationID": 6,
"MaxInstallments": 3,
"Notes": "My Note",
"OnePrice": true,
"ParentCatalogID": 1,
"ParentDescription": "My Parent Description",
"ProductCatalogCategory": "My Product Category",
"ProductCatalogCategoryID": 5,
"ProductCatalogClass": "My Product Catalog Class",
"ProductCatalogClassID": 2,
"ProductSubtype": "Direct Invoice",
"ProductSubtypeID": 1,
"ProductType": "Retail Product",
"ProductTypeID": 9,
"RootCatalogID": 1,
"RootDescription": "My Root Description",
"SKU": "KS944RUR",
"Specification": "https://mysite.com/application/",
"StartDate": "2008-10-27T16:03:36.443-04:00",
"WebCompare1": "My Webcompare",
"WebCompare2": "My Webcompare",
"WebCompare3": "My Webcompare",
"WebCompare4": "My Webcompare",
"WebDescription": "My Web Description",
"WebHighlight1": "My Web Highlight",
"WebHighlight2": "My Web Highlight",
"WebHighlight3": "My Web Highlight",
"WebName": "Bob Ross",
"WebPrice": 6.45,
"WebPriceDescription": "My Webprice Description",
"WholesaleCost": 3.14
}

Product Type

A list of all the product types configured in the system. [Rev 1.16]

Authorizations:

SWT

query Parameters

$count	number Example: $count=3 Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=Name eq 'Value' A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=Name A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=Name A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	number Example: $skip=10 Number of search results to skip.
$skiptoken	number Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	number Example: $top=1 Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type

application/json

{"Name": "Product Catalog Class Name",
"ProductTypeID": 1
}

Rate Plan Detail

A list of all of the rate plan details in the system. [Rev 1.12]

Authorizations:

SWT

query Parameters

$count	number Example: $count=3 Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=Name eq 'Value' A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=Name A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=Name A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	number Example: $skip=10 Number of search results to skip.
$skiptoken	number Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	number Example: $top=1 Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type

application/json

{"AdditionalAmount1": 10.2,
"AdditionalAmount2": 15.6,
"AdditionalAmount3": 26.2,
"AdditionalCriteriaType": "AdditionalCriteriaType Description''",
"AdditionalCriteriaTypeID": 256,
"AdditionalCriteriaValue": "My Criteria Value",
"DistanceType": "My DistanceType Description",
"DistanceTypeID": 47,
"EffectiveDate": "2008-10-27T16:03:36.443-04:00",
"InitialAmount1": 36.6,
"InitialAmount2": 457.75,
"InitialAmount3": 367.4,
"IsRegional": true,
"MaximumCallCharge": 7.46,
"MinimumCallCharge": 1.4,
"OverrideAdditionalIncrement": 34,
"OverrideInitialIncrement": 25,
"OverrideTimeOfDayGroup": "OverrideTimeOfDayGroup Description",
"OverrideTimeOfDayGroupID": 252,
"RatePlan": "RatePlan Description",
"RatePlanDetailID": 2364,
"RatePlanID": 253,
"RateSeconds": 21,
"RatingMethod": "RatingMethod Description",
"RatingMethodCriteria": "RatingMethodCriteria Description",
"RatingMethodID": 252,
"Surcharge": 25.2
}

Service

A list of details about items in the product catalog which are services. [Rev 1.09]

Authorizations:

SWT

query Parameters

$count	number Example: $count=3 Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=Name eq 'Value' A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=Name A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=Name A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	number Example: $skip=10 Number of search results to skip.
$skiptoken	number Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	number Example: $top=1 Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type

application/json

{"ALE": 9.2,
"AllowLineCards": true,
"AllowSubServices": false,
"AllowTemporaryBillingNumbers": true,
"AllowTemporaryServiceNumbers": false,
"AlternateDescription": "My AlternateDescription",
"AlternateInvoiceDescription": "My AlternateInvoiceDescription",
"Bypass2Of3Rule": false,
"CatalogID": 1,
"ClassOfService": "My Class of Service",
"ClassOfServiceID": 1,
"DefaultBillingStatus": "My Billing Status Description",
"DefaultBillingStatusID": 1,
"DefaultTechnologyType": "My default Technology Type",
"DefaultTechnologyTypeID": 15,
"Description": "My Description",
"E911ClassOfService": "My E911Class Service Description",
"E911ClassOfServiceID": 10,
"E911TypeOfService": "My E911 Type Of Service",
"E911TypeOfServiceID": 10,
"EnableCNAMSupport": true,
"EnableE911Support": false,
"EnablePerChannelTaxing": false,
"EnablePerSingleLineTaxing": false,
"EndDate": "2008-10-27T16:03:36.443-04:00",
"InvoiceCategory": "My Invoice Category Description",
"InvoiceCategoryID": 67,
"IsLoadable": true,
"IsPrePaid": true,
"PerLineTaxClass": "My Per Line Tax Class Description",
"PerLineTaxClassID": 10,
"ProductCatalogCategory": "My Product Category",
"ProductCatalogCategoryID": 5,
"ProductCatalogClass": "My Product Catalog Class",
"ProductCatalogClassID": 2,
"RequireHandset": true,
"RequirePreloadedSIMs": false,
"RequireRouteCommit": true,
"SKU": "KS944RUR",
"StartDate": "2008-10-27T16:03:36.443-04:00",
"TaxClass": "My TaxClass Description''",
"TaxClassID": 18,
"UsageTaxMethod": "My UsageTaxMethod Description",
"UsageTaxMethodID": 1,
"UsePortRequest": true,
"USOC": "My USOC"
}

Subservice Rule

A list of all the allowed relationships between parent service types and their child sub service types. [Rev 1.04]

Authorizations:

SWT

query Parameters

$count	number Example: $count=3 Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=Name eq 'Value' A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=Name A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=Name A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	number Example: $skip=10 Number of search results to skip.
$skiptoken	number Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	number Example: $top=1 Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type

application/json

{"ChildCatalog": "My ChildCatalog",
"ChildCatalogID": 10,
"ChildSKU": "WR234",
"ParentAllowsSubservices": true,
"ParentCatalog": "My parent Catalog",
"ParentCatalogID": 1,
"ParentSKU": "WPR234"
}

Tax Channel

A list of all of the tax channels configured in the product catalog. [Rev 1.09]

Authorizations:

SWT

query Parameters

$count	number Example: $count=3 Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=Name eq 'Value' A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=Name A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=Name A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	number Example: $skip=10 Number of search results to skip.
$skiptoken	number Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	number Example: $top=1 Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type

application/json

{"CatalogID": 1,
"IsDataUsageTaxable": true,
"IsInboundTaxable": true,
"IsOutboundTaxable": "",
"IsPerChannel": false,
"IsVoiceUsageTaxable": true,
"NumberOfChannels": 7,
"TaxChannelID": 6
}

Release Notes

Latest WSDL

WSDL

Release Notes 2.18

WSDL
Added SKUOrDescription to Catalog Search (CatalogSearchReq)

Release Notes 2.17

WSDL
Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.16

WSDL
Added CategoryDisplayName and CategoryRank to Assignment Template Lookup (AssignmentTemplateRule)

Release Notes 2.15

WSDL
Added AllowConcurrentPricePoints to Catalog Item Lookup (CatalogItemDetail)

Release Notes 2.14

WSDL
Added ContractCatalogID and NPANXXZoneID to Catalog Item Lookup (CatalogItem) (CatalogItemLookupKey)
Added ContractCatalogID and NPANXXZoneID to Catalog Search (CatalogSearchReq)

Release Notes 2.13

WSDL
Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.12

WSDL
Added IsForSaleInventoryStatus to Catalog Search (CatalogSearchReq)

Release Notes 2.11

WSDL
Added InventoryStatus, InventoryStatusID, OnHandQuantity to Catalog Search (CatalogSearchResponseElement, CatalogSearchResultItem)

Release Notes 2.10

WSDL
Added InstallmentAgreement, InstallmentAgreementID and InstallmentAgreementTerms to Catalog Item Lookup (CatalogItem) (RetailDetail)

Release Notes 2.09

WSDL
Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.08

WSDL
Deprecated CoreDataService.ProductCatalogTree

Release Notes 2.07

WSDL
Added QuantityDivisor to Catalog Item Lookup (CatalogItem) (RetailDetail)
Added QuantityDivisor to Catalog Search (CatalogSearchResponseElement, CatalogSearchResultItem)

Release Notes 2.06

WSDL
Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.05

WSDL
Added EquipmentType and EquipmentTypeID to Catalog Item Lookup (CatalogItem) (RetailDetail)
Added EquipmentInventory and EquipmentInventoryID to Catalog Item Lookup (CatalogItem) (RetailDetail)

Release Notes 2.04

WSDL
Added Protection Plan and Protection Plan MRC to ProductCatalogClass
Added ProtectionPlanProfileID to Catalog Item Lookup (CatalogItemDetail)
Added ProtectionPlanProfileTypeID to Catalog Item Lookup (CatalogItemDetail)

Release Notes 2.03

WSDL
Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.02

WSDL
Added IsMaxRefundDaysOverridden and MaxRefundDaysOverride to Catalog Item Lookup (CatalogItem) (RetailDetail)

Release Notes 2.01

WSDL
Added SIMCardAssociationType and SIMCardAssociationTypeID to Catalog Item Lookup (CatalogItem) (RetailDetail)
Added SupportedSIMClass and SupportedSIMClassID to Catalog Item Lookup (CatalogItem) (RetailDetail)

Release Notes 2.00

WSDL
Note: Major version change was for internal changes only and not a breaking change.

Release Notes 1.26

WSDL
Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.25

WSDL
Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.24

WSDL
Added IsProtected to Catalog Item Lookup (CatalogItem) (BehaviorDetail)
Added EnableCreditingOnServiceReconnect to Catalog Item Lookup (CatalogItem) (BillingDetail)

Release Notes 1.23

WSDL
Added AllowDirectInvoicing to Catalog Item Lookup (RetailDetail)
Added AllowDirectInvoicing to Catalog Search (CatalogSearchReq, CataglogSearchResponseElement, CatalogSearchResultItem)
Added AllowDirectInvoicing to CoreDataService.ProductCatalogTree
Added ProductSubtype value Direct Invoice to Catalog Search (CatalogSearchResultItem)
Added ProductSubtype value Direct Invoice to Catalog Item Lookup (CatalogItem)
Added ProductSubtype value Direct Invoice to CoreDataService.ProductCatalogTree

Release Notes 1.22

WSDL
Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.21

WSDL
Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.20

WSDL
Added ChildSKU and ParentSKU to #operation/SubserviceRuleSubserviceRule

Release Notes 1.19

WSDL
Added #operation/CatalogGroupMemberCatalogGroupMember

Release Notes 1.18

WSDL
Added CatalogGroup to CoreDataService

Release Notes 1.17

WSDL
Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.16

WSDL
Added ProductCatalogClass and ProductType to CoreDataService

Release Notes 1.15

WSDL
Added ProductSubtype, ProductSubtypeID, WholesaleCost to CataglogItem, CatalogSearchResponseElement, CatalogSearchResultItem, and ProductCatalogTree.

Release Notes 1.14

WSDL 1.14.01
Added Metered to ProductCatalogClass
WSDL 1.14.00
Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.13

WSDL 1.13.01
Added new value 'In Advance - Forward Disconnect' to ProrateType
WSDL 1.13.00
Added InstallmentPlanProfileOverview, InstallmentPlanProfileRuleExpanded to Core Data Service

Release Notes 1.12

WSDL
Added ForceChargeOverride to BillingDetail, CataglogSearchResponseElement, and CatalogSearchResultItem
Added PricingPlanRatePlan, RatePlanDetail to CoreDataService\n* Added RequireRouteCommit to Service

Release Notes 1.11

WSDL
Added DisableCreditingOnServiceDisconnect to BillingDetail

Release Notes 1.10

WSDL
Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.09

WSDL
Added Contract, ContractTerm, ContractTermPenalty, Service, TaxChannel to CoreDataService

Release Notes 1.08

WSDL
Added PromptForItemDetailOnReturns, ReturnInventoryStatusID to RetailDetail

Release Notes 1.07

WSDL
Added IsAccountLevel to AssignmentTemplateRule
Added IsDisplayableCatalogBrowseTag to CatalogBrowseTag
Added 500119, 500120 to CatalogSearch
Added PagingInformationBrowseTagSummaries to CatalogSearchReq and CatalogSearchResult

Release Notes 1.06

WSDL
Added BillingCycleType to CatalogSearchResultItem

Release Notes 1.05

WSDL
Implemented new internal client application tools in this release.

Release Notes 1.04

WSDL
Added AttributePropertyDisplay, AttributePropertyID to catalogItem and CatalogSearchResultItem
Added ExtendedInformationItem, SubserviceRule to CoreDataService

Release Notes 1.03

WSDL
Core Data Endpoint added to Catalog service
Added new value 'Other' to DistanceType

Release Notes 1.02

WSDL
Implemented new Single Sign-On Security in this release.

Release Notes 1.01

WSDL
Added AssignmentTemplate, IsDiscontinued to CatalogItem, CatalogSearchResultItem, and Operations and StateUSFExempt
Added isActive to CatalogSearchReq
Added AssignmentTemplate to CatalogItemLookupResponseGroup
Added Defaults: CatalogID, Description. to CatalogSearchResponseElement"