Query batch operation result

GET /sapigw/suppliers/{supplierId}/products/batch-requests/{batchRequestId} — PIM API · Operation Tracking

Returns the status of the BatchRequestId returned from product transfer or price/stock update and the result per row.

Status values:

Value Meaning
WAITING In queue, not started processing
PROCESSING Processing
COMPLETED Finished; row results in Items
ERROR Operation failed entirely
Not Found Batch No operation found with this ID

Items is populated only when status is COMPLETED. Each row's Value field is the barcode; Status is SUCCESS or ERROR, error reasons are in FailureReasons. Dates are Unix timestamps (milliseconds).

Parametreler

  • supplierId (path, string, zorunlu): Supplier ID provided by CommerceLab. If not defined in this environment, the request returns 401.
  • batchRequestId (path, string, zorunlu): BatchRequestId returned from the batch operation call.
  • Tenant (header, string): Company code for users accessing multiple companies with Basic Auth. Not required if using Bearer token.

Yanıtlar

  • 200: Current status of the operation.
  • 401: Authentication failed or supplierId not defined in this environment. Body is empty.
  • 500: Unexpected server-side error.

200 yanıt alanları

  • Items (object[]): Row results; populated only when status is COMPLETED.
  • Status (string): Operation status: WAITING, PROCESSING, COMPLETED, ERROR, or Not Found Batch.
  • ItemCount (integer): Number of result rows.
  • SourceType (string): Source of the request; always API.
  • CreationDate (integer<int64>): Operation creation time (Unix, milliseconds).
  • BatchRequestId (string): Queried operation ID.
  • LastModification (integer<int64>): Operation completion time (Unix, milliseconds); 0 if not finished.