Batch update orders

Updates one or more order attributes across multiple orders at once. Currently supports updating status. The operation is not transactional — orders that fail validation are reported in invalid_items while successfully updated ones appear in valid_items. Requires admin scope.

POST/shops/{shop_id}/orders/updaters

Authorization

AuthorizationBearer token (JWT) · headerrequired

OAuth 2.0 Bearer token. Obtain via POST https://auth.onbolder.com/oauth/token.

Scopes:admin

Path parameters

shop_idstringrequired

Shop ID or subdomain

Request body

requiredapplication/json

idsinteger[]required

Array of order IDs to update

additionsobjectrequired

Attributes to apply to all orders

Show properties

statusstring

New status to set

Allowed:pendingclosedshippedinvalid

Responses

200

Batch update result

idsinteger[]

additionsobject

removalsobject

_embeddedobject

Show properties

valid_itemsOrderSummary[]

Show properties

Array of OrderSummary

idinteger

shop_idinteger

codestring

statusstring

Allowed:checkoutpendingclosedshippedinvalid

net_totalinteger

Order subtotal in cents (before shipping/discounts)

totalinteger

Final total in cents

shipping_totalinteger

shipping_descriptionstring

discount_totalinteger

tracking_codestring | null

courier_namestring | null

total_weight_in_gramsinteger

created_onstring<date-time>

updated_onstring<date-time>

pending_onstring<date-time> | null

closed_onstring<date-time> | null

shipped_onstring<date-time> | null

fulfillmentobject

Show properties

fulfillment_methodstring

Allowed:shippingpickup

payment_infoobject

Show properties

typestring

namestring

auth_codestring

transaction_idstring

_linksobject

invalid_itemsobject[]

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_idpath*Shop ID or subdomain

Bodyapplication/json

Request body

Request

curl -X POST 'https://api.onbolder.com/v1/shops/string/orders/updaters' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "ids": [
    577048,
    12001
  ],
  "additions": {
    "status": "shipped"
  }
}'

const response = await fetch("https://api.onbolder.com/v1/shops/string/orders/updaters", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"ids\": [\n    577048,\n    12001\n  ],\n  \"additions\": {\n    \"status\": \"shipped\"\n  }\n}"
});

import requests

response = requests.post(
    "https://api.onbolder.com/v1/shops/string/orders/updaters",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"ids\": [\n    577048,\n    12001\n  ],\n  \"additions\": {\n    \"status\": \"shipped\"\n  }\n}",
)

Response

{
  "ids": [
    0
  ],
  "additions": {},
  "removals": {},
  "_embedded": {
    "valid_items": [
      {
        "id": 0,
        "shop_id": 0,
        "code": "string",
        "status": "checkout",
        "net_total": 0,
        "total": 0,
        "shipping_total": 0,
        "shipping_description": "string",
        "discount_total": 0,
        "tracking_code": "string",
        "courier_name": "string",
        "total_weight_in_grams": 0,
        "created_on": "2019-08-24T14:15:22Z",
        "updated_on": "2019-08-24T14:15:22Z",
        "pending_on": "2019-08-24T14:15:22Z",
        "closed_on": "2019-08-24T14:15:22Z",
        "shipped_on": "2019-08-24T14:15:22Z",
        "fulfillment": {
          "fulfillment_method": "shipping"
        },
        "payment_info": {
          "type": "string",
          "name": "string",
          "auth_code": "string",
          "transaction_id": "string"
        },
        "_links": {}
      }
    ],
    "invalid_items": [
      {}
    ]
  }
}