CellularItemSearch
Use the CellularItemSearch operation to search through PhoneDog's complete catalog of cell phones currently sold in the United States.
Note: This operation does not return cell phone items that are not currently sold within the United States. You can however, obtain a list of all CellularItemId's and use the CellularLookup operation to retrieve cell phone data on outdated and coming soon phones.
Request parameters
Request parameters specify the terms of your request and control the output data that is returned to you. The following parameters can be used with this operation.
| Operation |
The operation you want PWS to perform |
Yes |
CellularItemSearch |
| ApiKey |
Your ApiKey - used to authorize your request |
Yes |
|
| AgentId |
Your AgentId - used to authorize your request |
Yes |
|
| ManufacturerId |
Use up to 10 comma-separated id's of the available manufacturer id's to limit the result of cell phones to certain manufacturers. |
No |
Valid value:
|
| ProviderId |
Use up to 10 comma-separated id's of the available provider id's to limit the result of cell phones to certain providers (Cell phone carrier). |
No |
Valid value:
|
| MerchantId |
Use one of the available merchant id's to limit the result of cell phones to a certain merchant (seller). |
No |
Valid value:
|
| SaleType |
Optional parameter that allows filtering by a certain sale type (e.g. phones with service plan, phone only, pre-paid phones) |
No |
Valid value:
- PhoneAndPlan
- PhoneOnly
- PrePaid
|
| Keyword |
Use the keyword paramter to refine your search based on a specific word.
Note: At this time the keyword only applies to searching the phone's name. E.g. use "Razr" to limit your result to all available Motorola Razr cell phones. |
No |
Valid value:
- A keyword string no longer than 50 characters
|
| PriceFrom |
Use the pricefrom parameter to limit your results to cell phones with a certain starting price. E.g. passing the value 100 would return cell phones of 100 dollars and above. |
No |
Valid value:
- Any numeric value from
-1000 to 10000 (can also include up to two decimals) |
| PriceTo |
Use the priceto parameter to limit your results to cell phones up to a certain final price. Use the priceto parameter together with the pricefrom parameter to limit your results to show only cell phones within a certain price range. |
No |
Valid value:
- Any numeric value from
-1000 to 10000 (can also include up to two decimals) |
| Sort |
Use the sort parameter to specify how your results will be ordered. |
No |
Valid value:
(default value if not set is "featured") |
| PageIndex |
The pageindex parameter allows you to create a paginated list of search results. This parameter returns the specified page. The first page containing 15 cell phone items will be returned if left blank. |
No |
Valid value:
|
| PageSize |
Optionally you may choose to change the amount of results per page using the pagesize parameter. |
No |
Valid value:
|