Skip to main content
GET
/
v1
/
bulk_actions
/
{id}
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/bulk_actions/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "99734aa3-341a-43de-a1f3-fae0835d71ec",
  "object": "bulk_action",
  "action_type": "delete_products",
  "record_ids": [
    "edf7f0af-66dd-48cb-a52f-f781f6ea2a49",
    "cd2e4e34-cbf9-4d00-8e26-a6d84c341a1e",
    "4af724e2-37f0-47e6-9592-e74b04d016d7",
    "bf75690d-5d7b-47d9-9f80-d78d5d988f43",
    "88bbfde9-7439-4a3e-b38a-40001d902abf"
  ],
  "skipped_record_ids": [],
  "status": "pending",
  "created_at": 1776176512,
  "updated_at": 1776176512
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
action_type
string

The type of action to be performed. Possible values include:

  • delete_customers
  • delete_products
​
record_ids
array

The id of records to perform the bulk action on.

​
skipped_record_ids
array

The array of ids that are skipped due to the action not being applicable to them.

​
status
string

The status of the bulk action. Possible values include:

  • completed: The bulk action has been executed, possibly with some errors.
  • invalid: The bulk action contains no record_ids that support the given action.
  • pending: The bulk action is pending and not yet processed.
  • processing: The bulk action is currently being processed.
  • succeeded: The bulk action has succeeded with no errors for all the supporting record_ids.
​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.