Guides

Venue API

Vendor API

Webhooks & Callbacks

Order Status Callbacks

When a partner sends an order through POSaBIT, they can track its status in two ways:

  1. Poll via REST API — call GET /api/v3/incoming_orders/{id} to check the order status
  2. Status Callback URL — provide a status_callback URL when creating the order, and POSaBIT will POST status updates to it

Setting Up a Callback

Include a status_callback field in your incoming order request: 

{
  "incoming_order": {
    "order_type": "delivery",
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane@example.com",
    "telephone": "2065551234",
    "status_callback": "https://your-app.com/posabit/orders",
    "address": "123 Main St",
    "city": "Seattle",
    "state_abbrev": "WA",
    "zipcode": "98033",
    "reference_no": "ORD-12345",
    "source": "partner_name",
    "order_items_attributes": [
      {
        "product_id": 900835,
        "product_name": "Product (3.5g)",
        "price": 4000,
        "quantity": 2
      }
    ]
  }
}

Callback Payload

POSaBIT sends an HTTP POST request with application/x-www-form-urlencoded content type every time the order status changes: 

{
  "incoming_order": {
    "id": 12345,
    "reference_no": "ORD-12345",
    "status": "pending",
    "order_type": "pickup"
  }
}

Order Statuses

Status Description
Pending Awaiting fulfillment
Change Order has been modified, waiting for fulfillment
Processing Processing or paused by fulfillment
Completed Completed by fulfillment, awaiting delivery
En Route Out for delivery
Delivered Delivery completed
Canceled Order canceled
STS Failed Failed to create STS delivery