Get compliance information for brand's products

GET 
/partner/v1.0/brands/:brandSlug/passports

Get compliance information for brand's products

Request

Path Parameters

brandSlug stringrequired

The slug of the brand in the Carbon Trail platform

Query Parameters

view ComplianceViewType

Possible values: [agec]

The compliance view type for the product information

filterBy string

The date field to filter by. Valid values: 'created' (default) or 'updated'

startDate date-time

The start date for filtering products

endDate date-time

The end date for filtering products

page int32

Default value: 1

The page number for pagination (default: 1)

pageSize int32

Default value: 100

The number of items per page (default: 100, max: 1000)

Responses

200

OK

text/plain

Schema

Schema

data

object[]

nullable

The list of items for the current page.

Array [

name stringnullable

The name of the product.

sku stringnullable

The Stock Keeping Unit (SKU) of the product.

articleNumber stringnullable

The article number of the product.

hazardousSubstances string[]nullable

The list of hazardous substances associated with the product as per REACH regulation. Empty list indicates no hazardous substances are present.

productRecyclability RecyclableType (string)

Possible values: [Mostly Recyclable, Entirely Recyclable, Non Recyclable]

rawMaterialRecyclingPercentage double

The percentage of recycled materials used in the raw materials of the product (0-100).

packagingRecyclingPercentage double

The percentage of recycled materials used in the product's packaging (0-100).

microplasticsReleased boolean

Indicates whether the product releases microplastics during use or washing. True if synthetic materials constitute 50% or more of the product weight.

syntheticMaterials string[]nullable

The list of synthetic materials present in the product that may release microplastics.

traceability

object[]

nullable

The traceability information showing the manufacturing processes and their locations.

Provides supply chain transparency.

Array [

name stringnullable

The name of the manufacturing process (e.g., Knitting, Weaving, Dyeing, Assembly).

location

object

Represents a geographical location where a manufacturing process or material sourcing takes place.

id stringnullable

The unique identifier of the location.

city stringnullable

The name of the city.

country stringrequired

Possible values: non-empty

The ISO 3166-1 alpha-2 country code.

countryName stringnullable

The full name of the country.

continent stringnullable

The name of the continent.

latitude doublenullable

The latitude coordinate of the location.

longitude doublenullable

The longitude coordinate of the location.

]

]

page int32

The current page number (1-indexed).

pageSize int32

The number of items per page.

totalRecords int64nullable

The total number of records across all pages.

totalPages int32nullable

The total number of pages available based on TotalRecords and PageSize.

Example (from schema)

{
  "data": [
    {
      "name": "Organic Cotton T-Shirt",
      "sku": "SKU-12345",
      "articleNumber": "ART-67890",
      "hazardousSubstances": [
        "Lead",
        "Cadmium"
      ],
      "productRecyclability": "Mostly Recyclable",
      "rawMaterialRecyclingPercentage": 45.5,
      "packagingRecyclingPercentage": 80,
      "microplasticsReleased": false,
      "syntheticMaterials": [
        "Polyester",
        "Nylon"
      ],
      "traceability": [
        {
          "name": "Dyeing",
          "location": {
            "id": "loc-12345",
            "city": "Paris",
            "country": "FR",
            "countryName": "France",
            "continent": "Europe",
            "latitude": 48.8566,
            "longitude": 2.3522
          }
        }
      ]
    }
  ],
  "page": 1,
  "pageSize": 100,
  "totalRecords": 250,
  "totalPages": 3
}

application/json

Schema

Schema

data

object[]

nullable

The list of items for the current page.

Array [

name stringnullable

The name of the product.

sku stringnullable

The Stock Keeping Unit (SKU) of the product.

articleNumber stringnullable

The article number of the product.

hazardousSubstances string[]nullable

The list of hazardous substances associated with the product as per REACH regulation. Empty list indicates no hazardous substances are present.

productRecyclability RecyclableType (string)

Possible values: [Mostly Recyclable, Entirely Recyclable, Non Recyclable]

rawMaterialRecyclingPercentage double

The percentage of recycled materials used in the raw materials of the product (0-100).

packagingRecyclingPercentage double

The percentage of recycled materials used in the product's packaging (0-100).

microplasticsReleased boolean

Indicates whether the product releases microplastics during use or washing. True if synthetic materials constitute 50% or more of the product weight.

syntheticMaterials string[]nullable

The list of synthetic materials present in the product that may release microplastics.

traceability

object[]

nullable

The traceability information showing the manufacturing processes and their locations.

Provides supply chain transparency.

Array [

name stringnullable

The name of the manufacturing process (e.g., Knitting, Weaving, Dyeing, Assembly).

location

object

Represents a geographical location where a manufacturing process or material sourcing takes place.

id stringnullable

The unique identifier of the location.

city stringnullable

The name of the city.

country stringrequired

Possible values: non-empty

The ISO 3166-1 alpha-2 country code.

countryName stringnullable

The full name of the country.

continent stringnullable

The name of the continent.

latitude doublenullable

The latitude coordinate of the location.

longitude doublenullable

The longitude coordinate of the location.

]

]

page int32

The current page number (1-indexed).

pageSize int32

The number of items per page.

totalRecords int64nullable

The total number of records across all pages.

totalPages int32nullable

The total number of pages available based on TotalRecords and PageSize.

Example (from schema)

{
  "data": [
    {
      "name": "Organic Cotton T-Shirt",
      "sku": "SKU-12345",
      "articleNumber": "ART-67890",
      "hazardousSubstances": [
        "Lead",
        "Cadmium"
      ],
      "productRecyclability": "Mostly Recyclable",
      "rawMaterialRecyclingPercentage": 45.5,
      "packagingRecyclingPercentage": 80,
      "microplasticsReleased": false,
      "syntheticMaterials": [
        "Polyester",
        "Nylon"
      ],
      "traceability": [
        {
          "name": "Dyeing",
          "location": {
            "id": "loc-12345",
            "city": "Paris",
            "country": "FR",
            "countryName": "France",
            "continent": "Europe",
            "latitude": 48.8566,
            "longitude": 2.3522
          }
        }
      ]
    }
  ],
  "page": 1,
  "pageSize": 100,
  "totalRecords": 250,
  "totalPages": 3
}

text/json

Schema

Schema

data

object[]

nullable

The list of items for the current page.

Array [

name stringnullable

The name of the product.

sku stringnullable

The Stock Keeping Unit (SKU) of the product.

articleNumber stringnullable

The article number of the product.

hazardousSubstances string[]nullable

The list of hazardous substances associated with the product as per REACH regulation. Empty list indicates no hazardous substances are present.

productRecyclability RecyclableType (string)

Possible values: [Mostly Recyclable, Entirely Recyclable, Non Recyclable]

rawMaterialRecyclingPercentage double

The percentage of recycled materials used in the raw materials of the product (0-100).

packagingRecyclingPercentage double

The percentage of recycled materials used in the product's packaging (0-100).

microplasticsReleased boolean

Indicates whether the product releases microplastics during use or washing. True if synthetic materials constitute 50% or more of the product weight.

syntheticMaterials string[]nullable

The list of synthetic materials present in the product that may release microplastics.

traceability

object[]

nullable

The traceability information showing the manufacturing processes and their locations.

Provides supply chain transparency.

Array [

name stringnullable

The name of the manufacturing process (e.g., Knitting, Weaving, Dyeing, Assembly).

location

object

Represents a geographical location where a manufacturing process or material sourcing takes place.

id stringnullable

The unique identifier of the location.

city stringnullable

The name of the city.

country stringrequired

Possible values: non-empty

The ISO 3166-1 alpha-2 country code.

countryName stringnullable

The full name of the country.

continent stringnullable

The name of the continent.

latitude doublenullable

The latitude coordinate of the location.

longitude doublenullable

The longitude coordinate of the location.

]

]

page int32

The current page number (1-indexed).

pageSize int32

The number of items per page.

totalRecords int64nullable

The total number of records across all pages.

totalPages int32nullable

The total number of pages available based on TotalRecords and PageSize.

Example (from schema)

{
  "data": [
    {
      "name": "Organic Cotton T-Shirt",
      "sku": "SKU-12345",
      "articleNumber": "ART-67890",
      "hazardousSubstances": [
        "Lead",
        "Cadmium"
      ],
      "productRecyclability": "Mostly Recyclable",
      "rawMaterialRecyclingPercentage": 45.5,
      "packagingRecyclingPercentage": 80,
      "microplasticsReleased": false,
      "syntheticMaterials": [
        "Polyester",
        "Nylon"
      ],
      "traceability": [
        {
          "name": "Dyeing",
          "location": {
            "id": "loc-12345",
            "city": "Paris",
            "country": "FR",
            "countryName": "France",
            "continent": "Europe",
            "latitude": 48.8566,
            "longitude": 2.3522
          }
        }
      ]
    }
  ],
  "page": 1,
  "pageSize": 100,
  "totalRecords": 250,
  "totalPages": 3
}

Loading...