GuidesAPI Reference
Log In
API Reference

List Products for E-Commerce

List resource

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

API Change Set Filtering

This API supports filtering based on change sets. For more details on change sets, refer to the Getting Started - Change Sets guide.

Supported Change Sets

The API currently supports the following change set:

ecomm_product_list

The ecomm_product_list change set includes the following fields:

product fields

  • sku: The SKU number of the product.
  • description: The description of the product.
  • extended_description: The extended description of the product.
  • is_discontinued: Indicates whether the product is discontinued.
  • category: The category of the product.
  • height: The height of the product.
  • height_unit: The unit of measure for the product's height.
  • width: The width of the product.
  • width_unit: The unit of measure for the product's width.
  • length: The length of the product.
  • length_unit: The unit of measure for the product's length.
  • cube: The cubic volume of the product.
  • cubic_unit: The unit of measure for the product's cubic volume.
  • weight: The weight of the product.
  • weight_unit: The unit of measure for the product's weight.
  • manufacturer_sku: The manufacturer's SKU number for the product.
  • default_selling_uom: The default unit of measure used for selling.
  • consumer_brand_name: The brand name used by consumers for comparison.
  • alternate_code: The UPC or alternate code of the product.

item_details fields

  • primary_bin_location_id: Unique identifier of the primary bin location.
  • bin_location_2_id: Unique identifier for the bin location 2.
  • bin_location_3_id: Unique identifier for the bin location 3.
  • replacement_cost: The cost in the supplier's unit of measure.
  • order_point: The on-hand quantity at which more of these items will be ordered.
  • store_close_out: Store close-out type.
  • show_in_estore: The eStore platforms where the item is available.

When a change set is queried, the top level products and nested items_details only contain results for entities that were changed or created since the provided update_datetime.

Query Params
string

Optional secret used to sign callback requests.

uri
length ≥ 1

Optional HTTPS callback URL for deferred execution completion notifications.

string | null

The code for this product category.

string
enum
length ≥ 1
  • ecomm_product_list - ecomm_product_list
Allowed:
boolean

Set to true to enable asynchronous processing.

integer

Maximum number of results per page. The default is 25.

string

Fields to order upon. Valid fields include: product_id, create_datetime, update_datetime

integer

Page of results to retrieve

integer

The unique system assigned value that identifies this record.

string
length ≥ 1

Filter by e-store availability. Accepts comma-separated values
You can also use 'none' or 'any': none (no stores) any (any store)
Do NOT combine 'none' or 'any' with other values. For example, 'none,dib' or 'any,bigcommerce' will raise an error.
Both 'none' and 'any' must be used alone.

  • dib
  • bigcommerce
  • modernretail
  • none
  • any
string
length ≥ 1

The SKU number of this product.

integer

The system generated value that uniquely identifies this store.

integer

The current supplier for this item.

date-time

Filter on the update date/time for the indicated changeset_name using ISO8601 format. Assumption is UTC unless TZ offset is specified.

Headers
integer
required

The id of the active store to be used for this API invocation

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json