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": [
      "818d5f7c-deb5-483d-a7d2-13d0e9969906",
      "df628831-1b5f-4ea8-9f23-fd5f4fe3c2f5",
      "f57c9822-b888-462c-9c05-3f2442ae1636",
      "e386ee22-fb2e-4e4f-b017-049b989fba04",
      "5fe1da71-6001-4d14-9f72-b8b2270ddb68"
    ]
  }
}
'
{
  "id": "cbfeab9c-2d32-415d-8785-ee071bb9e4fd",
  "object": "bulk_action",
  "action_type": "delete_products",
  "record_ids": [
    "818d5f7c-deb5-483d-a7d2-13d0e9969906",
    "df628831-1b5f-4ea8-9f23-fd5f4fe3c2f5",
    "f57c9822-b888-462c-9c05-3f2442ae1636",
    "e386ee22-fb2e-4e4f-b017-049b989fba04",
    "5fe1da71-6001-4d14-9f72-b8b2270ddb68"
  ],
  "skipped_record_ids": [],
  "status": "processing",
  "created_at": 1775218844,
  "updated_at": 1775218844
}

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.