Batch update orders

Batch update multiple orders in a single request. additions accepts order fields (e.g. status, fulfillment_status, courier_name, tracking_code), plus tags to append.

POST/orders/updaters

Authorization

AuthorizationBearer token (JWT) · headerrequired

Query parameters

shop_idintegerrequired

Request body

requiredapplication/json

idsinteger[]required

Order IDs (or permalinks) to update

additionsobject

Fields to set on every matching order (e.g. `status`, `fulfillment_status`, `courier_name`, `tracking_code`), plus `tags` to append.

removalsobject

Show properties

tagsstring[]

replacementsobject

Show properties

tagsstring[]

decrement_stockboolean

default: true

notify_status_changeboolean

default: false

notification_messagestring

Responses

201Orders processed

idsinteger[]

additionsobject

removalsobject

_embeddedobject

Show properties

valid_itemsobject[]

Show properties

Array of object

idinteger

codestring

statusstring

invalid_itemsobject[]

Show properties

Array of object

idinteger

codestring

statusstring

422Validation error (e.g. missing `ids`, or neither `additions`/`removals`/`replacements` given)

Request

curl -X POST "https://api.onbolder.com/v2/orders/updaters?shop_id=0" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "ids": [
    5001,
    5002
  ],
  "additions": {
    "status": "closed",
    "tags": [
      "batch-updated"
    ]
  }
}'

const response = await fetch("https://api.onbolder.com/v2/orders/updaters?shop_id=0", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "ids": [
    5001,
    5002
  ],
  "additions": {
    "status": "closed",
    "tags": [
      "batch-updated"
    ]
  }
})
});

import requests

response = requests.post(
    "https://api.onbolder.com/v2/orders/updaters?shop_id=0",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
  "ids": [
    5001,
    5002
  ],
  "additions": {
    "status": "closed",
    "tags": [
      "batch-updated"
    ]
  }
},
)

Response

{
  "ids": [
    5001,
    5002
  ],
  "additions": {
    "status": "closed"
  },
  "_embedded": {
    "valid_items": [
      {
        "id": 5001,
        "code": "ORD-5001",
        "status": "closed"
      }
    ],
    "invalid_items": []
  }
}