Create a collection delivery batche
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| Idempotency-Key | header | string | 否 | 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. |
{
"type": "object",
"properties": {
"collectionOrderId": {
"type": "string",
"format": "uuid"
},
"supersedesDeliveryBatchId": {
"type": "string",
"nullable": true,
"format": "uuid",
"description": "Rejected or partially accepted delivery batch this declaration replaces. Copies attemptGroupKey and increments attemptNumber once."
},
"deliveryNumber": {
"type": "string",
"nullable": true,
"minLength": 1,
"description": "Required for a first delivery. Generated for replacements when omitted."
},
"supplierProjectMembershipId": {
"type": "string",
"nullable": true,
"format": "uuid",
"description": "Supplier project membership. Managers may set this; data suppliers use their own membership."
},
"sourceMetadata": {
"type": "object",
"additionalProperties": true,
"nullable": true
},
"declaredContent": {
"type": "object",
"additionalProperties": true,
"nullable": true
}
},
"required": [
"collectionOrderId"
]
}| 状态码 | 说明 | Content-Type | Schema |
|---|---|---|---|
| 201 | Success | application/json | object |
| 400 | Bad request. Enumerated catalog codes for this operation. | application/problem+json | union |
| 401 | Authentication failed. A specific TOKEN_* cause is returned only when the presented hash matched a stored row. | application/problem+json | union |
| 403 | Authorization failed. PERMISSION_DENIED on an any-of route lists the alternatives in message. | application/problem+json | union |
| 404 | 404 COLLECTION_DELIVERY_BATCH_NOT_FOUND | COLLECTION_DELIVERY_ORDER_NOT_FOUND | OpenAPI 中未发布 | OpenAPI 中未发布 |
| 409 | Conflict. Enumerated catalog codes for this operation. | application/problem+json | union |
| 422 | 422 COLLECTION_DELIVERY_REPLACEMENT_NOT_ALLOWED | COLLECTION_DELIVERY_ORDER_NOT_ACCEPTING | COLLECTION_DELIVERY_SUBMIT_NOT_ALLOWED | COLLECTION_DELIVERY_VERSION_REQUIRED | OpenAPI 中未发布 | OpenAPI 中未发布 |
| 429 | Authenticated per-principal or per-tenant request budget exceeded. Rate-limit headers appear only on 429. | application/problem+json | union |
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CollectionDeliveryBatchDto"
}
},
"required": [
"data"
]
}{
"allOf": [
{
"$ref": "#/components/schemas/ProblemJson"
},
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"enum": [
400
]
},
"code": {
"type": "string",
"enum": [
"BAD_REQUEST",
"IDEMPOTENCY_KEY_INVALID",
"IF_MATCH_INVALID",
"TENANT_CONTEXT_MISMATCH",
"TENANT_REQUIRED",
"VALIDATION_ERROR"
]
}
}
}
]
}{
"allOf": [
{
"$ref": "#/components/schemas/PublishedAuthProblem"
},
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"enum": [
401
]
},
"code": {
"type": "string",
"enum": [
"TOKEN_MALFORMED",
"TOKEN_NOT_FOUND",
"TOKEN_EXPIRED",
"TOKEN_REVOKED",
"UNAUTHORIZED",
"SESSION_EXPIRED",
"ACTIVATION_REQUIRED",
"MFA_REQUIRED"
]
}
}
}
]
}{
"allOf": [
{
"$ref": "#/components/schemas/PublishedAuthProblem"
},
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"enum": [
403
]
},
"code": {
"type": "string",
"enum": [
"PERMISSION_DENIED",
"PERMISSION_NOT_DECLARED",
"FORBIDDEN",
"MEMBERSHIP_NOT_FOUND",
"MEMBERSHIP_DISABLED",
"MEMBERSHIP_EXPIRED",
"PROJECT_MEMBERSHIP_EXPIRED"
]
}
}
}
]
}{
"allOf": [
{
"$ref": "#/components/schemas/ProblemJson"
},
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"enum": [
409
]
},
"code": {
"type": "string",
"enum": [
"IDEMPOTENCY_CONFLICT"
]
}
}
}
]
}{
"allOf": [
{
"$ref": "#/components/schemas/PublishedAuthProblem"
},
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"enum": [
429
]
},
"code": {
"type": "string",
"enum": [
"RATE_LIMITED"
]
}
}
}
]
}curl -X POST 'https://api.embodiflow.io/v1/collection-delivery-batches' \
-H 'Authorization: Bearer $EMBODIFLOW_PAT' \
-H 'Content-Type: application/json' \
-d '{}'