Akeneo PIM REST API
  1. PAM asset
Akeneo PIM REST API
  • Authentication
    • Get authentication token
      POST
  • Overview
    • Get list of all endpoints
      GET
  • PAM asset category
    • Get list of PAM asset categories
      GET
    • Update/create several PAM asset categories
      PATCH
    • Create a new PAM asset category
      POST
    • Get a PAM asset category
      GET
    • Update/create a PAM asset category
      PATCH
  • Asset family
    • Get list of asset families
      GET
    • Get an asset family
      GET
    • Update/create an asset family
      PATCH
  • Asset
    • Get the list of the assets of a given asset family
      GET
    • Update/create several assets
      PATCH
    • Delete an asset
      DELETE
    • Get an asset of a given asset family
      GET
    • Update/create an asset
      PATCH
  • Asset attribute
    • Get the list of attributes of a given asset family
      GET
    • Get an attribute of a given asset family
      GET
    • Update/create an attribute of a given asset family
      PATCH
  • Asset attribute option
    • Get a list of attribute options of a given attribute for a given asset family
    • Get an attribute option for a given attribute of a given asset family
    • Update/create an asset attribute option for a given asset family
  • Asset media file
    • Create a new media file for an asset
    • Download the media file associated to an asset
  • PAM asset tag
    • Get list of PAM asset tags
    • Get a PAM asset tag
    • Update/create a PAM asset tag
  • PAM asset
    • Get list of PAM assets
      GET
    • Update/create several PAM assets
      PATCH
    • Create a new PAM asset
      POST
    • Get a PAM asset
      GET
    • Update/create a PAM asset
      PATCH
  • PAM asset reference file
    • Get a reference file
    • Upload a new reference file
    • Download a reference file
  • PAM asset variation file
    • Get a variation file
    • Upload a new variation file
    • Download a variation file
  • Association type
    • Get a list of association types
    • Update/create several association types
    • Create a new association type
    • Get an association type
    • Update/create an association type
  • Attribute group
    • Get list of attribute groups
    • Update/create several attribute groups
    • Create a new attribute group
    • Get an attribute group
    • Update/create an attribute group
  • Attribute
    • Get list of attributes
    • Update/create several attributes
    • Create a new attribute
    • Get an attribute
    • Update/create an attribute
  • Attribute option
    • Get list of attribute options
    • Update/create several attribute options
    • Create a new attribute option
    • Get an attribute option
    • Update/create an attribute option
  • Category
    • Get list of categories
    • Update/create several categories
    • Create a new category
    • Get a category
    • Update/create a category
    • Download a category media file [COMING SOON]
  • Channel
    • Get a list of channels
    • Update/create several channels
    • Create a new channel
    • Get a channel
    • Update/create a channel
  • Currency
    • Get a list of currencies
    • Get a currency
  • Family
    • Get list of families
    • Update/create several families
    • Create a new family
    • Get a family
    • Update/create a family
    • Create a new family variant
  • Family variant
    • Get list of family variants
    • Update/create several family variants
    • Get a family variant
    • Update/create a family variant
  • Locale
    • Get a list of locales
    • Get a locale
  • Measure family
    • Get list of measure familiy
    • Get a measure family
  • Measurement family
    • Get list of measurement families
    • Update/create several measurement families
  • Product media file
    • Get a list of product media files
    • Create a new product media file
    • Get a product media file
    • Download a product media file
  • Product model
    • Get list of product models
    • Update/create several product models
    • Create a new product model
    • Delete a product model
    • Get a product model
    • Update/create a product model
    • Get a draft
    • Submit a draft for approval
  • Product
    • Get list of products
    • Update/create several products
    • Create a new product
    • Delete a product
    • Get a product
    • Update/create a product
    • Get a draft
    • Submit a draft for approval
  • Published product
    • Get list of published products
    • Get a published product
  • Reference entity
    • Get list of reference entities
    • Get a reference entity
    • Update/create a reference entity
  • Reference entity media file
    • Create a new media file for a reference entity or a record
    • Download the media file associated to a reference entity or a record
  • Reference entity attribute
    • Get the list of attributes of a given reference entity
    • Get an attribute of a given reference entity
    • Update/create an attribute of a given reference entity
  • Reference entity attribute option
    • Get a list of attribute options of a given attribute for a given reference entity
    • Get an attribute option for a given attribute of a given reference entity
    • Update/create a reference entity attribute option
  • Reference entity record
    • Get the list of the records of a reference entity
    • Update/create several reference entity records
    • Get a record of a given reference entity
    • Update/create a record of a given reference entity
  • System
    • Get system information
    • Get system information
  • Catalogs
    • Get the list of owned catalogs
    • Create a new catalog
    • Delete a catalog
    • Get a catalog
    • Update a catalog
  • Catalog products
    • Get the list of product uuids
    • Get the list of products related to a catalog
    • Get a product related to a catalog
  • Product [identifier]
    • Get list of products
    • Update/create several products
    • Create a new product
    • Delete a product
    • Get a product
    • Update/create a product
    • Get a draft
    • Submit a draft for approval
  • Product [uuid]
    • Get list of products
    • Update/create several products
    • Create a new product
    • Delete a product
    • Get a product
    • Update/create a product
    • Get a draft
    • Submit a draft for approval
  1. PAM asset

Get a PAM asset

GET
/api/rest/v1/assets/{code}
PAM asset
This endpoint allows you to get the information about a given PAM asset.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/rest/v1/assets/'
Response Response Example
200 - Example 1
{
  "categories": [
    "tshirts_assets"
  ],
  "code": "tshirt_artemis_main_picture",
  "description": "The main picture of the Artemis t-shirt",
  "end_of_use": "2019-09-01T00:00:00+0200",
  "localizable": false,
  "reference_files": [
    {
      "_link": {
        "download": {
          "href": "https://demo.akeneo.com/api/rest/v1/assets/tshirt_artemis_main_picture/reference-files/no_locale/download"
        },
        "self": {
          "href": "https://demo.akeneo.com/api/rest/v1/assets/tshirt_artemis_main_picture/reference-files/no_locale"
        }
      },
      "code": "7/5/8/e/759e39d48va7b42a55002434fd3d7b6cf3189b7f_tshirt_artemis_main_picture.jpg",
      "locale": null
    }
  ],
  "tags": [
    "tshirts",
    "red",
    "summer"
  ],
  "variation_files": [
    {
      "_link": {
        "download": {
          "href": "https://demo.akeneo.com/api/rest/v1/assets/tshirt_artemis_main_picture/variation-files/ecommerce/no_locale/download"
        },
        "self": {
          "href": "https://demo.akeneo.com/api/rest/v1/assets/tshirt_artemis_main_picture/variation-files/ecommerce/no_locale"
        }
      },
      "code": "7/5/8/e/758e39d48va7b42a55001434fd3d7b6cf3189b7f_tshirt_artemis_main_picture_ecommerce.jpg",
      "locale": null,
      "scope": "e_commerce"
    },
    {
      "_link": {
        "download": {
          "href": "https://demo.akeneo.com/api/rest/v1/assets/tshirt_artemis_main_picture/variation-files/print/no_locale/download"
        },
        "self": {
          "href": "https://demo.akeneo.com/api/rest/v1/assets/tshirt_artemis_main_picture/variation-files/print/no_locale"
        }
      },
      "code": "7/5/8/e/759e39d48va7b42a55002434fd3d7b6cf3189b7f_tshirt_artemis_main_picture_print.jpg",
      "locale": null,
      "scope": "print"
    }
  ]
}

Request

Path Params
code
string 
required
Code of the resource

Responses

🟢200OK
application/json
Body
categories
array[string]
optional
Codes of the PAM asset categories in which the asset is classified
code
string 
required
PAM asset code
description
string 
optional
Description of the PAM asset
Default:
null
end_of_use
string <dateTime>
optional
Date on which the PAM asset expire
Default:
null
localizable
boolean 
optional
Whether the asset is localized or not, meaning if you want to have different reference files for each of your locale
Default:
false
reference_files
array [object {3}] 
optional
Reference files of the PAM asset
_link
object 
optional
Links to get and download the reference file
code
string 
optional
Code of the reference file
locale
string 
optional
Locale code of the reference file
tags
array[string]
optional
Tags of the PAM asset
variation_files
array [object {4}] 
optional
Variations of the PAM asset
_link
object 
optional
Links to get and download the variation file
code
string 
optional
Code of the variation
locale
string 
optional
Locale code of the variation
scope
string 
optional
Channel code of the variation
🟠401Authentication required
🟠403Access forbidden
🟠404Resource not found
🟠406Not Acceptable
Modified at 2023-08-15 05:53:55
Previous
Create a new PAM asset
Next
Update/create a PAM asset
Built with