Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
z) Global Functionality

Search for batches

Returns a paginated list of batch history records, optionally filtered by type, status, date range, and other criteria.

get/eclipse-conductor/rest/v1/global/batches

Query parameters

activateFromDatestring
activateToDatestring
closedFromDatestring
closedToDatestring
createdBystring
dateFromInclstring

Start of the date range (inclusive). ISO-8601 date-time string.

dateToExclstring

End of the date range (exclusive). ISO-8601 date-time string.

includeCreatorDetailsboolean
includeProductDetailsboolean
limitinteger
offsetinteger
organisationIdstring
productIdstring
subTypestring
supplierIdstring
tenantIdstring
typestring required

Type of batch, e.g. RATIFY_BATCH, RATIFY_SDN, POSTILION_QRCODE.

Response

OK

activatedDatestring date-time
batchIdinteger
batchNumberstring
batchType'IMPORT_COMPLIANCE' | 'POSTILION_CARDS' | 'POSTILION_QRCODE' | 'PRODUCT_BATCH' | 'RATIFY_BATCH' | 'RATIFY_SDN' | 'TNX_HISTORY'
callBackIdinteger
callbackUrlstring
closedDatestring date-time
createdstring date-time
createdByinteger
descriptionstring
emailstring
infostring
lastModifiedstring date-time
qrcodeType'EXTERNAL_REF' | 'RANDOM_10' | 'ZA_MASTERPASS'
seqNumberstring
statusstring
subTypestring
tenantIdinteger

Example response

[
  {
    "activatedDate": "2022-03-10T12:15:50-04:00",
    "closedDate": "2022-03-10T12:15:50-04:00",
    "created": "2022-03-10T12:15:50-04:00",
    "creator": {
      "created": "2022-03-10T12:15:50-04:00",
      "lastModified": "2022-03-10T12:15:50-04:00",
      "nextMandatoryKycDate": "2022-03-10T12:15:50-04:00",
      "positions": [
        {
          "organisation": {
            "created": "2022-03-10T12:15:50-04:00",
            "lastModified": "2022-03-10T12:15:50-04:00"
          }
        }
      ]
    },
    "eclipseProduct": {
      "created": "2022-03-10T12:15:50-04:00",
      "lastModified": "2022-03-10T12:15:50-04:00"
    },
    "lastModified": "2022-03-10T12:15:50-04:00"
  }
]