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": "1ef79b1b-f6c2-4889-8695-12b50188b8fd",
  "object": "bulk_action",
  "action_type": "delete_products",
  "record_ids": [
    "2b78c495-017f-4361-bcb0-11fbd1a578db",
    "be8d90b6-e77b-4ec9-8133-38056598ed2a",
    "a17b7a97-8507-496d-b80f-e9e9aff0e6a0",
    "928f5913-5909-40ec-b4a3-5d174084efb9",
    "64c951f6-ffa2-4191-8511-e1d7bdb281ea"
  ],
  "skipped_record_ids": [],
  "status": "pending",
  "created_at": 1772112915,
  "updated_at": 1772112915
}

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.