From 0ee3e2122fab4ca6365f1ef002913a1dd671764d Mon Sep 17 00:00:00 2001 From: Vernon Keenan Date: Sun, 29 May 2022 10:36:31 -0700 Subject: [PATCH] swagger --- swagger/blaze-taxnexus.yaml | 215 ++- swagger/metrc-gw-taxnexus.yaml | 2515 ++++++++++++++++---------------- 2 files changed, 1481 insertions(+), 1249 deletions(-) diff --git a/swagger/blaze-taxnexus.yaml b/swagger/blaze-taxnexus.yaml index 2f8a4a7..c5b68c1 100644 --- a/swagger/blaze-taxnexus.yaml +++ b/swagger/blaze-taxnexus.yaml @@ -9,7 +9,7 @@ info: title: "vendor-gw-blaze" description: "Taxnexus Gateway Client API for Blaze.me Cannabis Management System" -host: "api.blaze.me" +host: "api.partners.blaze.me" basePath: "/api/v1" schemes: - "https" @@ -960,6 +960,8 @@ definitions: companyId: example: 5c7e8c7b722ed607e61edb06 type: string + complianceId: + type: string created: example: 1553982501834 type: number @@ -1057,6 +1059,8 @@ definitions: updated: example: false type: boolean + wmCategory: + type: string type: object categoryId: example: 5c9fe425e0faca07db94b986 @@ -1070,6 +1074,11 @@ definitions: cbn: example: 0 type: number + committedQuantities: + properties: + no_region: + type: number + type: object companyId: example: 5c7e8c7b722ed607e61edb06 type: string @@ -1103,6 +1112,8 @@ definitions: dirty: example: false type: boolean + discountEnabled: + type: boolean discountable: example: true type: boolean @@ -1130,6 +1141,14 @@ definitions: importSrc: example: string type: string + instock: + type: boolean + lastLeaflySyncStatus: + type: boolean + lastLeaflySyncTime: + type: number + lastWMSyncTime: + type: number lowInventoryNotification: example: false type: boolean @@ -1181,6 +1200,8 @@ definitions: active: example: true type: boolean + assignedPrice: + type: number companyId: example: 5c7e8c7b722ed607e61edb06 type: string @@ -1231,12 +1252,42 @@ definitions: items: type: string type: array + producerAddress: + properties: + address: + type: string + addressLine2: + type: string + city: + type: string + companyId: + type: string + country: + type: string + created: + type: number + deleted: + type: boolean + id: + type: string + modified: + type: number + state: + type: string + updated: + type: boolean + zipCode: + type: string pricingTemplateId: example: "" type: string productSaleType: example: Both type: string + productTagGroups: + items: + type: string + type: array productType: example: REGULAR type: string @@ -1289,6 +1340,143 @@ definitions: reOrderLevel: example: 0 type: number + secondaryVendorResult: + items: + type: object + properties: + id: + type: string + created: + type: number + modified: + type: number + deleted: + type: boolean + updated: + type: boolean + companyId: + type: string + active: + type: boolean + name: + type: string + phone: + type: string + email: + type: string + fax: + type: string + address: + properties: + id: + type: string + created: + type: number + modified: + type: number + deleted: + type: boolean + updated: + type: boolean + address: + type: string + city: + type: string + state: + type: string + zipCode: + type: string + addressLine2: + type: string + country: + type: string + type: "object" + description: + type: string + website: + type: string + firstName: + type: string + lastName: + type: string + notes: + type: array + items: + type: string + licenseNumber: + type: string + assets: + type: array + items: + type: string + backOrderEnabled: + type: boolean + licenseExpirationDate: + type: number + armsLengthType: + type: string + brands: + type: array + items: + type: string + qbVendorRef: + type: array + items: + type: string + additionalAddressList: + type: array + items: + type: string + credits: + type: number + relatedEntity: + type: boolean + vendorType: + type: string + companyLicenses: + type: array + items: + type: "object" + properties: + id: + type: string + created: + type: number + modified: + type: number + deleted: + type: boolean + updated: + type: boolean + companyType: + type: string + licenseType: + type: string + licenseNumber: + type: string + licenseExpirationDate: + type: number + toDefault: + type: boolean + createdBy: + type: string + defaultPaymentTerm: + type: string + toDefault: + type: boolean + vendorKey: + type: string + type: array + secondaryVendors: + items: + type: string + type: array + sellable: + type: boolean + sellableQuantities: + properties: + no_region: + type: number shopId: example: 5c9fe425e0faca07db94b970 type: string @@ -1332,6 +1520,8 @@ definitions: deleted: example: false type: boolean + displayName: + type: string dirty: example: false type: boolean @@ -1771,9 +1961,28 @@ definitions: example: Lowell Herb Co / The Hacienda Co LLC type: string notes: - items: - type: string type: array + items: + type: object + properties: + id: + type: string + created: + type: number + modified: + type: number + deleted: + type: boolean + updated: + type: boolean + writerId: + type: string + writerName: + type: string + message: + type: string + enableOnFleet: + type: boolean phone: example: "" type: string diff --git a/swagger/metrc-gw-taxnexus.yaml b/swagger/metrc-gw-taxnexus.yaml index 5f44524..3187f60 100644 --- a/swagger/metrc-gw-taxnexus.yaml +++ b/swagger/metrc-gw-taxnexus.yaml @@ -15,145 +15,153 @@ info: email: "support@taxnexus.net" name: "Taxnexus Support" url: "https://www.taxnexus.net/contact-us/" - description: Metrc Gateway Microservice + description: | + # Introduction + + The Taxnexus METRC Gateway is built on HTTP. Our API is RESTful. It has predictable + resource URLs. It returns HTTP response codes to indicate errors. It also + accepts and returns JSON in the HTTP body. license: name: "Proprietary" termsOfService: "https://www.taxnexus.com/terms/" - title: metrc-gw - version: 1.3.0 + title: "Metrc Gateway" + version: "1.2.6" consumes: - "application/json" produces: - "application/json" parameters: activeStatusQuery: - description: Get Active objects? - in: query + description: "Get Active objects?" + in: "query" name: active + type: "boolean" required: false - type: boolean + default: true itemNumberPath: - description: The Item Number + description: "The Item Number" in: path + type: "number" name: itemId required: true - type: number itemNumberQuery: description: The Item Number - in: query + in: "query" + type: "number" name: itemId required: false - type: number itemNumberQueryRequired: description: The Item Number - in: query + in: "query" + type: "number" name: itemId required: true - type: number - lastModifiedEndQuery: - description: The last modified end timestamp - in: query - name: lastModifiedEnd - required: false - type: string lastModifiedStartQuery: description: The last modified start timestamp - in: query + in: "query" + type: "string" name: lastModifiedStart required: false - type: string + lastModifiedEndQuery: + description: The last modified end timestamp + in: "query" + type: "string" + name: lastModifiedEnd + required: false licenseNumberQuery: description: The Licnese Number for the query - in: query + in: "query" + type: "string" name: license required: true - type: string mediaType: - default: application/json + default: "application/json" description: The response media type enum: - - application/json + - "application/json" in: header name: Accept - type: string + type: "string" onholdStatusQuery: description: Get On Hold objects? - in: query + in: "query" name: onhold + type: "boolean" required: false - type: boolean + default: false packageLabelQuery: description: The METRC Package Label - in: query + in: "query" + type: "string" name: label required: false - type: string packageNumberQuery: description: The METRC Package Number - in: query + in: "query" + type: "string" name: packageId required: false - type: string productionQuery: description: Use Production API? - in: query + in: "query" + type: "boolean" + default: true name: production required: false - type: boolean resellerKeyQuery: description: The METRC Reseller Key - in: query + in: "query" + type: "string" name: reseller required: true - type: string roomNumberQueryRequired: description: The Room ID number - in: query + in: "query" + type: "string" name: roomNumber required: true - type: string salesDeliveryNumberQuery: description: The Sales Delivery Number - in: query + in: "query" + type: "string" name: deliveryId required: false - type: string - salesDeliveryNumberQueryRequired: - description: The Sales Delivery Number - in: query - name: salesDeliveryId - required: true - type: string salesReceiptNumberQuery: description: The Sales Receipt Number - in: query + in: "query" + type: "string" name: salesReceiptId required: false - type: string salesReceiptNumberQueryRequired: description: The Sales Receipt Number - in: query + in: "query" + type: "string" name: salesReceiptId required: true - type: string salesTransactionNumberQueryRequired: description: The Sales Transaction Number - in: query + in: "query" + type: "string" name: transactionId required: true - type: string + salesDeliveryNumberQueryRequired: + description: The Sales Delivery Number + in: "query" + type: "string" + name: salesDeliveryId + required: true stateCodeQuery: description: The 2-character State Code - in: query + in: "query" + type: "string" name: state required: true - type: string userKeyQuery: description: The METRC User Key - in: query + in: "query" + type: "string" name: user required: true - type: string responses: Unauthorized: description: "Access unauthorized, invalid API-KEY was used" @@ -221,8 +229,7 @@ paths: get: summary: Metrics Scraper Endpoint operationId: getMetrics - description: - Provides application metrics to Prometheuus logging system + description: Provides application metrics to Prometheuus logging system tags: - Sys responses: @@ -321,8 +328,7 @@ paths: - $ref: "#/parameters/userKeyQuery" responses: "200": - description: - A list of Harvest Waste Types was succefully retrieved + description: A list of Harvest Waste Types was succefully retrieved schema: $ref: "#/definitions/HarvestWasteTypeResponse" "401": @@ -349,8 +355,7 @@ paths: $ref: "#/definitions/HarvestPackageRequest" responses: "200": - description: - An array of HarvestPackage records with the new IDs + description: An array of HarvestPackage records with the new IDs schema: $ref: "#/definitions/PlantResponse" "401": @@ -503,8 +508,7 @@ paths: - $ref: "#/parameters/userKeyQuery" responses: "200": - description: - A list of Item Product Categories was succefully retrieved + description: A list of Item Product Categories was succefully retrieved schema: $ref: "#/definitions/ProductCategoryResponse" "401": @@ -530,8 +534,7 @@ paths: - $ref: "#/parameters/userKeyQuery" responses: "200": - description: - A list of Item Product Categories was succefully retrieved + description: A list of Item Product Categories was succefully retrieved schema: $ref: "#/definitions/LabTestStateResponse" "401": @@ -557,8 +560,7 @@ paths: - $ref: "#/parameters/userKeyQuery" responses: "200": - description: - A list of Item Product Categories was succefully retrieved + description: A list of Item Product Categories was succefully retrieved schema: $ref: "#/definitions/LabTestTypeResponse" "401": @@ -811,8 +813,7 @@ paths: tags: - Plants operationId: getPlantGrowthPhases - description: - Get available Plant Growth Phases for this User-License + description: Get available Plant Growth Phases for this User-License parameters: - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/productionQuery" @@ -838,8 +839,7 @@ paths: tags: - Plants operationId: getPlantWasteMethods - description: - Get available Plant Waste Methods for this User-License + description: Get available Plant Waste Methods for this User-License parameters: - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/resellerKeyQuery" @@ -864,8 +864,7 @@ paths: tags: - Plants operationId: getPlantWasteReasons - description: - Get available Plant Waste Reasons for this User-License + description: Get available Plant Waste Reasons for this User-License parameters: - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/resellerKeyQuery" @@ -928,8 +927,7 @@ paths: $ref: "#/definitions/PlantBatchRequest" responses: "200": - description: - An array of Plant Batches records with the new IDs + description: An array of Plant Batches records with the new IDs schema: $ref: "#/definitions/PlantBatchResponse" "401": @@ -1218,8 +1216,7 @@ paths: - $ref: "#/parameters/userKeyQuery" responses: "200": - description: - A list of active Customer Types was succefully retrieved + description: A list of active Customer Types was succefully retrieved schema: $ref: "#/definitions/CustomerTypeResponse" "401": @@ -1275,8 +1272,7 @@ paths: $ref: "#/definitions/SalesDeliveryRequest" responses: "200": - description: - An array of Sales Delivery records with the new IDs + description: An array of Sales Delivery records with the new IDs schema: $ref: "#/definitions/SalesDeliveryResponse" "401": @@ -1301,8 +1297,7 @@ paths: $ref: "#/definitions/SalesDeliveryRequest" responses: "200": - description: - An array of Sales Delivery records with the new IDs + description: An array of Sales Delivery records with the new IDs schema: $ref: "#/definitions/SalesDeliveryResponse" "401": @@ -1354,9 +1349,7 @@ paths: - $ref: "#/parameters/userKeyQuery" responses: "200": - description: - A list of active Sales Delivery Return Reasons was - succefully retrieved + description: A list of active Sales Delivery Return Reasons was succefully retrieved schema: $ref: "#/definitions/SalesDeliveryReturnReasonResponse" "401": @@ -1386,8 +1379,7 @@ paths: - $ref: "#/parameters/userKeyQuery" responses: "200": - description: - A list of active Sales Receipts was succefully retrieved + description: A list of active Sales Receipts was succefully retrieved schema: $ref: "#/definitions/SalesReceiptResponse" "401": @@ -1413,8 +1405,7 @@ paths: $ref: "#/definitions/SalesReceiptRequest" responses: "200": - description: - An array of Sales Receipt records with the new IDs + description: An array of Sales Receipt records with the new IDs schema: $ref: "#/definitions/SalesReceiptResponse" "401": @@ -1439,8 +1430,7 @@ paths: $ref: "#/definitions/SalesReceiptRequest" responses: "200": - description: - An array of Sales Receipt records with the existing IDs + description: An array of Sales Receipt records with the existing IDs schema: $ref: "#/definitions/SalesReceiptResponse" "401": @@ -1494,8 +1484,7 @@ paths: - $ref: "#/parameters/userKeyQuery" responses: "200": - description: - A list of active Sales Receipts was succefully retrieved + description: A list of active Sales Receipts was succefully retrieved schema: $ref: "#/definitions/TransactionResponse" "401": @@ -1521,8 +1510,7 @@ paths: $ref: "#/definitions/TransactionRequest" responses: "200": - description: - An array of Sales Transaction records with the new IDs + description: An array of Sales Transaction records with the new IDs schema: $ref: "#/definitions/TransactionResponse" "401": @@ -1547,8 +1535,7 @@ paths: $ref: "#/definitions/TransactionRequest" responses: "200": - description: - An array of Sales Transaction records with the existing IDs + description: An array of Sales Transaction records with the existing IDs schema: $ref: "#/definitions/TransactionResponse" "401": @@ -1574,8 +1561,7 @@ paths: - $ref: "#/parameters/userKeyQuery" responses: "200": - description: - A list of Sales Transaction Dates was succefully retrieved + description: A list of Sales Transaction Dates was succefully retrieved schema: $ref: "#/definitions/SalesTransactionDateResponse" "401": @@ -1636,8 +1622,7 @@ paths: - $ref: "#/parameters/userKeyQuery" responses: "200": - description: - A list of Units of Measure was succefully retrieved + description: A list of Units of Measure was succefully retrieved schema: $ref: "#/definitions/UnitsOfMeasureResponse" "401": @@ -1651,1407 +1636,1445 @@ paths: summary: Units of Measure definitions: CustomerType: + type: "object" properties: name: - type: string - type: object + type: "string" CustomerTypeResponse: + type: "object" properties: - data: - items: - $ref: "#/definitions/CustomerType" - type: array meta: $ref: "#/definitions/ResponseMeta" - type: object + data: + type: "array" + items: + $ref: "#/definitions/CustomerType" Error: + type: "object" properties: error: - type: string + type: "string" status: maximum: 600 minimum: 100 - type: integer - type: object + type: "integer" Facility: properties: - Alias: - example: OR Larger Rec-WHSLR 1 - type: string - CredentialedDate: - example: "2017-08-13" - type: string - DisplayName: - example: OR Larger Rec-WHSLR 1 - type: string - FacilityType: - properties: - AdvancedSales: - example: false - type: boolean - CanAssignRoomsToPackages: - example: false - type: boolean - CanAssignRoomsToPlantBatches: - example: false - type: boolean - CanCreateDerivedPackages: - example: true - type: boolean - CanCreateOpeningBalancePackages: - example: true - type: boolean - CanCreateProcessValidationPackages: - example: true - type: boolean - CanDeliverSalesToConsumers: - example: false - type: boolean - CanDeliverSalesToPatients: - example: false - type: boolean - CanGrowPlants: - example: false - type: boolean - CanHaveMemberPatients: - example: false - type: boolean - CanInfuseProducts: - example: false - type: boolean - CanPackageVegetativePlants: - example: false - type: boolean - CanRemediatePackagesWithFailedLabResults: - example: false - type: boolean - CanReportHarvestSchedules: - example: false - type: boolean - CanReportPatientsAdverseResponses: - example: false - type: boolean - CanRequestProductRemediation: - example: false - type: boolean - CanRequireHarvestSampleLabTestBatches: - example: false - type: boolean - CanRequirePackageSampleLabTestBatches: - example: false - type: boolean - CanSellToCaregivers: - example: false - type: boolean - CanSellToConsumers: - example: false - type: boolean - CanSellToExternalPatients: - example: false - type: boolean - CanSellToPatients: - example: false - type: boolean - CanSubmitHarvestsForTesting: - example: false - type: boolean - CanSubmitPackagesForTesting: - example: true - type: boolean - CanTagPlantBatches: - example: false - type: boolean - CanTestPackages: - example: false - type: boolean - CanTrackVegetativePlants: - example: true - type: boolean - CanTransferFromExternalFacilities: - example: true - type: boolean - CanUpdatePlantStrains: - example: false - type: boolean - IsMedical: - example: false - type: boolean - IsRetail: - example: true - type: boolean - PackagesRequirePatientAffiliation: - example: false - type: boolean - PlantsRequirePatientAffiliation: - example: false - type: boolean - SalesDeliveryRequirePatientNumber: - example: false - type: boolean - SalesRequireCaregiverNumber: - example: false - type: boolean - SalesRequireCaregiverPatientNumber: - example: false - type: boolean - SalesRequireExternalPatientIdentificationMethod: - example: false - type: boolean - SalesRequireExternalPatientNumber: - example: false - type: boolean - SalesRequirePatientNumber: - example: false - type: boolean - type: object HireDate: + type: "string" example: "2017-08-14" - type: string - IsManager: - example: true - type: boolean IsOwner: + type: "boolean" example: true - type: boolean + IsManager: + type: "boolean" + example: true + Occupations: + type: "array" + items: + type: "string" + example: [] + Name: + type: "string" + example: "OR LARGER THAN SALES, LLC" + Alias: + type: "string" + example: "OR Larger Rec-WHSLR 1" + DisplayName: + type: "string" + example: "OR Larger Rec-WHSLR 1" + CredentialedDate: + type: "string" + example: "2017-08-13" License: $ref: "#/definitions/License" - Name: - example: "OR LARGER THAN SALES, LLC" - type: string - Occupations: - example: [] - items: - type: string - type: array + FacilityType: + properties: + IsMedical: + type: "boolean" + example: false + IsRetail: + type: "boolean" + example: true + CanGrowPlants: + type: "boolean" + example: false + CanTagPlantBatches: + type: "boolean" + example: false + CanUpdatePlantStrains: + type: "boolean" + example: false + CanAssignRoomsToPlantBatches: + type: "boolean" + example: false + CanTrackVegetativePlants: + type: "boolean" + example: true + PlantsRequirePatientAffiliation: + type: "boolean" + example: false + CanPackageVegetativePlants: + type: "boolean" + example: false + CanReportHarvestSchedules: + type: "boolean" + example: false + CanSubmitHarvestsForTesting: + type: "boolean" + example: false + CanRequireHarvestSampleLabTestBatches: + type: "boolean" + example: false + CanCreateOpeningBalancePackages: + type: "boolean" + example: true + CanCreateDerivedPackages: + type: "boolean" + example: true + CanAssignRoomsToPackages: + type: "boolean" + example: false + PackagesRequirePatientAffiliation: + type: "boolean" + example: false + CanSubmitPackagesForTesting: + type: "boolean" + example: true + CanCreateProcessValidationPackages: + type: "boolean" + example: true + CanRequirePackageSampleLabTestBatches: + type: "boolean" + example: false + CanRequestProductRemediation: + type: "boolean" + example: false + CanRemediatePackagesWithFailedLabResults: + type: "boolean" + example: false + CanInfuseProducts: + type: "boolean" + example: false + CanTestPackages: + type: "boolean" + example: false + CanTransferFromExternalFacilities: + type: "boolean" + example: true + CanSellToConsumers: + type: "boolean" + example: false + CanSellToPatients: + type: "boolean" + example: false + CanSellToExternalPatients: + type: "boolean" + example: false + CanSellToCaregivers: + type: "boolean" + example: false + AdvancedSales: + type: "boolean" + example: false + SalesRequirePatientNumber: + type: "boolean" + example: false + SalesRequireExternalPatientNumber: + type: "boolean" + example: false + SalesRequireExternalPatientIdentificationMethod: + type: "boolean" + example: false + SalesRequireCaregiverNumber: + type: "boolean" + example: false + SalesRequireCaregiverPatientNumber: + type: "boolean" + example: false + CanDeliverSalesToConsumers: + type: "boolean" + example: false + CanDeliverSalesToPatients: + type: "boolean" + example: false + SalesDeliveryRequirePatientNumber: + type: "boolean" + example: false + CanHaveMemberPatients: + type: "boolean" + example: false + CanReportPatientsAdverseResponses: + type: "boolean" + example: false + type: "object" FacilityResponse: + type: "object" properties: + meta: + $ref: "#/definitions/ResponseMeta" data: + type: "array" items: $ref: "#/definitions/Facility" - type: array - meta: - $ref: "#/definitions/ResponseMeta" - type: object Harvest: properties: - CurrentWeight: - example: 0 - type: number - DryingRoomId: - example: 1 - type: number - DryingRoomName: - example: Harvest Room - type: string - HarvestStartDate: - example: "2014-11-19" - type: string - HarvestType: - example: WholePlant - type: string Id: + type: "number" example: 2 - type: number - IsOnHold: - example: false - type: boolean - LastModified: - example: "0001-01-01T00:00:00+00:00" - type: string Name: - example: 2014-11-19-Harvest Room-H - type: string - PackageCount: - example: 0 - type: number - PlantCount: - example: 70 - type: number + type: "string" + example: "2014-11-19-Harvest Room-H" + HarvestType: + type: "string" + example: "WholePlant" SourceStrainCount: + type: "number" example: 0 - type: number - TotalPackagedWeight: + DryingRoomId: + type: "number" + example: 1 + DryingRoomName: + type: "string" + example: "Harvest Room" + CurrentWeight: + type: "number" example: 0 - type: number - TotalRestoredWeight: - example: 0 - type: number TotalWasteWeight: + type: "number" example: 0 - type: number + PlantCount: + type: "number" + example: 70 TotalWetWeight: + type: "number" example: 40 - type: number + TotalRestoredWeight: + type: "number" + example: 0 + PackageCount: + type: "number" + example: 0 + TotalPackagedWeight: + type: "number" + example: 0 UnitOfWeightName: - example: Ounces - type: string - HarvestPackage: - properties: - ActualDate: - example: "2015-12-15" - type: string - Ingredients: - items: - $ref: "#/definitions/HarvestPackageIngredient" - type: array - IsProductionBatch: + type: "string" + example: "Ounces" + IsOnHold: + type: "boolean" example: false - type: boolean - Item: - example: Buds - type: string - PatientLicenseNumber: - example: X00001 - type: string - ProductRequiresRemediation: - example: false - type: boolean - ProductionBatchNumber: - example: _string_ - type: string - RemediateProduct: - example: false - type: boolean - RemediationDate: - example: "2015-12-15" - type: string - RemediationMethodId: - example: _string_ - type: string - RemediationSteps: - example: _string_ - type: string - Room: - example: _string_ - type: string - Tag: - example: ABCDEF012345670000020201 - type: string - UnitOfWeight: - example: Grams - type: string - type: object - HarvestPackageIngredient: - properties: - HarvestId: - example: 2 - type: number - HarvestName: - example: _string_ - type: string - UnitOfWeight: - example: Grams - type: string - Weight: - example: 100.23 - type: number - type: object - HarvestPackageRequest: - properties: - data: - items: - $ref: "#/definitions/HarvestPackage" - type: array - meta: - $ref: "#/definitions/RequestMeta" - type: object + HarvestStartDate: + type: "string" + example: "2014-11-19" + LastModified: + type: "string" + example: "0001-01-01T00:00:00+00:00" HarvestResponse: + type: "object" properties: + meta: + $ref: "#/definitions/ResponseMeta" data: + type: "array" items: $ref: "#/definitions/Harvest" - type: array - meta: - $ref: "#/definitions/ResponseMeta" - type: object - HarvestUpdate: - properties: - ActualDate: - example: "2015-12-15" - type: string - Id: - example: 34904 - type: number - UnitOfWeight: - example: Grams - type: string - WasteType: - example: Plant Material - type: string - WasteWeight: - example: 10.05 - type: number - operationId: - example: removeWaste - type: string - type: object - HarvestUpdateRequest: - properties: - data: - items: - $ref: "#/definitions/HarvestUpdate" - type: array - meta: - $ref: "#/definitions/RequestMeta" - type: object - HarvestUpdateResponse: - properties: - data: - items: - $ref: "#/definitions/HarvestUpdate" - type: array - meta: - $ref: "#/definitions/ResponseMeta" - type: object HarvestWasteType: properties: Name: - example: Plant Material - type: string + type: "string" + example: "Plant Material" HarvestWasteTypeResponse: + type: "object" properties: - data: - items: - $ref: "#/definitions/HarvestWasteType" - type: array meta: $ref: "#/definitions/ResponseMeta" - type: object + data: + type: "array" + items: + $ref: "#/definitions/HarvestWasteType" + HarvestPackage: + type: "object" + properties: + ActualDate: + type: "string" + example: "2015-12-15" + IsProductionBatch: + type: "boolean" + example: false + Item: + type: "string" + example: "Buds" + PatientLicenseNumber: + type: "string" + example: "X00001" + ProductionBatchNumber: + type: "string" + example: "_string_" + ProductRequiresRemediation: + type: "boolean" + example: false + RemediateProduct: + type: "boolean" + example: false + RemediationDate: + type: "string" + example: "2015-12-15" + RemediationMethodId: + type: "string" + example: "_string_" + RemediationSteps: + type: "string" + example: "_string_" + Room: + type: "string" + example: "_string_" + Tag: + type: "string" + example: "ABCDEF012345670000020201" + UnitOfWeight: + type: "string" + example: "Grams" + Ingredients: + type: "array" + items: + $ref: "#/definitions/HarvestPackageIngredient" + HarvestPackageIngredient: + type: "object" + properties: + HarvestId: + type: "number" + example: 2 + HarvestName: + type: "string" + example: "_string_" + Weight: + type: "number" + example: 100.23 + UnitOfWeight: + type: "string" + example: "Grams" + HarvestPackageRequest: + type: "object" + properties: + meta: + $ref: "#/definitions/RequestMeta" + data: + type: "array" + items: + $ref: "#/definitions/HarvestPackage" + HarvestUpdate: + type: "object" + properties: + Id: + type: "number" + example: 34904 + operationId: + type: "string" + example: "removeWaste" + ActualDate: + type: "string" + example: "2015-12-15" + UnitOfWeight: + type: "string" + example: "Grams" + WasteType: + type: "string" + example: "Plant Material" + WasteWeight: + type: "number" + example: 10.05 + HarvestUpdateRequest: + type: "object" + properties: + meta: + $ref: "#/definitions/RequestMeta" + data: + type: "array" + items: + $ref: "#/definitions/HarvestUpdate" + HarvestUpdateResponse: + type: "object" + properties: + meta: + $ref: "#/definitions/ResponseMeta" + data: + type: "array" + items: + $ref: "#/definitions/HarvestUpdate" InvalidError: allOf: - $ref: "#/definitions/Error" - properties: details: items: - type: string - type: array - type: object + type: "string" + type: "array" + type: "object" Item: properties: - AdministrationMethod: - example: "" - type: string - ApprovalStatus: - example: Approved - type: string - DefaultLabTestingState: - example: NotSubmitted - type: string Id: + type: "number" example: 34904 - type: number - Ingredients: - example: "" - type: string Name: - example: Ak-47 Shatter 2 - type: string + type: "string" + example: "Ak-47 Shatter 2" ProductCategoryName: - example: Extracts (each) - type: string + type: "string" + example: "Extracts (each)" ProductCategoryType: - example: Concentrate - type: string + type: "string" + example: "Concentrate" QuantityType: - example: CountBased - type: string - ServingSize: - example: "" - type: string + type: "string" + example: "CountBased" + DefaultLabTestingState: + type: "string" + example: "NotSubmitted" UnitOfMeasureName: - example: Each - type: string + type: "string" + example: "Each" + ApprovalStatus: + type: "string" + example: "Approved" + AdministrationMethod: + type: "string" + example: "" UnitWeight: + type: "number" example: 50 - type: number UnitWeightUnitOfMeasureName: - example: Milligrams - type: string + type: "string" + example: "Milligrams" + ServingSize: + type: "string" + example: "" + Ingredients: + type: "string" + example: "" ItemRequest: + type: "object" properties: - data: - items: - $ref: "#/definitions/Item" - type: array meta: $ref: "#/definitions/RequestMeta" - type: object - ItemResponse: - properties: data: + type: "array" items: $ref: "#/definitions/Item" - type: array + ItemResponse: + type: "object" + properties: meta: $ref: "#/definitions/ResponseMeta" - type: object + data: + type: "array" + items: + $ref: "#/definitions/Item" LabTestState: + type: "object" properties: name: - type: string - type: object + type: "string" LabTestStateResponse: + type: "object" properties: + meta: + $ref: "#/definitions/ResponseMeta" data: + type: "array" items: $ref: "#/definitions/LabTestState" - type: array + LabTestType: + type: "object" + properties: + Id: + type: "number" + example: 1 + AlwaysPasses: + type: "boolean" + example: false + DependencyMode: + type: "number" + example: 0 + Name: + type: "string" + example: "THC" + RequiresTestResult: + type: "boolean" + example: false + LabTestTypeResponse: + type: "object" + properties: meta: $ref: "#/definitions/ResponseMeta" - type: object - LabTestType: - properties: - AlwaysPasses: - example: false - type: boolean - DependencyMode: - example: 0 - type: number - Id: - example: 1 - type: number - Name: - example: THC - type: string - RequiresTestResult: - example: false - type: boolean - type: object - LabTestTypeResponse: - properties: data: + type: "array" items: $ref: "#/definitions/LabTestType" - type: array + License: + type: "object" + required: + - "Number" + - "StartDate" + - "EndDate" + - "LicenseType" + properties: + Number: + type: "string" + example: "060-X0001" + StartDate: + type: "string" + example: "2013-01-28" + EndDate: + type: "string" + example: "2020-09-28" + LicenseType: + type: "string" + example: "Recreational Wholesaler" + Package: + type: "object" + properties: + Id: + type: "number" + example: 2 + ArchivedDate: + type: "string" + example: "2014-11-29" + ContainsRemediatedProduct: + type: "boolean" + example: false + FinishedDate: + type: "string" + example: "2014-11-29" + InitialLabTestingState: + type: "string" + example: "NotSubmitted" + IsOnHold: + type: "boolean" + example: false + IsProcessValidationTestingSample: + type: "boolean" + example: false + IsProductionBatch: + type: "boolean" + example: false + IsTestingSample: + type: "boolean" + example: false + Label: + type: "string" + example: "ABCDEF012345670000010042" + LabTestingState: + type: "string" + example: "NotSubmitted" + LabTestingStateDate: + type: "string" + example: "2014-11-29" + LastModified: + type: "string" + example: "2019-01-30T02:52:15.0599079+00:00" + PackagedDate: + type: "string" + example: "2014-11-29" + PackageType: + type: "string" + example: "Product" + PatientLicenseNumber: + type: "string" + example: "_string_" + ProductCategoryName: + type: "string" + example: "Buds" + ProductId: + type: "number" + example: 1 + ProductionBatchNumber: + type: "string" + example: "_string_" + ProductName: + type: "string" + example: "Buds" + ProductRequiresRemediation: + type: "boolean" + example: false + Quantity: + type: "number" + format: "double" + example: 1.0 + ReceivedDateTime: + type: "string" + example: "_string_" + ReceivedFromFacilityLicenseNumber: + type: "string" + example: "_string_" + ReceivedFromFacilityName: + type: "string" + example: "_string_" + ReceivedFromManifestNumber: + type: "string" + example: "_string_" + RemediationDate: + type: "string" + example: "2014-11-29" + RoomId: + type: "string" + example: "_string_" + RoomName: + type: "string" + example: "_string_" + SourceHarvestNames: + type: "string" + example: "_string_" + UnitOfMeasureAbbreviation: + type: "string" + example: "oz" + UnitOfMeasureName: + type: "string" + example: "Ounces" + PackageRequest: + type: "object" + properties: + meta: + $ref: "#/definitions/RequestMeta" + data: + type: "array" + items: + $ref: "#/definitions/Package" + PackageResponse: + type: "object" + properties: meta: $ref: "#/definitions/ResponseMeta" - type: object - License: - properties: - EndDate: - example: "2020-09-28" - type: string - LicenseType: - example: Recreational Wholesaler - type: string - Number: - example: 060-X0001 - type: string - StartDate: - example: "2013-01-28" - type: string - required: - - Number - - StartDate - - EndDate - - LicenseType - type: object - Package: - properties: - ArchivedDate: - example: "2014-11-29" - type: string - ContainsRemediatedProduct: - example: false - type: boolean - FinishedDate: - example: "2014-11-29" - type: string - Id: - example: 2 - type: number - InitialLabTestingState: - example: NotSubmitted - type: string - IsOnHold: - example: false - type: boolean - IsProcessValidationTestingSample: - example: false - type: boolean - IsProductionBatch: - example: false - type: boolean - IsTestingSample: - example: false - type: boolean - LabTestingState: - example: NotSubmitted - type: string - LabTestingStateDate: - example: "2014-11-29" - type: string - Label: - example: ABCDEF012345670000010042 - type: string - LastModified: - example: "2019-01-30T02:52:15.0599079+00:00" - type: string - PackageType: - example: Product - type: string - PackagedDate: - example: "2014-11-29" - type: string - PatientLicenseNumber: - example: _string_ - type: string - ProductCategoryName: - example: Buds - type: string - ProductId: - example: 1 - type: number - ProductName: - example: Buds - type: string - ProductRequiresRemediation: - example: false - type: boolean - ProductionBatchNumber: - example: _string_ - type: string - Quantity: - example: 1 - format: double - type: number - ReceivedDateTime: - example: _string_ - type: string - ReceivedFromFacilityLicenseNumber: - example: _string_ - type: string - ReceivedFromFacilityName: - example: _string_ - type: string - ReceivedFromManifestNumber: - example: _string_ - type: string - RemediationDate: - example: "2014-11-29" - type: string - RoomId: - example: _string_ - type: string - RoomName: - example: _string_ - type: string - SourceHarvestNames: - example: _string_ - type: string - UnitOfMeasureAbbreviation: - example: oz - type: string - UnitOfMeasureName: - example: Ounces - type: string - type: object - PackageAdjustmentReason: - properties: - Name: - type: string - RequiresNote: - type: boolean - type: object - PackageAdjustmentReasonResponse: - properties: data: + type: "array" + items: + $ref: "#/definitions/Package" + PackageType: + type: "object" + properties: + name: + type: "string" + PackageAdjustmentReason: + type: "object" + properties: + "Name": + type: "string" + "RequiresNote": + type: "boolean" + PackageAdjustmentReasonResponse: + type: "object" + properties: + meta: + $ref: "#/definitions/ResponseMeta" + data: + type: "array" items: $ref: "#/definitions/PackageAdjustmentReason" - type: array - meta: - $ref: "#/definitions/ResponseMeta" - type: object - PackageRequest: - properties: - data: - items: - $ref: "#/definitions/Package" - type: array - meta: - $ref: "#/definitions/RequestMeta" - type: object - PackageResponse: - properties: - data: - items: - $ref: "#/definitions/Package" - type: array - meta: - $ref: "#/definitions/ResponseMeta" - type: object - PackageType: - properties: - name: - type: string - type: object PackageTypeResponse: + type: "object" properties: + meta: + $ref: "#/definitions/ResponseMeta" data: + type: "array" items: $ref: "#/definitions/PackageType" - type: array - meta: - $ref: "#/definitions/ResponseMeta" - type: object Pagination: + type: "object" properties: - next_link: - type: string - p_limit: - description: The Limit for a Request - format: int64 - type: integer p_offset: - description: The Offset for a Request - format: int64 - type: integer + type: "integer" + format: "int64" + description: "The Offset for a Request" + default: 0 + p_limit: + type: "integer" + format: "int64" + description: "The Limit for a Request" + default: 100 page_size: - description: The number of records in a Response - format: int64 - type: integer + type: "integer" + format: "int64" + description: "The number of records in a Response" set_size: - description: - The total number of records available for a Response - format: int64 - type: integer - type: object + type: "integer" + format: "int64" + description: "The total number of records available for a Response" + next_link: + type: "string" Plant: + type: "object" properties: - GrowthPhase: - type: string - HarvestCount: - type: number Id: - type: number - IsOnHold: - type: boolean + type: "number" Label: - type: string - LastModified: - type: string - PlantBatchId: - type: number - PlantBatchName: - type: string - PlantBatchTypeName: - type: string - PlantedDate: - type: string - RoomId: - type: number - RoomName: - type: string + type: "string" State: - type: string + type: "string" + GrowthPhase: + type: "string" + PlantBatchId: + type: "number" + PlantBatchName: + type: "string" + PlantBatchTypeName: + type: "string" StrainId: - type: number + type: "number" StrainName: - type: string - VegetativeDate: - type: string - type: object - PlantBatch: - properties: - Count: - example: 80 - type: number - DestroyedCount: - example: 40 - type: number - HarvestedCount: - example: 0 - type: number - Id: - example: 5 - type: number - LastModified: - example: "0001-01-01T00:00:00+00:00" - type: string - LiveCount: - example: 10 - type: number - Name: - example: Demo Plant Batch 1 - type: string - PackagedCount: - example: 0 - type: number - PatientLicenseNumber: - example: _string_ - type: string - PlantedDate: - example: "2014-10-10" - type: string + type: "string" RoomId: - example: _string_ - type: string + type: "number" RoomName: - example: _string_ - type: string - SourcePackageId: - example: 0 - type: number - SourcePackageLabel: - example: _string_ - type: string - SourcePlantId: - example: 0 - type: number - SourcePlantLabel: - example: _string_ - type: string - StrainId: - example: 1 - type: number - StrainName: - example: Spring Hill Kush - type: string - TrackedCount: - example: 10 - type: number - Type: - example: Seed - type: string - UntrackedCount: - example: 80 - type: number - type: object - PlantBatchRequest: + type: "string" + HarvestCount: + type: "number" + IsOnHold: + type: "boolean" + PlantedDate: + type: "string" + VegetativeDate: + type: "string" + LastModified: + type: "string" + PlantRequest: + type: "object" properties: - data: - items: - $ref: "#/definitions/PlantBatch" - type: array meta: $ref: "#/definitions/RequestMeta" - type: object - PlantBatchResponse: - properties: data: + type: "array" items: - $ref: "#/definitions/PlantBatch" - type: array + $ref: "#/definitions/Plant" + PlantResponse: + type: "object" + properties: meta: $ref: "#/definitions/ResponseMeta" - type: object + data: + type: "array" + items: + $ref: "#/definitions/Plant" PlantGrowthPhase: + type: "object" properties: name: - type: string - type: object + type: "string" PlantGrowthPhaseResponse: + type: "object" properties: + meta: + $ref: "#/definitions/ResponseMeta" data: + type: "array" items: $ref: "#/definitions/PlantGrowthPhase" - type: array - meta: - $ref: "#/definitions/ResponseMeta" - type: object - PlantRequest: + PlantBatch: + type: "object" + properties: + Id: + type: "number" + example: 5 + Count: + type: "number" + example: 80 + DestroyedCount: + type: "number" + example: 40 + HarvestedCount: + type: "number" + example: 0 + LastModified: + type: "string" + example: "0001-01-01T00:00:00+00:00" + LiveCount: + type: "number" + example: 10 + Name: + type: "string" + example: "Demo Plant Batch 1" + PackagedCount: + type: "number" + example: 0 + PatientLicenseNumber: + type: "string" + example: "_string_" + PlantedDate: + type: "string" + example: "2014-10-10" + RoomId: + type: "string" + example: "_string_" + RoomName: + type: "string" + example: "_string_" + SourcePackageId: + type: "number" + example: 0 + SourcePackageLabel: + type: "string" + example: "_string_" + SourcePlantId: + type: "number" + example: 0 + SourcePlantLabel: + type: "string" + example: "_string_" + StrainId: + type: "number" + example: 1 + StrainName: + type: "string" + example: "Spring Hill Kush" + TrackedCount: + type: "number" + example: 10 + Type: + type: "string" + example: "Seed" + UntrackedCount: + type: "number" + example: 80 + PlantBatchRequest: + type: "object" properties: - data: - items: - $ref: "#/definitions/Plant" - type: array meta: $ref: "#/definitions/RequestMeta" - type: object - PlantResponse: - properties: data: + type: "array" items: - $ref: "#/definitions/Plant" - type: array + $ref: "#/definitions/PlantBatch" + PlantBatchResponse: + type: "object" + properties: meta: $ref: "#/definitions/ResponseMeta" - type: object + data: + type: "array" + items: + $ref: "#/definitions/PlantBatch" PlantWasteMethod: + type: "object" properties: name: - type: string - type: object + type: "string" PlantWasteMethodResponse: + type: "object" properties: - data: - items: - $ref: "#/definitions/PlantWasteMethod" - type: array meta: $ref: "#/definitions/ResponseMeta" - type: object + data: + type: "array" + items: + $ref: "#/definitions/PlantWasteMethod" PlantWasteReasonResponse: + type: "object" properties: - data: - items: - $ref: "#/definitions/PlantWasteMethod" - type: array meta: $ref: "#/definitions/ResponseMeta" - type: object - ProductCategory: - properties: - CanBeRemediated: - example: true - type: boolean - CanContainSeeds: - example: true - type: boolean - Name: - example: Buds - type: string - ProductCategoryType: - example: Buds - type: string - QuantityType: - example: WeightBased - type: string - RequiresAdministrationMethod: - example: false - type: boolean - RequiresIngredients: - example: false - type: boolean - RequiresItemBrand: - example: false - type: boolean - RequiresProductPhoto: - example: false - type: boolean - RequiresServingSize: - example: false - type: boolean - RequiresStrain: - example: false - type: boolean - RequiresSupplyDurationDays: - example: false - type: boolean - RequiresUnitCbdContent: - example: false - type: boolean - RequiresUnitCbdPercent: - example: false - type: boolean - RequiresUnitThcContent: - example: false - type: boolean - RequiresUnitThcPercent: - example: false - type: boolean - RequiresUnitVolume: - example: false - type: boolean - RequiresUnitWeight: - example: false - type: boolean - type: object - ProductCategoryResponse: - properties: data: + type: "array" + items: + $ref: "#/definitions/PlantWasteMethod" + ProductCategory: + type: "object" + properties: + Name: + type: "string" + example: "Buds" + ProductCategoryType: + type: "string" + example: "Buds" + QuantityType: + type: "string" + example: "WeightBased" + RequiresStrain: + type: "boolean" + example: false + RequiresItemBrand: + type: "boolean" + example: false + RequiresAdministrationMethod: + type: "boolean" + example: false + RequiresUnitCbdPercent: + type: "boolean" + example: false + RequiresUnitCbdContent: + type: "boolean" + example: false + RequiresUnitThcPercent: + type: "boolean" + example: false + RequiresUnitThcContent: + type: "boolean" + example: false + RequiresUnitVolume: + type: "boolean" + example: false + RequiresUnitWeight: + type: "boolean" + example: false + RequiresServingSize: + type: "boolean" + example: false + RequiresSupplyDurationDays: + type: "boolean" + example: false + RequiresIngredients: + type: "boolean" + example: false + RequiresProductPhoto: + type: "boolean" + example: false + CanContainSeeds: + type: "boolean" + example: true + CanBeRemediated: + type: "boolean" + example: true + ProductCategoryResponse: + type: "object" + properties: + meta: + $ref: "#/definitions/ResponseMeta" + data: + type: "array" items: $ref: "#/definitions/ProductCategory" - type: array - meta: - $ref: "#/definitions/ResponseMeta" - type: object RequestMeta: - properties: - license: - example: A12-0000015-LIC - type: string - operation_id: - description: Operation ID - type: string - production: - type: boolean - reseller: - example: <> - type: string - state: - example: CA - type: string - taxnexus_account: - description: Taxnexus Account Number for recording transactions - example: T0000001 - type: string - test_only: - example: true - type: boolean - transaction_date: - example: "2019-01-01" - type: string - user: - example: <> - type: string + type: "object" required: - - license - - production - - reseller - - state - - user - type: object - ResponseMeta: + - "license" + - "production" + - "reseller" + - "state" + - "user" properties: - contact: - description: Microservice Contact Info - type: string - copyright: - description: Copyright Info - type: string + taxnexus_account: + type: "string" + example: "T0000001" + description: "Taxnexus Account Number for recording transactions" license: - description: License Information and Restrictions - type: string - operationid: - description: Operation ID - type: string - requestip: - description: Request IP Address - type: string - requesttype: - description: Request Type - type: string - requesturl: - description: Request URL - type: string - serverinfo: - description: Data Server Info - type: string - serverresponsetime: - description: Data Server Response Time (ms) - type: string - servertimestamp: - description: Backend Server Timestamp - type: string - taxnexusaccount: - description: - Taxnexus Account Number used for recording transactions - type: string - type: object + type: "string" + example: "A12-0000015-LIC" + operation_id: + type: "string" + description: "Operation ID" + production: + type: "boolean" + example: true + default: true + reseller: + type: "string" + example: "<>" + state: + type: "string" + example: "CA" + test_only: + type: "boolean" + example: true + transaction_date: + type: "string" + example: "2019-01-01" + user: + type: "string" + example: "<>" + ResponseMeta: + type: "object" + properties: + test_only: + type: "boolean" + description: "Test Only flag; if test_only=TRUE then do not record ingest" + pagination: + $ref: "#/definitions/Pagination" + taxnexus_account: + type: "string" + description: "Taxnexus Account Number for recording transactions" + example: "T0000001" + api_info: + type: "string" + description: "App Server Information" + api_response_time: + type: "string" + description: "App Server Response Time" + api_timestamp: + type: "string" + description: "App Server Timestamp" + api_uid: + type: "string" + description: "App Server Transaction Id" + contact: + type: "string" + description: "Contact Info" + copyright: + type: "string" + description: "Copyright Info" + info: + type: "string" + description: "Request Status and Error Information" + license: + type: "string" + description: "License used for Operation" + operation_id: + type: "string" + description: "Operation ID that was performed" + production: + type: "boolean" + description: "TRUE to use production endpoints; FALSE uses Metrc Sandbox" + request_ip: + type: "string" + description: "Request IP Address" + request_type: + type: "string" + description: "Request Type" + request_url: + type: "string" + description: "Request URL" + server_info: + type: "string" + description: "Backend Server Info" + server_response_time: + type: "string" + description: "Backend Server Response Time" + reseller: + type: "string" + example: "<>" + description: "The Reseller Key used for the transaction" + state: + type: "string" + example: "CA" + transaction_date: + type: "string" + example: "2019-01-01 to 2019-01-02" + description: "The date (or dates) of transactions retrieved" + user: + type: "string" + example: "<>" + description: "The User Key used for the transaction" Room: + type: "object" properties: Id: - type: number + type: "number" Name: - type: string - type: object + type: "string" RoomRequest: + type: "object" properties: - data: - items: - $ref: "#/definitions/Room" - type: array meta: $ref: "#/definitions/RequestMeta" - type: object - RoomResponse: - properties: data: + type: "array" items: $ref: "#/definitions/Room" - type: array + RoomResponse: + type: "object" + properties: meta: $ref: "#/definitions/ResponseMeta" - type: object + data: + type: "array" + items: + $ref: "#/definitions/Room" SalesDelivery: + type: "object" properties: - DriverName: - example: John Doe - type: string - DriverOccupationalLicenseNumber: - example: "1" - type: string - DriverVehicleLicenseNumber: - example: "1" - type: string - EstimatedArrivalDateTime: - example: "2017-04-04T13:00:00.000" - type: string - EstimatedDepartureDateTime: - example: "2017-04-04T11:00:00.000" - type: string Id: + type: "number" example: 51 - type: number - PhoneNumberForQuestions: - example: +1-123-456-7890 - type: string - PlannedRoute: - example: Drive to destination. - type: string - RecipientAddressCity: - example: Denver - type: string - RecipientAddressPostalCode: - example: "11111" - type: string - RecipientAddressState: - example: CO - type: string - RecipientAddressStreet1: - example: 1 Someplace Road - type: string - RecipientAddressStreet2: - example: Ste 9 - type: string - SalesCustomerType: - example: Consumer - type: string SalesDateTime: + type: "string" example: "2017-04-04T10:10:19.000" - type: string + SalesCustomerType: + type: "string" + example: "Consumer" + DriverName: + type: "string" + example: "John Doe" + DriverOccupationalLicenseNumber: + type: "string" + example: "1" + DriverVehicleLicenseNumber: + type: "string" + example: "1" + PhoneNumberForQuestions: + type: "string" + example: "+1-123-456-7890" + VehicleMake: + type: "string" + example: "Car" + VehicleModel: + type: "string" + example: "Small" + VehicleLicensePlateNumber: + type: "string" + example: "000000" + RecipientAddressStreet1: + type: "string" + example: "1 Someplace Road" + RecipientAddressStreet2: + type: "string" + example: "Ste 9" + RecipientAddressCity: + type: "string" + example: "Denver" + RecipientAddressState: + type: "string" + example: "CO" + RecipientAddressPostalCode: + type: "string" + example: "11111" + PlannedRoute: + type: "string" + example: "Drive to destination." + EstimatedDepartureDateTime: + type: "string" + example: "2017-04-04T11:00:00.000" + EstimatedArrivalDateTime: + type: "string" + example: "2017-04-04T13:00:00.000" Transactions: + type: "array" items: $ref: "#/definitions/Transaction" - type: array - VehicleLicensePlateNumber: - example: "000000" - type: string - VehicleMake: - example: Car - type: string - VehicleModel: - example: Small - type: string - type: object SalesDeliveryRequest: + type: "object" properties: - data: - items: - $ref: "#/definitions/SalesDelivery" - type: array meta: $ref: "#/definitions/RequestMeta" - type: object - SalesDeliveryResponse: - properties: data: + type: "array" items: $ref: "#/definitions/SalesDelivery" - type: array + SalesDeliveryResponse: + type: "object" + properties: meta: $ref: "#/definitions/ResponseMeta" - type: object + data: + type: "array" + items: + $ref: "#/definitions/SalesDelivery" SalesDeliveryReturnReason: + type: "object" properties: Name: - type: string + type: "string" RequiresNote: - type: boolean - type: object + type: "boolean" SalesDeliveryReturnReasonResponse: + type: "object" properties: + meta: + $ref: "#/definitions/ResponseMeta" data: + type: "array" items: $ref: "#/definitions/SalesDeliveryReturnReason" - type: array - meta: - $ref: "#/definitions/ResponseMeta" - type: object SalesReceipt: + type: "object" properties: - ArchivedDate: - example: string - type: string - CaregiverLicenseNumber: - example: "" - type: string Id: + type: "number" example: 38304110 - type: number - IdentificationMethod: - example: "" - type: string - IsFinal: - example: false - type: boolean - LastModified: - example: "2019-02-14T23:52:31+00:00" - type: string - PatientLicenseNumber: - example: "" - type: string ReceiptNumber: - example: 0038304110 - type: string - SalesCustomerType: - example: Consumer - type: string + type: "string" + example: "0038304110" SalesDateTime: + type: "string" example: "2019-02-14T15:50:45.000" - type: string + SalesCustomerType: + type: "string" + example: "Consumer" + PatientLicenseNumber: + type: "string" + example: "" + CaregiverLicenseNumber: + type: "string" + example: "" + IdentificationMethod: + type: "string" + example: "" TotalPackages: + type: "number" example: 3 - type: number TotalPrice: + type: "number" example: 60.83 - type: number + IsFinal: + type: "boolean" + example: false + ArchivedDate: + type: "string" + example: "string" + LastModified: + type: "string" + example: "2019-02-14T23:52:31+00:00" Transactions: + type: "array" items: $ref: "#/definitions/Transaction" - type: array - type: object SalesReceiptRequest: + type: "object" properties: - data: - items: - $ref: "#/definitions/SalesReceipt" - type: array meta: $ref: "#/definitions/RequestMeta" - type: object - SalesReceiptResponse: - properties: data: + type: "array" items: $ref: "#/definitions/SalesReceipt" - type: array + SalesReceiptResponse: + type: "object" + properties: meta: $ref: "#/definitions/ResponseMeta" - type: object - SalesTransactionDateResponse: - properties: data: + type: "array" + items: + $ref: "#/definitions/SalesReceipt" + SalesTransactionDateResponse: + type: "object" + properties: + meta: + $ref: "#/definitions/ResponseMeta" + data: + type: "array" items: $ref: "#/definitions/Room" - type: array - meta: - $ref: "#/definitions/ResponseMeta" - type: object Strain: + type: "object" properties: - Genetics: - example: 100% Sativa - type: string Id: + type: "number" example: 2426 - type: number - IndicaPercentage: - example: 0 - type: number Name: - example: 0 Test - type: string - SativaPercentage: - example: 100 - type: number + type: "string" + example: "0 Test" TestingStatus: - example: None - type: string - type: object + type: "string" + example: "None" + IndicaPercentage: + type: "number" + example: 0 + SativaPercentage: + type: "number" + example: 100 + Genetics: + type: "string" + example: "100% Sativa" StrainRequest: + type: "object" properties: - data: - items: - $ref: "#/definitions/Strain" - type: array meta: $ref: "#/definitions/RequestMeta" - type: object + data: + type: "array" + items: + $ref: "#/definitions/Strain" StrainResponse: + type: "object" properties: + meta: + $ref: "#/definitions/ResponseMeta" data: + type: "array" items: $ref: "#/definitions/Strain" - type: array + Transaction: + type: "object" + properties: + PackageId: + type: "number" + example: 4081625 + PackageLabel: + type: "string" + example: "1A401030001AD55000000426" + ProductName: + type: "string" + example: "Platinum Yeti" + QuantitySold: + type: "number" + example: 4 + UnitOfMeasureName: + type: "string" + example: "Grams" + UnitOfMeasureAbbreviation: + type: "string" + example: "g" + TotalPrice: + type: "number" + example: 20 + SalesDeliveryState: + type: "string" + example: "string" + ArchivedDate: + type: "string" + example: "string" + LastModified: + type: "string" + example: "2019-02-14T23:52:31+00:00" + TransactionResponse: + type: "object" + properties: meta: $ref: "#/definitions/ResponseMeta" - type: object - Transaction: - properties: - ArchivedDate: - example: string - type: string - LastModified: - example: "2019-02-14T23:52:31+00:00" - type: string - PackageId: - example: 4081625 - type: number - PackageLabel: - example: 1A401030001AD55000000426 - type: string - ProductName: - example: Platinum Yeti - type: string - QuantitySold: - example: 4 - type: number - SalesDeliveryState: - example: string - type: string - TotalPrice: - example: 20 - type: number - UnitOfMeasureAbbreviation: - example: g - type: string - UnitOfMeasureName: - example: Grams - type: string - type: object - TransactionRequest: - properties: data: + type: "array" items: $ref: "#/definitions/Transaction" - type: array + TransactionRequest: + type: "object" + properties: meta: $ref: "#/definitions/RequestMeta" - type: object - TransactionResponse: - properties: data: + type: "array" items: $ref: "#/definitions/Transaction" - type: array + Transfer: + type: "object" + properties: + Id: + type: "number" + example: 1 + ActualArrivalDateTime: + type: "string" + example: "_string_" + ActualDepartureDateTime: + type: "string" + example: "_string_" + ContainsPlantPackage: + type: "boolean" + example: false + ContainsProductPackage: + type: "boolean" + example: false + ContainsProductRequiresRemediation: + type: "boolean" + example: false + ContainsRemediatedProductPackage: + type: "boolean" + example: false + ContainsTestingSample: + type: "boolean" + example: false + CreatedByUserName: + type: "string" + example: "_string_" + CreatedDateTime: + type: "string" + example: "2016-10-10T08:20:45-07:00" + DeliveryCount: + type: "number" + example: 0 + DeliveryId: + type: "number" + example: 1 + DeliveryPackageCount: + type: "number" + example: 7 + DeliveryReceivedPackageCount: + type: "number" + example: 0 + DriverName: + type: "string" + example: "_string_" + DriverOccupationalLicenseNumber: + type: "string" + example: "_string_" + DriverVehicleLicenseNumber: + type: "string" + example: "_string_" + EstimatedArrivalDateTime: + type: "string" + example: "2016-10-11T16:50:00.000" + EstimatedDepartureDateTime: + type: "string" + example: "2016-10-11T14:48:30.000" + LastModified: + type: "string" + example: "0001-01-01T00:00:00+00:00" + ManifestNumber: + type: "string" + example: "0000000001" + Name: + type: "string" + example: "_string_" + PackageCount: + type: "number" + example: 7 + ReceivedDateTime: + type: "string" + example: "2016-10-11T16:42:19-07:00" + ReceivedDeliveryCount: + type: "number" + example: 0 + ReceivedPackageCount: + type: "number" + example: 0 + RecipientFacilityLicenseNumber: + type: "string" + example: "123-ABC" + RecipientFacilityName: + type: "string" + example: "Lofty Med-Cultivation A" + ShipmentLicenseType: + type: "number" + example: 0 + ShipmentTransactionType: + type: "string" + example: "Standard" + ShipmentTypeName: + type: "string" + example: "Transfer" + ShipperFacilityLicenseNumber: + type: "string" + example: "123-ABC" + ShipperFacilityName: + type: "string" + example: "Lofty Med-Cultivation B" + TransporterFacilityLicenseNumber: + type: "string" + example: "123-BCD" + TransporterFacilityName: + type: "string" + example: "Lofty Med-Dispensary" + VehicleLicensePlateNumber: + type: "string" + example: "_string_" + VehicleMake: + type: "string" + example: "_string_" + VehicleModel: + type: "string" + example: "_string_" + TransferResponse: + type: "object" + properties: meta: $ref: "#/definitions/ResponseMeta" - type: object - Transfer: - properties: - ActualArrivalDateTime: - example: _string_ - type: string - ActualDepartureDateTime: - example: _string_ - type: string - ContainsPlantPackage: - example: false - type: boolean - ContainsProductPackage: - example: false - type: boolean - ContainsProductRequiresRemediation: - example: false - type: boolean - ContainsRemediatedProductPackage: - example: false - type: boolean - ContainsTestingSample: - example: false - type: boolean - CreatedByUserName: - example: _string_ - type: string - CreatedDateTime: - example: "2016-10-10T08:20:45-07:00" - type: string - DeliveryCount: - example: 0 - type: number - DeliveryId: - example: 1 - type: number - DeliveryPackageCount: - example: 7 - type: number - DeliveryReceivedPackageCount: - example: 0 - type: number - DriverName: - example: _string_ - type: string - DriverOccupationalLicenseNumber: - example: _string_ - type: string - DriverVehicleLicenseNumber: - example: _string_ - type: string - EstimatedArrivalDateTime: - example: "2016-10-11T16:50:00.000" - type: string - EstimatedDepartureDateTime: - example: "2016-10-11T14:48:30.000" - type: string - Id: - example: 1 - type: number - LastModified: - example: "0001-01-01T00:00:00+00:00" - type: string - ManifestNumber: - example: "0000000001" - type: string - Name: - example: _string_ - type: string - PackageCount: - example: 7 - type: number - ReceivedDateTime: - example: "2016-10-11T16:42:19-07:00" - type: string - ReceivedDeliveryCount: - example: 0 - type: number - ReceivedPackageCount: - example: 0 - type: number - RecipientFacilityLicenseNumber: - example: 123-ABC - type: string - RecipientFacilityName: - example: Lofty Med-Cultivation A - type: string - ShipmentLicenseType: - example: 0 - type: number - ShipmentTransactionType: - example: Standard - type: string - ShipmentTypeName: - example: Transfer - type: string - ShipperFacilityLicenseNumber: - example: 123-ABC - type: string - ShipperFacilityName: - example: Lofty Med-Cultivation B - type: string - TransporterFacilityLicenseNumber: - example: 123-BCD - type: string - TransporterFacilityName: - example: Lofty Med-Dispensary - type: string - VehicleLicensePlateNumber: - example: _string_ - type: string - VehicleMake: - example: _string_ - type: string - VehicleModel: - example: _string_ - type: string - type: object - TransferResponse: - properties: data: + type: "array" items: $ref: "#/definitions/Transfer" - type: array - meta: - $ref: "#/definitions/ResponseMeta" - type: object UnitsOfMeasure: properties: - Abbreviation: - example: ea - type: string - Name: - example: Each - type: string QuantityType: - example: CountBased - type: string + type: "string" + example: "CountBased" + Name: + type: "string" + example: "Each" + Abbreviation: + type: "string" + example: "ea" UnitsOfMeasureResponse: + type: "object" properties: - data: - items: - $ref: "#/definitions/UnitsOfMeasure" - type: array meta: $ref: "#/definitions/ResponseMeta" - type: object + data: + type: "array" + items: + $ref: "#/definitions/UnitsOfMeasure"