The following table describes common query parameters you can use with the Shopper APIs:

Name

Required

HTTP Verb

Resources

Description

accept false GET all The accept header parameter specifies the media type that is acceptable for the response.
cartId true POST Orders The id of a cart.
expand false GET all Request resource fields beyond the default set of fields returned. See Understanding the Fields and Expand Query Parameters.

fields

false

GET

all

Request specific resource fields. See Understanding the Fields and Expand Query Parameters.

format false

GET, POST

all Overrides the default format of xml for the Shopper API. Valid values are xml and json. See Supported Formats.

pageNumber

false

GET

Product, Offers, Orders

For resources that support pagination, the number indicating the page to return in a paginated response. Default is 1, the first page.

pageSize

false

GET

Product, Offers, Orders

For resources that support pagination, the number of products to include on each page of a paginated response. Default is 25.

productsPageSize false GET Categories For the Categories resources, the number of products to include for each category returned in a paginated response. Default is 10 for the Catalog Service resources. If a response returns three categories, and each category has ten products, a total of 30 products are returned for the default productsPageSize value.

quantity

false

POST

Line Item

The quantity of Line Item when updating with the action query parameter. Quantity defaults to 1 if not specified. For more information, see posting to the line items resource with the action query parameter.

sort

false

GET

Product

Allows sorting the list of returned products. Multiple sort fields may be used and for each a sort direction (asc or desc) must be specified. The value must be a comma-delimited list of sort fields with the following format: <fieldname>-<sort_direction>, as shown in the following example:

displayName-asc,listPrice-desc