Get product 📘

GET /products/{segment_key}/{product_id}
Api key

Get all information about a product:

  • descriptions in multiple languages - name / long description / short description
  • picture URLs - main picture + additional pictures
  • documents in multiple languages - technical sheet, manuals, CE certificates...
  • property values - as defined by segment data model
  • variants - child products which are variants of the parent product
  • SKUs - logistic references for products
  • relations with other products - symmetrical and asymmetrical, and potentially from other segments

Path parameters

  • segment_key string Required

    The segment key, as returned by list segments endpoint.

    Values are hand-protection, foot-protection, head-protection, eye-protection, body-protection, ear-protection, fall-protection, respiratory-protection, ergonomy, safety-first-aid, hygiene, lockout-tagout, electrical, lightening, safety-signs, or surface-cleaning.

  • product_id string Required

    The unique product id, as returned by list products endpoint.

Query parameters

  • with_sku_details boolean

    Set to "1" to request all detailed SKU information, otherwise only SKU codes will be provided. SKU data model can be requested on the Fetch segment data model endpoint with "sku" as segment key.

  • sku_type string

    Set to the sku type key for which you want to get SKU data from. It can be useful if you handle several SKU types in your corporation, but you want information on a different SKU type which is not the default one

  • with_asset_details boolean

    Set to "1" to request more detailed information about assets (name, source url, multiple assets...)

  • with_dynamic_tiles boolean

    Set to "1" to request dynamic information about tiles (in that case the title, the pictogram and the value can change for each product)

  • with_json_path boolean

    Set to "1" to also request api endpoint + json path for each item in the views, allosing easier query of detailed items attributes

Responses

  • 200 application/json

    Successfully returned product information

    Hide response attributes Show response attributes object
    • status string
    • result object
      Hide result attributes Show result attributes object
      • languages array[string]

        List of languages

        Value is en fr it es de hu ja be pt es fi ro tr pt-BR es-AR en-US.

      • product object
        Hide product attributes Show product attributes object
        • segment_key string

          Unique slug to identify the segment

          Values are hand-protection, foot-protection, head-protection, eye-protection, body-protection, ear-protection, fall-protection, respiratory-protection, ergonomy, safety-first-aid, hygiene, lockout-tagout, electrical, lightening, safety-signs, or surface-cleaning.

        • id string

          Id to identify the product, unique segment-wise

        • name string

          The name of the product

        • manufacturer string

          The manufacturer key of the product

        • level string

          The level of the product in the product hierarchy. Products which are not part of any hierarchy are marked as 'single'

          Values are single, parent, or variant.

        • main_picture_url url

          The URL of the main picture for the product

        • product_page_urls object

          Localized URLs for the object. Available languages depend on your corporation settings

          Hide product_page_urls attributes Show product_page_urls attributes object
          • en string
          • fr string
        • descriptions object
          Hide descriptions attributes Show descriptions attributes object
          • name object

            Translations for the object. Available languages depend on your corporation settings

            Hide name attributes Show name attributes object
            • en string
            • fr string
          • description object

            Translations for the object. Available languages depend on your corporation settings

            Hide description attributes Show description attributes object
            • en string
            • fr string
          • short_description object

            Translations for the object. Available languages depend on your corporation settings

            Hide short_description attributes Show short_description attributes object
            • en string
            • fr string
        • pictures array[object]
          Hide pictures attributes Show pictures attributes object
          • is_main_picture boolean
          • asset_uuid string
          • types array[string]

            Unique slug to identify an asset type for pictures

            Values are product-picture, picture-in-context, 360-picture, benefits-picture, or pictogram.

          • original url
          • square-80px url
          • square-300px url
          • square-800px url
          • hd url
        • documents object

          The list of available types used as keys depend on your corporation settings and on the content attached to the product

          Hide documents attributes Show documents attributes object
          • technical-sheet object

            Localized URLs for the object. Available languages depend on your corporation settings

            Hide technical-sheet attributes Show technical-sheet attributes object
            • en string
            • fr string
          • dcue-certificate object

            Localized URLs for the object. Available languages depend on your corporation settings

            Hide dcue-certificate attributes Show dcue-certificate attributes object
            • en string
            • fr string
        • values object

          Property values attached to this object

          Hide values attributes Show values attributes object
          • property_key string

            To be replaced with the property key of the property

          • value string

            The value for this property can be:

            • a value_key for enum
            • an array of value_key for enum_list
            • a string otherwise
        • tiles object

          Tiles attached to this object. One tile is composed of a pictogram + localized title & value

          Hide tiles attributes Show tiles attributes object
          • tile_key string

            To be replaced with the tile key of the tile. It will have a mycorp/ prefix for private tiles to avoid conflicts

          • value object

            Full tile content, including its pictogram, title and content (all of them are optional)

            Hide value attributes Show value attributes object
            • pictures array[object]

              Direct links to different sizes of the picture. Can be hotlinked

              Hide pictures attributes Show pictures attributes object
              • square-80px url
              • square-300px url
            • title object

              Translations for the object. Available languages depend on your corporation settings

              Hide title attributes Show title attributes object
              • en string
              • fr string
            • content object

              Translations for the object. Available languages depend on your corporation settings

              Hide content attributes Show content attributes object
              • en string
              • fr string
        • variants array[object]

          The list of available variants of this product

          Hide variants attributes Show variants attributes object
          • segment_key string

            Unique slug to identify the segment

            Values are hand-protection, foot-protection, head-protection, eye-protection, body-protection, ear-protection, fall-protection, respiratory-protection, ergonomy, safety-first-aid, hygiene, lockout-tagout, electrical, lightening, safety-signs, or surface-cleaning.

          • id string

            Id to identify the product, unique segment-wise

          • name string

            The name of the variant product

          • code string

            The code to identify the variant (optional)

          • rank integer

            The rank of the variant in the variants list

          • api_get_product url

            The API endpoint to get all information on the product

          • main_picture_url url

            The URL of the main picture for the product

          • last_modified date

            Date of last modification on product

          • values object

            Property values attached to this object

            Hide values attributes Show values attributes object
            • property_key string

              To be replaced with the property key of the property

            • value string

              The value for this property can be:

              • a value_key for enum
              • an array of value_key for enum_list
              • a string otherwise
        • variant_parent object
          Hide variant_parent attributes Show variant_parent attributes object
          • segment_key string

            Unique slug to identify the segment

            Values are hand-protection, foot-protection, head-protection, eye-protection, body-protection, ear-protection, fall-protection, respiratory-protection, ergonomy, safety-first-aid, hygiene, lockout-tagout, electrical, lightening, safety-signs, or surface-cleaning.

          • id string

            Id to identify the product, unique segment-wise

          • name string

            The name of the product

          • manufacturer string

            The manufacturer key for the product

          • level string

            The level of the product in the product hierarchy. Products which are not part of any hierarchy are marked as 'single'

            Values are single, parent, or variant.

          • last_modified date

            Date of last modification on product

          • parent_id string

            The id of the parent product (if level is "variant")

          • api_get_product url

            The API endpoint to get all information on the product

          • main_picture_url url

            The URL of the main picture for the product

          • product_page_url url

            The URL of the public product page

          • pim_status string

            The status of the product in the PIM. It is only available on products on which your are the owner

            Values are draft, ready, or archived.

        • skus array[object]

          The list of active SKUs on this product. SKU data model can be requested on the Fetch segment data model endpoint with "sku" as segment key.

          Hide skus attributes Show skus attributes object
          • code string

            The unique code for the SKU

          • label string

            A description for this SKU

          • values object

            Property values attached to this object

            Hide values attributes Show values attributes object
            • property_key string

              To be replaced with the property key of the property

            • value string

              The value for this property can be:

              • a value_key for enum
              • an array of value_key for enum_list
              • a string otherwise
        • relations array[object]

          The list of relations that this product has with other products, potentially from other segments. Relations can be asymmetrical or symmetrical. In a symmetrical relation both product are at the same level, whereas in an asymmetrical relation the roles of the products involved is not the same, one is the leader and the other the follower.

          Hide relations attributes Show relations attributes object
          • key string

            A key to define the type of relation between two products

            Values are is_part_of_kit, has_for_kit_content, is_spare_part_for, has_for_spare_parts, is_accessory_for, has_for_accessories, is_replaceable_by, can_replace, is_premium_replaceable_by, can_premium_replace, associated, or part_of_same_collection.

          • type string

            Defines wether a relation is symmetrical (true for both parties equally) or asymmetrical (different for each party)

            Values are symmetrical or asymmetrical.

          • products array[object]

            The list of relations with other products on this product

            Hide products attributes Show products attributes object
            • segment_key string

              Unique slug to identify the segment

              Values are hand-protection, foot-protection, head-protection, eye-protection, body-protection, ear-protection, fall-protection, respiratory-protection, ergonomy, safety-first-aid, hygiene, lockout-tagout, electrical, lightening, safety-signs, or surface-cleaning.

            • id string

              Id to identify the product, unique segment-wise

            • name string

              The name of the product

            • manufacturer string

              The manufacturer key for the product

            • level string

              The level of the product in the product hierarchy. Products which are not part of any hierarchy are marked as 'single'

              Values are single, parent, or variant.

            • last_modified date

              Date of last modification on product

            • parent_id string

              The id of the parent product (if level is "variant")

            • api_get_product url

              The API endpoint to get all information on the product

            • main_picture_url url

              The URL of the main picture for the product

            • product_page_url url

              The URL of the public product page

            • pim_status string

              The status of the product in the PIM. It is only available on products on which your are the owner

              Values are draft, ready, or archived.

        • countries array[string]

          The list of countries in which the product is sold, using alpha-2 iso codes
  • 404 application/json

    Unknown product id

    Hide response attributes Show response attributes object
    • status string
    • message string
  • 403 application/json

    Unauthorized product

    Hide response attributes Show response attributes object
    • status string
    • message string
  • 419 application/json

    Rate limit exceeded

    Hide response attributes Show response attributes object
    • status string
    • message string
GET /products/{segment_key}/{product_id} 
curl \
 --request GET 'https://api.ppe-analytics.com/api/v1/products/surface-cleaning/cbdeacabd0128cb641b64d0c0f590332' \
 --header "PPEApiKey: $API_KEY"
Response examples (200) 
{
  "status": "OK",
  "result": {
    "product": {
      "id": "f50938a24830edb8b1c2ecc3f7dd88a3",
      "name": "Apo-low 1027",
      "skus": [
        {
          "code": "APO1027-123",
          "label": "APO-LOW 1027 polybag",
          "values": [
            {
              "basic-unit-kind": "bg",
              "basic-packaging-ean": 283762387623,
              "basic-packaging-gross-weight": 540
            }
          ]
        },
        {
          "code": "APO1027-456",
          "label": "APO-LOW 1027 single",
          "values": [
            {
              "basic-unit-kind": "ea",
              "basic-packaging-ean": 283762387624,
              "basic-packaging-gross-weight": 122
            }
          ]
        },
        {
          "code": "APO1027-777",
          "label": "APO-LOW 1027 FOR EXPORT",
          "values": [
            {
              "basic-unit-kind": "bx",
              "basic-packaging-ean": 283762387625,
              "basic-packaging-gross-weight": 1250
            }
          ]
        }
      ],
      "level": "parent",
      "tiles": {
        "en374-letters": {
          "title": {
            "en": "EN344 Letters",
            "fr": "Lettres En344"
          },
          "content": {
            "en": "B + some details",
            "fr": "B + des détails"
          },
          "pictures": {
            "square-80px": "https://static.ppe-analytics.com/pictograms/public/d5/b2/d5b2f59e-9129-40c2-a9ea-1478c1431bcf/d5b2f59e-9129-40c2-a9ea-1478c1431bcf-80.png",
            "square-300px": "https://static.ppe-analytics.com/pictograms/public/d5/b2/d5b2f59e-9129-40c2-a9ea-1478c1431bcf/d5b2f59e-9129-40c2-a9ea-1478c1431bcf-300.png"
          }
        },
        "mycorp/advantages": {
          "title": {
            "en": "Advantages",
            "fr": "Avantages"
          },
          "content": {
            "en": "Cheap / green / robust",
            "fr": "Pas cher / écolo / robuste"
          }
        }
      },
      "views": {
        "web": {
          "norms": [
            {
              "key": "en388",
              "type": "property"
            },
            {
              "key": "tile-900",
              "type": "tile"
            }
          ],
          "default": [
            {
              "key": "technical-name",
              "type": "property"
            }
          ],
          "advantages": [
            {
              "key": "acme--fabdis-desc-32",
              "type": "localized-field"
            },
            {
              "key": "mycorp/comfort",
              "type": "property"
            }
          ]
        },
        "compare": {
          "default": [
            {
              "key": "mycorp/material",
              "type": "property"
            },
            {
              "key": "color",
              "type": "property"
            }
          ]
        }
      },
      "assets": {
        "technical-sheet": [
          {
            "url": "https://spontex.ppe-analytics.com/en/product/f50938a24830edb8b1c2ecc3f7dd88a3/pdf/dcue-certificate",
            "name": "Apo-low 1027 Technical sheet EN",
            "languages": [
              "en"
            ],
            "asset_uuid": "0bb230c2-2753-473c-b298-88fab2bc7001"
          },
          {
            "url": "https://spontex.ppe-analytics.com/fr/product/f50938a24830edb8b1c2ecc3f7dd88a3/pdf/dcue-certificate",
            "name": "Apo-low 1027 Technical sheet FR",
            "languages": [
              "fr"
            ],
            "asset_uuid": "0bb230c2-2753-473c-b298-88fab2bc7002"
          }
        ],
        "instructions-for-use": [
          {
            "url": "https://assets.ppe-analytics.com/mapa/ab/b2/abb230c2-2753-473c-b298-88fab2bc7c8c/abb230c2-2753-473c-b298-88fab2bc7c8c-0.pdf",
            "name": "Notice chemical range",
            "languages": [
              "en",
              "fr"
            ],
            "asset_uuid": "abb230c2-2753-473c-b298-88fab2bc7c8c"
          }
        ]
      },
      "values": {
        "has-latex": true,
        "main-color": [
          "blue"
        ],
        "en388-digits": "4343X"
      },
      "pictures": [
        {
          "hd": "https://assets.ppe-analytics.com/mapa/9e/15/9e158040-272e-4f6a-8da5-1bed82f8ca80/9e158040-272e-4f6a-8da5-1bed82f8ca80-0-hd.jpg",
          "types": [
            "product-picture"
          ],
          "original": "https://assets.ppe-analytics.com/mapa/9e/15/9e158040-272e-4f6a-8da5-1bed82f8ca80/9e158040-272e-4f6a-8da5-1bed82f8ca80-0.jpg",
          "asset_uuid": "9e158040-272e-4f6a-8da5-1bed82f8ca80-0.jpg",
          "square-80px": "https://assets.ppe-analytics.com/mapa/9e/15/9e158040-272e-4f6a-8da5-1bed82f8ca80/9e158040-272e-4f6a-8da5-1bed82f8ca80-0-80.jpg",
          "square-300px": "https://assets.ppe-analytics.com/mapa/9e/15/9e158040-272e-4f6a-8da5-1bed82f8ca80/9e158040-272e-4f6a-8da5-1bed82f8ca80-0-300.jpg",
          "square-800px": "https://assets.ppe-analytics.com/mapa/9e/15/9e158040-272e-4f6a-8da5-1bed82f8ca80/9e158040-272e-4f6a-8da5-1bed82f8ca80-0-800.jpg",
          "is_main_picture": true
        },
        {
          "hd": "https://assets.ppe-analytics.com/mapa/6c/b6/6cb60165-78ab-4bd7-8ac7-2afc3a5c952d/6cb60165-78ab-4bd7-8ac7-2afc3a5c952d-0-hd.png",
          "types": [
            "360-picture"
          ],
          "original": "https://assets.ppe-analytics.com/mapa/6c/b6/6cb60165-78ab-4bd7-8ac7-2afc3a5c952d/6cb60165-78ab-4bd7-8ac7-2afc3a5c952d-0.png",
          "asset_uuid": "6cb60165-78ab-4bd7-8ac7-2afc3a5c952d-0.png",
          "square-80px": "https://assets.ppe-analytics.com/mapa/6c/b6/6cb60165-78ab-4bd7-8ac7-2afc3a5c952d/6cb60165-78ab-4bd7-8ac7-2afc3a5c952d-0-80.png",
          "square-300px": "https://assets.ppe-analytics.com/mapa/6c/b6/6cb60165-78ab-4bd7-8ac7-2afc3a5c952d/6cb60165-78ab-4bd7-8ac7-2afc3a5c952d-0-300.png",
          "square-800px": "https://assets.ppe-analytics.com/mapa/6c/b6/6cb60165-78ab-4bd7-8ac7-2afc3a5c952d/6cb60165-78ab-4bd7-8ac7-2afc3a5c952d-0-800.png"
        }
      ],
      "variants": [
        {
          "code": "1027-BG",
          "rank": 0,
          "label": "Apo-low 1027 BLUEGREEN",
          "values": {
            "color": [
              "blue",
              "green"
            ]
          },
          "product_id": "f60938a24830edb8b1c2ecc3f7dd88a4",
          "segment_key": "ear-protection",
          "last_modified": "2023-12-24 17:14:46 +0200",
          "api_get_product": "/api/v1/products/ear-protection/f60938a24830edb8b1c2ecc3f7dd88a4",
          "main_picture_url": "https://app.ppe-analytics.com/static/pictures/300/surface-cleaning/f50938a24830edb8b1c2ecc3f7dd88a3.jpg"
        },
        {
          "code": "1027-BB",
          "rank": 1,
          "label": "Apo-low 1027 BLUEBLACK",
          "values": {
            "color": [
              "blue",
              "black"
            ]
          },
          "product_id": "f70938a24830edb8b1c2ecc3f7dd88a5",
          "segment_key": "ear-protection",
          "last_modified": "2024-01-09 12:55:02 +0200",
          "api_get_product": "/api/v1/products/ear-protection/f70938a24830edb8b1c2ecc3f7dd88a5",
          "main_picture_url": "https://app.ppe-analytics.com/static/pictures/300/surface-cleaning/f50938a24830edb8b1c2ecc3f7dd88a3.jpg"
        }
      ],
      "countries": [
        "it",
        "fr",
        "gb",
        "ml"
      ],
      "documents": {
        "technical-sheet": {
          "en": "https://spontex.ppe-analytics.com/en/product/f50938a24830edb8b1c2ecc3f7dd88a3/pdf/technical-sheet",
          "fr": "https://spontex.ppe-analytics.com/fr/product/f50938a24830edb8b1c2ecc3f7dd88a3/pdf/technical-sheet"
        },
        "instructions-for-use": {
          "en": "https://assets.ppe-analytics.com/mapa/ab/b2/abb230c2-2753-473c-b298-88fab2bc7c8c/abb230c2-2753-473c-b298-88fab2bc7c8c-0.pdf",
          "fr": "https://assets.ppe-analytics.com/mapa/ab/b2/abb230c2-2753-473c-b298-88fab2bc7c8c/abb230c2-2753-473c-b298-88fab2bc7c8c-0.pdf"
        }
      },
      "relations": [
        {
          "key": "is_part_of_kit",
          "type": "asymmetrical",
          "products": [
            {
              "code": "CLEAN-KIT",
              "label": "Kit nettoyage",
              "product_id": "f70938a24830edb8b1c2ecc3f7dd88a5",
              "segment_key": "surface-cleaning",
              "manufacturer": "spontex",
              "api_get_product": "/api/v1/products/ear-protection/f70938a24830edb8b1c2ecc3f7dd88a5",
              "main_picture_url": "https://app.ppe-analytics.com/static/pictures/300/surface-cleaning/f50938a24830edb8b1c2ecc3f7dd88a3.jpg"
            }
          ]
        },
        {
          "key": "can_replace",
          "type": "asymmetrical",
          "products": [
            {
              "code": "APOLI",
              "label": "Apo li light",
              "product_id": "f70938a24830edb8b1c2ecc3f7dd88a5",
              "segment_key": "surface-cleaning",
              "manufacturer": "spontex",
              "api_get_product": "/api/v1/products/ear-protection/f70938a24830edb8b1c2ecc3f7dd88a5",
              "main_picture_url": "https://app.ppe-analytics.com/static/pictures/300/surface-cleaning/f50938a24830edb8b1c2ecc3f7dd88a3.jpg"
            },
            {
              "code": "APOLOGIC",
              "label": "Apo logic",
              "product_id": "f70938a24830edb8b1c2ecc3f7dd88a5",
              "segment_key": "surface-cleaning",
              "manufacturer": "spontex",
              "api_get_product": "/api/v1/products/ear-protection/f70938a24830edb8b1c2ecc3f7dd88a5",
              "main_picture_url": "https://app.ppe-analytics.com/static/pictures/300/surface-cleaning/f50938a24830edb8b1c2ecc3f7dd88a3.jpg"
            }
          ]
        },
        {
          "key": "associated",
          "type": "symmetrical",
          "products": [
            {
              "code": "9872323-LUN",
              "label": "Lunettes anti projections",
              "product_id": "f70938a24830edb8b1c2ecc3f7dd88a5",
              "segment_key": "eye-protection",
              "manufacturer": "uvex",
              "api_get_product": "/api/v1/products/ear-protection/f70938a24830edb8b1c2ecc3f7dd88a5",
              "main_picture_url": "https://app.ppe-analytics.com/static/pictures/300/surface-cleaning/f50938a24830edb8b1c2ecc3f7dd88a3.jpg"
            }
          ]
        }
      ],
      "pim_status": "ready",
      "segment_key": "surface-cleaning",
      "descriptions": {
        "name": {
          "en": "Apo-low 1027",
          "fr": "Apo-bas 1027"
        },
        "description": {
          "en": "This product is truly awesome and made for you",
          "fr": "Ce produit est vraiment incroyable et pensé pour vous"
        },
        "short_description": {
          "en": "You deserve the best",
          "fr": "La meilleure qualité pour vous"
        }
      },
      "manufacturer": "spontex",
      "main_picture_url": "https://app.ppe-analytics.com/static/pictures/300/surface-cleaning/f50938a24830edb8b1c2ecc3f7dd88a3.jpg",
      "product_page_urls": {
        "en": "https://website.uk/product-64654",
        "fr": "https://website.fr/produit-64654"
      }
    },
    "languages": [
      "en",
      "fr"
    ]
  }
}
Response examples (404) 
{
  "status": "ERROR",
  "message": "Unknown product id 'abcdef-1234'"
}
Response examples (403) 
{
  "status": "ERROR",
  "message": "Unauthorized access to product 'secret-agent/007'"
}
Response examples (419) 
{
  "status": "ERROR",
  "message": "Rate limit exceeded on this endpoint. Please slow down your calls a little"
}