Upsert a batch of orders

Creates or updates up to 1000 orders keyed on order number, one transaction each, so a bad record never rolls back the good ones. This is the endpoint for an ERP that re-sends: while an order is still unwaved and planned/pending the whole record (lines included) is replaced; once it is in work only priority, notes and shipBy are applied and the rest is reported in ignoredFields. Always 200 when the batch is well-formed; per-record outcomes are in results.

Request body (optional)

ordersobject[]required

orderNumberstringrequired

clientIdstring (uuid)nullable

clientCodestring

locationIdstring (uuid)nullable

locationCodestring

customerNamestring

customerEmailstringnullable

statusenum

plannedpending

priorityenum

lownormalhighurgent

orderDatestringnullable

shipBystringnullable

releaseAtstringnullable

carrierstringnullable

servicestringnullable

externalRefstringnullable

notesstringnullable

linesobject[]

lineNointeger

skustringrequired

qtyinteger

totalItemsinteger

Responses

200Per-order result

creatednumberrequired

updatednumberrequired

failednumberrequired

resultsobject[]required

indexnumberrequired

orderNumberstringrequired

statusenumrequired

createdupdatederror

idstring (uuid)required

ignoredFieldsstring[]required

errorstringrequired

Sending requests from a browser

Open https://v3.revolutionstreetwxs.io/api/v3/docs to send requests to this endpoint with your API key.

Request

curl -X POST 'https://v3.revolutionstreetwxs.io/api/v3/orders/batch' \
  -H "Authorization: Bearer wxs_pk_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "orders": [
    {
      "orderNumber": "ORD-10042",
      "clientId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
      "clientCode": "client code",
      "locationId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
      "locationCode": "A-01-02",
      "customerName": "",
      "customerEmail": "ops@example.com",
      "status": "planned",
      "priority": "low",
      "orderDate": "order date",
      "shipBy": "ship by",
      "releaseAt": "release at",
      "carrier": "UPS",
      "service": "Ground",
      "externalRef": "external ref",
      "notes": "Example note",
      "lines": [],
      "totalItems": 10
    }
  ]
}'

const response = await fetch("https://v3.revolutionstreetwxs.io/api/v3/orders/batch", {
  method: "POST",
  headers: {
    Authorization: "Bearer wxs_pk_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "orders": [
      {
        "orderNumber": "ORD-10042",
        "clientId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
        "clientCode": "client code",
        "locationId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
        "locationCode": "A-01-02",
        "customerName": "",
        "customerEmail": "ops@example.com",
        "status": "planned",
        "priority": "low",
        "orderDate": "order date",
        "shipBy": "ship by",
        "releaseAt": "release at",
        "carrier": "UPS",
        "service": "Ground",
        "externalRef": "external ref",
        "notes": "Example note",
        "lines": [],
        "totalItems": 10
      }
    ]
  }),
});
const data = await response.json();

import requests

response = requests.post(
    "https://v3.revolutionstreetwxs.io/api/v3/orders/batch",
    headers={"Authorization": "Bearer wxs_pk_YOUR_API_KEY"},
    json={
      "orders": [
        {
          "orderNumber": "ORD-10042",
          "clientId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
          "clientCode": "client code",
          "locationId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
          "locationCode": "A-01-02",
          "customerName": "",
          "customerEmail": "ops@example.com",
          "status": "planned",
          "priority": "low",
          "orderDate": "order date",
          "shipBy": "ship by",
          "releaseAt": "release at",
          "carrier": "UPS",
          "service": "Ground",
          "externalRef": "external ref",
          "notes": "Example note",
          "lines": [],
          "totalItems": 10
        }
      ]
    },
)
data = response.json()

Response 200

{
  "created": 1.5,
  "updated": 1.5,
  "failed": 1.5,
  "results": [
    {
      "index": 1.5,
      "orderNumber": "ORD-10042",
      "status": "created",
      "id": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
      "ignoredFields": [
        "ignored field"
      ],
      "error": "error"
    }
  ]
}