Itemoo API for ERP

Resposta 200 · application/json

object

• brandstring | nullobrigatório
• slugstring | nullobrigatório
• keystringobrigatório
  Name of the API key
• scopesstring[]obrigatório

Exemplo

curl -X GET 'https://itemoo.eu/v1/ping' \
  -H 'Authorization: Bearer itm_YOUR_KEY'

const res = await fetch('https://itemoo.eu/v1/ping', {
  method: 'GET',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY },
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/ping');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY')],
]);
$data = json_decode(curl_exec($ch), true);

Resposta 200 · application/json

Item[]

• skustring | nullobrigatório
  ERP SKU paired with the item; null = not paired yet
• eanstring | nullobrigatório
• catalogNostring | nullobrigatório
• namestringobrigatório
• productstringobrigatório
  Product (page) name
• productSkustringobrigatório
  SKU of the product model that groups the items on one page
• pricenumber | nullobrigatório
  Gross price in the brand currency
• stockinteger | nullobrigatório
  null = stock is not tracked (unlimited sale)
• reservedintegerobrigatório
  Units held by orders not yet acknowledged by the ERP
• availablebooleanobrigatório

Exemplo

curl -X GET 'https://itemoo.eu/v1/items' \
  -H 'Authorization: Bearer itm_YOUR_KEY'

const res = await fetch('https://itemoo.eu/v1/items', {
  method: 'GET',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY },
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/items');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY')],
]);
$data = json_decode(curl_exec($ch), true);

Corpo do pedido application/json

• itemsobject[]obrigatório
  ›Campos

  • skustringobrigatório
    SKU in your ERP
  • catalogNostring
    Catalogue number used to find the item
  • eanstring
    EAN/GTIN used to find the item
  • namestring
    Name in the ERP — helps pairing by hand
  • priceGrossnumber
  • priceNetnumber
  • vatRate"0" | "5" | "8" | "23" | "exempt" | "outside_scope"
    23 | 8 | 5 | 0 | exempt (VAT-exempt) | outside_scope (outside the scope of VAT)
  • pricesobject[]
    Prices in the brand additional markets — never overwritten by exchange-rate recalculation
    ›Campos

    • currencystringobrigatório
    • priceGrossnumber | nullobrigatório
      Gross price in the market currency; null returns the market to the recalculated price
• dryRunboolean
  true = preview, nothing is saved

Resposta 200 · application/json

object

• receivedintegerobrigatório
• alreadyPairedintegerobrigatório
• pairedobject[]obrigatório
  ›Campos

  • skustringobrigatório
  • itemKeystringobrigatório
    Item key in Itemoo
  • by"ean" | "catalogNo"obrigatório
• unmatchedobject[]obrigatório
  ›Campos

  • skustringobrigatório
  • catalogNostring | nullobrigatório
  • eanstring | nullobrigatório
• conflictsobject[]obrigatório
  ›Campos

  • skustringobrigatório
  • reasonstringobrigatório
• appliedbooleanobrigatório
  false for dryRun
• pricesobjectobrigatório
  ›Campos

  • updatedintegerobrigatório
  • errorsobject[]obrigatório
    ›Campos

    • skustringobrigatório
    • reasonstringobrigatório

Exemplo

curl -X PUT 'https://itemoo.eu/v1/items' \
  -H 'Authorization: Bearer itm_YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"items":[{"sku":"KAW-250","ean":"5901234123457"},{"sku":"KAW-1000","catalogNo":"K-1000","priceGross":89.9,"vatRate":"23"}],"dryRun":true}'

const res = await fetch('https://itemoo.eu/v1/items', {
  method: 'PUT',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "items": [
      {
        "sku": "KAW-250",
        "ean": "5901234123457"
      },
      {
        "sku": "KAW-1000",
        "catalogNo": "K-1000",
        "priceGross": 89.9,
        "vatRate": "23"
      }
    ],
    "dryRun": true
  }),
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/items');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY'), 'Content-Type: application/json'],
  CURLOPT_POSTFIELDS => '{"items":[{"sku":"KAW-250","ean":"5901234123457"},{"sku":"KAW-1000","catalogNo":"K-1000","priceGross":89.9,"vatRate":"23"}],"dryRun":true}',
]);
$data = json_decode(curl_exec($ch), true);

Corpo do pedido application/json

• itemsobject[]obrigatório
  ›Campos

  • skustringobrigatório
  • qtyintegerobrigatório

Resposta 200 · application/json

object

• savedintegerobrigatório
• soldOutintegerobrigatório
  Items that became unavailable (stock 0)
• reservedDeductedintegerobrigatório
  Units subtracted for unacknowledged orders
• unknownSkustring[]obrigatório
  Saved, but no item has this SKU yet — takes effect once paired in the panel
• errorsobject[]obrigatório
  ›Campos

  • skustringobrigatório
  • reasonstringobrigatório

Exemplo

curl -X PUT 'https://itemoo.eu/v1/stock' \
  -H 'Authorization: Bearer itm_YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"items":[{"sku":"KAW-250","qty":12},{"sku":"KAW-1000","qty":0}]}'

const res = await fetch('https://itemoo.eu/v1/stock', {
  method: 'PUT',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "items": [
      {
        "sku": "KAW-250",
        "qty": 12
      },
      {
        "sku": "KAW-1000",
        "qty": 0
      }
    ]
  }),
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/stock');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY'), 'Content-Type: application/json'],
  CURLOPT_POSTFIELDS => '{"items":[{"sku":"KAW-250","qty":12},{"sku":"KAW-1000","qty":0}]}',
]);
$data = json_decode(curl_exec($ch), true);

Corpo do pedido application/json

• itemsobject[]obrigatório
  ›Campos

  • skustringobrigatório
  • lotstringobrigatório
  • producedAtstring
    ISO date (YYYY-MM-DD) or date-time
  • expiresAtstring
    ISO date (YYYY-MM-DD) or date-time
  • qtyinteger

Resposta 200 · application/json

object

• createdintegerobrigatório
• updatedintegerobrigatório
• unknownSkustring[]obrigatório
• errorsobject[]obrigatório
  ›Campos

  • skustringobrigatório
  • lotstringobrigatório
  • reasonstringobrigatório

Exemplo

curl -X PUT 'https://itemoo.eu/v1/batches' \
  -H 'Authorization: Bearer itm_YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"items":[{"sku":"KAW-250","lot":"L2026-10","producedAt":"2026-10-01","expiresAt":"2027-10-01","qty":500}]}'

const res = await fetch('https://itemoo.eu/v1/batches', {
  method: 'PUT',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "items": [
      {
        "sku": "KAW-250",
        "lot": "L2026-10",
        "producedAt": "2026-10-01",
        "expiresAt": "2027-10-01",
        "qty": 500
      }
    ]
  }),
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/batches');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY'), 'Content-Type: application/json'],
  CURLOPT_POSTFIELDS => '{"items":[{"sku":"KAW-250","lot":"L2026-10","producedAt":"2026-10-01","expiresAt":"2027-10-01","qty":500}]}',
]);
$data = json_decode(curl_exec($ch), true);

Parâmetros

Resposta 200 · application/json

object

• ordersOrder[]obrigatório
  ›Campos · Order

  • orderNostringobrigatório
  • channelstringobrigatório
    app | site | marketplace:allegro | marketplace:ebay | marketplace:amazon | erp
  • externalobject | nullobrigatório
    The order in the sales channel; null for brand shop orders
    ›Campos

    • orderIdstringobrigatório
    • marketplacestringobrigatório
    • statusstring | nullobrigatório
  • fulfilledBy"merchant" | "marketplace"obrigatório
    marketplace = shipped by the channel warehouse (e.g. FBA) — for bookkeeping only
  • createdAtstring (date-time)obrigatório
  • updatedAtstring (date-time)obrigatório
  • paymentobjectobrigatório
    ›Campos

    • status"pending" | "paid" | "failed" | "expired" | "refunded"obrigatório
    • method"online" | "transfer" | "on_delivery" | "on_pickup" | "deferred" | "marketplace"obrigatório
      online = card/BLIK/wallet in the shop; transfer = bank transfer; on_delivery = cash on delivery; on_pickup = paid at pickup; deferred = B2B deferred payment; marketplace = paid in the sales channel
    • paidAtstring (date-time) | nullobrigatório
    • approval"pending" | "approved" | "rejected" | nullobrigatório
      B2B deferred payment over the limit
  • fulfillment"new" | "packing" | "shipped" | "delivered" | "cancelled"obrigatório
  • acknowledgedAtstring (date-time) | nullobrigatório
    When the ERP acknowledged the order (POST /orders/ack)
  • readyToShipbooleanobrigatório
  • currencystringobrigatório
  • totalnumberobrigatório
  • totalNetnumber | nullobrigatório
  • customerDiscountnumberobrigatório
  • buyerTypestringobrigatório
    consumer | business
  • vatobjectobrigatório
    ›Campos

    • scheme"domestic" | "eu-domestic" | "oss" | "intra-eu" | "export" | "marketplace-collected" | "local"obrigatório
      domestic = seller country VAT; eu-domestic = EU consumer below the OSS threshold (seller country rates); oss = EU consumer, buyer country rates; intra-eu = intra-EU supply to a VAT-registered business, 0%; export = outside the EU, 0%; marketplace-collected = the sales channel collected the buyer country tax; local = VAT of the channel warehouse country
    • collectedByMarketplacenumber | nullobrigatório
    • countrystring | nullobrigatório
    • exportbooleanobrigatório
    • buyerVatIdstring | nullobrigatório
    • viesobject | nullobrigatório
      ›Campos

      • statusstringobrigatório
      • requestIdstring | nullobrigatório
      • checkedAtstring (date-time) | nullobrigatório
  • shippingCostnumberobrigatório
  • discountnumberobrigatório
  • promoCodestring | nullobrigatório
  • promoDiscountnumberobrigatório
  • buyerobjectobrigatório
    ›Campos

    • emailstring | nullobrigatório
    • namestring | nullobrigatório
    • phonestring | nullobrigatório
    • personalDataRemovedbooleanobrigatório
      true = personal data was erased (GDPR or the sales channel retention); amounts and lines stay
  • shippingobjectobrigatório
    ›Campos

    • methodstring | nullobrigatório
    • addressobjectobrigatório
      ›Campos

      • line1string | nullobrigatório
      • line2string | nullobrigatório
      • postalstring | nullobrigatório
      • citystring | nullobrigatório
      • countrystring | nullobrigatório
    • pointobject | nullobrigatório
      Pickup point (code, name, address) when chosen
      ›Campos
  • invoiceobject | nullobrigatório
    Invoice data entered by the buyer (company, taxId, address)
    ›Campos
  • notestring | nullobrigatório
  • carrierstring | nullobrigatório
  • trackingNostring | nullobrigatório
  • invoiceDocumentobject | nullobrigatório
    Invoice attached with PUT /orders/{orderNo}/invoice
    ›Campos

    • numberstringobrigatório
    • ksefNumberstring | nullobrigatório
    • issuedAtstring | nullobrigatório
    • hasPdfbooleanobrigatório
  • itemsOrderLine[]obrigatório
    ›Campos · OrderLine

    • skustring | nullobrigatório
    • catalogNostring | nullobrigatório
    • namestringobrigatório
    • qtynumberobrigatório
    • unitPricenumberobrigatório
    • discountnumberobrigatório
      Promotion and customer discount on the whole line (not per unit)
    • customerDiscountnumberobrigatório
      Part of the discount coming from the B2B customer discount
    • vatRatestring | nullobrigatório
    • vatCountrystring | nullobrigatório
      Country of the VAT rate (OSS: the buyer country)
    • netTotalnumber | nullobrigatório
      Net value of the line after discounts
    • giftbooleanobrigatório
    • lotsobject[]obrigatório
      Batches the line shipped from
      ›Campos

      • lotstringobrigatório
      • qtynumberobrigatório
    • unitsstring[]obrigatório
      Itemoo QR codes of the shipped units
• nextstring (date-time) | nullobrigatório
  Pass as updatedSince to get the next page; null = no more pages

Exemplo

curl -X GET 'https://itemoo.eu/v1/orders?unacknowledged=true&limit=50' \
  -H 'Authorization: Bearer itm_YOUR_KEY'

const res = await fetch('https://itemoo.eu/v1/orders?unacknowledged=true&limit=50', {
  method: 'GET',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY },
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/orders?unacknowledged=true&limit=50');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY')],
]);
$data = json_decode(curl_exec($ch), true);

Parâmetros

Resposta 200 · text/csv, application/xml

Orders file (attachment).

Colunas do ficheiro de encomendas

XML

Exemplo

curl -X GET 'https://itemoo.eu/v1/orders/export?format=csv' \
  -H 'Authorization: Bearer itm_YOUR_KEY'

const res = await fetch('https://itemoo.eu/v1/orders/export?format=csv', {
  method: 'GET',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY },
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/orders/export?format=csv');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY')],
]);
$data = json_decode(curl_exec($ch), true);

Corpo do pedido application/json

• orderNosstring[]obrigatório

Resposta 200 · application/json

object

• acknowledgedintegerobrigatório
• unknownstring[]obrigatório
  Order numbers that do not exist in the brand

Exemplo

curl -X POST 'https://itemoo.eu/v1/orders/ack' \
  -H 'Authorization: Bearer itm_YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"orderNos":["ITM-2026-000123"]}'

const res = await fetch('https://itemoo.eu/v1/orders/ack', {
  method: 'POST',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "orderNos": [
      "ITM-2026-000123"
    ]
  }),
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/orders/ack');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY'), 'Content-Type: application/json'],
  CURLOPT_POSTFIELDS => '{"orderNos":["ITM-2026-000123"]}',
]);
$data = json_decode(curl_exec($ch), true);

Parâmetros

Corpo do pedido application/json

• itemsobject[]obrigatório
  ›Campos

  • skustringobrigatório
  • lotstringobrigatório
  • qtyinteger
    The whole line quantity by default

Resposta 200 · application/json

object

• savedintegerobrigatório
• errorsstring[]obrigatório
  Rows that were skipped, as human-readable messages

Exemplo

curl -X PUT 'https://itemoo.eu/v1/orders/ITM-2026-000123/lots' \
  -H 'Authorization: Bearer itm_YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"items":[{"sku":"KAW-250","lot":"L2026-10","qty":2}]}'

const res = await fetch('https://itemoo.eu/v1/orders/ITM-2026-000123/lots', {
  method: 'PUT',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "items": [
      {
        "sku": "KAW-250",
        "lot": "L2026-10",
        "qty": 2
      }
    ]
  }),
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/orders/ITM-2026-000123/lots');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY'), 'Content-Type: application/json'],
  CURLOPT_POSTFIELDS => '{"items":[{"sku":"KAW-250","lot":"L2026-10","qty":2}]}',
]);
$data = json_decode(curl_exec($ch), true);

Parâmetros

Corpo do pedido application/json

• itemsobject[]obrigatório
  ›Campos

  • skustringobrigatório
  • codesstring[]obrigatório
    Itemoo QR codes; an empty list removes the units

Resposta 200 · application/json

object

• savedintegerobrigatório
• errorsstring[]obrigatório
  Rows that were skipped, as human-readable messages

Exemplo

curl -X PUT 'https://itemoo.eu/v1/orders/ITM-2026-000123/units' \
  -H 'Authorization: Bearer itm_YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"items":[{"sku":"KAW-250","codes":["U7K2M9QX"]}]}'

const res = await fetch('https://itemoo.eu/v1/orders/ITM-2026-000123/units', {
  method: 'PUT',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "items": [
      {
        "sku": "KAW-250",
        "codes": [
          "U7K2M9QX"
        ]
      }
    ]
  }),
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/orders/ITM-2026-000123/units');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY'), 'Content-Type: application/json'],
  CURLOPT_POSTFIELDS => '{"items":[{"sku":"KAW-250","codes":["U7K2M9QX"]}]}',
]);
$data = json_decode(curl_exec($ch), true);

Parâmetros

Corpo do pedido application/json

• numberstringobrigatório
• ksefNumberstring
• issuedAtstring
  ISO date (YYYY-MM-DD) or date-time
• pdfBase64string
  PDF file as base64 — the whole request is limited to 2 MB, so about 1.4 MB of PDF
• notifyCustomerboolean
  false = no email to the customer

Resposta 200 · application/json

object

• numberstringobrigatório
• ksefNumberstring | nullobrigatório
• issuedAtstring (date-time)obrigatório
• hasPdfbooleanobrigatório
• notifiedbooleanobrigatório
  The customer got an email with the invoice

Exemplo

curl -X PUT 'https://itemoo.eu/v1/orders/ITM-2026-000123/invoice' \
  -H 'Authorization: Bearer itm_YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"number":"FV/2026/10/123","issuedAt":"2026-10-16"}'

const res = await fetch('https://itemoo.eu/v1/orders/ITM-2026-000123/invoice', {
  method: 'PUT',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "number": "FV/2026/10/123",
    "issuedAt": "2026-10-16"
  }),
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/orders/ITM-2026-000123/invoice');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY'), 'Content-Type: application/json'],
  CURLOPT_POSTFIELDS => '{"number":"FV/2026/10/123","issuedAt":"2026-10-16"}',
]);
$data = json_decode(curl_exec($ch), true);

Parâmetros

Corpo do pedido application/json

• status"packing" | "shipped" | "delivered" | "cancelled"obrigatório
• carrierstring
• trackingNostring
• reasonstring
  Cancellation reason shown to the customer
• lotsobject[]
  Batches shipped, like PUT /orders/{orderNo}/lots
  ›Campos

  • skustringobrigatório
  • lotstringobrigatório
  • qtyinteger
    The whole line quantity by default

Resposta 200 · application/json

OrderAfterStatusChange

• orderNostringobrigatório
• channelstringobrigatório
  app | site | marketplace:allegro | marketplace:ebay | marketplace:amazon | erp
• externalobject | nullobrigatório
  The order in the sales channel; null for brand shop orders
  ›Campos

  • orderIdstringobrigatório
  • marketplacestringobrigatório
  • statusstring | nullobrigatório
• fulfilledBy"merchant" | "marketplace"obrigatório
  marketplace = shipped by the channel warehouse (e.g. FBA) — for bookkeeping only
• createdAtstring (date-time)obrigatório
• updatedAtstring (date-time)obrigatório
• paymentobjectobrigatório
  ›Campos

  • status"pending" | "paid" | "failed" | "expired" | "refunded"obrigatório
  • method"online" | "transfer" | "on_delivery" | "on_pickup" | "deferred" | "marketplace"obrigatório
    online = card/BLIK/wallet in the shop; transfer = bank transfer; on_delivery = cash on delivery; on_pickup = paid at pickup; deferred = B2B deferred payment; marketplace = paid in the sales channel
  • paidAtstring (date-time) | nullobrigatório
  • approval"pending" | "approved" | "rejected" | nullobrigatório
    B2B deferred payment over the limit
• fulfillment"new" | "packing" | "shipped" | "delivered" | "cancelled"obrigatório
• acknowledgedAtstring (date-time) | nullobrigatório
  When the ERP acknowledged the order (POST /orders/ack)
• readyToShipbooleanobrigatório
• currencystringobrigatório
• totalnumberobrigatório
• totalNetnumber | nullobrigatório
• customerDiscountnumberobrigatório
• buyerTypestringobrigatório
  consumer | business
• vatobjectobrigatório
  ›Campos

  • scheme"domestic" | "eu-domestic" | "oss" | "intra-eu" | "export" | "marketplace-collected" | "local"obrigatório
    domestic = seller country VAT; eu-domestic = EU consumer below the OSS threshold (seller country rates); oss = EU consumer, buyer country rates; intra-eu = intra-EU supply to a VAT-registered business, 0%; export = outside the EU, 0%; marketplace-collected = the sales channel collected the buyer country tax; local = VAT of the channel warehouse country
  • collectedByMarketplacenumber | nullobrigatório
  • countrystring | nullobrigatório
  • exportbooleanobrigatório
  • buyerVatIdstring | nullobrigatório
  • viesobject | nullobrigatório
    ›Campos

    • statusstringobrigatório
    • requestIdstring | nullobrigatório
    • checkedAtstring (date-time) | nullobrigatório
• shippingCostnumberobrigatório
• discountnumberobrigatório
• promoCodestring | nullobrigatório
• promoDiscountnumberobrigatório
• buyerobjectobrigatório
  ›Campos

  • emailstring | nullobrigatório
  • namestring | nullobrigatório
  • phonestring | nullobrigatório
  • personalDataRemovedbooleanobrigatório
    true = personal data was erased (GDPR or the sales channel retention); amounts and lines stay
• shippingobjectobrigatório
  ›Campos

  • methodstring | nullobrigatório
  • addressobjectobrigatório
    ›Campos

    • line1string | nullobrigatório
    • line2string | nullobrigatório
    • postalstring | nullobrigatório
    • citystring | nullobrigatório
    • countrystring | nullobrigatório
  • pointobject | nullobrigatório
    Pickup point (code, name, address) when chosen
    ›Campos
• invoiceobject | nullobrigatório
  Invoice data entered by the buyer (company, taxId, address)
  ›Campos
• notestring | nullobrigatório
• carrierstring | nullobrigatório
• trackingNostring | nullobrigatório
• invoiceDocumentobject | nullobrigatório
  Invoice attached with PUT /orders/{orderNo}/invoice
  ›Campos

  • numberstringobrigatório
  • ksefNumberstring | nullobrigatório
  • issuedAtstring | nullobrigatório
  • hasPdfbooleanobrigatório
• itemsOrderLine[]obrigatório
  ›Campos · OrderLine

  • skustring | nullobrigatório
  • catalogNostring | nullobrigatório
  • namestringobrigatório
  • qtynumberobrigatório
  • unitPricenumberobrigatório
  • discountnumberobrigatório
    Promotion and customer discount on the whole line (not per unit)
  • customerDiscountnumberobrigatório
    Part of the discount coming from the B2B customer discount
  • vatRatestring | nullobrigatório
  • vatCountrystring | nullobrigatório
    Country of the VAT rate (OSS: the buyer country)
  • netTotalnumber | nullobrigatório
    Net value of the line after discounts
  • giftbooleanobrigatório
  • lotsobject[]obrigatório
    Batches the line shipped from
    ›Campos

    • lotstringobrigatório
    • qtynumberobrigatório
  • unitsstring[]obrigatório
    Itemoo QR codes of the shipped units
• unchangedtrue
  The same status was sent again — nothing changed, no email

Exemplo

curl -X PUT 'https://itemoo.eu/v1/orders/ITM-2026-000123' \
  -H 'Authorization: Bearer itm_YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"status":"shipped","carrier":"InPost","trackingNo":"6200000000000000"}'

const res = await fetch('https://itemoo.eu/v1/orders/ITM-2026-000123', {
  method: 'PUT',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "status": "shipped",
    "carrier": "InPost",
    "trackingNo": "6200000000000000"
  }),
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/orders/ITM-2026-000123');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY'), 'Content-Type: application/json'],
  CURLOPT_POSTFIELDS => '{"status":"shipped","carrier":"InPost","trackingNo":"6200000000000000"}',
]);
$data = json_decode(curl_exec($ch), true);

Parâmetros

Resposta 200 · application/json

BrandPassport

• level"public" | "legit" | "authority"obrigatório
• recipientstring
  Name of the access grant used
• versionPassportVersion | nullobrigatório
  ›Campos · PassportVersion

  • hashstringobrigatório
    SHA-256 of the canonical (RFC 8785) composition of layer versions and the unit event chain head
  • layersobject[]obrigatório
    ›Campos

    • subject"product" | "variant" | "batch" | "unit"obrigatório
    • versionintegerobrigatório
    • hashstringobrigatório
  • eventsHeadstring | nullobrigatório
  • atstring (date-time)
    Present for a passport read at a point in time (?at=)
• backupobject | nullobrigatório
  Backup copy of the passport kept by a DPP service provider (Regulation (EU) 2024/1781 Annex III point (l)), when the brand designated one
  ›Campos

  • providerstringobrigatório
  • urlstringobrigatório
• identityProductIdentityobrigatório
  ›Campos · ProductIdentity

  • codestringobrigatório
    Itemoo code from the QR label
  • level"unit" | "batch" | "variant" | "model"obrigatório
  • gtinstring | nullobrigatório
  • skustring | nullobrigatório
  • variantobject
    ›Campos

    • labelstringobrigatório
    • catalogNostring | nullobrigatório
  • lotstring | nullobrigatório
  • serialstring | nullobrigatório
  • expiresAtstring (date-time) | nullobrigatório
  • statusstringobrigatório
    Batch status: ACTIVE | RECALLED | …
  • uniqueProductIdentifierstringobrigatório
    Unique product identifier of this code (EN 18219:2026): GS1 Digital Link with the batch and serial number of the code level, or the code address /q/{code} without a GTIN
• productProductSummaryobrigatório
  ›Campos · ProductSummary

  • namestringobrigatório
  • brandstringobrigatório
  • category"chemicals" | "cosmetics" | "medical" | "food" | "supplements" | "electronics" | "appliances" | "batteries" | "textiles" | "furniture" | "toys" | "construction" | "other" | nullobrigatório
    Regulatory product type — decides the mandatory information: chemicals | cosmetics | medical | food | supplements | electronics | appliances | batteries | textiles | furniture | toys | construction | other
  • descriptionstringobrigatório
  • imagestring
  • translationsobject
    Name and description in every language the brand provides (ISO 639-1 code → text); name and description above are in the language of the response
    ›Campos

    • namemap<string, string>obrigatório
    • descriptionmap<string, string>obrigatório
• manufacturerEconomicOperator | nullobrigatório
  ›Campos · EconomicOperator

  • namestringobrigatório
  • addressobjectobrigatório
    ›Campos

    • streetstring | nullobrigatório
    • postalCodestring | nullobrigatório
    • citystring | nullobrigatório
    • countrystring | nullobrigatório
      ISO 3166-1 alpha-2
  • emailstring | nullobrigatório
  • phonestring | nullobrigatório
    Shown only at the access level the brand chose for it (default: persons with a legitimate interest)
  • source"company" | "registry"obrigatório
    company = the brand company data; registry = an operator from the company operator register designated in the passport
  • tradeNamestring | null
    Registered trade name or trade mark (Regulation (EU) 2024/1781 Art. 27(6), 29(3))
  • identifiersobject[]
    Unique operator or facility identifiers (Regulation (EU) 2024/1781 Annex III points (g)–(k), Art. 12; EN 18219:2026 Clause 6 — ISO/IEC 6523 or ISO/IEC 15459)
    ›Campos

    • scheme"gln" | "duns" | "lei" | "vat" | "iso15459"obrigatório
      gln = GS1 GLN, duns = D-U-N-S, lei = Legal Entity Identifier (ISO 17442), vat = EU VAT number with country prefix, iso15459 = identifier of another ISO/IEC 15459 issuing agency
    • iacstring
      Issuing agency code (ISO/IEC 15459-2 register): 0–9 for GS1, UN for D&B, otherwise the registered agency code; absent for lei and vat
    • valuestringobrigatório
  • eoristring | null
    EORI number (importer, Annex III point (j)) — shown only at the access level the brand chose for it (default: legitimate interest)
• responsiblePersonEconomicOperator | nullobrigatório
  ›Campos · EconomicOperator

  • namestringobrigatório
  • addressobjectobrigatório
    ›Campos

    • streetstring | nullobrigatório
    • postalCodestring | nullobrigatório
    • citystring | nullobrigatório
    • countrystring | nullobrigatório
      ISO 3166-1 alpha-2
  • emailstring | nullobrigatório
  • phonestring | nullobrigatório
    Shown only at the access level the brand chose for it (default: persons with a legitimate interest)
  • source"company" | "registry"obrigatório
    company = the brand company data; registry = an operator from the company operator register designated in the passport
  • tradeNamestring | null
    Registered trade name or trade mark (Regulation (EU) 2024/1781 Art. 27(6), 29(3))
  • identifiersobject[]
    Unique operator or facility identifiers (Regulation (EU) 2024/1781 Annex III points (g)–(k), Art. 12; EN 18219:2026 Clause 6 — ISO/IEC 6523 or ISO/IEC 15459)
    ›Campos

    • scheme"gln" | "duns" | "lei" | "vat" | "iso15459"obrigatório
      gln = GS1 GLN, duns = D-U-N-S, lei = Legal Entity Identifier (ISO 17442), vat = EU VAT number with country prefix, iso15459 = identifier of another ISO/IEC 15459 issuing agency
    • iacstring
      Issuing agency code (ISO/IEC 15459-2 register): 0–9 for GS1, UN for D&B, otherwise the registered agency code; absent for lei and vat
    • valuestringobrigatório
  • eoristring | null
    EORI number (importer, Annex III point (j)) — shown only at the access level the brand chose for it (default: legitimate interest)
• importerEconomicOperator | nullobrigatório
  ›Campos · EconomicOperator

  • namestringobrigatório
  • addressobjectobrigatório
    ›Campos

    • streetstring | nullobrigatório
    • postalCodestring | nullobrigatório
    • citystring | nullobrigatório
    • countrystring | nullobrigatório
      ISO 3166-1 alpha-2
  • emailstring | nullobrigatório
  • phonestring | nullobrigatório
    Shown only at the access level the brand chose for it (default: persons with a legitimate interest)
  • source"company" | "registry"obrigatório
    company = the brand company data; registry = an operator from the company operator register designated in the passport
  • tradeNamestring | null
    Registered trade name or trade mark (Regulation (EU) 2024/1781 Art. 27(6), 29(3))
  • identifiersobject[]
    Unique operator or facility identifiers (Regulation (EU) 2024/1781 Annex III points (g)–(k), Art. 12; EN 18219:2026 Clause 6 — ISO/IEC 6523 or ISO/IEC 15459)
    ›Campos

    • scheme"gln" | "duns" | "lei" | "vat" | "iso15459"obrigatório
      gln = GS1 GLN, duns = D-U-N-S, lei = Legal Entity Identifier (ISO 17442), vat = EU VAT number with country prefix, iso15459 = identifier of another ISO/IEC 15459 issuing agency
    • iacstring
      Issuing agency code (ISO/IEC 15459-2 register): 0–9 for GS1, UN for D&B, otherwise the registered agency code; absent for lei and vat
    • valuestringobrigatório
  • eoristring | null
    EORI number (importer, Annex III point (j)) — shown only at the access level the brand chose for it (default: legitimate interest)
• authorisedRepresentativeEconomicOperator | nullobrigatório
  ›Campos · EconomicOperator

  • namestringobrigatório
  • addressobjectobrigatório
    ›Campos

    • streetstring | nullobrigatório
    • postalCodestring | nullobrigatório
    • citystring | nullobrigatório
    • countrystring | nullobrigatório
      ISO 3166-1 alpha-2
  • emailstring | nullobrigatório
  • phonestring | nullobrigatório
    Shown only at the access level the brand chose for it (default: persons with a legitimate interest)
  • source"company" | "registry"obrigatório
    company = the brand company data; registry = an operator from the company operator register designated in the passport
  • tradeNamestring | null
    Registered trade name or trade mark (Regulation (EU) 2024/1781 Art. 27(6), 29(3))
  • identifiersobject[]
    Unique operator or facility identifiers (Regulation (EU) 2024/1781 Annex III points (g)–(k), Art. 12; EN 18219:2026 Clause 6 — ISO/IEC 6523 or ISO/IEC 15459)
    ›Campos

    • scheme"gln" | "duns" | "lei" | "vat" | "iso15459"obrigatório
      gln = GS1 GLN, duns = D-U-N-S, lei = Legal Entity Identifier (ISO 17442), vat = EU VAT number with country prefix, iso15459 = identifier of another ISO/IEC 15459 issuing agency
    • iacstring
      Issuing agency code (ISO/IEC 15459-2 register): 0–9 for GS1, UN for D&B, otherwise the registered agency code; absent for lei and vat
    • valuestringobrigatório
  • eoristring | null
    EORI number (importer, Annex III point (j)) — shown only at the access level the brand chose for it (default: legitimate interest)
• facilityEconomicOperator | nullobrigatório
  ›Campos · EconomicOperator

  • namestringobrigatório
  • addressobjectobrigatório
    ›Campos

    • streetstring | nullobrigatório
    • postalCodestring | nullobrigatório
    • citystring | nullobrigatório
    • countrystring | nullobrigatório
      ISO 3166-1 alpha-2
  • emailstring | nullobrigatório
  • phonestring | nullobrigatório
    Shown only at the access level the brand chose for it (default: persons with a legitimate interest)
  • source"company" | "registry"obrigatório
    company = the brand company data; registry = an operator from the company operator register designated in the passport
  • tradeNamestring | null
    Registered trade name or trade mark (Regulation (EU) 2024/1781 Art. 27(6), 29(3))
  • identifiersobject[]
    Unique operator or facility identifiers (Regulation (EU) 2024/1781 Annex III points (g)–(k), Art. 12; EN 18219:2026 Clause 6 — ISO/IEC 6523 or ISO/IEC 15459)
    ›Campos

    • scheme"gln" | "duns" | "lei" | "vat" | "iso15459"obrigatório
      gln = GS1 GLN, duns = D-U-N-S, lei = Legal Entity Identifier (ISO 17442), vat = EU VAT number with country prefix, iso15459 = identifier of another ISO/IEC 15459 issuing agency
    • iacstring
      Issuing agency code (ISO/IEC 15459-2 register): 0–9 for GS1, UN for D&B, otherwise the registered agency code; absent for lei and vat
    • valuestringobrigatório
  • eoristring | null
    EORI number (importer, Annex III point (j)) — shown only at the access level the brand chose for it (default: legitimate interest)
• languagestringobrigatório
• publishedbooleanobrigatório
• recallRecall | nullobrigatório
  ›Campos · Recall

  • activetrueobrigatório
  • certainbooleanobrigatório
    true = this exact code is recalled; false = the batch is unknown and may be affected
  • scope"product" | "batch" | "lotRange"obrigatório
    product = the whole product; batch = one batch; lotRange = a range of batch numbers (lotFrom–lotTo)
  • reasonstringobrigatório
  • instructionsstring | nullobrigatório
  • lotFromstring | nullobrigatório
  • lotTostring | nullobrigatório
  • kind"recall" | "notice"
    recall = the product is recalled; notice = safety notice, the product is not withdrawn
• factsProvenanceFact[]obrigatório
  ›Campos · ProvenanceFact

  • keystring
    Stable English key of a standard fact (origin, materials, battery.capacityAh, chemical.ufi, …); absent for parameters defined by the brand — match on it, not on the translated name
  • namestringobrigatório
    Fact name in the response language
  • valuestringobrigatório
  • provenanceobject
    ›Campos

    • sourcestringobrigatório
      Document or block the fact comes from
    • versionstring
    • documentUrlstring
    • assertedBystringobrigatório
      Brand that published the fact
    • assertedAtstring
• documentsDocument[]obrigatório
  ›Campos · Document

  • titlestringobrigatório
  • urlstringobrigatório
  • kindstringobrigatório
    certificate | declaration | repair | dpp | manual | sds | …
  • versionstring
  • accessstring
    public | legit | authority — present on documents beyond the public level
  • docIdstring
    Library document identifier — the same as in { docId } values of document fields
  • languagestring
    Language of the file (ISO 639-1 code, e.g. de), set by the brand at the document version; absent — multilingual file or not specified
• componentsPassportComponent[]obrigatório
  Components with their own passport visible at this level (Regulation (EU) 2024/1781 Art. 2(4); CIRPASS-2 D4.1 recommendation 5)
  ›Campos · PassportComponent

  • codestring | nullobrigatório
    Itemoo code of the component passport (unit, batch, variant or model — also of another brand)
  • uristring | nullobrigatório
    Address of a component passport outside Itemoo (DPP URL or GS1 Digital Link)
  • urlstringobrigatório
    Where to read the component passport
  • rolestring | nullobrigatório
  • nameanyobrigatório
  • quantitynumber | nullobrigatório
  • unitstring | nullobrigatório
  • level"model" | "unit"obrigatório
    model — bill of components of the model; unit — installed in this unit (assembly events)
  • sincestring | nullobrigatório
    When the component was installed in this unit
• lifecycleobjectobrigatório
  Lifecycle status of the passport: recalled — an active recall covers the code (a safety notice does not); end_of_life — the unit was recycled or became waste; archived — the brand left Itemoo and the passport is kept read-only; closed — the brand closed the passport after the product was placed on the market (the passport shows the state as of the closing date, since). A passport is never deleted: removal is a status (CIRPASS-2 D4.1 recommendation 3); a retired code answers 410
  ›Campos

  • status"active" | "recalled" | "end_of_life" | "archived" | "closed"obrigatório
  • sincestring (date-time) | nullobrigatório
• modelobjectobrigatório
  Model passport fields visible at this level
• unitobject | nullobrigatório
  ›Campos

  • serialstring | nullobrigatório
  • dataobjectobrigatório
  • stateobjectobrigatório
    ›Campos

    • statusstring | nullobrigatório
      original | repurposed | re-used | remanufactured | waste | recycled (Regulation (EU) 2023/1542 Annex XIII point 4(c); recycled ends the passport). null — not visible at this access level (a battery status is for persons with a legitimate interest only)
    • sohnumber | nullobrigatório
      State of health, 0–100 (SoH, or SOCE / remaining capacity when only that is recorded)
    • sohAtstring (date-time) | nullobrigatório
    • cyclesnumber | nullobrigatório
    • incidentsintegerobrigatório
  • historyobject[]obrigatório
    ›Campos

    • kindstringobrigatório
    • dataanyobrigatório
    • occurredAtstring (date-time)obrigatório
    • sourcestring
  • linksobjectobrigatório
    ›Campos

    • predecessorobject | nullobrigatório
      Passport before remanufacturing or repurposing (Art. 77(7))
      ›Campos

      • codestringobrigatório
      • urlstringobrigatório
    • successorsobject[]obrigatório
      New passports created from this battery
      ›Campos

      • codestringobrigatório
      • urlstringobrigatório
  • custodianobject | nullobrigatório
    Operator responsible for the passport of a waste battery after a transfer (producer, PRO or waste management operator — Art. 77(7))
    ›Campos

    • namestringobrigatório
    • rolestringobrigatório
    • sincestring (date-time)obrigatório
• fieldsobjectobrigatório
  Editable fields with their access levels, per layer
  ›Campos

  • modelmap<string, object>obrigatório
    ›Campos

    • valueanyobrigatório
    • access"public" | "legit" | "authority"obrigatório
  • variantmap<string, object> | nullobrigatório
    Variant layer (overrides the model)
    ›Campos

    • valueanyobrigatório
    • access"public" | "legit" | "authority"obrigatório
  • batchmap<string, object> | nullobrigatório
    Batch layer (inherited by units)
    ›Campos

    • valueanyobrigatório
    • access"public" | "legit" | "authority"obrigatório
  • unitmap<string, object> | nullobrigatório
    ›Campos

    • valueanyobrigatório
    • access"public" | "legit" | "authority"obrigatório
• unitMetaobject | nullobrigatório
  Unit dates: code activation and placing on the market; predecessor passport code
  ›Campos

  • statusstringobrigatório
  • activatedAtstring (date-time) | nullobrigatório
  • placedOnMarketAtstring (date-time) | nullobrigatório
  • predecessorCodestring | nullobrigatório
• versionsany[]obrigatório
  Version history of all layers with pseudonymous authors (see the public PassportHistory)
• chainmap<string, integer | null>obrigatório
  Per layer: number of the first version whose hash does not verify, null = intact

Exemplo

curl -X GET 'https://itemoo.eu/v1/passport/A1B2C3D4' \
  -H 'Authorization: Bearer itm_YOUR_KEY'

const res = await fetch('https://itemoo.eu/v1/passport/A1B2C3D4', {
  method: 'GET',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY },
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/passport/A1B2C3D4');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY')],
]);
$data = json_decode(curl_exec($ch), true);

Parâmetros

Resposta 200 · application/ld+json

object

• @contextstringobrigatório
• idstringobrigatório
• type"Product"obrigatório
• passportobjectobrigatório
  ›Campos

  • type"DigitalProductPassport"obrigatório

Exemplo

curl -X GET 'https://itemoo.eu/v1/passport/A1B2C3D4/dpp.jsonld' \
  -H 'Authorization: Bearer itm_YOUR_KEY'

const res = await fetch('https://itemoo.eu/v1/passport/A1B2C3D4/dpp.jsonld', {
  method: 'GET',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY },
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/passport/A1B2C3D4/dpp.jsonld');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY')],
]);
$data = json_decode(curl_exec($ch), true);

Parâmetros

Resposta 200 · application/json

PassportHistory

• codestringobrigatório
• level"public" | "legit" | "authority"obrigatório
• versionPassportVersion | nullobrigatório
  ›Campos · PassportVersion

  • hashstringobrigatório
    SHA-256 of the canonical (RFC 8785) composition of layer versions and the unit event chain head
  • layersobject[]obrigatório
    ›Campos

    • subject"product" | "variant" | "batch" | "unit"obrigatório
    • versionintegerobrigatório
    • hashstringobrigatório
  • eventsHeadstring | nullobrigatório
  • atstring (date-time)
    Present for a passport read at a point in time (?at=)
• versionsobject[]obrigatório
  ›Campos

  • subject"product" | "variant" | "batch" | "unit"obrigatório
  • versionintegerobrigatório
  • hashstringobrigatório
  • prevHashstring | nullobrigatório
  • atstring (date-time)obrigatório
  • sourcestringobrigatório
  • changesobject[]obrigatório
    ›Campos

    • keystringobrigatório
    • op"add" | "change" | "remove"obrigatório
    • valueany
    • redactedboolean
  • leavesmap<string, object>
    Leaf hashes (authority level only) to recompute the version hash
    ›Campos

    • hstringobrigatório
    • access"public" | "legit" | "authority"obrigatório

Exemplo

curl -X GET 'https://itemoo.eu/v1/passport/A1B2C3D4/history' \
  -H 'Authorization: Bearer itm_YOUR_KEY'

const res = await fetch('https://itemoo.eu/v1/passport/A1B2C3D4/history', {
  method: 'GET',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY },
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/passport/A1B2C3D4/history');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY')],
]);
$data = json_decode(curl_exec($ch), true);

Parâmetros

Resposta 200 · application/json

object

• itemsobject[]obrigatório
  ›Campos

  • @contextstringobrigatório
  • idstringobrigatório
• cursorstring | nullobrigatório
  The cursor of the next page, null on the last one

Exemplo

curl -X GET 'https://itemoo.eu/v1/passport/export' \
  -H 'Authorization: Bearer itm_YOUR_KEY'

const res = await fetch('https://itemoo.eu/v1/passport/export', {
  method: 'GET',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY },
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/passport/export');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY')],
]);
$data = json_decode(curl_exec($ch), true);

Parâmetros

Corpo do pedido application/json

• fieldsmap<string, any | object>obrigatório
  { key: value } or { key: { value, access } }; value null removes the field
  ›Campos

  • valueanyobrigatório
  • access"public" | "legit" | "authority"

Resposta 200 · application/json

object

• productIdstringobrigatório
• skustring | nullobrigatório
• fieldsmap<string, object>obrigatório
  ›Campos

  • valueanyobrigatório
  • access"public" | "legit" | "authority"obrigatório

Exemplo

curl -X PUT 'https://itemoo.eu/v1/passport/products/AKU-100' \
  -H 'Authorization: Bearer itm_YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"fields":{"chemistry":{"value":"LFP","access":"public"},"cathodeSupplier":"ACME"}}'

const res = await fetch('https://itemoo.eu/v1/passport/products/AKU-100', {
  method: 'PUT',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "fields": {
      "chemistry": {
        "value": "LFP",
        "access": "public"
      },
      "cathodeSupplier": "ACME"
    }
  }),
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/passport/products/AKU-100');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY'), 'Content-Type: application/json'],
  CURLOPT_POSTFIELDS => '{"fields":{"chemistry":{"value":"LFP","access":"public"},"cathodeSupplier":"ACME"}}',
]);
$data = json_decode(curl_exec($ch), true);

Corpo do pedido application/json

• itemsobject[]obrigatório
  ›Campos

  • codestring
    Itemoo code of the unit — or sku + serial
  • skustring
  • serialstring
  • datamap<string, any | object>
    Unit fields; battery passport keys (battery.*) follow the field dictionary and have a fixed access level
    ›Campos

    • valueanyobrigatório
    • access"public" | "legit" | "authority"
  • placedOnMarketAtstring | null
    Date the unit was placed on the market (YYYY-MM-DD), null clears it. A unit placed on the market after a field set takes effect must have a complete passport

Resposta 200 · application/json

object

• receivedintegerobrigatório
• savedintegerobrigatório
• unknownstring[]obrigatório
• errorsobject[]obrigatório
  ›Campos

  • rowintegerobrigatório
  • codestringobrigatório

Exemplo

curl -X PUT 'https://itemoo.eu/v1/passport/units' \
  -H 'Authorization: Bearer itm_YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"items":[{"sku":"AKU-100","serial":"SN-0001","data":{"cellLot":"C-77"}}]}'

const res = await fetch('https://itemoo.eu/v1/passport/units', {
  method: 'PUT',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "items": [
      {
        "sku": "AKU-100",
        "serial": "SN-0001",
        "data": {
          "cellLot": "C-77"
        }
      }
    ]
  }),
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/passport/units');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY'), 'Content-Type: application/json'],
  CURLOPT_POSTFIELDS => '{"items":[{"sku":"AKU-100","serial":"SN-0001","data":{"cellLot":"C-77"}}]}',
]);
$data = json_decode(curl_exec($ch), true);

Parâmetros

Corpo do pedido application/json

• kind"status" | "soh" | "cycles" | "incident" | "temperature" | "soc" | "data" | "assembly"obrigatório
  assembly — component with its own passport installed or removed: data { action: install | remove, code (Itemoo code) or uri (https passport address), role? }
• dataobjectobrigatório
• occurredAtstring (date-time)
  Not in the future; now by default
• access"public" | "legit" | "authority"
  public for status by default, legit otherwise

Resposta 200 · application/json

object

• idstringobrigatório
• codestringobrigatório
• kindstringobrigatório
• dataanyobrigatório
• accessstringobrigatório
• occurredAtstring (date-time)obrigatório
• hashstring | nullobrigatório
  SHA-256 of the event chained with the previous one (RFC 8785)

Exemplo

curl -X POST 'https://itemoo.eu/v1/passport/units/U7K2M9QX/events' \
  -H 'Authorization: Bearer itm_YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"kind":"soh","data":{"soh":96}}'

const res = await fetch('https://itemoo.eu/v1/passport/units/U7K2M9QX/events', {
  method: 'POST',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "kind": "soh",
    "data": {
      "soh": 96
    }
  }),
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/passport/units/U7K2M9QX/events');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY'), 'Content-Type: application/json'],
  CURLOPT_POSTFIELDS => '{"kind":"soh","data":{"soh":96}}',
]);
$data = json_decode(curl_exec($ch), true);

Parâmetros

Resposta 200 · application/json

object

Exemplo

curl -X GET 'https://itemoo.eu/v1/drafts/products/KAW-250/page' \
  -H 'Authorization: Bearer itm_YOUR_KEY'

const res = await fetch('https://itemoo.eu/v1/drafts/products/KAW-250/page', {
  method: 'GET',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY },
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/drafts/products/KAW-250/page');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY')],
]);
$data = json_decode(curl_exec($ch), true);

Parâmetros

Corpo do pedido application/json

• draftRevisionstringobrigatório
  draftRevision from the last read; if the draft changed since, the call fails with draftConflict — read again
• operationsobject[]obrigatório
  Operations applied in order; indexes refer to the page after the previous operations
• dryRunboolean
  Default true: nothing is saved — the result shows what would change and a planToken. Ask the user, then call again with the SAME arguments, dryRun: false and that planToken.
• planTokenstring
  planToken from the preview of exactly these arguments (required with dryRun: false, valid 10 minutes)

Resposta 200 · application/json

object

Exemplo

curl -X PUT 'https://itemoo.eu/v1/drafts/products/KAW-250/page' \
  -H 'Authorization: Bearer itm_YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"draftRevision":"0123456789abcdef","operations":[{"op":"set","path":"2.lead","value":"Medium roast, notes of cocoa."}],"dryRun":true}'

const res = await fetch('https://itemoo.eu/v1/drafts/products/KAW-250/page', {
  method: 'PUT',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "draftRevision": "0123456789abcdef",
    "operations": [
      {
        "op": "set",
        "path": "2.lead",
        "value": "Medium roast, notes of cocoa."
      }
    ],
    "dryRun": true
  }),
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/drafts/products/KAW-250/page');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY'), 'Content-Type: application/json'],
  CURLOPT_POSTFIELDS => '{"draftRevision":"0123456789abcdef","operations":[{"op":"set","path":"2.lead","value":"Medium roast, notes of cocoa."}],"dryRun":true}',
]);
$data = json_decode(curl_exec($ch), true);

Corpo do pedido application/json

• productsobject[]obrigatório
  ›Campos

  • namestringobrigatório
    Product name
  • skustringobrigatório
    SKU — unique in the brand
  • categorystringobrigatório
    Product category key (e.g. "chemicals")
  • gtinstring
    GTIN / EAN (8–14 digits)
  • operationsobject[]
    Optional text operations on the starting page (as in product_page_draft_patch)
• langstring
  Language of the texts (two letters); default: the brand default language. Texts in other languages are marked as machine-written for review
• dryRunboolean
  Default true: nothing is saved — the result shows what would change and a planToken. Ask the user, then call again with the SAME arguments, dryRun: false and that planToken.
• planTokenstring
  planToken from the preview of exactly these arguments (required with dryRun: false, valid 10 minutes)

Resposta 200 · application/json

object

Exemplo

curl -X POST 'https://itemoo.eu/v1/drafts/products' \
  -H 'Authorization: Bearer itm_YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"products":[{"name":"Coffee 250 g","sku":"KAW-250","category":"food"}],"dryRun":true}'

const res = await fetch('https://itemoo.eu/v1/drafts/products', {
  method: 'POST',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "products": [
      {
        "name": "Coffee 250 g",
        "sku": "KAW-250",
        "category": "food"
      }
    ],
    "dryRun": true
  }),
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/drafts/products');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY'), 'Content-Type: application/json'],
  CURLOPT_POSTFIELDS => '{"products":[{"name":"Coffee 250 g","sku":"KAW-250","category":"food"}],"dryRun":true}',
]);
$data = json_decode(curl_exec($ch), true);

Resposta 200 · application/json

object

Exemplo

curl -X GET 'https://itemoo.eu/v1/drafts/site' \
  -H 'Authorization: Bearer itm_YOUR_KEY'

const res = await fetch('https://itemoo.eu/v1/drafts/site', {
  method: 'GET',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY },
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/drafts/site');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY')],
]);
$data = json_decode(curl_exec($ch), true);

Corpo do pedido application/json

• draftRevisionstringobrigatório
  draftRevision from the last read; if the draft changed since, the call fails with draftConflict — read again
• operationsobject[]obrigatório
  Operations applied in order; only theme, pages, navigation and seo, never legal pages or legal links
• dryRunboolean
  Default true: nothing is saved — the result shows what would change and a planToken. Ask the user, then call again with the SAME arguments, dryRun: false and that planToken.
• planTokenstring
  planToken from the preview of exactly these arguments (required with dryRun: false, valid 10 minutes)

Resposta 200 · application/json

object

Exemplo

curl -X PUT 'https://itemoo.eu/v1/drafts/site' \
  -H 'Authorization: Bearer itm_YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"draftRevision":"0123456789abcdef","operations":[{"op":"set","path":"seo.description","value":"Coffee roasted in Krakow."}],"dryRun":true}'

const res = await fetch('https://itemoo.eu/v1/drafts/site', {
  method: 'PUT',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "draftRevision": "0123456789abcdef",
    "operations": [
      {
        "op": "set",
        "path": "seo.description",
        "value": "Coffee roasted in Krakow."
      }
    ],
    "dryRun": true
  }),
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/drafts/site');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY'), 'Content-Type: application/json'],
  CURLOPT_POSTFIELDS => '{"draftRevision":"0123456789abcdef","operations":[{"op":"set","path":"seo.description","value":"Coffee roasted in Krakow."}],"dryRun":true}',
]);
$data = json_decode(curl_exec($ch), true);

Parâmetros

Resposta 200 · application/json

object

Exemplo

curl -X GET 'https://itemoo.eu/v1/drafts/publications/post-ai-x7Kp2' \
  -H 'Authorization: Bearer itm_YOUR_KEY'

const res = await fetch('https://itemoo.eu/v1/drafts/publications/post-ai-x7Kp2', {
  method: 'GET',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY },
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/drafts/publications/post-ai-x7Kp2');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY')],
]);
$data = json_decode(curl_exec($ch), true);

Corpo do pedido application/json

• idstring
  Existing post id (edit); omit to create
• draftRevisionstring
  draftRevision from the last read; if the draft changed since, the call fails with draftConflict — read again
• titlestringobrigatório
  Working name in the calendar
• messagestringobrigatório
  Main message of the post
• headlinestring
  Text on the graphic
• template"product" | "teaser" | "free"
  Graphic template; default: product when products are given, otherwise free
• productCodesstring[]
  Itemoo codes of the products in the post
• scheduledAtstring (date-time)
  Planned publication time (ISO 8601)
• variantsobject[]
  ›Campos

  • platform"facebook" | "instagram" | "linkedin" | "tiktok"obrigatório
  • textstringobrigatório
    Post text for this platform
  • hashtagsstring[]
  • altTextstring
    Alternative text of the graphic
• dryRunboolean
  Default true: nothing is saved — the result shows what would change and a planToken. Ask the user, then call again with the SAME arguments, dryRun: false and that planToken.
• planTokenstring
  planToken from the preview of exactly these arguments (required with dryRun: false, valid 10 minutes)

Resposta 200 · application/json

object

Exemplo

curl -X POST 'https://itemoo.eu/v1/drafts/publications' \
  -H 'Authorization: Bearer itm_YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"title":"New roast","message":"Our new medium roast is here.","dryRun":true}'

const res = await fetch('https://itemoo.eu/v1/drafts/publications', {
  method: 'POST',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "title": "New roast",
    "message": "Our new medium roast is here.",
    "dryRun": true
  }),
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/drafts/publications');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY'), 'Content-Type: application/json'],
  CURLOPT_POSTFIELDS => '{"title":"New roast","message":"Our new medium roast is here.","dryRun":true}',
]);
$data = json_decode(curl_exec($ch), true);

Parâmetros

Resposta 200 · application/json

object

Exemplo

curl -X GET 'https://itemoo.eu/v1/drafts/articles/clx0article' \
  -H 'Authorization: Bearer itm_YOUR_KEY'

const res = await fetch('https://itemoo.eu/v1/drafts/articles/clx0article', {
  method: 'GET',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY },
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/drafts/articles/clx0article');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY')],
]);
$data = json_decode(curl_exec($ch), true);

Corpo do pedido application/json

• idstring
  Existing draft article id; omit to create
• draftRevisionstring
  draftRevision from the last read; if the draft changed since, the call fails with draftConflict — read again
• langstring
  Language of the texts (two letters); default: the brand default language. Texts in other languages are marked as machine-written for review
• titlestring
  Title
• excerptstring
  Short summary
• bodystring
  Body: paragraphs separated by an empty line, "## " for subheadings
• categorystring
• slugstring
• productCodesstring[]
• dryRunboolean
  Default true: nothing is saved — the result shows what would change and a planToken. Ask the user, then call again with the SAME arguments, dryRun: false and that planToken.
• planTokenstring
  planToken from the preview of exactly these arguments (required with dryRun: false, valid 10 minutes)

Resposta 200 · application/json

object

Exemplo

curl -X POST 'https://itemoo.eu/v1/drafts/articles' \
  -H 'Authorization: Bearer itm_YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"title":"How to brew","body":"Use 15 g of coffee per 250 ml of water.","dryRun":true}'

const res = await fetch('https://itemoo.eu/v1/drafts/articles', {
  method: 'POST',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "title": "How to brew",
    "body": "Use 15 g of coffee per 250 ml of water.",
    "dryRun": true
  }),
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/drafts/articles');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY'), 'Content-Type: application/json'],
  CURLOPT_POSTFIELDS => '{"title":"How to brew","body":"Use 15 g of coffee per 250 ml of water.","dryRun":true}',
]);
$data = json_decode(curl_exec($ch), true);

Parâmetros

Resposta 200 · application/json

object

Exemplo

curl -X GET 'https://itemoo.eu/v1/drafts/campaigns/clx0campaign' \
  -H 'Authorization: Bearer itm_YOUR_KEY'

const res = await fetch('https://itemoo.eu/v1/drafts/campaigns/clx0campaign', {
  method: 'GET',
  headers: { Authorization: 'Bearer ' + process.env.ITEMOO_API_KEY },
});
const data = await res.json();

$ch = curl_init('https://itemoo.eu/v1/drafts/campaigns/clx0campaign');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ITEMOO_API_KEY')],
]);
$data = json_decode(curl_exec($ch), true);

Corpo do pedido application/json

• idstring
  Existing draft campaign id; omit to create
• draftRevisionstring
  draftRevision from the last read; if the draft changed since, the call fails with draftConflict — read again
• langstring
  Language of the texts (two letters); default: the brand default language. Texts in other languages are marked as machine-written for review
• namestring
  Internal name
• titlestring
  Notification title
• bodystring
  Notification text
• targetobject
  Where the button leads; default: the brand app
  ›Campos

  • type"app" | "product" | "group"obrigatório
  • codestring
    Product code for type "product"
  • groupstring
    Shop category for type "group"
• countriesstring[]
• productCodesstring[]
  Only people who scanned these products; empty = everyone with consent
• pushboolean
• emailboolean
• dryRunboolean
  Default true: nothing is saved — the result shows what would change and a planToken. Ask the user, then call again with the SAME arguments, dryRun: false and that planToken.
• planTokenstring
  planToken from the preview of exactly these arguments (required with dryRun: false, valid 10 minutes)