メインコンテンツへスキップ
GET
/
v1
/
batches
/
{batch_id}
/
items
特定のバッチに対して、完了または失敗したアイテムリストをオプションでコンテンツと共に取得
curl --request GET \
  --url https://api.olostep.com/v1/batches/{batch_id}/items \
  --header 'Authorization: Bearer <token>'
{
  "batch_id": "batch_abc123def456",
  "object": "list",
  "status": "completed",
  "items": [
    {
      "custom_id": "product-123",
      "retrieve_id": "ret_xyz789",
      "url": "https://example.com/product/123",
      "metadata": {
        "source": "catalog_sync",
        "priority": "high"
      }
    },
    {
      "custom_id": "product-456",
      "retrieve_id": "ret_abc456",
      "url": "https://example.com/product/456"
    }
  ],
  "items_count": 2
}
メタデータ: バッチを作成する際に個々のアイテムにmetadataを添付した場合、それはレスポンス内の各アイテムと共に返されます。

承認

Authorization
string
header
必須

Bearer認証ヘッダーの形式はBearer で、はあなたの認証トークンです。

パスパラメータ

batch_id
string
必須

アイテムを取得するバッチのID。

クエリパラメータ

status
enum<string>

取得するURLのステータス(completedまたはfailed)。

利用可能なオプション:
completed,
failed
cursor
integer

ページネーションカーソル。最初のリクエストではこのパラメータを省略してください。次のリクエストでは、前のレスポンスからのcursor値を使用してください。詳細はPaginationを参照してください。

limit
integer

返す結果の数(推奨10-50)。

レスポンス

バッチアイテムを含む成功したレスポンス。

batch_id
string
object
string
status
string
items
object[]
items_count
integer
cursor
integer

ページネーションカーソル。さらに結果がある場合に表示されます。この値を次のリクエストのcursorパラメータに使用してください。詳細はページネーションを参照してください。