Skip to main content
POST
/
v1
/
bulk_actions
Create
curl --request POST \
  --url https://{defaultHost}/v1/bulk_actions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bulk_action": {
    "action_type": "delete_products",
    "record_ids": [
      "7fbe4450-7d85-4064-a399-9f138678086f",
      "2ea81476-bfc8-45dc-8efe-4e06455c2037",
      "f3d9d605-f30b-4fee-aa50-4169d7bfb69e",
      "a3a1f11b-61d3-4974-a00f-aad8c8725628",
      "a762d99c-c905-40e3-b725-46e5fd9b940f"
    ]
  }
}
'
{
  "id": "51a84ac5-0bfd-4c5b-badc-3ea9a9b557dd",
  "object": "bulk_action",
  "action_type": "delete_products",
  "record_ids": [
    "7fbe4450-7d85-4064-a399-9f138678086f",
    "2ea81476-bfc8-45dc-8efe-4e06455c2037",
    "f3d9d605-f30b-4fee-aa50-4169d7bfb69e",
    "a3a1f11b-61d3-4974-a00f-aad8c8725628",
    "a762d99c-c905-40e3-b725-46e5fd9b940f"
  ],
  "skipped_record_ids": [],
  "status": "processing",
  "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.

Body

application/json
​
bulk_action
object

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.