Options
All
  • Public
  • Public/Protected
  • All
Menu

1.3.1

  • Documented the partner-orders polling endpoints (GET /v3/partner-orders and GET /v3/partner-orders/paginated) — see Partner Orders.
  • Partner-orders polling now authenticates via partner-role JWT (Authorization: Bearer <access-token>); the previous static signing-key bearer is no longer supported.
  • Added the active query parameter to both partner-orders endpoints. When active=true, orders whose status is one of new, cancelled, closed, completed, invoice sent are excluded.

1.3.0

  • Added SetJobAppointment command and the dedicated POST /v3/commands/partner/appointment endpoint. Sets or updates a job's appointment (appointment_confirmed). Identifier accepts any of jobApiId, invoicingEid, gidOrderNumber (Job.name), or yourOrderID (Job.extPartnerId).
  • Added SetJobYourOrderId command and the dedicated POST /v3/commands/partner/your-order-id endpoint. Sets the partner-side external order id (Job.extPartnerId) on a specific job without changing its status.
  • Partner command endpoints enforce partner ownership: the authenticated account must equal Job.partner.id or Job.partner.parentId (master/child support); otherwise 403 is returned.
  • Partner command endpoints use a new x-webhook-signature HMAC header (SHA-256 hex of the raw body, only required when the calling partner has a signature key configured on their WebhookConfiguration).
  • Added the Commands overview page covering all currently supported commands.

1.1.0

1.0.0

Initial release of the API.

Generated using TypeDoc