Create a collection delivery batche
POST
/v1/collection-delivery-batchescurl -X POST 'https://api.embodiflow.io/v1/collection-delivery-batches' \
-H 'Authorization: Bearer $EMBODIFLOW_PAT' \
-H 'Content-Type: application/json' \
-d '{
"collectionOrderId": "00000000-0000-0000-0000-000000000000",
"supersedesDeliveryBatchId": "00000000-0000-0000-0000-000000000000",
"deliveryNumber": "string",
"supplierProjectMembershipId": "00000000-0000-0000-0000-000000000000",
"sourceMetadata": {},
"declaredContent": {}
}'Authorization
Send a personal access token with every request.
- Authorization: Bearer PAT
Header parameters
- Idempotency-Keystring
Optional idempotency key, at most 255 characters (UUIDv4 recommended). A repeated key returns the first response byte-for-byte, including a 5xx. The same key with a different body, or a second in-flight request, returns 409 IDEMPOTENCY_CONFLICT. Keys are unique per tenant and retained for 24 hours.
Request body
Content-Typeapplication/json
- collectionOrderIdstring (uuid)required
- supersedesDeliveryBatchIdstring (uuid) | null
Rejected or partially accepted delivery batch this declaration replaces. Copies attemptGroupKey and increments attemptNumber once.
- deliveryNumberstring | null
Required for a first delivery. Generated for replacements when omitted.
- supplierProjectMembershipIdstring (uuid) | null
Supplier project membership. Managers may set this; data suppliers use their own membership.
- sourceMetadataobject | null
- declaredContentobject | null
Responses
Success
- dataobjectrequired
- idstringrequired
- tenantIdstringrequired
- projectIdstringrequired
- collectionOrderIdstringrequired
- supplierProjectMembershipIdstringrequired
- deliveryNumberstringrequired
- statusstringrequired
- attemptGroupKeystringrequired
- attemptNumbernumberrequired
- supersedesDeliveryBatchIdstring | nullrequired
- reviewTaskIdstring | nullrequired
- sourceMetadataobject | nullrequired
- declaredContentobject | nullrequired
- machineVerdictobjectrequired
- acceptanceDecisionobjectrequired
- linkedUploadBatchIdsarray<string>required
- attemptCountnumberrequired
- outstandingReworkCountnumberrequired
- outstandingReworkarray<CollectionDeliveryOutstandingReworkDto>required
- createdAtstringrequired
- updatedAtstringrequired
- rowVersionnumberrequired
Response example
{
"data": {
"id": "string",
"tenantId": "string",
"projectId": "string",
"collectionOrderId": "string",
"supplierProjectMembershipId": "string",
"deliveryNumber": "string",
"status": "string",
"attemptGroupKey": "string",
"attemptNumber": 0,
"supersedesDeliveryBatchId": "string",
"reviewTaskId": "string",
"sourceMetadata": {},
"declaredContent": {},
"machineVerdict": {
"contractVersion": "embodiflow-collection-delivery/v1",
"criteriaId": "embodiflow-collection-delivery/v1",
"criteriaVersion": 0,
"criteriaHash": "string",
"generatedAt": "string",
"sourceWorkflowRunId": "string",
"sourceDatasetVersionId": "string",
"overall": "error",
"quality": {
"status": "warn",
"blockingFailCount": 0,
"summaries": [
{
"status": "warn",
"checkId": "string",
"count": 0
}
]
},
"alignment": {
"status": "warn",
"checkIds": [
"string"
]
},
"composition": {
"status": "warn",
"profileId": "string",
"inputDigest": "string"
}
},
"acceptanceDecision": {
"contractVersion": "embodiflow-collection-delivery/v1",
"reviewTaskId": "string",
"reviewerProjectMembershipId": "string",
"decision": "approve",
"batchStatus": "accepted",
"comment": "string",
"waiverReason": "string",
"acceptedItemIds": [
"string"
],
"rejectedItemIds": [
"string"
],
"rejectedQueryDescriptors": [
"string"
],
"criteriaHash": "string",
"criteriaVersion": 0,
"machineOverall": "error"
},
"linkedUploadBatchIds": [
"string"
],
"attemptCount": 0,
"outstandingReworkCount": 0,
"outstandingRework": [
{
"repairTaskId": "string",
"sourceId": "string",
"status": "string",
"severity": "string"
}
],
"createdAt": "string",
"updatedAt": "string",
"rowVersion": 0
}
}Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1