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": [
      "42689178-39bb-4e65-85a1-5c5aaec4a65c",
      "d6943379-bbf7-466a-b109-bcfcb16f7bff",
      "ced14138-dc74-45e8-9b45-3fd958cd2500",
      "1894942e-b20e-4579-87f2-0269bada6904",
      "e2884b68-a0a0-4998-a1da-ce1cd09976f5"
    ]
  }
}
'
{
  "id": "7d342434-cb39-4d2f-8b29-bf70ac19b00b",
  "object": "bulk_action",
  "action_type": "delete_products",
  "record_ids": [
    "42689178-39bb-4e65-85a1-5c5aaec4a65c",
    "d6943379-bbf7-466a-b109-bcfcb16f7bff",
    "ced14138-dc74-45e8-9b45-3fd958cd2500",
    "1894942e-b20e-4579-87f2-0269bada6904",
    "e2884b68-a0a0-4998-a1da-ce1cd09976f5"
  ],
  "skipped_record_ids": [],
  "status": "processing",
  "created_at": 1782485806,
  "updated_at": 1782485806
}

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.