ServiceProduct

Search service products

Search for one or more service products.

get/v1/ServiceProduct

Request

Query parameters

search.service_idinteger[]

Query by one or more service identifiers.

search.customer_idinteger[]

Query by one or more customer identifiers.

search.product_idinteger[]

Query by one or more product identifiers.

search.package_idinteger[]

Query by one or more package identifiers.

search.descriptionstring[]

Query by one or more product description.

search.code_1string[]

Query by one or more code 1 values.

search.statusstring[]

Query by one or more statuses.

search.billed_through_date_startstring date-time

Return products with billed-through-date on or after provided date.

search.billed_through_date_endstring date-time

Return products with billed-through-date on or before provided date.

search.activation_date_startstring date-time

Return products with activation date on or after provided date.

search.activation_date_endstring date-time

Return products with activation date on or before provided date.

search.canceled_date_startstring date-time

Return products with canceled date on or after provided date.

search.canceled_date_endstring date-time

Return products with canceled date on or before provided date.

search.created_date_startstring date-time

Return products with created date on or after provided date.

search.created_date_endstring date-time

Return products with created date on or before provided date.

search.status_date_startstring date-time

Return products with status date on or after provided date.

search.status_date_endstring date-time

Return products with status date on or before provided date.

search.contract_start_date_startstring date-time

Return products with contract-start-date on or after provided date.

search.contract_start_date_endstring date-time

Return products with contract-start-date on or before provided date.

search.contract_end_date_startstring date-time

Return products with contract-end-date on or after provided date.

search.contract_end_date_endstring date-time

Return products with contract-end-date on or before provided date.

search.automatic_expiration_end_date_startstring date-time

Return products with automatic-expiration-end-date on or after provided date.

search.automatic_expiration_end_date_endstring date-time

Return products with automatic-expiration-end-date on or before provided date.

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.