Skip to main content
GET
/
commerce
/
catalog
/
admin
/
products
Error
A valid request URL is required to generate request examples
{
  "startIndex": 123,
  "pageSize": 123,
  "pageCount": 123,
  "totalCount": 123,
  "items": [
    {
      "productCode": "<string>",
      "productUsage": "<string>",
      "fulfillmentTypesSupported": [
        "<string>"
      ],
      "masterCatalogId": 123,
      "productSequence": 123,
      "productTypeId": 123,
      "isValidForProductType": true,
      "baseProductCode": "<string>",
      "productInCatalogs": [
        {
          "catalogId": 123,
          "isActive": true,
          "isPriceOverridden": true,
          "price": {
            "isoCurrencyCode": "<string>",
            "price": 123,
            "salePrice": 123,
            "msrp": 123,
            "map": 123,
            "mapStartDate": "2023-11-07T05:31:56Z",
            "mapEndDate": "2023-11-07T05:31:56Z",
            "creditValue": 123
          },
          "productCategories": [
            {
              "categoryId": 123
            }
          ],
          "primaryProductCategory": {
            "categoryId": 123
          },
          "dateFirstAvailableInCatalog": "2023-11-07T05:31:56Z",
          "activeDateRange": {
            "startDate": "2023-11-07T05:31:56Z",
            "endDate": "2023-11-07T05:31:56Z"
          },
          "auditInfo": {
            "updateDate": "2023-11-07T05:31:56Z",
            "createDate": "2023-11-07T05:31:56Z",
            "updateBy": "<string>",
            "createBy": "<string>"
          }
        }
      ],
      "content": {
        "localeCode": "<string>",
        "productName": "<string>",
        "productFullDescription": "<string>",
        "productShortDescription": "<string>",
        "productImages": [
          {
            "id": 123,
            "localeCode": "<string>",
            "imageLabel": "<string>",
            "altText": "<string>",
            "imageUrl": "<string>",
            "cmsId": "<string>",
            "videoUrl": "<string>",
            "mediaType": "<string>",
            "sequence": 123,
            "productImageGroupId": "<string>"
          }
        ]
      },
      "localizedContent": [
        {
          "localeCode": "<string>",
          "productName": "<string>",
          "productFullDescription": "<string>",
          "productShortDescription": "<string>",
          "productImages": [
            {
              "id": 123,
              "localeCode": "<string>",
              "imageLabel": "<string>",
              "altText": "<string>",
              "imageUrl": "<string>",
              "cmsId": "<string>",
              "videoUrl": "<string>",
              "mediaType": "<string>",
              "sequence": 123,
              "productImageGroupId": "<string>"
            }
          ]
        }
      ],
      "price": {
        "isoCurrencyCode": "<string>",
        "price": 123,
        "salePrice": 123,
        "msrp": 123,
        "map": 123,
        "mapStartDate": "2023-11-07T05:31:56Z",
        "mapEndDate": "2023-11-07T05:31:56Z",
        "creditValue": 123
      },
      "pricingBehavior": {
        "discountsRestricted": true,
        "discountsRestrictedStartDate": "2023-11-07T05:31:56Z",
        "discountsRestrictedEndDate": "2023-11-07T05:31:56Z",
        "variationPricingMethod": "<string>"
      },
      "seoContent": {
        "localeCode": "<string>",
        "metaTagTitle": "<string>",
        "metaTagDescription": "<string>",
        "metaTagKeywords": "<string>",
        "titleTagTitle": "<string>",
        "seoFriendlyUrl": "<string>"
      },
      "localizedSEOContent": [
        {
          "localeCode": "<string>",
          "metaTagTitle": "<string>",
          "metaTagDescription": "<string>",
          "metaTagKeywords": "<string>",
          "titleTagTitle": "<string>",
          "seoFriendlyUrl": "<string>"
        }
      ],
      "options": [
        {
          "attributeFQN": "<string>",
          "isProductImageGroupSelector": true,
          "values": [
            {
              "value": "<unknown>",
              "attributeVocabularyValueDetail": {
                "valueSequence": 123,
                "value": "<unknown>",
                "mappedGenericValues": [
                  "<unknown>"
                ],
                "productName": "<string>",
                "content": {
                  "localeCode": "<string>",
                  "stringValue": "<string>"
                },
                "localizedContent": [
                  {
                    "localeCode": "<string>",
                    "stringValue": "<string>"
                  }
                ],
                "displayOrder": 123
              }
            }
          ]
        }
      ],
      "extras": [
        {
          "attributeFQN": "<string>",
          "isRequired": true,
          "isMultiSelect": true,
          "values": [
            {
              "value": "<unknown>",
              "deltaPrice": {
                "currencyCode": "<string>",
                "deltaPrice": 123
              },
              "localizedDeltaPrice": [
                {
                  "currencyCode": "<string>",
                  "deltaPrice": 123
                }
              ],
              "deltaWeight": 123,
              "isDefaulted": true,
              "quantity": 123,
              "attributeVocabularyValueDetail": {
                "valueSequence": 123,
                "value": "<unknown>",
                "mappedGenericValues": [
                  "<unknown>"
                ],
                "productName": "<string>",
                "content": {
                  "localeCode": "<string>",
                  "stringValue": "<string>"
                },
                "localizedContent": [
                  {
                    "localeCode": "<string>",
                    "stringValue": "<string>"
                  }
                ],
                "displayOrder": 123
              }
            }
          ]
        }
      ],
      "properties": [
        {
          "attributeFQN": "<string>",
          "values": [
            {
              "value": "<unknown>",
              "content": {
                "localeCode": "<string>",
                "stringValue": "<string>"
              },
              "localizedContent": [
                {
                  "localeCode": "<string>",
                  "stringValue": "<string>"
                }
              ],
              "attributeVocabularyValueDetail": {
                "valueSequence": 123,
                "value": "<unknown>",
                "mappedGenericValues": [
                  "<unknown>"
                ],
                "productName": "<string>",
                "content": {
                  "localeCode": "<string>",
                  "stringValue": "<string>"
                },
                "localizedContent": [
                  {
                    "localeCode": "<string>",
                    "stringValue": "<string>"
                  }
                ],
                "displayOrder": 123
              }
            }
          ],
          "forceOrder": true
        }
      ],
      "isTaxable": true,
      "inventoryInfo": {
        "manageStock": true,
        "outOfStockBehavior": "<string>"
      },
      "shippingClassId": 123,
      "isRecurring": true,
      "upc": "<string>",
      "supplierInfo": {
        "mfgPartNumber": "<string>",
        "distPartNumber": "<string>",
        "cost": {
          "isoCurrencyCode": "<string>",
          "cost": 123
        }
      },
      "isPackagedStandAlone": true,
      "standAlonePackageType": "<string>",
      "packageHeight": {
        "unit": "<string>",
        "value": 123
      },
      "packageWidth": {
        "unit": "<string>",
        "value": 123
      },
      "packageLength": {
        "unit": "<string>",
        "value": 123
      },
      "packageWeight": {
        "unit": "<string>",
        "value": 123
      },
      "applicableDiscounts": [
        {
          "scope": "<string>",
          "target": {
            "type": "<string>",
            "includeAllProducts": true,
            "includedCategoriesOperator": "<string>",
            "categories": [
              {
                "id": 123
              }
            ],
            "excludedCategoriesOperator": "<string>",
            "excludedCategories": [
              {
                "id": 123
              }
            ],
            "products": [
              {
                "productCode": "<string>"
              }
            ],
            "excludedProducts": [
              {
                "productCode": "<string>"
              }
            ],
            "excludeItemsWithExistingShippingDiscounts": true,
            "excludeItemsWithExistingProductDiscounts": true,
            "shippingMethods": [
              {
                "code": "<string>",
                "name": "<string>"
              }
            ],
            "shippingZones": [
              {
                "zone": "<string>"
              }
            ],
            "doNotApplyToHandlingFees": true,
            "maximumQuantityPerRedemption": 123,
            "appliesToLeastExpensiveProductsFirst": true
          },
          "amountType": "<string>",
          "id": 123,
          "content": {
            "name": "<string>",
            "localeCode": "<string>",
            "friendlyDescription": "<string>",
            "customPropertyValues": {
              "value1": "<string>",
              "value2": "<string>",
              "value3": "<string>",
              "value4": "<string>",
              "value5": "<string>",
              "value6": "<string>",
              "value7": "<string>",
              "value8": "<string>",
              "value9": "<string>",
              "value10": "<string>"
            },
            "auditInfo": {
              "updateDate": "2023-11-07T05:31:56Z",
              "createDate": "2023-11-07T05:31:56Z",
              "updateBy": "<string>",
              "createBy": "<string>"
            }
          },
          "localizedContent": [
            {
              "name": "<string>",
              "localeCode": "<string>",
              "friendlyDescription": "<string>",
              "customPropertyValues": {
                "value1": "<string>",
                "value2": "<string>",
                "value3": "<string>",
                "value4": "<string>",
                "value5": "<string>",
                "value6": "<string>",
                "value7": "<string>",
                "value8": "<string>",
                "value9": "<string>",
                "value10": "<string>"
              },
              "auditInfo": {
                "updateDate": "2023-11-07T05:31:56Z",
                "createDate": "2023-11-07T05:31:56Z",
                "updateBy": "<string>",
                "createBy": "<string>"
              }
            }
          ],
          "conditions": {
            "maxRedemptionCount": 123,
            "requiresCoupon": true,
            "couponCode": "<string>",
            "requiresAuthenticatedUser": true,
            "includedPaymentWorkflows": [
              "<string>"
            ],
            "includedCategories": [
              {
                "categoryId": 123
              }
            ],
            "excludedCategories": [
              {
                "categoryId": 123
              }
            ],
            "includedProducts": [
              {
                "productCode": "<string>"
              }
            ],
            "excludedProducts": [
              {
                "productCode": "<string>"
              }
            ],
            "customerSegments": [
              {
                "id": 123
              }
            ],
            "minimumQuantityRequiredProducts": 123,
            "minimumQuantityProductsRequiredInCategories": 123,
            "minimumOrderAmount": 123,
            "maximumOrderAmount": 123,
            "categoriesToExcludeFromMinOrderTotal": [
              {
                "categoryId": 123
              }
            ],
            "productsToExcludeFromMinOrderTotal": [
              {
                "productCode": "<string>"
              }
            ],
            "minimumLifetimeValueAmount": 123,
            "startDate": "2023-11-07T05:31:56Z",
            "expirationDate": "2023-11-07T05:31:56Z",
            "minimumCategorySubtotalBeforeDiscounts": 123,
            "minimumRequiredQuantityPerRedemption": 123,
            "validSubscriptionFrequencies": [
              "<string>"
            ],
            "validSubscriptionContinuityOrdinals": [
              123
            ],
            "minDistinctProductsRequired": 123,
            "minTotalOrderQuantity": 123,
            "pricingContext": "<string>",
            "continuityRecurrenceSettings": {
              "startOrdinal": 123,
              "interval": 123,
              "stopOrdinal": 123
            },
            "validFulfillmentMethods": [
              "<string>"
            ],
            "exclusiveSiteIds": [
              123
            ],
            "expression": {
              "text": "<string>",
              "tree": {
                "type": "<string>",
                "logicalOperator": "<string>",
                "nodes": "<array>",
                "left": "<string>",
                "operator": "<string>",
                "right": "<unknown>"
              }
            },
            "exclusiveLocationCodes": [
              "<string>"
            ]
          },
          "currentRedemptionCount": 123,
          "amount": 123,
          "status": "<string>",
          "canBeDeleted": true,
          "doesNotApplyToSalePrice": true,
          "doesNotApplyToProductsWithSalePrice": true,
          "isDisabled": true,
          "maximumUsesPerUser": 123,
          "maximumDiscountImpactPerOrder": 123,
          "maximumDiscountImpactPerRedemption": 123,
          "maximumRedemptionsPerOrder": 123,
          "includedPriceLists": [
            "<string>"
          ],
          "doesNotApplyToMultiShipToOrders": true,
          "isBxGx": true,
          "canBeStackedUpon": true,
          "stackingLayer": 123,
          "thresholdMessage": {
            "discountId": 123,
            "thresholdValue": 123,
            "isActive": true,
            "showInCart": true,
            "showOnCheckout": true,
            "requiresCouponCode": true,
            "content": {
              "messageTemplate": "<string>",
              "localeCode": "<string>",
              "auditInfo": {
                "updateDate": "2023-11-07T05:31:56Z",
                "createDate": "2023-11-07T05:31:56Z",
                "updateBy": "<string>",
                "createBy": "<string>"
              }
            },
            "localizedContent": [
              {
                "messageTemplate": "<string>",
                "localeCode": "<string>",
                "auditInfo": {
                  "updateDate": "2023-11-07T05:31:56Z",
                  "createDate": "2023-11-07T05:31:56Z",
                  "updateBy": "<string>",
                  "createBy": "<string>"
                }
              }
            ],
            "auditInfo": {
              "updateDate": "2023-11-07T05:31:56Z",
              "createDate": "2023-11-07T05:31:56Z",
              "updateBy": "<string>",
              "createBy": "<string>"
            }
          },
          "preventLineItemShippingDiscounts": true,
          "preventOrderProductDiscounts": true,
          "preventOrderShippingDiscounts": true,
          "hasPurchaseConditions": true,
          "purchaseRequirementType": "<string>",
          "auditInfo": {
            "updateDate": "2023-11-07T05:31:56Z",
            "createDate": "2023-11-07T05:31:56Z",
            "updateBy": "<string>",
            "createBy": "<string>"
          },
          "tagCodes": [
            "<string>"
          ],
          "isSubscriptionDiscount": true,
          "isPublic": true,
          "code": "<string>",
          "labels": [
            "<string>"
          ]
        }
      ],
      "isVariation": true,
      "variationKey": "<string>",
      "hasConfigurableOptions": true,
      "hasStandAloneOptions": true,
      "variationOptions": [
        {
          "attributeFQN": "<string>",
          "value": "<unknown>",
          "content": {
            "localeCode": "<string>",
            "stringValue": "<string>"
          }
        }
      ],
      "publishingInfo": {
        "publishedState": "<string>",
        "lastPublishedBy": "<string>",
        "lastPublishedDate": "2023-11-07T05:31:56Z",
        "publishSetCode": "<string>"
      },
      "bundledProducts": [
        {
          "productCode": "<string>",
          "quantity": 123,
          "price": {
            "isoCurrencyCode": "<string>",
            "price": 123,
            "salePrice": 123,
            "msrp": 123,
            "map": 123,
            "mapStartDate": "2023-11-07T05:31:56Z",
            "mapEndDate": "2023-11-07T05:31:56Z",
            "creditValue": 123
          },
          "productName": "<string>",
          "packageHeight": {
            "unit": "<string>",
            "value": 123
          },
          "packageWidth": {
            "unit": "<string>",
            "value": 123
          },
          "packageLength": {
            "unit": "<string>",
            "value": 123
          },
          "packageWeight": {
            "unit": "<string>",
            "value": 123
          },
          "fulfillmentTypesSupported": [
            "<string>"
          ]
        }
      ],
      "productCollectionProducts": [
        {
          "memberKey": {
            "value": "<string>"
          },
          "productUsage": "<string>",
          "content": {
            "localeCode": "<string>",
            "productName": "<string>",
            "productFullDescription": "<string>",
            "productShortDescription": "<string>",
            "productImages": [
              {
                "id": 123,
                "localeCode": "<string>",
                "imageLabel": "<string>",
                "altText": "<string>",
                "imageUrl": "<string>",
                "cmsId": "<string>",
                "videoUrl": "<string>",
                "mediaType": "<string>",
                "sequence": 123,
                "productImageGroupId": "<string>"
              }
            ]
          },
          "price": {
            "isoCurrencyCode": "<string>",
            "price": 123,
            "salePrice": 123,
            "msrp": 123,
            "map": 123,
            "mapStartDate": "2023-11-07T05:31:56Z",
            "mapEndDate": "2023-11-07T05:31:56Z",
            "creditValue": 123
          }
        }
      ],
      "productCollections": [
        {
          "collectionProductCode": "<string>",
          "collectionName": "<string>",
          "isPrimaryCollection": true
        }
      ],
      "productImageGroups": [
        {
          "productImageGroupId": "<string>",
          "productImageGroupTags": [
            {
              "fqn": "<string>",
              "values": [
                "<string>"
              ]
            }
          ]
        }
      ],
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      },
      "slicingSettings": {
        "slicingAttributeFqn": "<string>"
      },
      "primaryProductCollectionCode": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Query Parameters

startIndex
integer<int32>
default: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
integer<int32>
default: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.

q
string
qLimit
integer<int32>
noCount
boolean
responseFields
string

limits which fields are returned in the response body

Response

Success

Collection of products returned as a whole. A collection is not paged.

startIndex
integer<int32>
pageSize
integer<int32>
pageCount
integer<int32>
totalCount
integer<int32>
items
object[] | null