A valid request URL is required to generate request examples{
"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>"
}
}Update Product in Catalog
Update a product in a particular catalog. 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”.
A valid request URL is required to generate request examples{
"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>"
}
}Authorizations
JWT Authorization header using the Bearer scheme.
Query Parameters
limits which fields are returned in the response body
Body
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.
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)
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.
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 of the product and currency used.
Show child attributes
Show child attributes
Categories to which the product belongs for this catalog.
Show child attributes
Show child attributes
Categories to which the product belongs.
Show child attributes
Show child attributes
Date this product was first Available for sale in the catalog. This is utilized in expressions that reference DaysInCatloag.
Active Effectivity Dates
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Success
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.
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)
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.
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 of the product and currency used.
Show child attributes
Show child attributes
Categories to which the product belongs for this catalog.
Show child attributes
Show child attributes
Categories to which the product belongs.
Show child attributes
Show child attributes
Date this product was first Available for sale in the catalog. This is utilized in expressions that reference DaysInCatloag.
Active Effectivity Dates
Show child attributes
Show child attributes
Show child attributes
Show child attributes