Transactions
Manage sales transactions including creating, updating, and completing orders. Transactions represent the core sales workflow in Blaze.
Base URL: /api/v1/partner/transactions
Endpoints Overview
| Method | Endpoint | Description |
|---|---|---|
| GET | / | Get All Transaction |
| GET | /days | Get All Transaction By Days |
| GET | /active | Get All Transaction |
| GET | /{transactionId} | Get Transaction by Id |
| POST | /queues/{queueName} | Add Member to Queue |
| POST | /{transactionId}/schedule | Update Scheduled Delivery Time for Accepted Orders |
| DELETE | /{transactionId} | Delete Transaction from Queue |
| POST | /{transactionId}/prepare | Prepare Cart |
| POST | /{transactionId}/sendToFulfill | Set Transaction to Fulfill |
| POST | /{transactionId}/complete | Complete Transaction |
| POST | /{transactionId}/markAsPaid | Mark Transaction as Paid |
| POST | /{transactionId}/sign | Sign Transaction |
| POST | /{transactionId}/hold | Hold Transaction |
| POST | /{transactionId}/address | Update delivery address for transaction |
| POST | /{transactionId}/employee | Reassign Transaction Employee |
| GET | /{transactionId}/unassign | Unassign Transaction |
| GET | /{transactionId}/start | Start Transaction |
| GET | /{transactionId}/stop | Stop Transaction |
| GET | /members/{memberId}/completed | Get completed transactions for member |
| GET | /members/{memberId}/active | Get active transactions for member |
| POST | /{transactionId}/finalize | Finalize all transaction items |
| POST | /{transactionId}/unfinalize | Unfinalize all transaction items |
| POST | /{transactionId}/packedBy | Update Pack By Employee |
| POST | /{transactionId}/preparedBy | Update Prepare By Employee |
Get All Transaction
GET /api/v1/partner/transactions
Retrieve a paginated list of transactions within a date range. Dates must be in MM/dd/yyyy format. The maximum date range is 7 days — requests exceeding this will be rejected. If no dates are provided, defaults to the last 7 days. Results are capped at 100 per page.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
startDate | string | No | Start date filter |
endDate | string | No | End date filter |
skip | integer | No | Number of records to skip |
limit | integer | No | Maximum records to return |
Response
Returns a paginated SearchResult of Transaction objects.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Get All Transaction By Days
GET /api/v1/partner/transactions/days
Retrieve transactions starting from a given date for a specified number of days. This is a convenience alternative to the date-range endpoint — instead of providing both startDate and endDate, you specify a startDate and a days count (1–7). The same 7-day maximum applies.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
startDate | string | No | Start date filter |
days | integer | No | Number of days to query (default: 1) |
skip | integer | No | Number of records to skip |
limit | integer | No | Maximum records to return |
Response
Returns a paginated SearchResult of Transaction objects.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Get All Transaction
GET /api/v1/partner/transactions/active
Retrieve all currently active (in-progress) transactions for the store. Active transactions are orders that have been started but not yet completed, held, or cancelled. No date or pagination parameters are needed.
Response
Returns a paginated SearchResult of Transaction objects.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Get Transaction by Id
GET /api/v1/partner/transactions/{transactionId}
Retrieve a single transaction by its ID. Returns the full transaction object including line items, payment info, and status.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
transactionId | string | The transaction i d |
Response
Returns a Transaction object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Add Member to Queue
POST /api/v1/partner/transactions/queues/{queueName}
Create a new transaction by adding a member to a named queue. The queueName path parameter identifies which queue to add the member to (e.g., pickup, delivery). The request body must include memberId, terminalId, and employeeId. Optionally set delivery scheduling fields like deliveryDate, pickUpDate, and completeAfter.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
queueName | string | The queue name |
Request Body
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
memberId | string | Yes | Member identifier |
associatePickerUpOrder | string | No | Associate Picker Up Order |
createOnFleetTask | boolean | No | Create On Fleet Task (default: false) |
memo | string | No | Memo/notes |
onFleetTeamId | string | No | On Fleet Team identifier |
createTookanTask | boolean | No | Create Tookan Task |
tookanTeamId | string | No | Tookan Team identifier |
orderTags | string[] | No | Order Tags |
kioskCheckInId | string | No | Kiosk Check In identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
completeAfter | long | No | Complete After |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
shopId | string | No | Shop identifier |
defaultRegionByAddress | boolean | No | Default Region By Address |
terminalId | string | Yes | Terminal identifier |
employeeId | string | Yes | Employee identifier |
{
"memberId": "abc123",
"associatePickerUpOrder": "string",
"createOnFleetTask": false,
"memo": "string",
"onFleetTeamId": "abc123",
"createTookanTask": false,
"tookanTeamId": "abc123",
"orderTags": [],
"kioskCheckInId": "abc123",
"deliveryDate": 1704067200000,
"pickUpDate": 1704067200000,
"completeAfter": 0,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"shopId": "abc123",
"defaultRegionByAddress": false,
"terminalId": "abc123",
"employeeId": "abc123"
}
Response
Returns a Transaction object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Update Scheduled Delivery Time for Accepted Orders
POST /api/v1/partner/transactions/{transactionId}/schedule
Update the scheduled delivery time for an accepted order. Use this after an order has been accepted to change when it should be delivered. Requires employeeId in the request body along with the new scheduleDate timestamp.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
transactionId | string | The transaction i d |
Request Body
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
scheduleDate | long | No | Schedule timestamp (epoch ms) |
completeAfter | long | No | Complete After |
employeeId | string | Yes | Employee identifier |
{
"scheduleDate": 1704067200000,
"completeAfter": 0,
"employeeId": "abc123"
}
Response
Returns a Transaction object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Delete Transaction from Queue
DELETE /api/v1/partner/transactions/{transactionId}
Cancel a transaction and remove it from the queue. The request body must include terminalId and employeeId. You can optionally provide a reason string explaining why the transaction was cancelled.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
transactionId | string | The transaction i d |
Request Body
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
reason | string | No | Reason |
pin | string | No | Pin |
action | string | No | Action |
targetId | string | No | Target identifier |
targetName | string | No | Target Name |
terminalId | string | Yes | Terminal identifier |
employeeId | string | Yes | Employee identifier |
{
"reason": "string",
"pin": "string",
"action": "string",
"targetId": "abc123",
"targetName": "string",
"terminalId": "abc123",
"employeeId": "abc123"
}
Prepare Cart
POST /api/v1/partner/transactions/{transactionId}/prepare
Calculate pricing, taxes, and discounts for a transaction without finalizing it. This is a non-destructive "dry run" — use it to preview the cart totals before completing the transaction. Send the full transaction object in the request body.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
transactionId | string | The transaction i d |
Request Body
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Response
Returns a Transaction object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Set Transaction to Fulfill
POST /api/v1/partner/transactions/{transactionId}/sendToFulfill
Transition a transaction to fulfillment status, indicating it is ready for packing, preparation, or delivery. Send the full transaction object in the request body.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
transactionId | string | The transaction i d |
Request Body
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Response
Returns a Transaction object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Complete Transaction
POST /api/v1/partner/transactions/{transactionId}/complete
Complete and close a transaction. The transaction object in the request body must include memberId, sellerId, and terminalId — the request will be rejected if any of these are missing. This is the final step in the transaction lifecycle.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
transactionId | string | The transaction i d |
Request Body
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Response
Returns a Transaction object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Mark Transaction as Paid
POST /api/v1/partner/transactions/{transactionId}/markAsPaid
Mark a completed transaction as paid using the specified payment method. The paymentOption query parameter specifies the payment type (e.g., Cash, Credit, Check, ACH, Split). No request body is required.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
transactionId | string | The transaction i d |
Response
Returns a Transaction object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Sign Transaction
POST /api/v1/partner/transactions/{transactionId}/sign
Upload a signature image file for a transaction. Send the file as multipart/form-data with the signer's name field.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
transactionId | string | The transaction i d |
Request
This endpoint accepts multipart/form-data.
| Field | Type | Description |
|---|---|---|
name | string | name |
file | final | file |
Response
Returns a Transaction object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Hold Transaction
POST /api/v1/partner/transactions/{transactionId}/hold
Place a transaction on hold, pausing its processing. Like the complete endpoint, the request body must include memberId, sellerId, and terminalId. A held transaction can later be resumed or cancelled.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
transactionId | string | The transaction i d |
Request Body
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Response
Returns a Transaction object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Update delivery address for transaction
POST /api/v1/partner/transactions/{transactionId}/address
Update the delivery address for a transaction. Send an Address object in the request body with the new address details.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
transactionId | string | The transaction i d |
Request Body
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
address | string | No | Address (default: ``) |
city | string | No | City (default: ``) |
state | string | No | State (default: ``) |
zipCode | string | No | Zip Code (default: ``) |
addressLine2 | string | No | Address Line2 (default: ``) |
country | string | No | Country (default: DEFAULT_COUNTRY) |
latitude | number | No | Latitude |
longitude | number | No | Longitude |
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
}
Response
Returns a Transaction object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Reassign Transaction Employee
POST /api/v1/partner/transactions/{transactionId}/employee
Reassign a transaction from one employee to another. Requires currentTerminalId and currentEmployeeId to identify the current assignment, and employeeId for the new assignee. Optionally set transferItems to move items between inventories.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
transactionId | string | The transaction i d |
Request Body
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
employeeId | string | No | Employee identifier |
eta | integer | No | Eta (default: -1) |
transferItems | boolean | No | Transfer Items (default: false) |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onFleetTeamId | string | No | On Fleet Team identifier |
overrideInventoryId | string | No | Override Inventory identifier |
consumerCart | ConsumerCart | No | Consumer Cart |
memberId | string | No | Member identifier |
cartUpdated | boolean | No | Cart Updated (default: false) |
createTookanTask | boolean | No | Create Tookan Task |
tookanTeamId | string | No | Tookan Team identifier |
packedBy | string | No | Packed By |
skipInvValidation | boolean | No | Skip Inv Validation |
completeTransfer | boolean | No | Complete Transfer |
fromInventoryId | string | No | From Inventory identifier |
toInventoryId | string | No | To Inventory identifier |
linkedSourceReq | transferlinkedsourcereq | No | Linked Source Req |
currentTerminalId | string | Yes | Current Terminal identifier |
currentEmployeeId | string | Yes | Current Employee identifier |
{
"employeeId": "abc123",
"eta": "-1",
"transferItems": false,
"createOnfleetTask": false,
"onFleetTeamId": "abc123",
"overrideInventoryId": "abc123",
"consumerCart": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"consumerId": "abc123",
"memberId": "abc123",
"assignedNearbyDriverId": "abc123",
"cart": {},
"orderPlacedTime": 1704067200000,
"acceptedTime": 1704067200000,
"packagedTime": 1704067200000,
"onTheWayTime": 1704067200000,
"completedTime": 1704067200000,
"canceledTime": 1704067200000,
"declinedTime": 1704067200000,
"placed": false,
"accepted": false,
"completed": false,
"packaged": false,
"onTheWay": false,
"anonymous": false,
"eta": 0,
"reason": "string",
"sessionId": "abc123",
"publicKey": "string",
"committed": false,
"cartStatus": "InProgress",
"trackingStatus": "NotStarted",
"pickupType": "Delivery",
"source": "string",
"salesChannel": "string",
"partnerId": "abc123",
"externalId": "abc123",
"transactionId": "abc123",
"reqLinkedTransId": "abc123",
"transNo": "TXN-001",
"orderNo": "string",
"employeeName": "string",
"memo": "string",
"additionalNotes": "string",
"pickUpDate": 1704067200000,
"transactionSource": "Widget",
"assignedEmployeeId": "abc123",
"deliveryDate": 1704067200000,
"deliveryAddress": {},
"completeAfter": 0,
"orderTags": [],
"rewardName": "string",
"prepaid": false,
"disableAutoAssignment": false,
"disableAutoRegionDispatch": false,
"overrideRegionId": "abc123",
"dispatchRegionId": "",
"overrideInventoryId": "abc123",
"activeInventoryIds": [],
"expiredAt": 0,
"integrations": {},
"externalPaymentIds": [],
"externalPaymentConfigId": "abc123",
"stronghold": {},
"chargeId": "abc123"
},
"memberId": "abc123",
"cartUpdated": false,
"createTookanTask": false,
"tookanTeamId": "abc123",
"packedBy": "string",
"skipInvValidation": false,
"completeTransfer": false,
"fromInventoryId": "abc123",
"toInventoryId": "abc123",
"linkedSourceReq": {},
"currentTerminalId": "abc123",
"currentEmployeeId": "abc123"
}
Response
Returns a Transaction object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Unassign Transaction
GET /api/v1/partner/transactions/{transactionId}/unassign
Remove the current employee assignment from a transaction, returning it to an unassigned state.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
transactionId | string | The transaction i d |
Response
Returns a Transaction object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Start Transaction
GET /api/v1/partner/transactions/{transactionId}/start
Start processing a transaction. Transitions the transaction from a queued state to actively being worked on.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
transactionId | string | The transaction i d |
Response
Returns a Transaction object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Stop Transaction
GET /api/v1/partner/transactions/{transactionId}/stop
Stop processing a transaction. Pauses active work on the transaction without cancelling it.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
transactionId | string | The transaction i d |
Response
Returns a Transaction object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Get completed transactions for member
GET /api/v1/partner/transactions/members/{memberId}/completed
Retrieve all completed transactions for a specific member. Supports pagination with start and limit parameters. Use this to display a member's order history.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
memberId | string | The member i d |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
start | integer | No | Number of records to skip |
limit | integer | No | Maximum records to return |
Response
Returns a paginated SearchResult of Transaction objects.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Get active transactions for member
GET /api/v1/partner/transactions/members/{memberId}/active
Retrieve all currently active (in-progress) transactions for a specific member. Returns all active transactions without pagination.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
memberId | string | The member i d |
Response
Returns a paginated SearchResult of Transaction objects.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Finalize all transaction items
POST /api/v1/partner/transactions/{transactionId}/finalize
Lock all items in the transaction, preventing further modifications. Finalized items are ready for completion. This must be done before completing the transaction.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
transactionId | string | The transaction i d |
Request Body
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Response
Returns a Transaction object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Unfinalize all transaction items
POST /api/v1/partner/transactions/{transactionId}/unfinalize
Unlock all items in the transaction, allowing further modifications. Use this to make changes to items after they were previously finalized.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
transactionId | string | The transaction i d |
Request Body
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Response
Returns a Transaction object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Update Pack By Employee
POST /api/v1/partner/transactions/{transactionId}/packedBy
Record which employee packed the order. Send an EmployeePackByRequest with the packedBy employee ID.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
transactionId | string | The transaction i d |
Request Body
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
packedBy | string | No | Packed By |
{
"packedBy": "string"
}
Response
Returns a Transaction object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}
Update Prepare By Employee
POST /api/v1/partner/transactions/{transactionId}/preparedBy
Record which employee prepared the order. Send an EmployeePrepareByRequest with the preparedBy employee ID.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
transactionId | string | The transaction i d |
Request Body
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
preparedBy | string | No | Prepared By |
{
"preparedBy": "string"
}
Response
Returns a Transaction object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
metrcId | long | No | Metrc identifier |
metrcSaleTime | string | No | Metrc Sale timestamp (epoch ms) (default: null) |
traceSubmitTime | long | No | Trace Submit timestamp (epoch ms) |
traceSubmitStatus | string | No | Trace Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
traceMessage | string | No | Trace Message (default: null) |
complianceDeliverySaleType | string | No | Compliance Delivery Sale Type. One of: None, Planned, Unplanned (default: None) |
tripId | string | No | Trip identifier (default: null) |
orderMenuType | string | No | Order Menu Type. One of: Standard, Scheduled, Express (default: Standard) |
transNo | string | No | Trans No |
parentTransactionId | string | No | Parent Transaction identifier |
priority | long | No | Priority |
createdById | string | No | Created By identifier |
sellerId | string | No | Seller identifier |
memberId | string | No | Member identifier |
associateCaregiver | boolean | No | Associate Caregiver (default: false) |
caregiverId | string | No | Caregiver identifier |
terminalId | string | No | Terminal identifier |
sellerTerminalId | string | No | Seller Terminal identifier |
overrideInventoryId | string | No | Override Inventory identifier |
checkinTime | long | No | Checkin timestamp (epoch ms) |
startTime | long | No | Start timestamp (epoch ms) |
endTime | long | No | End timestamp (epoch ms) |
active | boolean | No | Whether active (default: false) |
queueType | string | No | Queue Type. One of: WalkIn, Delivery, Online, None, Special (default: None) |
status | string | No | Status. One of: Queued, Hold, InProgress, Completed, Pending, Canceled, RefundWithInventory, RefundWithoutInventory, Void, VoidSales, Draft (default: Queued) |
note | Note | No | Note |
memo | string | No | Memo/notes |
deleteNote | Note | No | Delete Note |
cart | Cart | No | Cart |
processedTime | long | No | Processed timestamp (epoch ms) |
paid | boolean | No | Paid (default: false) |
paidTime | long | No | Paid timestamp (epoch ms) |
completedTime | long | No | Completed timestamp (epoch ms) |
dispatchCreatedTime | long | No | Dispatch Created timestamp (epoch ms) |
dispatchRegionId | string | No | Dispatch Region identifier |
inventoryId | string | No | Inventory identifier |
onlineInventoryId | string | No | Online Inventory identifier |
autoAccepted | boolean | No | Auto Accepted (default: false) |
loc | double[] | No | Loc |
transType | string | No | Trans Type. One of: Sale, Refund, Adjustment, Transfer, Exchange, ReturnToVendor, ShippingManifest, Void (default: Sale) |
assignedEmployeeId | string | No | Assigned Employee identifier |
transporterName | string | No | Transporter Name |
transporterLicense | string | No | Transporter License |
timeZone | string | No | Time Zone |
deliveryAddress | Address | No | Delivery Address |
locked | boolean | No | Locked (default: false) |
hypurPin | string | No | Hypur Pin |
hypurCheckinISN | string | No | Hypur Checkin I S N |
entityISN | string | No | Entity I S N |
fulfillmentStep | string | No | Fulfillment Step. One of: Prepare, Fulfill, ReadyForDelivery, OutForDelivery (default: Prepare) |
startRouteDate | long | No | Start Route timestamp (epoch ms) |
routing | boolean | No | Routing (default: false) |
startRouteLocation | double[] | No | Start Route Location |
endRouteDate | long | No | End Route timestamp (epoch ms) |
endRouteLocation | double[] | No | End Route Location |
pointsEarned | number | No | Points Earned |
memberSignature | CompanyAsset | No | Member Signature |
transferShopId | string | No | Transfer Shop identifier |
transferRequest | BulkInventoryTransferRequest | No | Transfer Request |
consumerCartId | string | No | Consumer Cart identifier |
source | string | No | Source |
salesChannel | string | No | Sales Channel |
consumerOrderNo | string | No | Consumer Order No |
eta | integer | No | Eta (default: 0) |
mileageCalculated | boolean | No | Mileage Calculated (default: false) |
mileage | number | No | Mileage |
paymentCardPayments | PaymentCardPayment[] | No | Payment Card Payments |
payments | TransactionPayment[] | No | Payments |
previousBalance | number | No | Previous Balance |
balance | number | No | Balance |
paymentReceived | number | No | Payment Received |
paidAmount | number | No | Paid Amount |
blazeTip | number | No | Blaze Tip |
blazeFee | number | No | Blaze Fee |
blazeTotalCharged | number | No | Blaze Total Charged |
blazeCashBack | number | No | Blaze Cash Back |
member | Member | No | Member |
seller | Employee | No | Seller |
sellerTerminal | Terminal | No | Seller Terminal |
preparedBy | string | No | Prepared By |
preparedDate | long | No | Prepared timestamp (epoch ms) |
packedBy | string | No | Packed By |
packedDate | long | No | Packed timestamp (epoch ms) |
pickUpDate | long | No | Pick Up timestamp (epoch ms) |
draftCreatedTime | long | No | Draft Created timestamp (epoch ms) |
defaultRegionByAddress | boolean | No | Default Region By Address |
deferred | boolean | No | Deferred (default: false) |
deferredTime | long | No | Deferred timestamp (epoch ms) |
deferredNote | Note | No | Deferred Note |
dispatchedProcessor | string | No | Dispatched Processor (default: ``) |
dispatched | boolean | No | Dispatched (default: false) |
onFleetTaskId | string | No | On Fleet Task identifier |
onFleetError | string | No | On Fleet Error |
createOnfleetTask | boolean | No | Create Onfleet Task (default: false) |
onfleetTwoWaySuccess | boolean | No | Onfleet Two Way Success (default: true) |
state | integer | No | State |
shortId | string | No | Short identifier |
onFleetTaskStatus | string | No | On Fleet Task Status. One of: TASK_NONE, TASK_ARRIVAL, TASK_COMPLETED, TASK_FAILED, TASK_ASSIGNED_PARTIAL, TASK_ASSIGNED, TASK_DELETED |
onFleetTeamId | string | No | On Fleet Team identifier |
qbSalesReceiptRef | string | No | Qb Sales Receipt Ref |
qbRefundReceipt | string | No | Qb Refund Receipt |
qbJournalEntryRef | string | No | Qb Journal Entry Ref |
transactionRefundStatus | string | No | Transaction Refund Status. One of: None, In_Progress, Complete_Refund, Partial_Refund (default: None) |
assigned | boolean | No | Assigned |
tookanTaskId | string | No | Tookan Task identifier |
orderTags | string[] | No | Order Tags |
mtracTxnId | string | No | Mtrac Txn identifier |
deliveryDate | long | No | Delivery timestamp (epoch ms) |
completeBy | long | No | Complete By |
completeAfter | long | No | Complete After |
addressUpdate | boolean | No | Address Update |
paymentEditedBy | string | No | Payment Edited By |
paymentEditedTime | long | No | Payment Edited timestamp (epoch ms) |
dejavooTerminalConfig | DejavooTerminalConfig | No | Dejavoo Terminal Config |
identifications | Identification[] | No | Identifications |
assets | CompanyAsset[] | No | Assets |
metrcDeliveryId | long | No | Metrc Delivery identifier |
metrcDeliveryLedgerId | long | No | Metrc Delivery Ledger identifier |
metrcDeliverySubmitTime | long | No | Metrc Delivery Submit timestamp (epoch ms) |
metrcSubmissionDeleteTime | long | No | Metrc Submission Delete timestamp (epoch ms) |
metrcSubmissionCompleteTime | long | No | Metrc Submission Complete timestamp (epoch ms) |
metrcDeliverySubmitStatus | string | No | Metrc Delivery Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
deliveryTraceMessage | string | No | Delivery Trace Message (default: null) |
waivedStatus | boolean | No | Waived Status (default: false) |
waivedDate | long | No | Waived timestamp (epoch ms) |
message | string | No | Message |
voidDate | long | No | Void timestamp (epoch ms) |
voidedByEmployeeId | string | No | Voided By Employee identifier |
sessionId | string | No | Session identifier |
queueBlazePayId | string | No | Queue Blaze Pay identifier |
managerPinOverrides | ManagerPinOverride[] | No | Manager Pin Overrides |
enableBlazePayTips | boolean | No | Enable Blaze Pay Tips (default: false) |
roundUpEnabled | boolean | No | Round Up Enabled (default: false) |
estimatedLoyaltyPoints | boolean | No | Estimated Loyalty Points (default: false) |
summaryPaymentInfo | SummaryPaymentInfo | No | Summary Payment Info |
cardComplianceId | string | No | Card Compliance identifier |
complianceId | string | No | Compliance identifier |
nmCcdCheckoutUuid | string | No | Nm Ccd Checkout Uuid |
nmCcdVoidUuid | string | No | Nm Ccd Void Uuid |
nmCcdBarCode | string | No | Nm Ccd Bar Code |
nmCcdCorrectionHistory | NmCcdRefundCorrection[] | No | Nm Ccd Correction History |
refundComplianceId | string | No | Refund Compliance identifier |
compliance | boolean | No | Compliance (default: false) |
complianceSaleTime | long | No | Compliance Sale timestamp (epoch ms) |
complianceValidItems | object | No | Compliance Valid Items |
transferId | string | No | Transfer identifier |
consumerType | string | No | Consumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
purchaseType | string | No | Purchase Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty |
complianceDeliveryId | string | No | Compliance Delivery identifier |
complianceDeliveryTransactionId | string | No | Compliance Delivery Transaction identifier |
complianceLedgerId | string | No | Compliance Ledger identifier |
complianceSubmitStatus | string | No | Compliance Submit Status. One of: None, SubmissionError, SubmissionPending, SubmissionInProgress, SubmissionWaitingID, Completed, Deleted, Submitted, Rescheduled (default: None) |
inventoryProcessed | boolean | No | Inventory Processed |
processingTimeMs | long | No | Processing Time Ms |
waitingTimeMs | long | No | Waiting Time Ms |
lastStartTimestamp | long | No | Last Start Timestamp |
lastHoldTimestamp | long | No | Last Hold Timestamp |
externalPaymentContext | pspaymentcontext | No | External Payment Context |
activeInventoryIds | string[] | No | Active Inventory Ids |
deliveryStatus | deliverystatus | No | Delivery Status |
externalPaymentConfigId | string | No | External Payment Config identifier |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"metrcId": 0,
"metrcSaleTime": "null",
"traceSubmitTime": 1704067200000,
"traceSubmitStatus": "None",
"traceMessage": "null",
"complianceDeliverySaleType": "None",
"tripId": "null",
"orderMenuType": "Standard",
"transNo": "TXN-001",
"parentTransactionId": "abc123",
"priority": 0,
"createdById": "abc123",
"sellerId": "abc123",
"memberId": "abc123",
"associateCaregiver": false,
"caregiverId": "abc123",
"terminalId": "abc123",
"sellerTerminalId": "abc123",
"overrideInventoryId": "abc123",
"checkinTime": 1704067200000,
"startTime": 1704067200000,
"endTime": 1704067200000,
"active": false,
"queueType": "None",
"status": "Queued",
"note": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"memo": "string",
"deleteNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"cart": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"discount": 0,
"promoCode": "string",
"consumerType": "Other",
"cashReceived": 0,
"changeDue": 0,
"paymentOption": "None",
"cfdPaymentMethodIntent": false,
"subTotal": 0,
"totalDiscount": 0,
"calcCartDiscount": 0,
"subTotalDiscount": 0,
"loyaltyDiscount": 0,
"total": 0,
"feeTotal": "ZERO",
"feeTotalRefunded": "ZERO",
"taxRateTotalRefunded": "ZERO",
"totalBeforeTaxRounding": 0,
"totalAfterTaxRounding": 0,
"taxTable": {},
"tax": 0,
"taxResult": {},
"taxRateDetails": [],
"totalCalcTax": 0,
"totalPreCalcTax": 0,
"refundAmount": 0,
"enableDeliveryFee": false,
"deliveryFee": 0,
"deliveryDiscount": 0,
"deliveryPromotionId": "abc123",
"afterTaxDiscount": 0,
"appliedAfterTaxDiscount": 0,
"roundAmt": 0,
"pointSpent": 0,
"items": [],
"promotionReqs": [],
"splitPayment": {},
"blazePayRequest": {},
"paymentType": "Full",
"totalExciseTax": 0,
"totalALExciseTax": 0,
"balanceDue": 0,
"creditCardFee": 0,
"lastCreditCardFee": 0,
"currentSurchargeFeeTax": 0,
"enableCreditCardFee": false,
"refundOption": "Void",
"refundOrderItemRequests": [],
"requestRefundAmt": 0,
"finalRefundAmt": 0,
"adjustmentAmount": "ZERO",
"adjustmentInfoList": [],
"tipAmount": 0,
"nonCannabisTaxTable": {},
"cartDiscountNotes": "string",
"afterTaxDiscountNotes": "string",
"currentAmount": 0,
"totalFees": 0,
"deliveryDiscountAmount": 0,
"origDeliveryFee": 0,
"cdtfaTaxRate": "null",
"activeCDTFATax": false,
"externalPaymentProvider": "string",
"storageLocation": "CashDrawer"
},
"processedTime": 1704067200000,
"paid": false,
"paidTime": 1704067200000,
"completedTime": 1704067200000,
"dispatchCreatedTime": 1704067200000,
"dispatchRegionId": "abc123",
"inventoryId": "abc123",
"onlineInventoryId": "abc123",
"autoAccepted": false,
"loc": [],
"transType": "Sale",
"assignedEmployeeId": "abc123",
"transporterName": "string",
"transporterLicense": "string",
"timeZone": "America/Los_Angeles",
"deliveryAddress": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"address": "",
"city": "",
"state": "",
"zipCode": "",
"addressLine2": "",
"country": "DEFAULT_COUNTRY",
"latitude": 0,
"longitude": 0
},
"locked": false,
"hypurPin": "string",
"hypurCheckinISN": "string",
"entityISN": "string",
"fulfillmentStep": "Prepare",
"startRouteDate": 1704067200000,
"routing": false,
"startRouteLocation": [],
"endRouteDate": 1704067200000,
"endRouteLocation": [],
"pointsEarned": 0,
"memberSignature": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"transferShopId": "abc123",
"transferRequest": {
"fromShopId": "abc123",
"toShopId": "abc123",
"transfers": []
},
"consumerCartId": "abc123",
"source": "string",
"salesChannel": "string",
"consumerOrderNo": "string",
"eta": 0,
"mileageCalculated": false,
"mileage": 0,
"paymentCardPayments": [
{
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"status": "Pending",
"processedTime": 1704067200000,
"type": "Linx",
"paymentCardNumber": "string",
"amount": 0,
"statusMessage": "string",
"balance": 0,
"paymentId": "abc123",
"currency": "string",
"expYear": 0,
"cardEncrypted": "string",
"expMonth": 0,
"cvv": "string",
"email": "user@example.com"
}
],
"payments": [
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"transactionId": "abc123",
"transNo": "TXN-001",
"paymentProcessor": "None",
"posDisplayName": "string",
"merchantDisplayName": "string",
"provider": "string",
"externalId": "abc123",
"loyaltyPoints": 0,
"amount": "ZERO",
"changeDue": "ZERO",
"paymentReceived": "ZERO",
"calculatedAmount": "ZERO",
"cashBack": "ZERO",
"tips": "ZERO",
"transactionFee": "ZERO",
"total": "ZERO",
"cardFee": "ZERO",
"creditAmount": "ZERO",
"feeAmount": "ZERO",
"surchargeTax": {},
"requestId": "abc123",
"split": false,
"manual": false,
"voidT": false,
"terminal": {},
"posTerminal": {},
"refID": "string",
"batchNum": 0,
"invNum": 0,
"processor": 0,
"deletedBy": "string",
"fromIncomingOrder": false,
"paymentFlowType": "string",
"cardMaskedPan": "string",
"cardReaderId": "abc123",
"balance": "ZERO",
"isBlazePay": false,
"deferredCapture": false,
"externalStatus": "string",
"refundedAmount": "ZERO",
"reconciled": false
}
],
"previousBalance": 0,
"balance": 0,
"paymentReceived": 0,
"paidAmount": 0,
"blazeTip": 0,
"blazeFee": 0,
"blazeTotalCharged": 0,
"blazeCashBack": 0,
"member": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"firstName": "John",
"lastName": "Doe",
"middleName": "string",
"address": {},
"uppercaseCity": "string",
"email": "user@example.com",
"dob": 1704067200000,
"birthdate": "string",
"localDob": "string",
"localDobUTC": 0,
"primaryPhone": "555-0100",
"cpn": "string",
"textOptIn": true,
"emailOptIn": true,
"medical": false,
"searchText": "string",
"metadata": [],
"nickname": "string",
"sex": "OTHER",
"anonymous": false,
"status": "Inactive",
"notes": [],
"contracts": [],
"preferences": [],
"identifications": [],
"recommendations": [],
"mergeRole": {},
"mergedIntoMemberId": "abc123",
"mergeOrderRouting": {},
"lastMergeEpoch": 0,
"mergedAt": 0,
"mergedByEmployeeId": "abc123",
"lastVisitDate": 1704067200000,
"startDate": 1704067200000,
"importId": "abc123",
"memberGroupId": "abc123",
"memberGroup": {},
"recentProducts": [],
"dlExpired": false,
"recommendationExpired": false,
"agreementExpired": false,
"emailVerified": false,
"consumerUserId": "abc123",
"marketingSource": "string",
"consumerType": "AdultUse",
"alternateEmails": [],
"enableLoyalty": true,
"loyaltyPoints": 0,
"lifetimePoints": 0,
"enabledCareGiver": false,
"careGivers": [],
"regionId": "abc123",
"addresses": [],
"eligibleForFTMPromos": true,
"banPatient": false,
"tags": [],
"recommendationExpiryLeft": 0,
"referralCode": "string",
"complianceCardSessionId": "abc123",
"sbid": 0,
"exemptFromLimits": false,
"alternatePhones": [],
"strongholdCustomerId": "abc123",
"consumerUserIdHistory": [],
"growthLoyaltyTier": {},
"allotmentOverride": {},
"expStatuses": []
},
"seller": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"authUserId": "abc123",
"firstName": "John",
"lastName": "Doe",
"pin": "string",
"roleId": "abc123",
"email": "user@example.com",
"password": "string",
"driversLicense": "string",
"occupationLicenseNumber": "string",
"dlExpirationDate": "string",
"vehicleMake": "string",
"notes": [],
"shops": [],
"disabled": false,
"phoneNumber": "string",
"assignedInventoryId": "abc123",
"assignedTerminalId": "abc123",
"address": {},
"timecardId": "abc123",
"timeCard": {},
"role": {},
"canApplyCustomDiscount": true,
"insuranceExpireDate": 1704067200000,
"insuranceCompanyName": "string",
"policyNumber": "string",
"registrationExpireDate": 1704067200000,
"vehiclePin": "string",
"vinNo": "string",
"vehicleModel": "string",
"vehicleLicensePlate": "string",
"tripId": "abc123",
"recentLocation": "null",
"employeeOnFleetInfoList": [],
"tookanInfoList": [],
"lastLoggedInShopId": "abc123",
"lastLoginTime": 1704067200000,
"driver": false,
"externalId": "abc123",
"organizationIds": [],
"yellowfinRoleCode": {},
"defaultVehicleId": "abc123",
"complianceId": "abc123",
"biotrack": false,
"biotrackTransId": "abc123",
"biotrackTransIdOriginal": "string",
"birthDate": 1704067200000,
"hireDate": 1704067200000,
"sessionTime": 1704067200000,
"lastPasswordChangedOn": 0,
"packer": false,
"internal": false,
"isBlazeAdmin": false,
"importId": "abc123",
"metrcRetailerDeliveryId": 0,
"platformUserId": "abc123",
"platformCognitoId": "abc123",
"isSuperAdmin": false
},
"sellerTerminal": {
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"active": false,
"deviceId": "abc123",
"name": "string",
"deviceModel": "string",
"deviceVersion": "string",
"deviceName": "string",
"appVersion": "string",
"deviceToken": "string",
"deviceType": "iOS",
"assignedInventoryId": "abc123",
"cvAccountId": "abc123",
"currentEmployeeId": "abc123",
"terminalType": "NotAssigned",
"posTerminal": "string",
"regionId": "abc123",
"creditCardReader": {},
"onPremEnabled": false,
"brandIds": [],
"terminalLocations": [],
"deviceDetails": [],
"quickStartAmount": 0,
"version": "1.0.0",
"sdkVersion": "string"
},
"preparedBy": "string",
"preparedDate": 1704067200000,
"packedBy": "string",
"packedDate": 1704067200000,
"pickUpDate": 1704067200000,
"draftCreatedTime": 1704067200000,
"defaultRegionByAddress": false,
"deferred": false,
"deferredTime": 1704067200000,
"deferredNote": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"writerId": "abc123",
"writerName": "string",
"message": "string",
"enableOnFleet": false
},
"dispatchedProcessor": "",
"dispatched": false,
"onFleetTaskId": "abc123",
"onFleetError": "string",
"createOnfleetTask": false,
"onfleetTwoWaySuccess": true,
"state": 0,
"shortId": "abc123",
"onFleetTaskStatus": "TASK_NONE",
"onFleetTeamId": "abc123",
"qbSalesReceiptRef": "string",
"qbRefundReceipt": "string",
"qbJournalEntryRef": "string",
"transactionRefundStatus": "None",
"assigned": false,
"tookanTaskId": "abc123",
"orderTags": [],
"mtracTxnId": "abc123",
"deliveryDate": 1704067200000,
"completeBy": 0,
"completeAfter": 0,
"addressUpdate": false,
"paymentEditedBy": "string",
"paymentEditedTime": 1704067200000,
"dejavooTerminalConfig": {
"id": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"terminalId": "abc123",
"enabled": false,
"manual": false,
"online": false,
"authKey": "string",
"registerId": "abc123",
"serialNumber": "string",
"name": "string",
"processors": []
},
"identifications": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"verified": false,
"licenseNumber": "string",
"expirationDate": 1704067200000,
"expirationDateUTC": "string",
"localExpirationDate": "",
"frontPhoto": {},
"assets": [],
"state": "CA",
"type": "Drivers"
}
],
"assets": [
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
}
],
"metrcDeliveryId": 0,
"metrcDeliveryLedgerId": 0,
"metrcDeliverySubmitTime": 1704067200000,
"metrcSubmissionDeleteTime": 1704067200000,
"metrcSubmissionCompleteTime": 1704067200000,
"metrcDeliverySubmitStatus": "None",
"deliveryTraceMessage": "null",
"waivedStatus": false,
"waivedDate": 1704067200000,
"message": "string",
"voidDate": 1704067200000,
"voidedByEmployeeId": "abc123",
"sessionId": "abc123",
"queueBlazePayId": "abc123",
"managerPinOverrides": [
{
"action": "string",
"approvedByEmployeeId": "abc123",
"activeEmployeeId": "abc123",
"scope": "PRODUCT",
"targetId": "abc123",
"targetName": "string",
"createdAt": 0
}
],
"enableBlazePayTips": false,
"roundUpEnabled": false,
"estimatedLoyaltyPoints": false,
"summaryPaymentInfo": {
"totalFees": 0,
"total": 0,
"changeDue": 0,
"cashBack": 0
},
"cardComplianceId": "abc123",
"complianceId": "abc123",
"nmCcdCheckoutUuid": "string",
"nmCcdVoidUuid": "string",
"nmCcdBarCode": "string",
"nmCcdCorrectionHistory": [
{
"refundTransactionId": "abc123",
"sourceCheckoutUuid": "string",
"sourceTicketId": "abc123",
"voidUuid": "string",
"replacementCheckoutUuid": "string",
"replacementTicketId": "abc123",
"replacementOrderNumber": "string",
"status": "VOID_PENDING",
"createdAt": 0,
"voidedAt": 0,
"completedAt": 0,
"sanitizedFailureMessage": "string"
}
],
"refundComplianceId": "abc123",
"compliance": false,
"complianceSaleTime": 1704067200000,
"complianceValidItems": {},
"transferId": "abc123",
"consumerType": "Other",
"purchaseType": "Other",
"complianceDeliveryId": "abc123",
"complianceDeliveryTransactionId": "abc123",
"complianceLedgerId": "abc123",
"complianceSubmitStatus": "None",
"inventoryProcessed": false,
"processingTimeMs": 0,
"waitingTimeMs": 0,
"lastStartTimestamp": 0,
"lastHoldTimestamp": 0,
"externalPaymentContext": {},
"activeInventoryIds": [],
"deliveryStatus": {},
"externalPaymentConfigId": "abc123"
}