Products
Last updated
Shopper APIs reference
Last updated
/v1/shoppers/me/products/{productId}/pricing/volume-pricing
Provide the product identifier.
Provide your client identifier.
Provide the authorized or anonymous token for a shopper.
Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides more fields in the response. Expanding resources reduces the number of API calls required to accomplish a task.
Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.
Set the preferred currency for the pricing information returned for a product. The currency query parameter takes precedence over locale.
Set the preferred locale for the pricing information returned for products. The currency query parameter takes precedence over locale.
/v1/shoppers/me/products
Provide your client identifier.
Provide the authorized or anonymous token for a shopper.
Provide the external reference identifier for your product. The externalReferenceId is your company's internal identifier or stock keeping unit (SKU) for a product.
Provide a comma-separated list of one or more product identifiers to include in the response. This parameter is required if the inventory status is requested to be included in the response.
Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides more fields in the response. Expanding resources reduces the number of API calls required to accomplish a task.
Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.
Set the preferred currency for the pricing information returned for a product. The currency query parameter takes precedence over locale.
Set the preferred locale for the pricing information returned for products. The currency query parameter takes precedence over locale.
Provide the identifier for the company that owns the product. If you do not provide the companyId, the call will use the default company associated with the API key.
Specify the page to display from the result pages.
Specify the maximum number of items to include in each page.
You can sort the list of products returned by specifying one or more sort fields and their respective sort direction (asc or desc). To do this, use a comma-delimited list of sort fields in the format of {fieldname}-{sort_direction}. For instance, displayName-asc,listPrice-desc.
/v1/shoppers/me/products/{productId}
PProvide the product identifier.
Provide your client identifier.
Provide the authorized or anonymous token for a shopper.
Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides more fields in the response. Expanding resources reduces the number of API calls required to accomplish a task.
Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.
Set the preferred currency for the pricing information returned for a product. The currency query parameter takes precedence over locale.
Set the preferred locale for the pricing information returned for products. The currency query parameter takes precedence over locale.
To retrieve all products for a specified category, specify the category's ID in the {id} URI path parameter. The default setting is to display only the base products in the order of their rank.
/v1/shoppers/me/categories/{categoryId}/products
Category ID.
Provide your client identifier.
Provide the authorized or anonymous token for a shopper.
Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides more fields in the response. Expanding resources reduces the number of API calls required to accomplish a task.
Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.
Set the preferred currency for the pricing information returned for a product. The currency query parameter takes precedence over locale.
Set the preferred locale for the pricing information returned for products. The currency query parameter takes precedence over locale.
Provide the identifier for the company that owns the product. If you do not provide the companyId, the call will use the default company associated with the API key.
Specify the page to display from the result pages.
Specify the maximum number of items to include in each page.
Specify the maximum number of products to include for each category returned in a paginated response. Must be a positive integer greater than zero and less than 100000. Default is 10.
You can sort the list of products returned by specifying one or more sort fields and their respective sort direction (asc or desc). To do this, use a comma-delimited list of sort fields in the format of {fieldname}-{sort_direction}. For instance, displayName-asc,listPrice-desc.