Upload Batches

List upload batches

List your organization's most recent upload batches, newest first. Only batches whose object types you can read are returned.

Required scopes: documents:read, plus the read scope of a batch's object types (shipments:read or customs:read; shipments:read for unrestricted batches).

get/api/v1/external/upload-batches

Request

Query parameters

limitinteger

Maximum number of batches to return

Response

Upload batches retrieved successfully

successboolean

Example response

{
  "success": true,
  "data": {
    "batches": [
      {
        "id": "1017334964043997186",
        "label": "Shipment 1",
        "filingCountry": "US",
        "createdEntities": [
          {
            "entityType": "shipment",
            "entityId": "1015989120405430278"
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.