v1

latestSwagger 2.02026-07-13137761.0 MB

Published product

Get a published product

This endpoint allows you to get the information about a given published product.

get/api/rest/v1/published-products/{code}

Path parameters

codestring required

Code of the resource

Response

identifierstring required

Published product identifier, i.e. the value of the only pim_catalog_identifier attribute

enabledboolean

Whether the published product is enable

familystring

<a href='api-reference-paas.html#Family'>Family</a> code from which the published product inherits its attributes and attributes requirements

categoriesstring[]

Codes of the <a href='api-reference-paas.html#Category'>categories</a> in which the published product is classified

groupsstring[]

Codes of the groups to which the published product belong

valuesobject

Published product attributes values, see <a href='/concepts/products.html#focus-on-the-product-values'>Product values</a> section for more details

quantified_associationsobject

Warning: associations with quantities are not compatible with the published products. The response will always be empty.

createdstring dateTime

Date of creation

updatedstring dateTime

Date of the last update

Example response

{
  "identifier": "top",
  "enabled": true,
  "family": "tshirt",
  "categories": [
    "summer_collection"
  ],
  "groups": [],
  "values": {
    "name": [
      {
        "data": "Top",
        "locale": "en_US",
        "scope": null
      },
      {
        "data": "Débardeur",
        "locale": "fr_FR",
        "scope": null
      }
    ],
    "description": [
      {
        "data": "Summer top",
        "locale": "en_US",
        "scope": "ecommerce"
      },
      {
        "data": "Top",
        "locale": "en_US",
        "scope": "tablet"
      },
      {
        "data": "Débardeur pour l'été",
        "locale": "fr_FR",
        "scope": "ecommerce"
      },
      {
        "data": "Débardeur",
        "locale": "fr_FR",
        "scope": "tablet"
      }
    ],
    "price": [
      {
        "locale": null,
        "scope": null,
        "data": [
          {
            "amount": "15.5",
            "currency": "EUR"
          },
          {
            "amount": "15",
            "currency": "USD"
          }
        ]
      }
    ],
    "color": [
      {
        "locale": null,
        "scope": null,
        "data": "black"
      }
    ],
    "size": [
      {
        "locale": null,
        "scope": null,
        "data": "m"
      }
    ]
  },
  "created": "2016-06-23T18:24:44+02:00",
  "updated": "2016-06-25T17:56:12+02:00",
  "associations": {
    "PACK": {
      "products": [
        "sunglass"
      ],
      "product_models": [],
      "groups": []
    }
  }
}