Using product details
Understand how to use the productDetails object
Last updated
Understand how to use the productDetails object
Last updated
A productDetails object contains .
If you decide to use productDetails, you'll need to retrieve product data from your system at checkout-time and then use it to define the object. Since you don't persist productDetails in Digital River's system, this object reduces your catalog management requirements.
If your integration currently uses SKUs and you're considering a migration, you should know the .
You'll most commonly use productDetails in and requests to send Digital River the following :
The id in productDetails should represent the unique identifier of the product in your system.
In productDetails, you can define a parameter representing a hierarchical classification system that organizes and categorizes your products based on their attributes, characteristics, and relationships.
The parameter's name depends on the resource you're creating:
itemBreadcrumb
categories
You'll typically structure itemBreadcrumb / categories by defining a broad top-level category and getting more specific at each subsequent level as you move down the hierarchy.
You might have built similar data structures that inventory your products and make it easier for customers to find what they want. In that case, we recommend using this same data.
For example, Clothing > Women’s Jeans is an acceptable value but Clothing > Women’s Clothing > Jeans > Bootcut Jeans will likely result in more accurate classifications. You can provide multiple hierarchies; just make sure to separate each with a ; (semi-colon).
Although not technically required, it's highly recommended that you define itemBreadcrumb in English. The classification service will disregard this data point if its value is in a different language.
For productDetails, the name should represent the product's brand name and description should provide more details about the product.
A name is required but description is optional. If you assign a string to description, then we recommend limiting its length to 1000 characters or less.
For productDetails, you can use:
image to specify the URL of a resource that contains the product's image. It should be similar to the image(s) you display to customers while they review your store's products.
url to specify the address of a resource that contains the product's description.
If you provide a weight but not a weightUnit, then the value defaults to oz.
A productDetails can contain a partNumber. It represents a unique manufacturer part number (MPN) issued by manufacturers to identify a part or product.
MPNs are meant to be static identifiers of a part/product, universal to all distributors, wholesalers, and resellers. They allow customers to accurately identify exact parts and protect themselves from counterfeits.
If two parts or products originate from two different manufacturers, each must have its own MPN. Due to the numerous parts in these complex products, these identifiers are especially relevant for automotive and consumer electronics.
In productDetails, a skuGroupId identifies the that the product belongs to. You're required to provide this identifier because Digital River uses it to access this .
For details, refer to .
throws the following errors if you send productDetails that doesn't contain a skuGroupId:
The countryOfOrigin is a two-letter as described in the international standard. This attribute represents the country where a product was manufactured.
requests throws the following errors if you send productDetails, and it doesn't contain countryOfOrigin:
requests throws the following errors if you send productDetails, and it contains an invalid countryOfOrigin:
If you're engaging the , then all of your must have an itemBreadcrumb / categories.
Even if you're not currently making sales, it's best practice to define this parameter so that, in the event you do start selling internationally, you're better positioned to get started.
We recommend making your taxonomies as detailed as possible. This will increase the probability that the returned by the service are accurate.
In , name is displayed in the order summary section.
If your integration gives customers the option to use then productDetails must contain an image and url.
In , each items[].productDetails.image in a is displayed in the order summary section.
For , productDetails can be used to send a weight denoted by weightUnit. The enumerated weightUnit values are oz, lb, g, and kg.
If your site intends to sell physical products , then we recommend that you pass the weight and weightUnit of all of your catalog's .
In some countries, like Switzerland, customs officials use a product's weight when calculating import duties. Without this data, Digital River is unable to calculate .
If you send a or request whose shipTo.address.country represents one of these nations, and any productDetails in the checkout's are missing weight, then the following error is thrown:
The attributes in and are nearly identical. The key exceptions are taxCode, eccn, and hsCode, which exist in SKUs but not in productDetails.
However, since these attributes hold , they're contained in the referenced .
For details, refer to .
SKUs also have a and this attribute is not in productDetails.
In , manufacturerId is used to set up products in warehouses. But since that process is handled before deployment, sending the manufacturerId at checkout-time is unecessary.