Checkout Retail Dispense

Successful Response

{
    "status": "ok",
    "message": "",
    "data": {
        "retailDispenseTicketId": 4217,
        "barCode": "1234567890123456",
        "internalRequestId": "7693ae51-135b-4755-a15e-f7aac21bc33a",
        "totalItems": 2,
        "totalDollarAmount": 40.00,
        "totalTaxAmount": 3.20,
        "grandTotalAmount": 43.20,
        "totalThcMg": 520.00,
        "delta9ThcMgTotal": 450.00,
        "adultUseCannabisGramsTotal": 7.00,
        "adultUseConcentrateGramsTotal": 0,
        "adultUseCannabisMilligramsTotal": 0,
        "medicalUnitsTotal": 0,
        "plantCountTotal": 0,
        "medicalIdentifierId": null
    }
}

Response Fields

Endpoint-Specific Errors

Void: Eligibility and Safety Rules

The void is allowed only when all applicable conditions remain true:

• The ticket belongs to the authorized organization and location.
• The ticket was created through the POS API.
• The ticket currently has status Complete.
• The location has an active license or valid temporary access for the original Retail or Consumption room.
• The original ticket item rows and inventory records still exist.
• Each inventory item remains at the original organization and location.
• The inventory has no transfer, manifest, or destruction activity.
• Each ticket item retains its original dispense inventory-history link.
• The inventory has no later unsafe history event that prevents automatic reversal.
• Stored item quantities and package quantities are valid.

The route intentionally does not apply the administrative inventory-case restriction check. A case hold does not by itself prevent a safe void, although all downstream-activity and inventory-integrity checks still apply.

Inventory Restoration

• Packaged inventory has its package count increased by the dispensed package quantity.
• When an amount-per-package snapshot is available, packaged inventory also has its total cannabis material restored.
• Unpackaged weight or volume inventory has its total cannabis material increased by the dispensed quantity.
• Inventory deleted because the full available amount was sold is restored to active status.
• A new inventory-history record documents the restored quantity and the void reason.
• The parent ticket is updated to Voided and stores the void request ID, date/time, user, and reason.

Void Idempotency

• For this endpoint, internalRequestId identifies one logical void and is stored as voidInternalRequestId. The POS API should persist one UUID per intended void and reuse that same UUID when retrying after an uncertain response.
• If the original void completed and the same ticket is retried with the same request ID, the endpoint returns a successful Voided response without restoring inventory a second time.
• The idempotent retry response contains an empty restoredItems array because the restoration occurred during the original call.
• Reusing the void request ID for a different operation may return DUPLICATE_VOID_INTERNAL_REQUEST_ID.
• A new UUID must be generated for a different logical void.

Successful Response

{
    "status": "ok",
    "message": "",
    "data": {
        "retailDispenseTicketId": 4217,
        "barCode": "1234567890123456",
        "ticketStatus": "Voided",
        "voidedDateTime": "2026-07-25T16:20:14.000Z",
        "voidedByUserId": 1001,
        "voidReason": "The POS user selected the wrong inventory item and confirmed that no downstream inventory activity occurred.",
        "voidInternalRequestId": "f87a21f8-cf3a-46af-b4df-b25633499f14",
        "restoredItems": [
            {
                "inventoryId": 1789,
                "barCode": "9876543210987654",
                "quantity": 2,
                "unit": "pkg"
            }
        ]
    }
}

Idempotent Retry Response

{
    "status": "ok",
    "message": "",
    "data": {
        "retailDispenseTicketId": 4217,
        "barCode": "1234567890123456",
        "ticketStatus": "Voided",
        "voidedDateTime": "2026-07-25T16:20:14.000Z",
        "voidedByUserId": 1001,
        "voidReason": "The POS user selected the wrong inventory item and confirmed that no downstream inventory activity occurred.",
        "voidInternalRequestId": "f87a21f8-cf3a-46af-b4df-b25633499f14",
        "restoredItems": []
    }
}

Response Fields

Restored Item Fields

Endpoint-Specific Errors