Skip to main content

CreateQuoteInput

idempotencyKeystring

A value you generate for this quote. Same effect as the Idempotency-Key header: a retry with the same key and body returns the original quote.

statusstring

Status the quote is created in. Defaults to DRAFT. A quote cannot be created already accepted, rejected, expired, converted or cancelled.

Possible values: [DRAFT, PENDING, SENT, VIEWED, APPROVED]

customerIdstringrequired

Id of the customer the quote is for, from the customers list.

Example: 9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d
customerNamestring

Customer name to show on the quote.

Example: Example Trading Co
customerEmailstring

Customer email to show on the quote.

Example: buyer@example.com
customerMobilestring

Customer phone number to show on the quote.

Example: +1 555 0100
validUntilstring

The quote is valid until this date, ISO 8601.

Example: 2026-02-14
quoteDatestring

Quote date, ISO 8601. Defaults to today. Any other day needs the user who created the key to hold the back-dating permission.

Example: 2026-01-15
referencestring

Your own reference for the quote, such as its id in your system.

Example: INT-0001
prioritystring

Priority of the quote.

Possible values: [LOW, NORMAL, HIGH, URGENT]

notesstring

Free-text notes on the quote.

internalNotesstring

Free-text notes for your own team.

deliveryInstructionsstring

Instructions for the delivery.

termsstring

Terms and conditions text for the quote.

currencystringrequired

ISO 4217 currency code of every amount on the quote.

Example: USD
exchangeRatenumber

Rate from the quote currency to the workspace currency. Greater than zero.

Possible values: > 0

Example: 1
discountTypestringrequired

How discountValue is read: as a percent or as an amount.

Possible values: [PERCENTAGE, AMOUNT]

discountValuenumberrequired

Quote-level discount, a percent or an amount according to discountType. Use 0 for none.

Possible values: >= 0

Example: 0
taxRatenumberrequired

Quote-level tax rate percent.

Example: 10
shippingCostnumberrequired

Shipping charge in the quote currency. Use 0 for none.

Possible values: >= 0

Example: 0
taxCalculationMethodstring

Whether line prices already include tax (INCLUSIVE) or tax is added on top (EXCLUSIVE).

Possible values: [INCLUSIVE, EXCLUSIVE]

billingAddressstring

Billing address as text, as it should print on the quote.

shippingAddressstring

Shipping address as text, as it should print on the quote.

warehouseIdstring

Warehouse the quote is for.

Example: 9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d
paymentTermsstring

Payment terms code, from the payment terms list.

Example: NET_30
items object[]required

The quote lines. At least one is required.

Possible values: >= 1

  • Array [
    • productIdstringrequired

    Id of the product, from the products list.

    Example: 9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d
    variantIdstringrequired

    Variant id, from the products list.

    Example: 9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d
    productNamestringrequired

    Name to show on the line.

    Example: Sample Widget
    productSkustring

    Stock keeping unit to show on the line.

    Example: SKU-1001
    descriptionstring

    Longer description to show on the line.

    quantitynumberrequired

    Quantity quoted. Must be greater than zero.

    Example: 2
    uomIdstring

    Id of the unit of measure the quantity is in, from the units list.

    Example: 9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d
    uomNamestring

    Name of the unit, to show on the line.

    Example: Each
    unitPricenumberrequired

    Unit price in the quote currency. Required.

    Possible values: >= 0

    Example: 12.5
    salePricenumber

    The variant's sale price, when it has one.

    priceOverrideboolean

    Set to true when unitPrice deliberately differs from the catalogue price. The user who created the key may need the price-override permission.

    overrideReasonstring

    Why the price was overridden.

    Possible values: <= 500 characters

    discountnumberrequired

    Line discount, a percent or an amount according to the line's discountType. Required; use 0 for none.

    Possible values: >= 0

    Example: 0
    discountTypestringrequired

    How discount is read: as a percent or as an amount.

    Possible values: [PERCENTAGE, AMOUNT]

    discountAmountnumber

    Line discount as an amount in the quote currency.

    Possible values: >= 0

    taxRatenumberrequired

    Tax rate percent for the line. Required.

    Example: 10
    taxAmountnumberrequired

    Tax on the line in the quote currency, as your system computed it. Required.

    Example: 2.5
    taxCalculationMethodstring

    Whether the line price includes tax (INCLUSIVE) or tax is added on top (EXCLUSIVE).

    Possible values: [INCLUSIVE, EXCLUSIVE]

    totalPricenumber

    Line total in the quote currency.

    Example: 27.5
    warehouseIdstring

    Warehouse this line ships from.

    Example: 9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d
  • ]
    • subtotalnumberrequired

    Sum of the line values before discount and tax, as your system computed it. Required.

    Example: 25
    discountAmountnumberrequired

    Total discount in the quote currency, as your system computed it. Required; use 0 for none.

    Possible values: >= 0

    Example: 0
    taxAmountnumberrequired

    Total tax in the quote currency, as your system computed it. Required.

    Example: 2.5
    totalAmountnumberrequired

    Grand total in the quote currency, as your system computed it. Required.

    Example: 27.5
    ownership object

    Who owns the quote.

    ownerIdstring

    Id of the user who owns the quote.

    Example: 9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d
    CreateQuoteInput
    {
      "idempotencyKey": "string",
      "status": "DRAFT",
      "customerId": "9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d",
      "customerName": "Example Trading Co",
      "customerEmail": "buyer@example.com",
      "customerMobile": "+1 555 0100",
      "validUntil": "2026-02-14",
      "quoteDate": "2026-01-15",
      "reference": "INT-0001",
      "priority": "LOW",
      "notes": "string",
      "internalNotes": "string",
      "deliveryInstructions": "string",
      "terms": "string",
      "currency": "USD",
      "exchangeRate": 1,
      "discountType": "PERCENTAGE",
      "discountValue": 0,
      "taxRate": 10,
      "shippingCost": 0,
      "taxCalculationMethod": "INCLUSIVE",
      "billingAddress": "string",
      "shippingAddress": "string",
      "warehouseId": "9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d",
      "paymentTerms": "NET_30",
      "items": [
        {
          "productId": "9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d",
          "variantId": "9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d",
          "productName": "Sample Widget",
          "productSku": "SKU-1001",
          "description": "string",
          "quantity": 2,
          "uomId": "9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d",
          "uomName": "Each",
          "unitPrice": 12.5,
          "salePrice": 0,
          "priceOverride": true,
          "overrideReason": "string",
          "discount": 0,
          "discountType": "PERCENTAGE",
          "discountAmount": 0,
          "taxRate": 10,
          "taxAmount": 2.5,
          "taxCalculationMethod": "INCLUSIVE",
          "totalPrice": 27.5,
          "warehouseId": "9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d"
        }
      ],
      "subtotal": 25,
      "discountAmount": 0,
      "taxAmount": 2.5,
      "totalAmount": 27.5,
      "ownership": {
        "ownerId": "9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d"
      }
    }