KashierDevelopersKashier Developers
API reference and playgroundBulk batches

Delete a batch or empty it

curl -X DELETE "https://test-api.kashier.io/v2/batch/string?operation=batch"
{  "data": {    "_id": "string",    "isDeleted": true,    "deletedAt": "string"  },  "message": "string"}

Deletes a batch, or just its contents. Pass operation=batch to remove the batch itself, or operation=batch_items to empty it and keep the batch so you can re-import a corrected sheet into it.

Authorization

secretKey
Authorization<token>

Merchant secret key used to identify the merchant, obtained from Kashier's dashboard. Pass the raw secret key value in the Authorization header (NOT a "Bearer" token).

In: header

Path Parameters

batchId*string

The batch's record id.

Query Parameters

operation*string

What to delete — the batch itself, or only the items inside it.

Value in

  • "batch"
  • "batch_items"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

DELETE
/v2/batch/{batchId}

Get a batch GET

Retrieves a single batch together with the items it contains, so you can review what was imported before sharing it.

Update a batch PUT

Renames an existing batch. The items inside it are left untouched — to change those use updateBatchItem.