Create Quotation From POS Bill

Creates a quotation in one call from POS-bill-shaped data: location, optional customer, and bill lines. A bill-level discount_amount is distributed across lines proportionally to each line's share of sub_total. With auto_approve: true the quotation is finalized immediately, otherwise it is left as a draft.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
location
object
required

{id} of the location (required).

customer
object | null

{id} of the customer to attach (optional).

number
required

Bill sub total, used to apportion discount_amount across lines. Required in practice — omitting it fails.

number
required

Bill-level discount amount to distribute across the lines. Required in practice whenever sub_total is greater than zero — omitting it fails; send 0 for no discount.

bill_lines
array of objects
required

Lines from the bill. Each line requires variant ({id}), quantity, sales_price, unit, unit_quantity, taxes (array of {id}; pass [] for none), total (line total, used for discount apportioning) and a discount_type key (may be null). Optional: text, price_level, discount_type_value, discount_amount, note, note_internal.

bill_lines*
string | null

Accepted by validation but not persisted — set terms via the update endpoint instead.

boolean

Finalize the quotation immediately after creating it.

Headers
string
required

The merchant install this request acts on (install.store_id from the app.installed webhook).

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json