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": [
      "37142cce-51b9-40f3-ae9a-d1fc5f9cca61",
      "face3990-1a22-4e9d-b37a-d03c7f3a4916",
      "225c5cf3-13b8-419f-a8b0-0558b8bc7247",
      "9f84fd32-7530-43f3-9b83-3c552d23b7e1",
      "7a4c598b-dc0b-4d6b-bee0-1c12d101ed9f"
    ]
  }
}
'
{
  "id": "c86d2718-3c1e-486d-b7a3-03e809c9d38c",
  "object": "bulk_action",
  "action_type": "delete_products",
  "record_ids": [
    "37142cce-51b9-40f3-ae9a-d1fc5f9cca61",
    "face3990-1a22-4e9d-b37a-d03c7f3a4916",
    "225c5cf3-13b8-419f-a8b0-0558b8bc7247",
    "9f84fd32-7530-43f3-9b83-3c552d23b7e1",
    "7a4c598b-dc0b-4d6b-bee0-1c12d101ed9f"
  ],
  "skipped_record_ids": [],
  "status": "processing",
  "created_at": 1770234840,
  "updated_at": 1770234840
}

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.