Products

GET Get product information.

GET /organizations/{organizationId}/products/{productId}

Operation ID: getProduct. Security: AmOAuth2 (sfcc.products, sfcc.products.rw).

Retrieve detailed information about a specific product.

Parameters

• productId (path, ProductId, required)
• organizationId (path, OrganizationId, required) An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character realm identifier and a 3-character instance type identifier.

  Example

  f_ecom_zzxy_prd

• siteId (query, SiteId) The site context.

Responses

• 200 Retrieved product information successfully.

  Media type: application/json. Schema: Product.

  Example: DataProductExpand

  {
    "assignedCategories": [
      {
        "catalogId": "apparel-catalog",
        "categoryId": "mens-accessories"
      },
      {
        "catalogId": "storefront-catalog-en",
        "categoryId": "top-seller"
      },
      {
        "catalogId": "storefront-catalog-en",
        "categoryId": "electronics-gaming"
      }
    ],
    "brand": "Apple",
    "classificationCategory": {
      "catalogId": "storefront-catalog-en",
      "categoryId": "top-seller"
    },
    "creationDate": "2019-02-21T22:10:02.000Z",
    "id": "apple-ipod-classic",
    "image": {
      "absUrl": "https://example.com/images/large/ipod-classic-silver.jpg",
      "alt": {
        "default": "Apple iPod Classic, , large"
      },
      "path": "large/ipod-classic-silver.jpg",
      "title": {
        "default": "Apple iPod Classic, "
      }
    },
    "imageGroups": [
      {
        "images": [
          {
            "absUrl": "https://example.com/images/large/ipod-classic-silver.jpg",
            "alt": {
              "default": "Apple iPod Classic, , large"
            },
            "path": "large/ipod-classic-silver.jpg",
            "title": {
              "default": "Apple iPod Classic, "
            }
          }
        ],
        "viewType": "large"
      },
      {
        "images": [
          {
            "absUrl": "https://example.com/images/medium/ipod-classic-silver.jpg",
            "alt": {
              "default": "Apple iPod Classic, , medium"
            },
            "path": "medium/ipod-classic-silver.jpg",
            "title": {
              "default": "Apple iPod Classic, "
            }
          }
        ],
        "viewType": "medium"
      },
      {
        "images": [
          {
            "absUrl": "https://example.com/images/small/ipod-classic-silver.jpg",
            "alt": {
              "default": "Apple iPod Classic, , small"
            },
            "path": "small/ipod-classic-silver.jpg",
            "title": {
              "default": "Apple iPod Classic, "
            }
          }
        ],
        "viewType": "small"
      }
    ],
    "lastModified": "2019-08-28T18:49:09.000Z",
    "localizedTaxClassId": {
      "de": "exempt",
      "default": "standard",
      "en-US": "exempt"
    },
    "longDescription": {
      "default": {
        "markup": "Supports MP3, MP3 VBR, AAC, Protected AAC, Audible 2, 3 and 4, Apple Lossless and AIFF audio formats; also supports JPEG, BMP, GIF, TIFF, PSD (Mac only) and PNG image formats and H.264 (high-definition), MPEG-4 and MPEG-4 video formats",
        "source": "Supports MP3, MP3 VBR, AAC, Protected AAC, Audible 2, 3 and 4, Apple Lossless and AIFF audio formats; also supports JPEG, BMP, GIF, TIFF, PSD (Mac only) and PNG image formats and H.264 (high-definition), MPEG-4 and MPEG-4 video formats"
      }
    },
    "name": {
      "default": "Apple iPod Classic"
    },
    "onlineFlag": {
      "default": true
    },
    "owningCatalogId": "electronics-catalog",
    "owningCatalogName": {
      "default": "Electronics Master Catalog"
    },
    "pageDescription": {
      "default": "This iPod delivers everything you love about iPod with added features all wrapped in a tiny 4.9 oz. package. With 120GB of storage and up to 36 hours music playback, iPod classic lets you enjoy up to 30,000 songs or 150 hours of video — or a combination — wherever you go."
    },
    "pageKeywords": {
      "default": "Apple, iPod, iPod Classic, MP3, Music Player"
    },
    "pageTitle": {
      "default": "Apple iPod Nano"
    },
    "primaryCategories": [
      {
        "catalogId": "apparel-catalog",
        "categoryId": "mens-accessories"
      },
      {
        "catalogId": "storefront-catalog-en",
        "categoryId": "top-seller"
      }
    ],
    "primaryCategoryId": "top-seller",
    "searchable": {
      "default": true
    },
    "shortDescription": {
      "default": {
        "markup": "This iPod delivers everything you love about iPod with added features all wrapped in a tiny 4.9 oz. package. With 120GB of storage and up to 36 hours music playback, iPod classic lets you enjoy up to 30,000 songs or 150 hours of video — or a combination — wherever you go.",
        "source": "This iPod delivers everything you love about iPod with added features all wrapped in a tiny 4.9 oz. package. With 120GB of storage and up to 36 hours music playback, iPod classic lets you enjoy up to 30,000 songs or 150 hours of video — or a combination — wherever you go."
      }
    },
    "taxClassId": "standard",
    "type": {
      "master": true
    },
    "validFrom": {
      "default": "1998-05-03T00:00:00.000Z",
      "default@SiteGenesis": "1998-05-11T00:00:00.000Z"
    },
    "validTo": {
      "default": "2028-07-03T00:00:00.000Z",
      "default@SiteGenesis": "2028-05-30T00:03:00.000Z"
    },
    "variants": [
      {
        "productId": "apple-ipod-classic-silver-120g",
        "variationValues": {
          "color": "Silver",
          "memorySize": "120 GB"
        }
      },
      {
        "productId": "apple-ipod-classic-black-120g",
        "variationValues": {
          "color": "Black",
          "memorySize": "120 GB"
        }
      }
    ],
    "variationAttributes": [
      {
        "attributeDefinitionId": "color",
        "attributeDefinitionName": {
          "default": "Color"
        },
        "id": "color",
        "name": {
          "default": "Color"
        },
        "shared": true,
        "slicing": false,
        "values": [
          {
            "name": {
              "default": "Silver"
            },
            "position": 1,
            "value": "Silver"
          },
          {
            "name": {
              "default": "Black"
            },
            "position": 2,
            "value": "Black"
          },
          {
            "name": {
              "default": "Purple"
            },
            "position": 3,
            "value": "Purple"
          },
          {
            "name": {
              "default": "Blue"
            },
            "position": 4,
            "value": "Blue"
          },
          {
            "name": {
              "default": "Green"
            },
            "position": 5,
            "value": "Green"
          },
          {
            "name": {
              "default": "Yellow"
            },
            "position": 6,
            "value": "Yellow"
          },
          {
            "name": {
              "default": "Orange"
            },
            "position": 7,
            "value": "Orange"
          },
          {
            "name": {
              "default": "Red"
            },
            "position": 8,
            "value": "Red"
          },
          {
            "name": {
              "default": "Fuscia"
            },
            "position": 9,
            "value": "Fuscia"
          }
        ],
        "variationAttributeType": "string"
      },
      {
        "attributeDefinitionId": "memorySize",
        "attributeDefinitionName": {
          "default": "Memory Size"
        },
        "id": "memorySize",
        "name": {
          "default": "Memory Size"
        },
        "shared": true,
        "slicing": false,
        "values": [
          {
            "name": {
              "default": "1 GB"
            },
            "position": 1,
            "value": "1 GB"
          },
          {
            "name": {
              "default": "2 GB"
            },
            "position": 2,
            "value": "2 GB"
          },
          {
            "name": {
              "default": "8 GB"
            },
            "position": 3,
            "value": "8 GB"
          },
          {
            "name": {
              "default": "16 GB"
            },
            "position": 4,
            "value": "16 GB"
          },
          {
            "name": {
              "default": "32 GB"
            },
            "position": 5,
            "value": "32 GB"
          },
          {
            "name": {
              "default": "120 GB"
            },
            "position": 6,
            "value": "120 GB"
          }
        ],
        "variationAttributeType": "string"
      }
    ]
  }

• 400 Bad Request. Thrown when a specified expand parameter value is unknown.

  Media type: application/problem+json. Schema: ErrorResponse.

  Example: getProduct400

  {
    "title": "Unqueryable Field",
    "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/unqueryable-field",
    "detail": "The field 'link' can't be queried.",
    "field": "link"
  }

• 401 Unauthorized. Your Client ID is invalid, or you are not allowed to access the content provided by the requested URL.

  Media type: application/problem+json. Schema: ErrorResponse.

  Example: getProduct401

  {
    "title": "Invalid Access Token",
    "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/invalid-access-token",
    "detail": "The request is unauthorized, the access token is invalid.",
    "accessToken": "hbGciOiJIUzI1NiIsInR5cCI6Ikp"
  }

• 404 Resource requested not found.

  Media type: application/problem+json. Schema: ErrorResponse.

  Example: getProduct404

  {
    "title": "Product Not Found",
    "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/product-not-found",
    "detail": "No product with ID '1585183329877' could be found.",
    "productId": "1585183329877"
  }