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": [
      "64ed9ea8-561b-44ac-9375-2adf8acb4538",
      "f3673036-7ac3-48d6-975d-efd06421895b",
      "e038169b-eca2-4fa5-ac40-c5f064947167",
      "b5f3b02d-0d29-4d3a-85da-892e5e431ffe",
      "1f85613a-d0f0-4e1e-921c-0703ef1f4fe2"
    ]
  }
}
'
{
  "id": "cc4dee2f-a74a-48e3-8136-db82553931cb",
  "object": "bulk_action",
  "action_type": "delete_products",
  "record_ids": [
    "64ed9ea8-561b-44ac-9375-2adf8acb4538",
    "f3673036-7ac3-48d6-975d-efd06421895b",
    "e038169b-eca2-4fa5-ac40-c5f064947167",
    "b5f3b02d-0d29-4d3a-85da-892e5e431ffe",
    "1f85613a-d0f0-4e1e-921c-0703ef1f4fe2"
  ],
  "skipped_record_ids": [],
  "status": "processing",
  "created_at": 1771429851,
  "updated_at": 1771429851
}

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.