Upload Batches

Get upload batch

Poll a batch for its status and, once completed, the entities it created.

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

get/api/v1/external/upload-batches/{batchId}

Request

Path parameters

batchIdstring required

Upload batch identifier

Response

Upload batch retrieved successfully

successboolean

Example response

{
  "success": true,
  "data": {
    "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.