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.

• with_asset_details boolean

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

• 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