GuidesAPI Reference
Log In
API Reference

List Products for E-Commerce

List resource

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.

Language
Credentials
Bearer
JWT
URL
Click Try It! to start a request and see the response here!