Documentation

Webhooks

Configure a callback URL in your API settings to receive order-status instead of polling.

Delivery & retries

  • QCC POSTs application/json to your endpoint. Return an HTTP 2xx to acknowledge.
  • On a 5xx response we retry up to 3 times, about 3 seconds apart, then stop. We recommend monitoring your callback logs and alerting on 5xx.

Payload

ParameterTypeDescription
eventTypeString(50)Event type, e.g. Order Status.
resultObjectEvent result (below).

Result

ParameterTypeDescription
orderNoString(50)Order number used to retrieve data.
qccCodeString(50)QCC code.
objectNameString(500)Target legal (script) name.
objectNameEnString(1000)Target English name.
statusString(1)S = success, F = failure.
{
  "eventType": "OrderStatus",
  "result": {
    "orderNo": "A2026...",
    "qccCode": "QCN...",
    "objectName": "Sample Company",
    "status": "S"
  }
}