productDetails

Gets pricing and product details for a specific product in a webstore. Use this wire adapter in Order Management repricing scenarios.

productDetails uses this Commerce API resource.

  • webstoreId—(Required) The ID of the webstore. The ID prefix is 0ZE.
  • skuOrProductId—(Required) The SKU or product ID to look up.
  • version—(Required) The API version for the adapter, for example, v62.0. Without this parameter, the wire doesn’t fire.
  • effectiveAccountId—(Optional) The effective account ID for buyer-specific pricing and entitlements.
  • currencyCode—(Optional) The ISO currency code for pricing, for example, USD.
  • locale—(Optional) The locale for localized product content, for example, en-US.
  • excludeAttributeSetInfo—(Optional) Set to true to exclude attribute set information from the response. Available in API version 44.0 and later.
  • excludeMedia—(Optional) Set to true to exclude media from the response. Available in API version 44.0 and later.
  • excludeQuantityRule—(Optional) Set to true to exclude the purchase quantity rule from the response. Available in API version 44.0 and later.
  • excludeVariationInfo—(Optional) Set to true to exclude variation information from the response. Available in API version 44.0 and later.
  • excludePrices—(Optional) Set to true to exclude prices from the response. Available in API version 44.0 and later.
  • excludeBundleChildrenInfo—(Optional) Set to true to exclude bundle children information from the response. Available in API version 56.0 and later.
  • data—A ProductDetailsOutputRepresentation object with these fields:
    • productId—The product ID.
    • stockKeepingUnit—The SKU.
    • name—The product name.
    • description—The product description.
    • productClass—The product class. Valid values: Bundle, Simple, Variation, VariationParent, Set.
    • totalChildrenCount—The number of children for a bundle product.
    • fields—A map of requested product fields.
    • variants—A list of product variants.
    • imageGroups—A list of product media image groups.
    • unitPrice—The unit price.
    • listPrice—The list price.
    • attributes—A list of variation attributes.
    • currencyIsoCode—The ISO currency code.
    • productQuantityRule—The purchase quantity rule.
    • childItems—A list of bundle child items.
    • success—Indicates whether the request was successful.
    • errors—A list of errors, if any. Each error has errorCode, message, and errorEntityId fields.
  • error—FetchResponse

If the wire adapter encounters an error, data is undefined and error contains the error details.

See Also