Products

Search products

Search for one or more products.

get/v1/Products

Request

Query parameters

search.product_idinteger[]

Query by product identifier.

search.provider_idinteger[]

Query by provider identifier.

search.activeboolean

Return when Null: All; when True: Only Active; when False: Only Inactive.

search.product_type_idinteger[]

Query by product type identifier.

search.descriptionstring[]

Query by all or part of product description.

search.code_1string[]

Query by all or part of primary provision code (a.k.a. USOC).

search.created_date_startstring date-time

Query by created date.

search.created_date_endstring date-time

Query by created date.

search.bill_profile_idsinteger[]

Query by bill profile identifier.

search.service_type_idsinteger[]

Query by service type identifier.

search.currency_codestring[]

Query by three-letter currency code.

search.bill_everystring[]

Query by bill every.

search.page_sizeinteger

Defines how many items to return at a time.

search.pageinteger

Specifies which page to display (i.e. 3rd page of 50 items out of 1000 items)

search.sortstring

Specifies the model member you wish to sort by. Defaults to Ascending order, add a "-" sign to the beginning to indicate Descending order.

Response

OK

okboolean
has_moreboolean

Helper for pagination. Indicates there are more records returned.

record_countinteger

Total number of records found by the search.

Changes

No recorded changes to this operation across all 2 revisions of this API.