Documentos

Documentos são o recurso principal na Carrot API. Um documento (comumente um MassID) se torna o contêiner imutável para dados de rastreabilidade, e todas as alterações acontecem através de eventos adicionados.

Criar documento

curl -X POST "https://example.com/documents" \  -H "Authorization: string" \  -H "Content-Type: application/json" \  -d '{    "category": "DOCUMENT",    "externalCreatedAt": "2020-01-01T00:00:00.000Z",    "isPublic": true,    "isPubliclySearchable": true,    "type": "ORGANIC"  }'

{  "id": "28b04f62-8fe2-4332-b854-fe8a922788b5"}

Utilize POST /documents para criar um documento com os campos obrigatórios:

• category
• externalCreatedAt
• isPublic
• isPubliclySearchable
• type
• participantId — um participante resolvido via a API de Participantes
• addressId — um endereço resolvido via a API de Participantes

Enviar objetos completos participant ou address inline em vez de participantId/addressId está descontinuado e será removido em uma versão futura. Resolva participantes e endereços primeiro e então referencie-os por ID.

Campos opcionais:

• deduplicationId para evitar envios duplicados em retentativas.
• tags, title, shortTitle e campos de classificação.

Recuperar documento por id

curl -X GET "https://example.com/documents/string" \  -H "Authorization: string"

{  "address": null,  "author": null,  "category": "DOCUMENT",  "createdAt": "2020-01-01T00:00:00.000Z",  "currentValue": 1500,  "events": [    {      "address": null,      "author": null,      "externalCreatedAt": "2020-01-01T00:00:00.000Z",      "externalId": "123456",      "id": "JrSRCUhKOxKyUujM2DkH9",      "isPublic": true,      "label": "Waste Generator",      "metadata": null,      "name": "Pick-up",      "participant": null,      "preserveSensitiveData": true,      "relatedDocument": null,      "tags": [        "string"      ],      "target": null,      "value": 1000    }  ],  "externalCreatedAt": "2020-01-01T00:00:00.000Z",  "externalId": "123456",  "id": "28b04f62-8fe2-4332-b854-fe8a922788b5",  "isPublic": true,  "isPubliclySearchable": true,  "measurementUnit": "kg",  "parentDocumentId": "6sV74NaFq_hWLt6v5pWd5",  "participant": null,  "primaryAddress": null,  "primaryParticipant": null,  "shortTitle": "MassID",  "status": "OPEN",  "subtype": "Wood",  "tags": [    "string"  ],  "title": "MassID",  "type": "ORGANIC"}

Utilize GET /documents/{id} para obter o payload completo do documento, incluindo:

• status e valor atuais
• referências de participante e endereço
• linha do tempo completa de eventos
• flags de visibilidade pública

Nota de design: imutabilidade

Os dados do documento são apenas por adição (append-only) na prática. Não há endpoint PATCH/PUT para mutação de documento e nem endpoint DELETE. Alterações operacionais são representadas como eventos.

Para um fluxo orientado à produção, consulte Enviando um MassID.