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": "12ba22fb-7661-4e72-b20a-710c06647920",
  "object": "bulk_action",
  "action_type": "delete_products",
  "record_ids": [
    "0a4a5391-a917-4a19-8866-18429a5ed786",
    "2909ca9a-f589-47a8-89f8-acb7d1b9039b",
    "676f9038-f56e-40a1-b8cf-09460e35e5b1",
    "308565bb-b716-4972-9148-b94e2628a54c",
    "b5a1fb14-629a-4c45-b6c5-09a989d093b8"
  ],
  "skipped_record_ids": [],
  "status": "pending",
  "created_at": 1780925356,
  "updated_at": 1780925356
}

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.