BulkItemResult
The base result envelope for a single item in a bulk operation response.
Declaration
object BulkItemResultProperties
| Name | Type | Description |
|---|---|---|
correlationId | int64 | The client-supplied integer from the corresponding request item. Use this to map each response entry back to its input. Read-only. |
operation | string | The operation performed on this item: |
success | boolean | Whether this individual item operation succeeded. Read-only. |
error | Error | Per-item error details when this item failed. Null on success. See Error. Read-only. |
result | Response.Result | The response payload. Type depends on the specific response subtype. See Response.Result. Absent when the request fails. |
Discussion
The BulkItemResult object is the shared result wrapper that the API returns for each item in a bulk create, update, or delete response. It extends the standard Response envelope with per-item operation metadata. All keyword and negative keyword bulk response types extend this schema by adding a typed result field.
When allowPartialSuccess is true in the request, inspect success on each entry individually. A false value indicates that the specific item failed.
Example
{
"correlationId": 2,
"operation": "UPDATE",
"success": false,
"error": {
"code": "INVALID_FIELD",
"message": "bid.amount must be greater than 0",
"details": []
}
}See Also
BaseBulkRequestBulkOperationRequestBulkItemResultKeywordBulkItemResultNegativeKeywordBulkResponseKeywordCreateBulkRequestKeywordCreateBulkResponseKeywordUpdateBulkRequestKeywordUpdateBulkResponseNegativeKeywordCreateBulkRequestNegativeKeywordCreateBulkResponseNegativeKeywordUpdateBulkRequestNegativeKeywordUpdateBulkResponseBulkKeywordCreateBulkKeywordUpdate