Quick Sale – OptoSoft API

Adds one line item to the temporary cart. Call it once per product. For a spectacle lens, the optical powers travel on the line itself — that is how a single order can carry different powers for each pair.

Most-used fields

Example request

curl -X POST https://api.opto-soft.com/api/quickSale/saveSalesOrderTemp \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "sessionID": "3f9c1a52-7b40-4e6d-9a11-0d2c8e5b7f31",
    "itemID": "ENCRYPTED_ITEM_ID",
    "qty": 1,
    "mrp": 4500,
    "price": 4500,
    "discountRate": 10,
    "sgstRate": 6,
    "cgstRate": 6,
    "pairNo": "1"
  }'

Reads the current cart back with live totals. Extra charges are supplied here rather than stored on the cart, so the same session can be re-totalled under different charge assumptions.

Request body

Example request

curl -X POST https://api.opto-soft.com/api/quickSale/GetSalesOrderTemp \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "sessionId": "3f9c1a52-7b40-4e6d-9a11-0d2c8e5b7f31",
    "jobCharges": 150,
    "isCompositionScheme": false,
    "isCustomerStateNotSameAsCompanyState": false
  }'

Edits one cart line in place — the quantity, price or discount stepper on a POS screen. Tax and totals are recalculated for you.

Request body

Example request

curl -X POST https://api.opto-soft.com/api/quickSale/update-sales-order-temp-values \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "ENCRYPTED_TEMP_LINE_ID",
    "qty": 2,
    "price": 4500,
    "discountRate": 15
  }'

Removes a single line, or a whole pair, from the cart.

Request body

Example request

curl -X POST https://api.opto-soft.com/api/quickSale/delete-salesorder-temp \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "sessionID": "3f9c1a52-7b40-4e6d-9a11-0d2c8e5b7f31",
    "salesOrderTempId": "ENCRYPTED_TEMP_LINE_ID"
  }'

Abandons the whole cart. Call this whenever a transaction is cancelled, and on start-up for any session your client did not finish.

Request body

Example request

curl -X POST https://api.opto-soft.com/api/quickSale/deleteSalesOrderTempBySession \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "sessionID": "3f9c1a52-7b40-4e6d-9a11-0d2c8e5b7f31" }'

Resolves a barcode or item code into a full item record with price and tax rates. This is the barcode-scanner endpoint — the fastest way to add a frame or accessory to the cart.

Query parameters

Example request

curl "https://api.opto-soft.com/api/quickSale/getItemDetailFromCode?code=8901234567890" \
  -H "Authorization: Bearer YOUR_TOKEN"

Returns the live on-hand quantity for one item. Call it before committing a sale to avoid overselling a frame that is down to its last piece.

Query parameters

Example request

curl "https://api.opto-soft.com/api/quickSale/getExactItemStock?itemId=88214" \
  -H "Authorization: Bearer YOUR_TOKEN"

Type-ahead search across frames and sunglasses. Use it when the barcode is unreadable or the customer is browsing by brand or model.

Query parameters

Example request

curl "https://api.opto-soft.com/api/quickSale/GetFrameSunGlassForAutoComplete?term=rayban&yearId=9" \
  -H "Authorization: Bearer YOUR_TOKEN"

Type-ahead search across spectacle lenses. Unlike the frame search, this takes no year parameter.

Query parameters

Example request

curl "https://api.opto-soft.com/api/quickSale/GetSpectacleLensForAutoComplete?term=progressive" \
  -H "Authorization: Bearer YOUR_TOKEN"

Searches contact lenses. This one is a POST with a JSON body rather than a query string, unlike the two autocomplete endpoints above.

Request body

Example request

curl -X POST https://api.opto-soft.com/api/quickSale/search-contact-lens \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "term": "acuvue" }'

Resolves an item type by its numeric ID — used to decide which cart section (frame, lens, contact lens, accessory) a scanned item belongs in.

Query parameters

Example request

curl "https://api.opto-soft.com/api/quickSale/get-item-type-id?id=3" \
  -H "Authorization: Bearer YOUR_TOKEN"

The commit call. Converts the temporary cart into a real transaction — sales order, invoice, receipt, stock movement and any lab purchase order — in one atomic operation.

The body is the composite OMFastWizardModel, the same object used by /api/Invoice/save-invoice-data. Its top-level structure is documented on the Invoices page.

Key fields

Example request

curl -X POST https://api.opto-soft.com/api/quickSale/SaveSale \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data-binary @sale.json

Raises an invoice against an order that already exists, without recreating the order. This is the delivery-day call: the customer collects their spectacles and the tax invoice is generated.

Request body

Example request

curl -X POST https://api.opto-soft.com/api/quickSale/SaveInvoiceOnly \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "salesOrderID": "ENCRYPTED_SALES_ORDER_ID",
    "customerID": "ENCRYPTED_CUSTOMER_ID",
    "invoiceDate": "2026-07-29T00:00:00",
    "isCompositionScheme": false
  }'

Records a payment. Use it for an advance at order time, for the balance on delivery, or for a standalone payment not tied to an invoice.

The model is large (164 fields) because it doubles as the print payload — it carries branch letterhead, terms and totals for the printed receipt as well as the payment itself. In practice you set a small subset.

Most-used fields

Example request

curl -X POST https://api.opto-soft.com/api/quickSale/SaveReceipt \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "salesOrderID": "ENCRYPTED_SALES_ORDER_ID",
    "yearId": "ENCRYPTED_YEAR_ID",
    "branchId": 24,
    "receiptTypeId": 2,
    "receiptAmount": 3000,
    "referenceNo": "UPI-402291837",
    "salesOrderNo": "SO/2026/001842"
  }'

Lists the configured payment methods — cash, card, UPI, cheque, credit note and so on. Fetch once at start-up and cache; the IDs feed receiptTypeId on SaveReceipt.

Example request

curl https://api.opto-soft.com/api/quickSale/Fetch-Receipt-Type \
  -H "Authorization: Bearer YOUR_TOKEN"

Returns the full detail of one receipt, in the shape needed to reprint it.

Query parameters

Example request

curl "https://api.opto-soft.com/api/quickSale/GetReceiptDetails?customerId=30188&receiptId=77120&salesOrderId=104822" \
  -H "Authorization: Bearer YOUR_TOKEN"

Lists unredeemed credit notes held by a customer — from returns, cancellations or goodwill adjustments — so they can be applied against a new sale.

Query parameters

Example request

curl "https://api.opto-soft.com/api/quickSale/get-credit-notes?customerId=30188" \
  -H "Authorization: Bearer YOUR_TOKEN"

Referring doctors, in picker form. The fuller doctor master with addresses lives in Customers & Prescriptions.

Query parameters

None.

Staff who fit lenses into frames. Feeds fitterID on SaveSale.

Query parameters

None.

Labs and suppliers used for lens surfacing. Feeds supplierID on the purchase order raised with a sale.

Query parameters

None.

Job priorities — normal, urgent, same-day. Feeds priorityID and drives the promised delivery date.

Query parameters

None.

Gender options with their encrypted IDs, for genderID on customer upsert.

Query parameters

None.

Customer acquisition sources — walk-in, referral, online, campaign. Paged, unusually for a lookup.

Query parameters

Example request

curl "https://api.opto-soft.com/api/quickSale/getSources?page=1&pageSize=100" \
  -H "Authorization: Bearer YOUR_TOKEN"

Loyalty and membership schemes, with their encrypted IDs. Paged like getSources.

Query parameters

Example request

curl "https://api.opto-soft.com/api/quickSale/getMemberships?page=1&pageSize=50" \
  -H "Authorization: Bearer YOUR_TOKEN"

Lists the card types configured for card payments, for the picker shown when receiptTypeId is a card method.

Query parameters

None.

Returns the branch profile for the token’s scope — name, address, GSTIN, phone and email. Use it to populate the letterhead fields on SaveReceipt and on printed documents.

Query parameters

None. Scope comes from the bearer token.

Example request

curl https://api.opto-soft.com/api/quickSale/get-branch-details \
  -H "Authorization: Bearer YOUR_TOKEN"

Streams the branch logo image for printed receipts and invoices. Returns image bytes, not JSON.

Path parameters

Example request

curl https://api.opto-soft.com/api/quickSale/get-branch-logo/24/logo.png \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -o logo.png

Returns the minimum supported client version. The OptoSoft Android POS app calls this on launch to decide whether to prompt for an update. Worth calling from your own client too, as a forward-compatibility signal.

Query parameters

None.

Example request

curl https://api.opto-soft.com/api/quickSale/app-version \
  -H "Authorization: Bearer YOUR_TOKEN"