Sign in

v1

latestOpenAPI 3.0.12026-07-2353480642.4 KB
Batch

Get single batch details

get/orders/batch/{batchId}

Path parameters

batchIdstring uuid required

Idenitifer assigned to the order batch.

Batch ID for this request.

Response

Details of a batch

processingStatus'SUCCESS' | 'CORRUPT_FILE' | 'DUPLICATE_FILE_NAME' | 'NO_FILES_RECEIVED' | 'INPROGRESS' | 'PENDING' | 'TX_COMPLETED' | 'PARTIAL_SUCCESS' | 'FORCE_STOPPED' required
responseFileSentboolean
responseFileNamestring
batchIdstring uuid required

Idenitifer assigned to the order batch.

fileCreatedDatestring date-time

The date time when the file was created on SFTP.

filePickupDatestring date-time

The date time when the file was picked up by the batch process.

fileNamestring
orderType'POIOrder' | 'MerchantOrder' | 'POIMaintenanceOrder' | 'MerchantMaintenanceOrder' | 'POIAccessoryOrder' | 'AdditionalServicesOrder' | 'HardwareOrder'
retryCountinteger
completionDatestring date-time