---
updatedAt: 2025-09-11T20:54:09.000Z
agentTools:
  projectIndex: https://developer.ware2go.io/llms.txt
---

# Publish an Outbound Order status change event

Publish an Outbound Orders status change event

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Webhooks",
    "version": "1.0",
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "contact": {
      "name": "Ware2Go",
      "url": "http://www.ware2go.co",
      "email": "support@ware2go.co"
    },
    "description": "Webhook API for customer access"
  },
  "servers": [
    {
      "url": "https://{host}",
      "description": "Webhook Receiving Server",
      "variables": {
        "host": {
          "default": "localhost:3000",
          "description": "The base URL used to construct webhook paths from"
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Outbound Tracking",
      "description": "Operations related to shipment tracking for outbound sales orders"
    }
  ],
  "paths": {
    "/v1/events/sales_orders/{salesOrderNumber}": {
      "post": {
        "summary": "Publish an Outbound Order status change event",
        "tags": [
          "Outbound Tracking"
        ],
        "operationId": "post-outbound-order-status-change",
        "responses": {
          "200": {
            "description": "Event Acknowledged"
          },
          "400": {
            "description": "Missing Required Information"
          },
          "429": {
            "description": "Too Many Requests"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "title": "Sales Order Webhook Request",
                "type": "object",
                "properties": {
                  "data": {
                    "type": "object",
                    "properties": {
                      "salesOrderNumber": {
                        "type": "string"
                      },
                      "organizationId": {
                        "type": "string"
                      },
                      "eventType": {
                        "type": "string",
                        "title": "Outbound Events",
                        "enum": [
                          "SHIPMENT_MANIFEST_PICKUP",
                          "SHIPMENT_BOOKED_NOT_PICKED_UP",
                          "SHIPMENT_PICKUP",
                          "SHIPMENT_IN_TRANSIT",
                          "SHIPMENT_OUT_FOR_DELIVERY",
                          "SHIPMENT_RETURNED_TO_SENDER",
                          "SHIPMENT_DELIVERED",
                          "SHIPMENT_VOIDED",
                          "SHIPMENT_EXCEPTION",
                          "SHIPMENT_NOT_AVAILABLE",
                          "SHIPMENT_AVAILABLE_FOR_PICKUP",
                          "WAREHOUSE_CREATED",
                          "WAREHOUSE_BACK_ORDERED",
                          "WAREHOUSE_PARTIALLY_ALLOCATED",
                          "WAREHOUSE_ALLOCATED",
                          "WAREHOUSE_DROPPED",
                          "WAREHOUSE_PROCESSING",
                          "WAREHOUSE_WAVED",
                          "WAREHOUSE_PICKING_INITIATED",
                          "WAREHOUSE_PICKING_COMPLETE",
                          "WAREHOUSE_PACKED",
                          "WAREHOUSE_LOADED",
                          "WAREHOUSE_CANCELLED",
                          "WAREHOUSE_SHIPPED"
                        ]
                      },
                      "trackingNumber": {
                        "type": "string"
                      }
                    }
                  },
                  "meta": {
                    "title": "Meta",
                    "type": "object",
                    "properties": {
                      "version": {
                        "type": "string"
                      },
                      "serviceName": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "version",
                      "serviceName"
                    ]
                  },
                  "links": {
                    "title": "Links",
                    "type": "object"
                  }
                },
                "required": [
                  "data",
                  "meta",
                  "links"
                ]
              },
              "examples": {
                "Handle Warehouse Shipped for order abcd1234": {
                  "value": {
                    "data": {
                      "salesOrderNumber": "abcd1234",
                      "organizationId": "MYMERCHANTID",
                      "eventType": "WAREHOUSE_SHIPPED",
                      "trackingNumber": null
                    },
                    "links": {
                      "v1": "https://openapi.ware2go.io/v1/merchants/MYMERCHANTID/orders/abcd1234"
                    },
                    "meta": {
                      "version": "1.0.0",
                      "serviceName": "webhooks"
                    }
                  }
                },
                "Handle Shipment Delivered for order abcd1234": {
                  "value": {
                    "data": {
                      "salesOrderNumber": "abcd1234",
                      "organizationId": "MYMERCHANTID",
                      "eventType": "SHIPMENT_DELIVERED",
                      "trackingNumber": "1Z12345E1512345676"
                    },
                    "links": {
                      "v1": "https://openapi.ware2go.io/v1/merchants/MYMERCHANTID/orders/abcd1234"
                    },
                    "meta": {
                      "version": "1.0.0",
                      "serviceName": "webhooks"
                    }
                  }
                }
              }
            }
          },
          "description": "Post the Outbound Orders event payload"
        },
        "description": "Publish an Outbound Orders status change event"
      },
      "parameters": [
        {
          "schema": {
            "type": "string"
          },
          "name": "salesOrderNumber",
          "in": "path",
          "required": true
        }
      ]
    }
  },
  "components": {
    "securitySchemes": {
      "Bearer": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "Bearer Authentication (Bearer Token) on the Authorization Header"
      }
    }
  },
  "security": [
    {
      "Bearer": []
    }
  ]
}
```