Skip to content

Orders API

14 endpoints. All requests need an Authorization header — see Authentication. API keys additionally need the matching scope.

Method Path Description
GET /api/orders/ List Orders Query: status, opportunity_id, account_id.
POST /api/orders/ Create Order Accepts a JSON body.
POST /api/orders/from-cpq-quote/{cpq_quote_id} Create Order From Cpq Quote
POST /api/orders/from-quote/{quote_id} Create Order From Quote
GET /api/orders/{order_id} Get Order
PATCH /api/orders/{order_id} Update Order Accepts a JSON body.
DELETE /api/orders/{order_id} Delete Order
POST /api/orders/{order_id}/cancel Cancel Order
POST /api/orders/{order_id}/close Close Order
POST /api/orders/{order_id}/confirm Confirm Order
POST /api/orders/{order_id}/fulfill Fulfill Order
POST /api/orders/{order_id}/generate-pdf Generate Order Pdf
POST /api/orders/{order_id}/invoice Invoice Order
GET /api/orders/{order_id}/pdf Download Order Pdf

Try it

The full request/response schema for every endpoint is in the OpenAPI spec served by your own workspace.