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

201

Orders 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

422

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

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

shop_idquery*

Bodyapplication/json

Request body

Request

curl -X POST 'https://api.onbolder.com/v2/orders/updaters?shop_id=0' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -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",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"ids\": [\n    5001,\n    5002\n  ],\n  \"additions\": {\n    \"status\": \"closed\",\n    \"tags\": [\n      \"batch-updated\"\n    ]\n  }\n}"
});

import requests

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

Response

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