List delivery batches for a collection order

GET

/v1/projects/{projectId}/collection-orders/{orderId}/delivery-batches

curl -X GET 'https://api.embodiflow.io/v1/projects/{projectId}/collection-orders/{orderId}/delivery-batches' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Path parameters

projectIdstringrequired
orderIdstringrequired

Query parameters

pageSizenumber
Page size (default 25, maximum 100). Over-maximum is refused.
pageTokenstring
Opaque page token from the previous response.

Responses

Success

dataarray<CollectionOrderDeliveryBatchRowDto>required
- deliveryBatchIdstringrequired
- collectorMembershipIdstringrequired
- statusstringrequired
- submissionCountnumberrequired
- acceptedCountnumberrequired
- rejectedCountnumberrequired
- submittedAtstring | nullrequired
- resolvedAtstring | nullrequired
nextPageTokenstring
Opaque AIP-158 page token. Omitted when the collection is exhausted.
metaobjectrequired
- pageSizenumberrequired
- totalCountnumber
- truncatedone of
- requestIdstring

Response example

{
  "data": [
    {
      "deliveryBatchId": "string",
      "collectorMembershipId": "string",
      "status": "string",
      "submissionCount": 0,
      "acceptedCount": 0,
      "rejectedCount": 0,
      "submittedAt": "string",
      "resolvedAt": "string"
    }
  ],
  "nextPageToken": "string",
  "meta": {
    "pageSize": 0,
    "totalCount": 0,
    "truncated": false,
    "requestId": "string"
  }
}

Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1