Sign in

v1

latestSwagger 2.0BeezUP2026-07-13254876845.8 KB
Catalogs - Catalog

Get product batch status

Get the tracking information of a previously submitted product batch.

  • When isStarted is false, the batch hasn't been picked up yet by the importation engine and no correlationId is available.
  • When isStarted is true, a correlationId is returned and the report can be fetched via GET /{storeId}/product-batches/{batchId}/reports/{correlationId}.
get/v2/user/catalogs/{storeId}/product-batches/{batchId}

Path parameters

storeIdstring guid required

Your store identifier

batchIdstring BatchId required

The product batch identifier

Response

The product batch tracking information

requestedUtcDatestring date-time required

UTC date and time when the batch was requested (i.e. accepted by the API).

isStartedboolean required

True once the batch has been picked up by the importation engine. When true, startedUtcDate and correlationId are also returned.

startedUtcDatestring date-time

UTC date and time when the batch was picked up by the importation engine. Present only when isStarted is true.

correlationIdstring Guid

Correlation identifier of the underlying importation. Present only when isStarted is true. Used to fetch the report via GET /{storeId}/product-batches/{batchId}/reports/{correlationId}.