Bulk Cancel

POST

/preorders/orders/bulk_cancel

curl --request POST \
  --url https://app.stoqapp.com/api/v2/external/preorders/orders/bulk_cancel \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <X-Auth-Token>' \
  --data '{ "order_ids": [ "string" ], "refund_deposit": "string", "refund_balance": "string", "notify_customer": "string", "reason": "string" }'

• Production

Cancel many preorder orders (max 1000), with optional refund flags.

Authorizations

• ApiKeyAuth

Request Body^required

Media typeapplication/json

object

order_ids

refund_deposit

refund_balance

notify_customer

reason

Example

{
  "order_ids": [
    "string"
  ],
  "refund_deposit": "string",
  "refund_balance": "string",
  "notify_customer": "string",
  "reason": "string"
}

Responses

200

Success — the updated resource.

Media typeapplication/json

object

Example ^generated

{}

202

Accepted — async/bulk work was queued. Poll the returned job.

Media typeapplication/json

Returned for async/bulk work — poll the job until it reaches a terminal state.

object

job_id

string

status_url

string

Example

{
  "job_id": "job_a1b2c3",
  "status_url": "/api/v2/external/jobs/job_a1b2c3"
}

401

Missing or invalid X-Auth-Token.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Unauthorized"
  ]
}

422

The request failed validation.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "name is required"
  ]
}

429

Rate limited — cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Rate limit exceeded"
  ]
}