GETMethod GET/partner-portal/products/{identifier}

You find a product from the identifier read on the object, and you receive its passport filtered on the accreditations that brand has recognized for you, and on those alone. By the end of this page, you will know which identifiers this endpoint accepts, what the response contains, and which errors it returns.

This endpoint belongs to the partner portal. It is reserved for repairer and recycler accounts, and it authenticates with the account session. The brand's API key has no currency here.

Full address:

GET https://api.sealtrust.io/v1/partner-portal/products/{identifier}

The same endpoint also answers without the /v1 prefix, at https://api.sealtrust.io/partner-portal/products/{identifier}. Both addresses call the same code. Use the /v1 form for a new integration.

#Authorization

Session of a partner account. You open that session with POST /v1/auth/login, which returns an access token and also sets a session cookie. You then present the token in the Authorization header, in Bearer format. It is valid for 60 minutes.

You must meet three conditions, in this order.

1. Your session is valid and your account is active. Otherwise the response is
2. Your account is of the repairer or recycler type. An account of another type receives 403.
3. At least one brand has accredited you, and that accreditation is active. Without that, the response is 403 before any product search at all.

The API searches only among the brands that have accredited you. It never returns a product of another brand to you.

The portal is intended for the partner application. The API also accepts a server to server call that carries the token in the Authorization header.

The API refuses with a 403 a call that relies on the session cookie and that comes from an origin the API does not accept.

#Call limit

A call limit applies to this endpoint. It is set for the normal use of the portal, where you look up a product then record an intervention.

Beyond it, the API answers 429. The refusal carries a Retry-After header that gives the number of seconds to wait. Wait that delay, then call again.

The limit covers the whole partner portal. Alternating between endpoints therefore does not give you headroom back. Space out your calls instead of sending them in bursts.

The value of the limit is not a commitment and can change without notice. Do not write any threshold into your code, rely on Retry-After.

#Path and query parameters

This endpoint has no query parameter.

The API tries the four forms in this order.

The serial number is the only form a human has in front of them. It is written in an alphabet that excludes the characters the eye confuses. On reading, the API puts the input in uppercase, then it brings I and L onto 1, and O onto 0. So you can enter the letter I, the API reads it as the digit 1. An operator copying a label is not punished for a character confusion. The API treats as a serial number only a string of exactly 12 characters, all taken from that alphabet.

The API does not resolve a destroyed product, nor a product the brand has withdrawn from the catalog. The response is then 404.

#Headers

#Request body

None. This request has no body.

#Example request

Search for the product whose printed serial number is EXEMPLE00001. Replace VOTRE_JETON_DE_SESSION with the access token the login returned to you.

The TypeScript SDK does not cover this surface, so the TypeScript tab shows a direct fetch call.

curl -i https://api.sealtrust.io/v1/partner-portal/products/EXEMPLE00001 \
  -H "Authorization: Bearer VOTRE_JETON_DE_SESSION"

const reponse = await fetch(
  "https://api.sealtrust.io/v1/partner-portal/products/EXEMPLE00001",
  {
    method: "GET",
    headers: {
      Authorization: "Bearer VOTRE_JETON_DE_SESSION",
    },
  },
);

console.log(reponse.status);
console.log(await reponse.json());

import requests

response = requests.get(
    "https://api.sealtrust.io/v1/partner-portal/products/EXEMPLE00001",
    headers={
        "Authorization": "Bearer VOTRE_JETON_DE_SESSION",
    },
    timeout=30,
)

print(response.status_code)
print(response.json())

#Example response

HTTP code 200.

{
  "product": {
    "product_id": 4821,
    "token_id": "1029384756",
    "uid_hash": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "product_name": "Sac Modèle A",
    "brand_id": 12,
    "brand_name": "Exemple SAS",
    "category_name": "Maroquinerie",
    "status": "written"
  },
  "passport": {
    "available": true,
    "access_tier": "recycler",
    "passport_version": 3,
    "data": {
      "product_identity": {
        "gtin": "03701234567890",
        "model": "Modèle A",
        "brand": "Exemple SAS",
        "made_in": "FR"
      },
      "materials": {
        "primary": { "name": "Cuir pleine fleur", "percentage": 70, "origin": "IT" },
        "certified_organic": false
      },
      "circularity": {
        "repairability_index": 7.8,
        "expected_lifetime_years": 15,
        "disassembly_instructions_url": "https://exemple-sas.test/demontage/modele-a"
      },
      "compliance": {
        "eu_espr": true,
        "reach": true
      }
    }
  },
  "allowed_event_types": [
    "after_sale_service",
    "maintenance",
    "reconditioning",
    "repair"
  ]
}

The response has three top level fields.

#The product block

status takes one of these values: draft, minting, mined, written, burn_submitted, burned, superseded, archived, stolen, revoked. The superseded and archived states take the product out of the catalog. This endpoint never returns a product in either of those two states, nor a destroyed product.

#The passport block

When the API finds no passport, the block is {"available": false, "access_tier": "public", "passport_version": null, "data": null}. The API returns the rest of the response normally. You can record an intervention on a product with no passport.

Three rules decide the passport returned.

• The API only returns a published passport, in public visibility or in visibility reserved for the owner. It does not return a draft, nor a passport the brand keeps for its internal use.
• The API first looks for the passport belonging to the item you resolved. Failing that, and if the product is attached to a model, it returns the reference passport of that model. An item with no passport of its own is therefore described by the reference of its model. The per unit data you read always concerns the item you resolved.
• When several versions exist, the API returns the highest one.

#The allowed_event_types block

These values are exactly the ones that POST /v1/partner-portal/interventions accepts for this product. That endpoint refuses with a 422 any type absent from this list.

An account holding both active accreditations on the same brand receives the eight values. The API computes this list brand by brand. The same account can therefore receive a different list for a product of another brand.

#Errors

The body of an error response carries a detail field.

#See also

• POST /partner-portal/interventions, record an intervention on a product.
• GET /partner-portal/interventions, list the interventions your account has recorded.
• GET /partner-portal/me, read your partner profile and the brands that have accredited you.