Biklo for developersTESTsandbox-api.biklo.comchange

Batch status and per-item results

GET/v1/products/batch/{batchId}

scope products.write

Failures are listed first, because that is what you opened this for. ?failed_only=1 returns just those.

Query parameters#

NameExample
failed_only—1 to return only the failures

Response#

FieldTypeDescription
batch_idstringThe batch handle.
statusstringWhere the batch is. completed means every item was ATTEMPTED — not that every item succeeded, so always read failed.

Accepts queued · processing · completed · failed

totalintegerHow many products were in it.
processedintegerHow many have been attempted so far.
succeededintegerHow many were written.
failedintegerHow many were not. Non-zero on a completed batch is the normal way a partial failure looks.
created_atstring|nullISO-8601 UTC.
completed_atstring|nullISO-8601 UTC, or null while still running.
errorstring|nullSet only when the batch itself failed, as opposed to items within it.
items_shownintegerHow many items are in items. Capped at 500 per response, so on a larger batch use ?status=failed to see the ones that need attention.
itemsarrayPer-item results.
items[].positionintegerIts index in the products array you sent — this is how you match a result back to your own record.
items[].external_idstring|nullYour id for it, as sent.
items[].statusstringWhat happened to this one.

Accepts pending · success · failed

items[].product_idinteger|nullThe product that was created or updated, or null if it failed.
items[].errorobject|nullWhy it failed, or null. One bad item never stops the rest.
items[].error.codestringA machine-readable reason.
items[].error.messagestringThe same in words.

Example

{
    "batch_id": "batch_v4lfngtgb6sxqkzwagrqv8c2",
    "status": "completed",
    "total": 7,
    "processed": 7,
    "succeeded": 5,
    "failed": 2,
    "created_at": "2026-09-11T14:02:10Z",
    "completed_at": "2026-09-11T14:02:38Z",
    "error": null,
    "items_shown": 2,
    "items": [
        {
            "position": 0,
            "external_id": "ERP-1001",
            "status": "success",
            "product_id": 237224,
            "error": null
        },
        {
            "position": 5,
            "external_id": "BATCH-BAD",
            "status": "failed",
            "product_id": null,
            "error": {
                "code": "missing_required_attribute",
                "message": "The attribute \"Brand\" is required for this category."
            }
        }
    ]
}

Failures use the shared error envelope — a machine-readable code and a request_id to quote to support. Error handling.

curl -X GET "https://sandbox-api.biklo.com/v1/products/batch/123" \
  -H "Authorization: Bearer bk_test_YOUR_KEY"
<?php

$ch = curl_init('https://sandbox-api.biklo.com/v1/products/batch/123');

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST  => 'GET',
    CURLOPT_HTTPHEADER     => [
        'Authorization: Bearer bk_test_YOUR_KEY',
    ],
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);

using System.Net.Http;
using System.Net.Http.Headers;

var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", "bk_test_YOUR_KEY");

var request = new HttpRequestMessage(
    new HttpMethod("GET"),
    "https://sandbox-api.biklo.com/v1/products/batch/123");

var response = await client.SendAsync(request);
var json = await response.Content.ReadAsStringAsync();

import requests

response = requests.get(
    "https://sandbox-api.biklo.com/v1/products/batch/123",
    headers={"Authorization": "Bearer bk_test_YOUR_KEY"},
)

data = response.json()

const response = await fetch("https://sandbox-api.biklo.com/v1/products/batch/123", {
  method: "GET",
  headers: {
    Authorization: "Bearer bk_test_YOUR_KEY"
  }
});

const data = await response.json();

import java.net.http.*;
import java.net.URI;

var client = HttpClient.newHttpClient();

var request = HttpRequest.newBuilder()
    .uri(URI.create("https://sandbox-api.biklo.com/v1/products/batch/123"))
    .header("Authorization", "Bearer bk_test_YOUR_KEY")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = client.send(request, HttpResponse.BodyHandlers.ofString());