commerce/catalog/admin/products

Use the Product Administration resource to create new product definitions in the master catalog and determine which catalogs will feature products. You can also assign attribute values for defined products, manage product-level location inventory, and configure the variations of a product.

JSON Example

Product Properties

Property Description
applicableDiscounts

type: list of discount

List of discounts available per configured conditions and criteria. These discounts are associated with products, orders, and shipping costs. Shoppers can view these discounts per order, per product in an order, or for their shipping depending on the configuration.

discount.amount

type: decimal

The amount of the order-level adjustment, which can be a positive or negative amount.

discount.amountType

type: string

The type of discount amount, such as an amount or a percentage.

discount.auditInfo

type: auditInfo

Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data.

discount.auditInfo.createBy

type: string

Identifier of the user that created the object. System created and read only.

discount.auditInfo.createDate

type: DateTime

The date and time in UTC format set when the object was created.

discount.auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

discount.auditInfo.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

discount.canBeDeleted

type: bool

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

discount.canBeStackedUpon

type: bool

Boolean field, if true, this discount will allow discounts in the following layer to be stacked on top.

discount.conditions

type: discountCondition

List of conditions that must be met for the discount to apply.

discount.discountCondition.categoriesToExcludeFromMinOrderTotal

type: list of categoryDiscountCondition

discount.discountCondition.categoryDiscountCondition.categoryId

type: int

ID of the relevant category.

discount.discountCondition.couponCode

type: string

The coupon code that a shopper uses to redeem an associated discount on a purchase. This is also the unique identifier of the coupon itself.

discount.discountCondition.customerSegments

type: list of customerSegment

List of customer segments associated with the discount. Shoppers who are members of an associated customer segment can redeem this discount.

discount.discountCondition.customerSegment.id

type: int

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

discount.discountCondition.excludedCategories

type: list of categoryDiscountCondition

List of the product categories that are not eligible for the discount.

discount.discountCondition.categoryDiscountCondition.categoryId

type: int

ID of the relevant category.

discount.discountCondition.excludedProducts

type: list of productDiscountCondition

List of products that are not eligible for the discount.

discount.discountCondition.productDiscountCondition.productCode

type: string

The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product.

discount.discountCondition.expirationDate

type: DateTime

Date and time in UTC format when a discount, credit, wish list, or cart expires. An expired discount no longer can be redeemed. An expired wish list is no longer available. An expired credit can no longer be redeemed for a purchase. Acart becomes inactive and expired based on a system-calculated interval. For example, if an anonymous shopper has 14 days of inactivity, the cart is considered abandoned after that period of inactivity. System-supplied and read-only.

discount.discountCondition.includedCategories

type: list of categoryDiscountCondition

List of product categories that are eligible for the discount.

discount.discountCondition.categoryDiscountCondition.categoryId

type: int

ID of the relevant category.

discount.discountCondition.includedPaymentWorkflows

type: list of string

List of payment types that trigger this discount to be valid.

discount.discountCondition.includedProducts

type: list of productDiscountCondition

List of products that are eligible for the discount.

discount.discountCondition.productDiscountCondition.productCode

type: string

The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product.

discount.discountCondition.maxRedemptionCount

type: int

The maximum number of times the discount can be redeemed.

discount.discountCondition.minimumCategorySubtotalBeforeDiscounts

type: decimal

This specifies the minimum amount that must be purchased in the combined categories defined in IncludedCategories. This amount is calculated before discounting and it is not used if IncludedCategories is empty.

discount.discountCondition.minimumLifetimeValueAmount

type: decimal

The minimum customer lifetime value amount required to redeem this discount.

discount.discountCondition.minimumOrderAmount

type: decimal

The minimum order amount required to redeem this discount.

discount.discountCondition.minimumQuantityProductsRequiredInCategories

type: int

This specifies the minimum quantity of products in the categories specified in IncludedCategories, which must be purchased to qualify for the associated discount. This defaults to 1 if null, and IncludedCategories has values.

discount.discountCondition.minimumQuantityRequiredProducts

type: int

This specifies the minimum quantity of products in the specified IncludedProducts that must be purchased to qualify for the associated discount. This defaults to 1 if null, and IncludedProducts has values.

discount.discountCondition.minimumRequiredQuantityPerRedemption

type: int

minimumRequiredQuantityPerRedemption ApiType DOCUMENT_HERE

discount.discountCondition.productsToExcludeFromMinOrderTotal

type: list of productDiscountCondition

discount.discountCondition.productDiscountCondition.productCode

type: string

The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product.

discount.discountCondition.requiresAuthenticatedUser

type: bool

If true, only authenticated users can redeem the discount. If false, anonymous users can redeem the discount.

discount.discountCondition.requiresCoupon

type: bool

If true, redemption of this discount requires entry of a coupon code.

discount.discountCondition.startDate

type: DateTime

The earliest date and time this discount can be redeemed.

discount.content

type: discountLocalizedContent

Localizable content (such as a name and/or description) for an attribute. The content may be localized when displayed according to the locale code specified by the master catalog. Content can include descriptive text for product extensible attributes, catalog-level descriptions (displayed if isContentOverriden is true), product bundles, and customer account notes.

discount.discountLocalizedContent.auditInfo

type: auditInfo

Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data.

discount.discountLocalizedContent.auditInfo.createBy

type: string

Identifier of the user that created the object. System created and read only.

discount.discountLocalizedContent.auditInfo.createDate

type: DateTime

The date and time in UTC format set when the object was created.

discount.discountLocalizedContent.auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

discount.discountLocalizedContent.auditInfo.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

discount.discountLocalizedContent.friendlyDescription

type: string

The localizable, shopper-facing description defined for a discount or a storefront message.

discount.discountLocalizedContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

discount.discountLocalizedContent.name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

discount.currentRedemptionCount

type: int

The number of times this discount has been redeemed.

discount.doesNotApplyToMultiShipToOrders

type: bool

True if the discount should not apply to orders with multiple shipments. For more information, refer to the topic on multiple shipments.

discount.doesNotApplyToProductsWithSalePrice

type: bool

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.

discount.doesNotApplyToSalePrice

type: bool

If true, this discount does not apply to a line item product with a defined sale price. The default is false, which applies the discount to products with and without defined sale prices.

discount.hasPurchaseConditions

type: bool

hasPurchaseConditions ApiType DOCUMENT_HERE

discount.id

type: int

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

discount.includedPriceLists

type: list of string

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

discount.isBxGx

type: bool

This field is read-only and specifies whether the discount condition is one product or category, and matches the discount target.

discount.maximumDiscountImpactPerOrder

type: decimal

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

discount.maximumDiscountImpactPerRedemption

type: decimal

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

discount.maximumRedemptionsPerOrder

type: int

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

discount.maximumUsesPerUser

type: int

The maximum number of times an individual shopper can redeem the discount.

discount.preventLineItemShippingDiscounts

type: bool

discount.preventOrderProductDiscounts

type: bool

discount.preventOrderShippingDiscounts

type: bool

discount.purchaseRequirementType

type: string

purchaseRequirementType ApiType DOCUMENT_HERE

discount.scope

type: string

The scope to which the discount applies, which is "Order" for order discounts or "LineItem" for individual product discounts.

discount.stackingLayer

type: int

Numerical field representing number of discount layer (up to 3) -Each discount can be assigned to a layer which is then used to determine the order of application. Discounts in the same layer will compete and provide the best value for the shopper.

discount.status

type: string

The current status of the object.

This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive".

discount.target

type: discountTarget

Targets represent the object, such as an item to apply discounts to(products or orders) or a view field for content. Targets are the dot notations that link to the source document property. For example, firstitem for the direct level or firstitem.seconditem.thirditem for a deeper property.

discount.discountTarget.appliesToLeastExpensiveProductsFirst

type: bool

Determines which way the discount is optimized. Consumers favor(default - false/null) or tenants favor (when this is set to true) Applies to discounts where target is not a specific product or list of products. May also impact behavior of Buy X Get Y so that X is the most expensive items and Y the least expensive.

discount.discountTarget.categories

type: list of targetedCategory

The list of all categories associated with the product. These categories contain products, can have discounts associated, and define the grouping of products to display on the storefront.

discount.discountTarget.targetedCategory.id

type: int

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

discount.discountTarget.excludedCategories

type: list of targetedCategory

List of the product categories that are not eligible for the discount.

discount.discountTarget.targetedCategory.id

type: int

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

discount.discountTarget.excludedCategoriesOperator

type: string

The operator to use on the excludedCategories field.

Valid values are: "All" and "Any".

discount.discountTarget.excludedProducts

type: list of targetedProduct

List of products that are not eligible for the discount.

discount.discountTarget.targetedProduct.productCode

type: string

The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product.

discount.discountTarget.excludeItemsWithExistingProductDiscounts

type: bool

Prevents order scoped discounts from layering over items that already have a product discount with the same type.

discount.discountTarget.excludeItemsWithExistingShippingDiscounts

type: bool

Prevents order scoped discounts from layering over items that already have a shipping discount with the same type.

discount.discountTarget.includeAllProducts

type: bool

If true, the target discount applies to all products sold on the site, regardless of product category.

discount.discountTarget.includedCategoriesOperator

type: string

The operator of the includedCategories field.

Valid values are: "All" and "Any".

discount.discountTarget.maximumQuantityPerRedemption

type: int

When a condition is specified, this property limits the number of items that are targeted for each discount redemption with an order. If multiple redemptions are allowed for each order then multiples of this value are allowed in multiples of the associated condition. If no condition is specified, then this value is not used. If null and condition exists, then defaults to 1.

discount.discountTarget.products

type: list of targetedProduct

List of product codes that represent the products to which the discount can apply.

discount.discountTarget.targetedProduct.productCode

type: string

The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product.

discount.discountTarget.shippingMethods

type: list of targetedShippingMethod

The list of shipping method codes that represents the shipping service types to which the discount can apply.

discount.discountTarget.targetedShippingMethod.code

type: string

The unique identifier of the object.

discount.discountTarget.targetedShippingMethod.name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

discount.discountTarget.shippingZones

type: list of targetedShippingZone

The list of shipping zones that are applicable for this discount.

discount.discountTarget.targetedShippingZone.zone

type: string

The zone string for the tenant domain.

discount.discountTarget.type

type: string

The type of scope, which is a developer account or production tenant.

discount.thresholdMessage

type: thresholdMessage

Information on where, when and what content to display in a threshold message to customers.

discount.thresholdMessage.auditInfo

type: auditInfo

Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data.

discount.thresholdMessage.auditInfo.createBy

type: string

Identifier of the user that created the object. System created and read only.

discount.thresholdMessage.auditInfo.createDate

type: DateTime

The date and time in UTC format set when the object was created.

discount.thresholdMessage.auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

discount.thresholdMessage.auditInfo.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

discount.thresholdMessage.content

type: thresholdMessageLocalizedContent

Localizable content (such as a name and/or description) for an attribute. The content may be localized when displayed according to the locale code specified by the master catalog. Content can include descriptive text for product extensible attributes, catalog-level descriptions (displayed if isContentOverriden is true), product bundles, and customer account notes.

discount.thresholdMessage.thresholdMessageLocalizedContent.auditInfo

type: auditInfo

Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data.

discount.thresholdMessage.thresholdMessageLocalizedContent.auditInfo.createBy

type: string

Identifier of the user that created the object. System created and read only.

discount.thresholdMessage.thresholdMessageLocalizedContent.auditInfo.createDate

type: DateTime

The date and time in UTC format set when the object was created.

discount.thresholdMessage.thresholdMessageLocalizedContent.auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

discount.thresholdMessage.thresholdMessageLocalizedContent.auditInfo.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

discount.thresholdMessage.thresholdMessageLocalizedContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

discount.thresholdMessage.thresholdMessageLocalizedContent.messageTemplate

type: string

Locale-based contents of the Threshold Message that will be displayed.

discount.thresholdMessage.discountId

type: int

The unique identifier of the discount.

discount.thresholdMessage.isActive

type: bool

Indicates if the object or feature is active.

discount.thresholdMessage.requiresCouponCode

type: bool

Indicates if the threshold message will display when a promo code is evaluated

discount.thresholdMessage.showInCart

type: bool

Indicates if the threshold message will display in the cart

discount.thresholdMessage.showOnCheckout

type: bool

Indicates if the threshold message will display on the checkout page

discount.thresholdMessage.thresholdValue

type: decimal

The cart total amount that must be met before the threshold message is displayed

auditInfo

type: auditInfo

Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data.

auditInfo.createBy

type: string

Identifier of the user that created the object. System created and read only.

auditInfo.createDate

type: DateTime

The date and time in UTC format set when the object was created.

auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

auditInfo.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

baseProductCode

type: string

Product code defined by the tenant administrator to use as a base prefix when generating product codes for any variations of this product.

bundledProducts

type: list of bundledProduct

Properties of a collection of component products that make up a single product bundle with its own product code. Tenants can define product bundles for any product type that supports the Bundle product usage.

bundledProduct.fulfillmentTypesSupported

type: list of string

List of supported types of fulfillment for the product or variation. The types include direct ship, in-store pickup, or both.

bundledProduct.packageHeight

type: measurement

Height of a package or bundle package in imperial units of feet and inches.

bundledProduct.measurement.unit

type: string

The unit of measurement, such as length or weight.

bundledProduct.measurement.value

type: decimal

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

bundledProduct.packageLength

type: measurement

Length of a package or bundle package in imperial units of feet and inches.

bundledProduct.measurement.unit

type: string

The unit of measurement, such as length or weight.

bundledProduct.measurement.value

type: decimal

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

bundledProduct.packageWeight

type: measurement

Weight of a package or bundle package in imperial units of pounds and ounces.

bundledProduct.measurement.unit

type: string

The unit of measurement, such as length or weight.

bundledProduct.measurement.value

type: decimal

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

bundledProduct.packageWidth

type: measurement

Width of a package or bundle package in imperial units of feet and inches.

bundledProduct.measurement.unit

type: string

The unit of measurement, such as length or weight.

bundledProduct.measurement.value

type: decimal

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

bundledProduct.price

type: productPrice

The price of either the product or shipping.

This amount can be affected by discounts and/or fees. For products, this amount can also be affected by price lists.

bundledProduct.productPrice.creditValue

type: decimal

The credit value of the product or bundled product. When the `goodsType `is `DigitalCredit`, this value is populated to indicate the value of the credit. This is used to create store credit in the fulfillment of gift cards.

bundledProduct.productPrice.isoCurrencyCode

type: string

The three character ISO currency code for the monetary amount. For example, USD is used for US Dollars.

bundledProduct.productPrice.map

type: decimal

The minimum advertised price a client can charge for the associated product, as determined by the supplier. Client administrators can override the minimum advertised price at the catalog level.

bundledProduct.productPrice.mapEndDate

type: DateTime

If the product has a supplier-defined minimum advertised price, the date and time after which the client can sell the product for less than the minimum advertised price.

bundledProduct.productPrice.mapStartDate

type: DateTime

If the product has a supplier-defined minimum advertised price, the date and time after which the client cannot sell the product for less than the minimum advertised price.

bundledProduct.productPrice.msrp

type: decimal

The manufacturer's suggested retail price (MSRP) for the product. This content may be defined by the supplier.

bundledProduct.productPrice.price

type: decimal

The price of either the product or shipping.

This amount can be affected by discounts and/or fees. For products, this amount can also be affected by price lists.

bundledProduct.productPrice.salePrice

type: decimal

The set sale price for a product consisting of a price with a discount already applied.

For price list entries, this property is the product's sale price if the priceListEntryPrice.salePriceMode is set to Overridden.

bundledProduct.productCode

type: string

The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product.

bundledProduct.productName

type: string

The name of the product that represents a line item in a taxable order or product bundle.

bundledProduct.quantity

type: int

The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations.

content

type: productLocalizedContent

Localizable content (such as a name and/or description) for an attribute. The content may be localized when displayed according to the locale code specified by the master catalog. Content can include descriptive text for product extensible attributes, catalog-level descriptions (displayed if isContentOverriden is true), product bundles, and customer account notes.

productLocalizedContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

productLocalizedContent.productFullDescription

type: string

Lengthy full description for a product description, displayed on product detail pages within the storefront.

productLocalizedContent.productImages

type: list of productLocalizedImage

List of image files associated with a product. This content may include the image file URL, name, and other information as available.

productLocalizedContent.productLocalizedImage.altText

type: string

Descriptive text associated with the image or video that appears on the web storefront. This text displays on a hover-over in the browser, providing further information on the content displayed. The alternate text should be plain alphanumeric text without special characters or HTML coding.

productLocalizedContent.productLocalizedImage.cmsId

type: string

The identifier of the image in the Kibo eCommerce CMS. Supply a value for either the CMS ID or Image URL parameter.

productLocalizedContent.productLocalizedImage.id

type: int

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

productLocalizedContent.productLocalizedImage.imageLabel

type: string

The localized title for an image that displays on the storefront. If localized, the displayed content is set per the locale code for the site.

productLocalizedContent.productLocalizedImage.imageUrl

type: string

The URL link for the image file associated with a product or category.

productLocalizedContent.productLocalizedImage.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

productLocalizedContent.productLocalizedImage.mediaType

type: string

Type of media specification required to successfully render the image, video, or other media content for products and categories.

productLocalizedContent.productLocalizedImage.sequence

type: int

The numeric order of objects, used by a vocabulary value defined for an extensible attribute, images, and categories.

productLocalizedContent.productLocalizedImage.videoUrl

type: string

The URL of a video files for a product or category. The path name is set in the language specified by the LocaleCode.

productLocalizedContent.productName

type: string

The name of the product that represents a line item in a taxable order or product bundle.

productLocalizedContent.productShortDescription

type: string

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

extras

type: list of productExtra

List of extra product attributes defined for this product. For example, monogram could be a possible extra for a shirt product.

productExtra.attributeFQN

type: string

The fully qualified name of the attribute. The attributeDefiniteId may be used to generate this name.

productExtra.isMultiSelect

type: bool

If true, the shopper can select more than one value from a predefined list for this extra.

productExtra.isRequired

type: bool

Indicates if the property, attribute, product option, or product extra is required. If true, the object must have a defined value.

productExtra.values

type: list of productExtraValue

List of value data for objects.

productExtra.productExtraValue.attributeVocabularyValueDetail

type: attributeVocabularyValue

Properties of an individual vocabulary value for an attribute. For example, a "color" attribute might have the following vocabulary values: Red, Blue, Green.

productExtra.productExtraValue.attributeVocabularyValue.content

type: attributeVocabularyValueLocalizedContent

Localizable content (such as a name and/or description) for an attribute. The content may be localized when displayed according to the locale code specified by the master catalog. Content can include descriptive text for product extensible attributes, catalog-level descriptions (displayed if isContentOverriden is true), product bundles, and customer account notes.

productExtra.productExtraValue.attributeVocabularyValue.attributeVocabularyValueLocalizedContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

productExtra.productExtraValue.attributeVocabularyValue.attributeVocabularyValueLocalizedContent.stringValue

type: string

If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options.

productExtra.productExtraValue.attributeVocabularyValue.displayOrder

type: int

The order in which the attribute value displays. If you omit a value for this property, Kibo eCommerce infers the display order from the attribute value's position the list.

productExtra.productExtraValue.attributeVocabularyValue.localizedContent

type: list of attributeVocabularyValueLocalizedContent

The localized content associated with the object.

productExtra.productExtraValue.attributeVocabularyValue.attributeVocabularyValueLocalizedContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

productExtra.productExtraValue.attributeVocabularyValue.attributeVocabularyValueLocalizedContent.stringValue

type: string

If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options.

productExtra.productExtraValue.attributeVocabularyValue.productName

type: string

The name of the product that represents a line item in a taxable order or product bundle.

productExtra.productExtraValue.attributeVocabularyValue.value

type: object

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

productExtra.productExtraValue.attributeVocabularyValue.valueSequence

type: int

The number that denotes the order of the entity value within a list of entity values.

productExtra.productExtraValue.deltaPrice

type: productExtraValueDeltaPrice

If the product is in relative pricing mode, this is the difference between associated prices for a product, variation option, or extra. The difference is calculated by subtracting the base price from the associated price with this product, option, and/or extra. For example, if a product with a defined monogram extra costs an additional $10, the `deltaPrice `value is "10". Between options, a price for a medium may be $10 and a large $12 giving a `deltaPrice `value of "2".

Refer to Product Variant Pricing and Weight in the Products guides topic for more information.

productExtra.productExtraValue.productExtraValueDeltaPrice.currencyCode

type: string

The localized currency code for the monetary amount.

productExtra.productExtraValue.productExtraValueDeltaPrice.deltaPrice

type: decimal

If the product is in relative pricing mode, this is the difference between associated prices for a product, variation option, or extra. The difference is calculated by subtracting the base price from the associated price with this product, option, and/or extra. For example, if a product with a defined monogram extra costs an additional $10, the `deltaPrice `value is "10". Between options, a price for a medium may be $10 and a large $12 giving a `deltaPrice `value of "2".

Refer to Product Variant Pricing and Weight in the Products guides topic for more information.

productExtra.productExtraValue.deltaWeight

type: decimal

The difference between the weight associated with this product, variation option, or extra and the base product. For example, if a product with a monogram weighs an extra 1/4 lb, the DeltaWeight value is "0.25". The amount of the delta is set by the weight type for the storefront.

productExtra.productExtraValue.isDefaulted

type: bool

If true, the value for the product extra is selected by default. Shopper entered extras cannot be defaulted.

productExtra.productExtraValue.localizedDeltaPrice

type: list of productExtraValueDeltaPrice

The difference between associated prices for a product, variation option, or extra that is localized per the `localeCode`. The difference is calculated by subtracting the base price from the associated price with this product, option, and/or extra. Depending on the localeCode, the price may be converted such as from USD (US Dollar) to EUR (euro).

productExtra.productExtraValue.productExtraValueDeltaPrice.currencyCode

type: string

The localized currency code for the monetary amount.

productExtra.productExtraValue.productExtraValueDeltaPrice.deltaPrice

type: decimal

If the product is in relative pricing mode, this is the difference between associated prices for a product, variation option, or extra. The difference is calculated by subtracting the base price from the associated price with this product, option, and/or extra. For example, if a product with a defined monogram extra costs an additional $10, the `deltaPrice `value is "10". Between options, a price for a medium may be $10 and a large $12 giving a `deltaPrice `value of "2".

Refer to Product Variant Pricing and Weight in the Products guides topic for more information.

productExtra.productExtraValue.quantity

type: int

The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations.

productExtra.productExtraValue.value

type: object

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

fulfillmentTypesSupported

type: list of string

List of supported types of fulfillment for the product or variation. The types include direct ship, in-store pickup, or both.

hasConfigurableOptions

type: bool

If true, the product has configurable options. This option means that a product is not purchasable until the shopper selects options that resolve into a product variation. Configurable options for a product are the choices a shopper makes when ordering a product. Size and color are configurable options. System-supplied and read-only.

hasStandAloneOptions

type: bool

If true, this product has standalone options that a shopper can select without configuring a defined product variations. System-supplied and read only.

inventoryInfo

type: productInventoryInfo

Properties and data of inventory information for configured and bundled products. If product stock is managed, the data specifies out of stock behavior.

productInventoryInfo.manageStock

type: bool

Indicates is the item's stock is managed. If true, Kibo eCommerce manages inventory levels for this product.

productInventoryInfo.outOfStockBehavior

type: string

Determines the method this product uses when active stock is depeleted. Options include "DisplayMessage" to display an out of stock message to the shopper, "HideProduct" to disable the product on the storefront, or "AllowBackOrder" to allow the shopper to back order the product. This property is required only if Kibo eCommerce manages inventory for this product.

isPackagedStandAlone

type: bool

Indicates if the product must be shipped alone in a container. This is used for products and products within a bundle. If true, this product cannot be shipped in a package with other items and must ship in a package by itself.

isRecurring

type: bool

Indicates if the product in a cart, order, or wish list is purchased on a recurring schedule. If true, the item can be purchased or fulfilled at regular intervals, such as a monthly billing cycle. For example, digital or physical product subscriptions are recurring cart items. This property is not used at this time and is reserved for future functionality.

isTaxable

type: bool

Indicates if the item is subject to taxation, used by products, options, extras, cart and order items, line items, and wish lists. If true, the entity is subject to tax based on the relevant tax rate and rules.

isValidForProductType

type: bool

If true, this product is valid for the assigned product type.

isVariation

type: bool

If true, this configured product represents a product variation defined with configurable options. System-supplied and read only.

masterCatalogId

type: int

Unique identifier for the master catalog.

options

type: list of productOption

List of option attributes configured for an object. These values are associated and used by products, product bundles, and product types.

productOption.attributeFQN

type: string

The fully qualified name of the attribute. The attributeDefiniteId may be used to generate this name.

productOption.values

type: list of productOptionValue

List of value data for objects.

productOption.productOptionValue.attributeVocabularyValueDetail

type: attributeVocabularyValue

Properties of an individual vocabulary value for an attribute. For example, a "color" attribute might have the following vocabulary values: Red, Blue, Green.

productOption.productOptionValue.attributeVocabularyValue.content

type: attributeVocabularyValueLocalizedContent

Localizable content (such as a name and/or description) for an attribute. The content may be localized when displayed according to the locale code specified by the master catalog. Content can include descriptive text for product extensible attributes, catalog-level descriptions (displayed if isContentOverriden is true), product bundles, and customer account notes.

productOption.productOptionValue.attributeVocabularyValue.attributeVocabularyValueLocalizedContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

productOption.productOptionValue.attributeVocabularyValue.attributeVocabularyValueLocalizedContent.stringValue

type: string

If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options.

productOption.productOptionValue.attributeVocabularyValue.displayOrder

type: int

The order in which the attribute value displays. If you omit a value for this property, Kibo eCommerce infers the display order from the attribute value's position the list.

productOption.productOptionValue.attributeVocabularyValue.localizedContent

type: list of attributeVocabularyValueLocalizedContent

The localized content associated with the object.

productOption.productOptionValue.attributeVocabularyValue.attributeVocabularyValueLocalizedContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

productOption.productOptionValue.attributeVocabularyValue.attributeVocabularyValueLocalizedContent.stringValue

type: string

If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options.

productOption.productOptionValue.attributeVocabularyValue.productName

type: string

The name of the product that represents a line item in a taxable order or product bundle.

productOption.productOptionValue.attributeVocabularyValue.value

type: object

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

productOption.productOptionValue.attributeVocabularyValue.valueSequence

type: int

The number that denotes the order of the entity value within a list of entity values.

productOption.productOptionValue.value

type: object

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

packageHeight

type: measurement

Height of a package or bundle package in imperial units of feet and inches.

measurement.unit

type: string

The unit of measurement, such as length or weight.

measurement.value

type: decimal

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

packageLength

type: measurement

Length of a package or bundle package in imperial units of feet and inches.

measurement.unit

type: string

The unit of measurement, such as length or weight.

measurement.value

type: decimal

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

packageWeight

type: measurement

Weight of a package or bundle package in imperial units of pounds and ounces.

measurement.unit

type: string

The unit of measurement, such as length or weight.

measurement.value

type: decimal

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

packageWidth

type: measurement

Width of a package or bundle package in imperial units of feet and inches.

measurement.unit

type: string

The unit of measurement, such as length or weight.

measurement.value

type: decimal

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

price

type: productPrice

The price of either the product or shipping.

This amount can be affected by discounts and/or fees. For products, this amount can also be affected by price lists.

productPrice.creditValue

type: decimal

The credit value of the product or bundled product. When the `goodsType `is `DigitalCredit`, this value is populated to indicate the value of the credit. This is used to create store credit in the fulfillment of gift cards.

productPrice.isoCurrencyCode

type: string

The three character ISO currency code for the monetary amount. For example, USD is used for US Dollars.

productPrice.map

type: decimal

The minimum advertised price a client can charge for the associated product, as determined by the supplier. Client administrators can override the minimum advertised price at the catalog level.

productPrice.mapEndDate

type: DateTime

If the product has a supplier-defined minimum advertised price, the date and time after which the client can sell the product for less than the minimum advertised price.

productPrice.mapStartDate

type: DateTime

If the product has a supplier-defined minimum advertised price, the date and time after which the client cannot sell the product for less than the minimum advertised price.

productPrice.msrp

type: decimal

The manufacturer's suggested retail price (MSRP) for the product. This content may be defined by the supplier.

productPrice.price

type: decimal

The price of either the product or shipping.

This amount can be affected by discounts and/or fees. For products, this amount can also be affected by price lists.

productPrice.salePrice

type: decimal

The set sale price for a product consisting of a price with a discount already applied.

For price list entries, this property is the product's sale price if the priceListEntryPrice.salePriceMode is set to Overridden.

pricingBehavior

type: productPricingBehaviorInfo

Properties that describe the behavior the system uses when determining the price of products.

productPricingBehaviorInfo.discountsRestricted

type: bool

Indicates if the discount is restricted. If true, the system cannot apply any discounts to this product. Discount restrictions are defined at the master catalog level. Client administrators cannot override discount restrictions at the catalog level, but they can limit the restriction to a defined time interval.

For price list entries, specifies whether discounts are restricted for the specific entry if discountRestrictedMode is set to Overridden.

Refer to Discount Restriction in the Price Lists guides topic for more information.

productPricingBehaviorInfo.discountsRestrictedEndDate

type: DateTime

The date and time on which the discount restriction period ends.

productPricingBehaviorInfo.discountsRestrictedStartDate

type: DateTime

The date and time on which the discount restriction period starts.

productPricingBehaviorInfo.variationPricingMethod

type: string

Specifies the pricing method for variations associated with the product.

This property has the following valid values:

  • Delta
  • Fixed

productCode

type: string

The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product.

productInCatalogs

type: list of productInCatalogInfo

Properties defined for a product as they appear in its associated catalogs.

productInCatalogInfo.activeDateRange

type: activeDateRange

Specifies a start date and end date for when associated object is on the live site, if isActive is set to True.

If isActive is set to False Kibo eCommerce ignores this property.

productInCatalogInfo.activeDateRange.endDate

type: DateTime

The date that the product is no longer active on the site.

productInCatalogInfo.activeDateRange.startDate

type: DateTime

The date that the product starts being active on the site.

productInCatalogInfo.auditInfo

type: auditInfo

Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data.

productInCatalogInfo.auditInfo.createBy

type: string

Identifier of the user that created the object. System created and read only.

productInCatalogInfo.auditInfo.createDate

type: DateTime

The date and time in UTC format set when the object was created.

productInCatalogInfo.auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

productInCatalogInfo.auditInfo.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

productInCatalogInfo.catalogId

type: int

The unique identifier for the product catalog. Catalogs are part of a master catalog.

productInCatalogInfo.content

type: productLocalizedContent

Localizable content (such as a name and/or description) for an attribute. The content may be localized when displayed according to the locale code specified by the master catalog. Content can include descriptive text for product extensible attributes, catalog-level descriptions (displayed if isContentOverriden is true), product bundles, and customer account notes.

productInCatalogInfo.productLocalizedContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

productInCatalogInfo.productLocalizedContent.productFullDescription

type: string

Lengthy full description for a product description, displayed on product detail pages within the storefront.

productInCatalogInfo.productLocalizedContent.productImages

type: list of productLocalizedImage

List of image files associated with a product. This content may include the image file URL, name, and other information as available.

productInCatalogInfo.productLocalizedContent.productLocalizedImage.altText

type: string

Descriptive text associated with the image or video that appears on the web storefront. This text displays on a hover-over in the browser, providing further information on the content displayed. The alternate text should be plain alphanumeric text without special characters or HTML coding.

productInCatalogInfo.productLocalizedContent.productLocalizedImage.cmsId

type: string

The identifier of the image in the Kibo eCommerce CMS. Supply a value for either the CMS ID or Image URL parameter.

productInCatalogInfo.productLocalizedContent.productLocalizedImage.id

type: int

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

productInCatalogInfo.productLocalizedContent.productLocalizedImage.imageLabel

type: string

The localized title for an image that displays on the storefront. If localized, the displayed content is set per the locale code for the site.

productInCatalogInfo.productLocalizedContent.productLocalizedImage.imageUrl

type: string

The URL link for the image file associated with a product or category.

productInCatalogInfo.productLocalizedContent.productLocalizedImage.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

productInCatalogInfo.productLocalizedContent.productLocalizedImage.mediaType

type: string

Type of media specification required to successfully render the image, video, or other media content for products and categories.

productInCatalogInfo.productLocalizedContent.productLocalizedImage.sequence

type: int

The numeric order of objects, used by a vocabulary value defined for an extensible attribute, images, and categories.

productInCatalogInfo.productLocalizedContent.productLocalizedImage.videoUrl

type: string

The URL of a video files for a product or category. The path name is set in the language specified by the LocaleCode.

productInCatalogInfo.productLocalizedContent.productName

type: string

The name of the product that represents a line item in a taxable order or product bundle.

productInCatalogInfo.productLocalizedContent.productShortDescription

type: string

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

productInCatalogInfo.dateFirstAvailableInCatalog

type: DateTime

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

productInCatalogInfo.isActive

type: bool

Indicates if the object or feature is active.

productInCatalogInfo.isContentOverridden

type: bool

If true, the content defined for this product in the master catalog in overridden in the catalog with the content specified in the request body. If false, this catalog uses the content defined in the master catalog for the product.

productInCatalogInfo.isPriceOverridden

type: bool

If true, the price defined for this product in the master catalog in overridden in the catalog with the price specified in the request body. If false, this catalog uses the price defined in the master catalog for the product.

productInCatalogInfo.isseoContentOverridden

type: bool

If true, the SEO content defined for this product in the master catalog in overridden in the catalog with the SEO content specified in the request body. If false, this catalog uses the SEO content defined in the master catalog for the product.

productInCatalogInfo.price

type: productPrice

The price of either the product or shipping.

This amount can be affected by discounts and/or fees. For products, this amount can also be affected by price lists.

productInCatalogInfo.productPrice.creditValue

type: decimal

The credit value of the product or bundled product. When the `goodsType `is `DigitalCredit`, this value is populated to indicate the value of the credit. This is used to create store credit in the fulfillment of gift cards.

productInCatalogInfo.productPrice.isoCurrencyCode

type: string

The three character ISO currency code for the monetary amount. For example, USD is used for US Dollars.

productInCatalogInfo.productPrice.map

type: decimal

The minimum advertised price a client can charge for the associated product, as determined by the supplier. Client administrators can override the minimum advertised price at the catalog level.

productInCatalogInfo.productPrice.mapEndDate

type: DateTime

If the product has a supplier-defined minimum advertised price, the date and time after which the client can sell the product for less than the minimum advertised price.

productInCatalogInfo.productPrice.mapStartDate

type: DateTime

If the product has a supplier-defined minimum advertised price, the date and time after which the client cannot sell the product for less than the minimum advertised price.

productInCatalogInfo.productPrice.msrp

type: decimal

The manufacturer's suggested retail price (MSRP) for the product. This content may be defined by the supplier.

productInCatalogInfo.productPrice.price

type: decimal

The price of either the product or shipping.

This amount can be affected by discounts and/or fees. For products, this amount can also be affected by price lists.

productInCatalogInfo.productPrice.salePrice

type: decimal

The set sale price for a product consisting of a price with a discount already applied.

For price list entries, this property is the product's sale price if the priceListEntryPrice.salePriceMode is set to Overridden.

productInCatalogInfo.primaryProductCategory

type: productCategory

Specifies which static category to use in the navigation breadcrumb, regardless of how shoppers navigate to the product. If not set, or if the product belongs only to dynamic categories, the default is to use the category with the smallest ID.

productInCatalogInfo.productCategory.categoryId

type: int

ID of the relevant category.

productInCatalogInfo.productCategories

type: list of productCategory

The product categories to define for the product associated with the specified catalog.

productInCatalogInfo.productCategory.categoryId

type: int

ID of the relevant category.

productInCatalogInfo.seoContent

type: productLocalizedSEOContent

The search engine optimized content defined for products or products associated with a catalog. If no SEO content is specified in the request for products associated with a catalog, this catalog uses the SEO content defined in the master catalog. To override the SEO content for this catalog, the `IsSEOContentOverridden `flag must be set to "true".

productInCatalogInfo.productLocalizedSEOContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

productInCatalogInfo.productLocalizedSEOContent.metaTagDescription

type: string

Description defined for metadata, used to interally manage data, in the language specified by the `localeCode`. This content is used by categories, products, localized content, and SEO content.

productInCatalogInfo.productLocalizedSEOContent.metaTagKeywords

type: string

Keywords defined for metadata, used to internally manage data, in the language specified by the `localeCode`. Keywords are used by content for categories, products, localized content, and SEO content.

productInCatalogInfo.productLocalizedSEOContent.metaTagTitle

type: string

Title defined for metadata, used to internally manage data, in the language specified by the `localeCode`. Titles are used by content for categories, products, localized content, and SEO content.

productInCatalogInfo.productLocalizedSEOContent.seoFriendlyUrl

type: string

The search engine optimized, human-readable portion of the URL. The content is localized according to the product's `localeCode`.

productInCatalogInfo.productLocalizedSEOContent.titleTagTitle

type: string

Customizes the HTML title tag within the header section of the product details page for the specified product.

productSequence

type: int

Integer that represents the sequential order of the product.

productTypeId

type: int

Unique identifier of the product type assigned for this product. Tenant administrators can only define one product type per product.

productUsage

type: string

The usage type that applies to this product, which is Standard (a single product without configurable options), Configurable (a product that includes configurable option attributes), Bundle (a collection of products sold as a single entity), or Component (an invididual product that represents a component in a bundle).

properties

type: list of productProperty

Collection of property attributes defined for the object. Properties are associated to all objects within Kibo eCommerce, including documents, products, and product types.

productProperty.attributeFQN

type: string

The fully qualified name of the attribute. The attributeDefiniteId may be used to generate this name.

productProperty.values

type: list of productPropertyValue

List of value data for objects.

productProperty.productPropertyValue.attributeVocabularyValueDetail

type: attributeVocabularyValue

Properties of an individual vocabulary value for an attribute. For example, a "color" attribute might have the following vocabulary values: Red, Blue, Green.

productProperty.productPropertyValue.attributeVocabularyValue.content

type: attributeVocabularyValueLocalizedContent

Localizable content (such as a name and/or description) for an attribute. The content may be localized when displayed according to the locale code specified by the master catalog. Content can include descriptive text for product extensible attributes, catalog-level descriptions (displayed if isContentOverriden is true), product bundles, and customer account notes.

productProperty.productPropertyValue.attributeVocabularyValue.attributeVocabularyValueLocalizedContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

productProperty.productPropertyValue.attributeVocabularyValue.attributeVocabularyValueLocalizedContent.stringValue

type: string

If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options.

productProperty.productPropertyValue.attributeVocabularyValue.displayOrder

type: int

The order in which the attribute value displays. If you omit a value for this property, Kibo eCommerce infers the display order from the attribute value's position the list.

productProperty.productPropertyValue.attributeVocabularyValue.localizedContent

type: list of attributeVocabularyValueLocalizedContent

The localized content associated with the object.

productProperty.productPropertyValue.attributeVocabularyValue.attributeVocabularyValueLocalizedContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

productProperty.productPropertyValue.attributeVocabularyValue.attributeVocabularyValueLocalizedContent.stringValue

type: string

If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options.

productProperty.productPropertyValue.attributeVocabularyValue.productName

type: string

The name of the product that represents a line item in a taxable order or product bundle.

productProperty.productPropertyValue.attributeVocabularyValue.value

type: object

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

productProperty.productPropertyValue.attributeVocabularyValue.valueSequence

type: int

The number that denotes the order of the entity value within a list of entity values.

productProperty.productPropertyValue.content

type: productPropertyValueLocalizedContent

Localizable content (such as a name and/or description) for an attribute. The content may be localized when displayed according to the locale code specified by the master catalog. Content can include descriptive text for product extensible attributes, catalog-level descriptions (displayed if isContentOverriden is true), product bundles, and customer account notes.

productProperty.productPropertyValue.productPropertyValueLocalizedContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

productProperty.productPropertyValue.productPropertyValueLocalizedContent.stringValue

type: string

If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options.

productProperty.productPropertyValue.localizedContent

type: list of productPropertyValueLocalizedContent

The localized content associated with the object.

productProperty.productPropertyValue.productPropertyValueLocalizedContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

productProperty.productPropertyValue.productPropertyValueLocalizedContent.stringValue

type: string

If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options.

productProperty.productPropertyValue.value

type: object

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

publishingInfo

type: productPublishingInfo

Properties of the product publishing settings for the associated product.

productPublishingInfo.lastPublishedBy

type: string

The user ID of the user who last published changes for this product in the catalog.

productPublishingInfo.lastPublishedDate

type: DateTime

The date and time a draft change for this product was published to the catalog.

productPublishingInfo.publishedState

type: string

The current publishing state of this product in the catalog, which is Live, New, or Draft. Live products appear on the storefront and have no pending changes. New products have been created but do not yet appear on the storefront. Draft products appear on the storefront but have pending changes that have not yet been published.

productPublishingInfo.publishSetCode

type: string

The unique identifier of the publish set the pending product draft is assigned to. This field is not valid if the product is live.

seoContent

type: productLocalizedSEOContent

The search engine optimized content defined for products or products associated with a catalog. If no SEO content is specified in the request for products associated with a catalog, this catalog uses the SEO content defined in the master catalog. To override the SEO content for this catalog, the `IsSEOContentOverridden `flag must be set to "true".

productLocalizedSEOContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

productLocalizedSEOContent.metaTagDescription

type: string

Description defined for metadata, used to interally manage data, in the language specified by the `localeCode`. This content is used by categories, products, localized content, and SEO content.

productLocalizedSEOContent.metaTagKeywords

type: string

Keywords defined for metadata, used to internally manage data, in the language specified by the `localeCode`. Keywords are used by content for categories, products, localized content, and SEO content.

productLocalizedSEOContent.metaTagTitle

type: string

Title defined for metadata, used to internally manage data, in the language specified by the `localeCode`. Titles are used by content for categories, products, localized content, and SEO content.

productLocalizedSEOContent.seoFriendlyUrl

type: string

The search engine optimized, human-readable portion of the URL. The content is localized according to the product's `localeCode`.

productLocalizedSEOContent.titleTagTitle

type: string

Customizes the HTML title tag within the header section of the product details page for the specified product.

shippingClassId

type: int

Identifier of the shipping class.

standAlonePackageType

type: string

If the product must be packaged separately, the type of standalone package to use.

supplierInfo

type: productSupplierInfo

Supplier-defined properties assigned for the product.

productSupplierInfo.cost

type: productCost

The cost of the product to the retailer, as specified through API or using the Cost field of the Product editor in Admin. This is not the price that the shopper sees on the storefront (which is usually higher).

For price lists entries, this property specifies the cost of the product if costMode is set to Overridden.

productSupplierInfo.productCost.cost

type: decimal

The cost of the product to the retailer, as specified through API or using the Cost field of the Product editor in Admin. This is not the price that the shopper sees on the storefront (which is usually higher).

For price lists entries, this property specifies the cost of the product if costMode is set to Overridden.

productSupplierInfo.productCost.isoCurrencyCode

type: string

The three character ISO currency code for the monetary amount. For example, USD is used for US Dollars.

productSupplierInfo.distPartNumber

type: string

The distributor part number associated with this product, defined by the product distributor.

productSupplierInfo.mfgPartNumber

type: string

The manufacturer's part number for the product.

upc

type: string

The universal product code (UPC) is the barcode defined for the product. The UPC is unique across all sales channels.

variationKey

type: string

System-generated key that represents the attribute values that uniquely identify a specific product variation.

variationOptions

type: list of productVariationOption

The list of product variation configurations defined for this product based on its available product option attributes.

productVariationOption.attributeFQN

type: string

The fully qualified name of the attribute. The attributeDefiniteId may be used to generate this name.

productVariationOption.content

type: attributeVocabularyValueLocalizedContent

Localizable content (such as a name and/or description) for an attribute. The content may be localized when displayed according to the locale code specified by the master catalog. Content can include descriptive text for product extensible attributes, catalog-level descriptions (displayed if isContentOverriden is true), product bundles, and customer account notes.

productVariationOption.attributeVocabularyValueLocalizedContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

productVariationOption.attributeVocabularyValueLocalizedContent.stringValue

type: string

If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options.

productVariationOption.value

type: object

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

Operations

Operation Name Request URI Description
AddProduct POST %3fresponseFields%3d%7bresponseFields%7d

Creates a new product definition in the specified master catalog.

AddProductInCatalog POST %7bproductCode%7d%2fProductInCatalogs%3fresponseFields%3d%7bresponseFields%7d

Associates a new product defined in the master catalog with a specific catalog.

DeleteProduct DELETE %7bproductCode%7d

Deletes the specified product from a master catalog.

DeleteProductInCatalog DELETE %7bproductCode%7d%2fProductInCatalogs%2f%7bcatalogId%7d

Removes the product association defined for a specific catalog.

GetProduct GET %7bproductCode%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of a product definition.

GetProductInCatalog GET %7bproductCode%7d%2fProductInCatalogs%2f%7bcatalogId%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of a product associated with a specific catalog.

GetProductInCatalogs GET %7bproductCode%7d%2fProductInCatalogs

Retrieves a product that is associated with one or more specific catalogs.

GetProducts GET %3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26q%3d%7bq%7d%26qLimit%3d%7bqLimit%7d%26noCount%3d%7bnoCount%7d%26responseFields%3d%7bresponseFields%7d

Retrieves a list of products according to any specified facets, filter criteria, and sort options.

RenameProductCodes POST Actions%2fRenameProductCodes

Performs an update to a product code by renaming or replacing the current product code with a new one.

UpdateProduct PUT %7bproductCode%7d%3fresponseFields%3d%7bresponseFields%7d

Updates one or more properties of a product definition in a master catalog.

UpdateProductInCatalog PUT %7bproductCode%7d%2fProductInCatalogs%2f%7bcatalogId%7d%3fresponseFields%3d%7bresponseFields%7d

Updates one or more properties of a product associated with a specific catalog.

UpdateProductInCatalogs PUT %7bproductCode%7d%2fProductInCatalogs

Updates the properties of a product specific to each catalog associated with the product.