Update an ASN (header fields or status)

Parameters

idpathrequiredstring

Request body (optional)

asnNumberstring

clientIdstringnullable

poIdstringnullable

carrierstringnullable

trackingNumberstringnullable

expectedArrivalstring (date-time)nullable

notesstringnullable

statusenum

expectedin_transitarrivedreceivingreceivedclosedcancelled

Responses

200Updated ASN

idstring (uuid)required

asnNumberstringrequired

clientIdstring (uuid)required

poIdstring (uuid)required

statusstringrequired

carrierstringrequired

trackingNumberstringrequired

expectedArrivalstringrequired

arrivedAtstringrequired

notesstringrequired

createdAtstringrequired

updatedAtstringrequired

422Invalid update

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 PATCH 'https://v3.revolutionstreetwxs.io/api/v3/asns/3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10' \
  -H "Authorization: Bearer wxs_pk_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "asnNumber": "ASN-5510",
  "clientId": "client id",
  "poId": "po id",
  "carrier": "UPS",
  "trackingNumber": "tracking number",
  "expectedArrival": "2026-09-15T14:30:00Z",
  "notes": "Example note",
  "status": "expected"
}'

const response = await fetch("https://v3.revolutionstreetwxs.io/api/v3/asns/3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer wxs_pk_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "asnNumber": "ASN-5510",
    "clientId": "client id",
    "poId": "po id",
    "carrier": "UPS",
    "trackingNumber": "tracking number",
    "expectedArrival": "2026-09-15T14:30:00Z",
    "notes": "Example note",
    "status": "expected"
  }),
});
const data = await response.json();

import requests

response = requests.patch(
    "https://v3.revolutionstreetwxs.io/api/v3/asns/3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
    headers={"Authorization": "Bearer wxs_pk_YOUR_API_KEY"},
    json={
      "asnNumber": "ASN-5510",
      "clientId": "client id",
      "poId": "po id",
      "carrier": "UPS",
      "trackingNumber": "tracking number",
      "expectedArrival": "2026-09-15T14:30:00Z",
      "notes": "Example note",
      "status": "expected"
    },
)
data = response.json()

Response 200

{
  "id": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
  "asnNumber": "ASN-5510",
  "clientId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
  "poId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
  "status": "status",
  "carrier": "UPS",
  "trackingNumber": "tracking number",
  "expectedArrival": "expected arrival",
  "arrivedAt": "arrived at",
  "notes": "Example note",
  "createdAt": "created at",
  "updatedAt": "updated at"
}