Bronnen

Eenheden

Elk Eenheden-endpoint, met de scope die het afdwingt, het lichaam dat het aanneemt, een leesbaar antwoord en de weigeringen die het kan teruggeven.

Geserialiseerde eenheden opsommen.

get/organizations/{organization}/passports/{id}/units

Scope: units:read
Idempotency-Key: Wordt niet geaccepteerd
Levert: 200

Padparameters

organizationstringVerplicht

De organisatie waarvoor dit verzoek handelt. De sleutel moet daarvoor zijn vrijgegeven.

idstringVerplicht

De identificatie van de bron. Behandel die als een ondoorzichtige tekenreeks.

Queryparameters

limitstringOptioneel

Hoeveel records worden teruggegeven. De server mag er minder teruggeven.

cursorstringOptioneel

De next_cursor van de vorige pagina. Een cursor codeert de filters waaronder hij is uitgegeven; meesturen met andere filters wordt geweigerd met cursor_invalid.

statusstringOptioneel

Geeft alleen eenheden met deze status terug.

unit_serialstringOptioneel

Geeft uitsluitend de eenheid terug die dit serienummer draagt.

Fouten

Elke weigering die dit endpoint kan teruggeven, met de status waarmee die binnenkomt.

Verzoek

curl "https://passportcraft.com/api/v1/organizations/8f14e45f-ceea-467a-9a5f-8dc7d9c6a1b2/passports/b6f0d4a2-71c3-4e58-8a19-3f7c2d5e8b04/units?limit=25" \
  -H "Authorization: Bearer $PASSPORTCRAFT_API_KEY"

Antwoord · 200

{
  "object": "list",
  "data": [
    {
      "object": "unit",
      "id": "d41d8cd9-8f00-4b20-a204-9800998ecf84",
      "name": "organizations/8f14e45f-ceea-467a-9a5f-8dc7d9c6a1b2/passports/b6f0d4a2-71c3-4e58-8a19-3f7c2d5e8b04/units/d41d8cd9-8f00-4b20-a204-9800998ecf84",
      "organization_id": "8f14e45f-ceea-467a-9a5f-8dc7d9c6a1b2",
      "passport_id": "b6f0d4a2-71c3-4e58-8a19-3f7c2d5e8b04",
      "passport": "organizations/8f14e45f-ceea-467a-9a5f-8dc7d9c6a1b2/passports/b6f0d4a2-71c3-4e58-8a19-3f7c2d5e8b04",
      "unit_serial": "BAT-2026-000117",
      "status": "original",
      "livemode": true,
      "created_at": "2026-08-01T12:00:03.114Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

GET /organizations/8f14e45f-ceea-467a-9a5f-8dc7d9c6a1b2/passports/b6f0d4a2-71c3-4e58-8a19-3f7c2d5e8b04/units?limit=25

Geserialiseerde eenheden aanmaken.

post/organizations/{organization}/passports/{id}/units

Scope: units:write
Idempotency-Key: Wordt geaccepteerd
Levert: 201

Padparameters

organizationstringVerplicht

De organisatie waarvoor dit verzoek handelt. De sleutel moet daarvoor zijn vrijgegeven.

idstringVerplicht

De identificatie van de bron. Behandel die als een ondoorzichtige tekenreeks.

Verzoeklichaam

unitsarray of objectsVerplicht

Tussen 1 en 1000 eenheden. Het bovenliggende paspoort moet in de categorie battery vallen — geserialiseerde eenheden zijn een batterijbegrip, en elk ander bovenliggend paspoort wordt geweigerd met invalid_request. Een serienummer dat binnen één verzoek wordt herhaald, wordt per rij geweigerd in plaats van ontdubbeld, zodat een bulkimport nooit denkt dat hij een rij heeft aangemaakt die er niet is.

unit_serialstringVerplicht

Het serienummer op dit fysieke exemplaar, maximaal 70 tekens. Uniek binnen het paspoort.

statusstringOptioneel

De levenscyclusstatus, uit de woordenlijst van bijlage XIII: original, repurposed, re-used, remanufactured, waste. Wordt opgeslagen als vrije tekst van maximaal 70 tekens — een waarde buiten die lijst wordt geaccepteerd en vervolgens door niets herkend.

Fouten

Elke weigering die dit endpoint kan teruggeven, met de status waarmee die binnenkomt.

Verzoek

curl "https://passportcraft.com/api/v1/organizations/8f14e45f-ceea-467a-9a5f-8dc7d9c6a1b2/passports/b6f0d4a2-71c3-4e58-8a19-3f7c2d5e8b04/units" \
  -X POST \
  -H "Authorization: Bearer $PASSPORTCRAFT_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "units": [
    {
      "unit_serial": "BAT-2026-000117",
      "status": "original"
    },
    {
      "unit_serial": "BAT-2026-000118"
    }
  ]
}'

Antwoord · 201

{
  "object": "list",
  "data": [
    {
      "object": "unit",
      "id": "d41d8cd9-8f00-4b20-a204-9800998ecf84",
      "name": "organizations/8f14e45f-ceea-467a-9a5f-8dc7d9c6a1b2/passports/b6f0d4a2-71c3-4e58-8a19-3f7c2d5e8b04/units/d41d8cd9-8f00-4b20-a204-9800998ecf84",
      "organization_id": "8f14e45f-ceea-467a-9a5f-8dc7d9c6a1b2",
      "passport_id": "b6f0d4a2-71c3-4e58-8a19-3f7c2d5e8b04",
      "passport": "organizations/8f14e45f-ceea-467a-9a5f-8dc7d9c6a1b2/passports/b6f0d4a2-71c3-4e58-8a19-3f7c2d5e8b04",
      "unit_serial": "BAT-2026-000117",
      "status": "original",
      "livemode": true,
      "created_at": "2026-08-02T09:31:18.446Z"
    },
    {
      "object": "unit",
      "id": "5a3e7c19-2b60-4d84-91f2-7e0c4b6a8d35",
      "name": "organizations/8f14e45f-ceea-467a-9a5f-8dc7d9c6a1b2/passports/b6f0d4a2-71c3-4e58-8a19-3f7c2d5e8b04/units/5a3e7c19-2b60-4d84-91f2-7e0c4b6a8d35",
      "organization_id": "8f14e45f-ceea-467a-9a5f-8dc7d9c6a1b2",
      "passport_id": "b6f0d4a2-71c3-4e58-8a19-3f7c2d5e8b04",
      "passport": "organizations/8f14e45f-ceea-467a-9a5f-8dc7d9c6a1b2/passports/b6f0d4a2-71c3-4e58-8a19-3f7c2d5e8b04",
      "unit_serial": "BAT-2026-000118",
      "status": null,
      "livemode": true,
      "created_at": "2026-08-02T09:31:18.446Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

POST /organizations/8f14e45f-ceea-467a-9a5f-8dc7d9c6a1b2/passports/b6f0d4a2-71c3-4e58-8a19-3f7c2d5e8b04/units