Get Products

get https://t{tenantId}-s{siteId}.{env}.mozu.com/api/commerce/catalog/admin/products

Retrieves a list of products according to any specified filter criteria and sort options. This current version of the Products API includes localizedContent to support multi-locale catalogs, which was not present in the previous API model. If you were a client prior to May 2024 and have upgraded your implementation to support this feature, you can still access product data that has not yet been rewritten to the new model by providing an x-api-version header set to "1".

Query Params

startIndex

int32

Defaults to 0

Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a PageSize of 25, to get the 51st through the 75th items, startIndex=3. The default value is 0.

pageSize

int32

Defaults to 0

Used to page results from a query. Indicates the maximum number of entities to return from a single query. The default value is 20 and the maximum value is 200.

sortBy

string

The element to sort the results by and the order in which the results appear. Either ascending or descending order. For example, to sort the results by “ID” ascending then by “CreateDate” descending, use: id asc,createdate desc.

responseGroups

string

Used to get more specific information from the request. For example to get discounts applied to a product use the AppliedProducts response group. Available response groups: ApplicableDiscounts, VariationOptions, and BaseProductCode.

filter

string

A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional.

string

qLimit

int32

noCount

boolean

responseFields

string

limits which fields are returned in the response body

Response

Response body

object

startIndex

int32

pageSize

int32

pageCount

int32

totalCount

int32

items

array of objects | null

items

object

productCode

string | null

Merchant-created code identifier associated with the product, for example, a SKU or product item number.

productUsage

string | null

Indicates the usage type of this product. Must be one of the values in ProductUsageConst.

fulfillmentTypesSupported

array of strings | null

Indicates the fulfillment types the product supports.

fulfillmentTypesSupported

masterCatalogId

int32 | null

Identifier of the Master Catalog that this product is a member of. System-supplied and read-only

productSequence

int32 | null

System generated monotonically increasing sequence

productTypeId

int32 | null

Unique identifier of the productType of the product. Refers to a valid ProductType that was previously created with the ProductType resource.

isValidForProductType

boolean | null

Read only flag that indicates if the product meets the product type constraints (All adminRequired attributes have a valid value)

baseProductCode

string | null

This is the base product ProductCode of a product that is a variation. It is read-only and only populated for products that are variations of a configurable base product.

productInCatalogs

array of objects | null

Catalog specific info for each catalog a product is valid in. There should always be one or more entries here.

productInCatalogs

object

catalogId

int32

The CatalogId of the catalog that the product is associated with (The catalog must a valid catalog within the MasterCatalog that the product belongs to)

isActive

boolean | null

If true, the product is marked as available for sale in the catalog. Setting a product to IsActive = false will prevent it from being shown on the customer facing storefront.

isPriceOverridden

boolean | null

If true, the price for this product is overridden in the catalog. If false, the MasterCatalog level price will be used for the product.

price

object

Price of the product and currency used.

productCategories

array of objects | null

Categories to which the product belongs for this catalog.

productCategories

object

categoryId

int32

Unique identifier of the category. System-supplied and read-only.

primaryProductCategory

object

Categories to which the product belongs.

dateFirstAvailableInCatalog

date-time | null

Date this product was first Available for sale in the catalog. This is utilized in expressions that reference DaysInCatloag.

activeDateRange

object

Active Effectivity Dates

auditInfo

object

content

object

Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally.

localizedContent

array of objects | null

The content for each locale code supported by the master catalog

localizedContent

object

localeCode

string | null

Lanugage used for product content. Currently, only en_US is supported.

productName

string | null

Name of the product.

productFullDescription

string | null

Long description of the product typically used for a product details page.

productShortDescription

string | null

Brief description of the product typically used when the product is displayed in a list or search results.

productImages

array of objects | null

List of images associated with the product.

productImages

object

int32 | null

Unique identifier of the image. System-supplied and read-only.

localeCode

string | null

Language used for the image content.

imageLabel

string | null

Image title that appears on the storefront.

altText

string | null

Descriptive text associated with the image or video that appears on the storefront.

imageUrl

string | null

URL of the image.

cmsId

string | null

Id of the image in the CMS.

videoUrl

string | null

URL of a video associated with the product.

mediaType

string | null

Type of media. Used by the client to determine how to render the image or video or what have you.

sequence

int32 | null

For products with multiple images, the order in which this image appears on the storefront.

productImageGroupId

string | null

Image group to which this image belongs. Default is null.

price

object

Price of the product and currency used.

pricingBehavior

object

Pricing behavior associated with the product

seoContent

object

localizedSEOContent

array of objects | null

localizedSEOContent

object

localeCode

string | null

Lanugage used for product content. Currently, only en_US is supported.

metaTagTitle

string | null

Metadata title. Metadata can be used to manage information internally. Sometimes used for SEO.

metaTagDescription

string | null

Metadata description. Metadata can be used to manage information internally. Sometimes used for SEO.

metaTagKeywords

string | null

Metadata keywords. Metadata can be used to manage information internally. Sometimes used for SEO.

titleTagTitle

string | null

Used to customize the HTML title tag within the head section of the product details page

seoFriendlyUrl

string | null

Human-readable identifier that you can give to the product to create friendly URLs. For example,
instead of "http: //example.com/products?category=2&id=25," the friendly URL can be "http: //example.com/products/category/2/25."

options

array of objects | null

The Options defined in the product Type that are currently assigned to this product

options

object

attributeFQN

string | null

Unique identifier of the Attribute.

isProductImageGroupSelector

boolean | null

Defines whether or not this option can be used to segment product images

values

array of objects | null

List of all the values for this product option.

values

object

value

string

attributeVocabularyValueDetail

object

Value of an attribute

extras

array of objects | null

The Extras defined in the product Type that are currently assigned to this product

extras

object

attributeFQN

string | null

Unique identifier of the Attribute.

isRequired

boolean | null

isMultiSelect

boolean | null

values

array of objects | null

values

object

value

string

deltaPrice

object

How much a product option costs above the cost of the base product, if at all.

localizedDeltaPrice

array of objects | null

localizedDeltaPrice

object

currencyCode

string | null

Which currency to use.

deltaPrice

double

Amount of money saved when discounts are applied.

deltaWeight

double | null

isDefaulted

boolean | null

quantity

int32 | null

attributeVocabularyValueDetail

object

Value of an attribute

properties

array of objects | null

The Properties defined in the product Type that are currently assigned to this product

properties

object

attributeFQN

string | null

Unique identifier of the Attribute.

values

array of objects | null

values

object

value

string

content

object

Attribute Value Localized Resource

localizedContent

array of objects | null

localizedContent

object

localeCode

string | null

Language used for the string attribute value.

stringValue

string | null

Localized Value in the language of the locale code

attributeVocabularyValueDetail

object

Value of an attribute

forceOrder

boolean | null

isTaxable

boolean | null

If true, the product is subject to tax.

inventoryInfo

object

Use the Products resource to create and manage products for your store. You can create products with options that a shopper configures (such as a T-shirt color and size). The system can manage inventory for all combinations of your product options, and can calculate tax and shipping costs.

shippingClassId

int32 | null

isRecurring

boolean | null

If true, the product can be purchased or fulfilled at regular intervals, for example, monthly billing or a subscription.

upc

string | null

UPC code of the product.

supplierInfo

object

Supplier info for the product

isPackagedStandAlone

boolean | null

Does this product need to be packaged on its own

standAlonePackageType

string | null

When packaged alone this is the package type

packageHeight

object

packageWidth

object

packageLength

object

packageWeight

object

applicableDiscounts

array of objects | null

Read only. List of discounts that are available for a product.

applicableDiscounts

object

int32 | null

Unique identifier of the discount. System-supplied and read-only.

content

object

Container for the language-specific name of the discount. You will have a container for each supported language
(LocaleCode).
This enables you to display the discount name in multiple languages yet manage it as a single discount internally.

localizedContent

array of objects | null

Container for the language-specific name of the discount. You will have a container for each supported language (LocaleCode).
This enables you to display the discount name in multiple languages yet manage it as a single discount internally.

localizedContent

object

localeCode

string | null

Lanugage used for the discount in the current catalog. Defaults setting for the active catalog.

name

string

required

length between 0 and 200

Name of the discount.

friendlyDescription

string | null

Promotional text or HTML that can be utilized as friendly content like "Buy this product now and get X!"

auditInfo

object

scope

string

required

Scope to which the discount applies, valid values are: Order, LineItem

conditions

object

Specifies constraints that must be satified for a discount to be applied to a target.
Constraints are Anded together

target

object

required

What to discount. Specifies the type of discount (percentage off, monetary amount, or free shipping) and which products, categories, or shipping methods are eligible for the discount.
Can also specify the minimum amount that the order must total for the discount to apply.

currentRedemptionCount

int32 | null

How many times this discount has been redeemed. System-supplied and read-only.

amount

double | null

Amount of the discount, as a percentage or monetary amount, for example 15% or $15.

Must be either null or greater than zero.

amountType

string

required

Type of discount, which can be either a percentage off the price,
a specific monetary amount, or free.
Possible values:
Percentage
Amount
Free
FixedPrice

status

string | null

Discount status which can be "Active," "Scheduled," or "Expired." System-supplied and read-only.

canBeDeleted

boolean

Signifies that the discount is not referenced and can be hard deleted

doesNotApplyToSalePrice

boolean | null

Determines if the discount should apply to sale price or regular price only.
Discounts will apply to sale prices by default.
Only applies to LineItem product discounts.

doesNotApplyToProductsWithSalePrice

boolean | null

Determines whether or not a discount applies to a items with a sale price. Applicable
on order and line item discounts. For line items, when this is true, the discount will
be disqualified. For order level discounts, when true, the discount will not be applied
to those items have a sale price.

isDisabled

boolean | null

Signifies if the discount is disabled (Null is treated as false)

maximumUsesPerUser

int32 | null

Maximum number of times a user can redeem this discount.
Must be either null or greater than zero.

maximumDiscountImpactPerOrder

double | null

Maximum impact this discount can apply on a single order.
Must be either null or greater than zero.

maximumDiscountImpactPerRedemption

double | null

Maximum impact this discount can apply on a single line item.
Must be either null or greater than zero.

maximumRedemptionsPerOrder

int32 | null

Maximum number of redemptions allowed per order.
If null, defaults to unlimited.

includedPriceLists

array of strings | null

Products receiving a price from a price list specified here or a child of a specified
price list can be discounted.

includedPriceLists

doesNotApplyToMultiShipToOrders

boolean | null

Flag to allow or prevent application to multi-ship-to orders,
Only applicable to shipping discounts.

isBxGx

boolean | null

Readonly property indicating that the condition required purchase is the
same as the target items. Used in BxGx and BoGo type discounts.

canBeStackedUpon

boolean | null

Indicates whether or not stacking is enabled for this discount

stackingLayer

int32 | null

Indicates which stacking layer this discount is a part of

thresholdMessage

object

preventLineItemShippingDiscounts

boolean | null

Prevents Line Item Shipping discounts from being applied when a Line Item Product
discount has been applied

preventOrderProductDiscounts

boolean | null

Prevents Order Product discounts from being applied when a Line Item Product
or Shipping discount has been applied

preventOrderShippingDiscounts

boolean | null

Prevents Order Shipping discounts from being applied when a Line Item Product/Shipping
or Order Product discount has been applied

hasPurchaseConditions

boolean

Indicates if this discount has purchase conditions that must be met before
the discount is applied

purchaseRequirementType

string | null

The type of purchase requirement for this discount, either purchase conditions and targets which
Supports BoGo, and BxGx scenarios. Or Target only that only have a target and no purchase conditions

auditInfo

object

tagCodes

array of strings | null

System-supplied and read-only.

tagCodes

isSubscriptionDiscount

boolean | null

Determines how discounts will be evaluated for subscription items and during continuity orders.

isPublic

boolean | null

Determines whether the discount is available for every shopper.

code

string | null

Indicates unique code for the discount, if not present Discount Id is used as a code.

labels

array of strings | null

Indicates unique discount labels.

labels

isVariation

boolean

Read only. If true, this is a product variation of a product with configurable options. System-supplied and read-only.

variationKey

string | null

Read only. If IsVariation true, thish provides a unique key to manage the variation of the base product.

hasConfigurableOptions

boolean

Read only. If true, this product has configurable options. The product is not purchasable until the shopper selects options that resolve to a product variation. System-supplied and read-only.

hasStandAloneOptions

boolean

Read only. If true, the product has stand-alone options that a shopper may select. System-supplied and read-only.

variationOptions

array of objects | null

Read only List of variations that exist for a product. This is only populated when IsVariation is true. To get the list of options, the GET request must include the VariationOptions response group.

variationOptions

object

attributeFQN

string | null

Unique identifier of the product variation option. System-supplied and read-only.

value

string

Name of the product variation option used on the admin side independent of how it appears on the storefront. For example, the internal "SZ" attribute might appear as "size" on the storefront.

content

object

Attribute Value Localized Resource

publishingInfo

object

Price of the product and currency used.

bundledProducts

array of objects | null

list of other products that are included in a BundleProduct
This requires that the ProductUsage be set to Bundle

bundledProducts

object

productCode

string | null

Product Code

quantity

int32

Qty of the bundled PRoduct

price

object

Price of the product and currency used.

productName

string | null

Read only Name of the BundledProduct

packageHeight

object

packageWidth

object

packageLength

object

packageWeight

object

fulfillmentTypesSupported

array of strings | null

Indicates the fulfillment types the product supports.

fulfillmentTypesSupported

productCollectionProducts

array of objects | null

list of other products that are members of a ProductCollection
This requires that the ProductUsage be set to Collection

productCollectionProducts

object

memberKey

object

Key to resolve a collection member

productUsage

string | null

ReadOnly Indicates the usage type of this product. Must be one of the values in ProductUsageConst.

content

object

price

object

Price of the product and currency used.

productCollections

array of objects | null

List of Mozu.ProductAdmin.Contracts.ProductCollectionInfo that this product belongs to

productCollections

object

collectionProductCode

string | null

Product code of the product that is the collection that the containing product belongs to

collectionName

string | null

Collection name in the language of the master catalog

isPrimaryCollection

boolean | null

True when this is the primary collection for the containing product.

productImageGroups

array of objects | null

List of the image groups this product uses.
Image groups are used to map different images to different product options.
If the product doesn't have options then all images will be in the default
image group.

productImageGroups

object

productImageGroupId

string

required

productImageGroupTags

array of objects | null

productImageGroupTags

object

fqn

string

required

values

array of strings | null

values

auditInfo

object

slicingSettings

object

Container class for Slicing Settings

primaryProductCollectionCode

string | null

When this product belongs to a product collection this is the product id for the primary collection.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://t0-s0.sandbox.mozu.com/api/commerce/catalog/admin/products?startIndex=0&pageSize=0' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

text/plain

200Success