swagger: "2.0" securityDefinitions: ApiKeyAuth: type: "apiKey" in: "header" name: "X-API-Key" security: - ApiKeyAuth: [] schemes: - "http" host: "metrc-gw.fabric.tnxs.net:8080" basePath: "/v1" info: contact: email: "support@taxnexus.net" name: "Taxnexus Support" url: "https://www.taxnexus.net/contact-us/" 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 Gateway" version: "1.2.6" consumes: - "application/json" produces: - "application/json" parameters: activeStatusQuery: description: "Get Active objects?" in: "query" name: active type: "boolean" required: false default: true itemNumberPath: description: "The Item Number" in: path type: "number" name: itemId required: true itemNumberQuery: description: The Item Number in: "query" type: "number" name: itemId required: false itemNumberQueryRequired: description: The Item Number in: "query" type: "number" name: itemId required: true lastModifiedStartQuery: description: The last modified start timestamp in: "query" type: "string" name: lastModifiedStart required: false 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" type: "string" name: license required: true mediaType: default: "application/json" description: The response media type enum: - "application/json" in: header name: Accept type: "string" onholdStatusQuery: description: Get On Hold objects? in: "query" name: onhold type: "boolean" required: false default: false packageLabelQuery: description: The METRC Package Label in: "query" type: "string" name: label required: false packageNumberQuery: description: The METRC Package Number in: "query" type: "string" name: packageId required: false productionQuery: description: Use Production API? in: "query" type: "boolean" default: true name: production required: false resellerKeyQuery: description: The METRC Reseller Key in: "query" type: "string" name: reseller required: true roomNumberQueryRequired: description: The Room ID number in: "query" type: "string" name: roomNumber required: true salesDeliveryNumberQuery: description: The Sales Delivery Number in: "query" type: "string" name: deliveryId required: false salesReceiptNumberQuery: description: The Sales Receipt Number in: "query" type: "string" name: salesReceiptId required: false salesReceiptNumberQueryRequired: description: The Sales Receipt Number in: "query" type: "string" name: salesReceiptId required: true salesTransactionNumberQueryRequired: description: The Sales Transaction Number in: "query" type: "string" name: transactionId required: true salesDeliveryNumberQueryRequired: description: The Sales Delivery Number in: "query" type: "string" name: salesDeliveryId required: true stateCodeQuery: description: The 2-character State Code in: "query" type: "string" name: state required: true userKeyQuery: description: The METRC User Key in: "query" type: "string" name: user required: true responses: Unauthorized: description: "Access unauthorized, invalid API-KEY was used" schema: $ref: "#/definitions/Error" AccessForbidden: description: "Access forbidden, account lacks access" schema: $ref: "#/definitions/Error" Conflict: description: Conflict schema: $ref: "#/definitions/Error" InvalidDataError: description: Invalid data was sent schema: $ref: "#/definitions/InvalidError" ServerError: description: Server Internal Error schema: $ref: "#/definitions/Error" NotFound: description: Resource was not found schema: $ref: "#/definitions/Error" tags: - description: | METRC functions related to getting Facility information name: Facilities - description: | METRC functions related to Harvests name: Harvests - description: | METRC functions related to Items name: Items - description: | METRC functions related to Packages name: Packages - description: | METRC functions related to Lab Tests name: Lab Tests - description: | METRC functions related to Plants name: Plants - description: | METRC functions related to Plant Batches name: Plant Batches - description: | METRC functions related to Rooms name: Rooms - description: | METRC functions related to Strains name: Strains - description: | METRC functions related to Sales name: Sales - description: | METRC functions related to Transfers name: Transfers - description: | METRC functions related to Units of Measure name: Units of Measure paths: /metrics: get: summary: Metrics Scraper Endpoint operationId: getMetrics description: Provides application metrics to Prometheuus logging system tags: - Sys responses: "200": description: OK /facilities: get: tags: - Facilities operationId: getFacilities description: | Facilities for this User parameters: - $ref: "#/parameters/productionQuery" - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: A list of Facilities was retrieved successfully schema: $ref: "#/definitions/FacilityResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Facilities for this User /harvests: get: tags: - Harvests operationId: getHarvests description: | Get a Harvest for this User-License parameters: - $ref: "#/parameters/activeStatusQuery" - $ref: "#/parameters/itemNumberQuery" - $ref: "#/parameters/productionQuery" - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/onholdStatusQuery" - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: A Harvest was successfully retrieved schema: $ref: "#/definitions/HarvestResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Harvest for this User-License put: tags: - Harvests description: Update Harvest Records operationId: putHarvests parameters: - in: body name: harvestUpdateRequest description: The Harvest Update records schema: $ref: "#/definitions/HarvestUpdateRequest" responses: "200": description: An array of Harvest Update records schema: $ref: "#/definitions/HarvestUpdateResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" /harvests/wastetypes: get: tags: - Harvests operationId: getHarvestWasteTypes description: | Harvest Waste Types for this User parameters: - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: A list of Harvest Waste Types was succefully retrieved schema: $ref: "#/definitions/HarvestWasteTypeResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Harvest Waste Types for User /harvestpackages: post: tags: - Harvests summary: Create new Harvest Packages operationId: postHarvestPackages description: Create new Plants parameters: - in: body name: harvestPackageRequest description: The New HarvestPackages schema: $ref: "#/definitions/HarvestPackageRequest" responses: "200": description: An array of HarvestPackage records with the new IDs schema: $ref: "#/definitions/PlantResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" /items: get: tags: - Items operationId: getItems description: | Get one or more Items for this User-License parameters: - $ref: "#/parameters/activeStatusQuery" - $ref: "#/parameters/itemNumberQuery" - $ref: "#/parameters/lastModifiedEndQuery" - $ref: "#/parameters/lastModifiedStartQuery" - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/onholdStatusQuery" - $ref: "#/parameters/productionQuery" - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: An item was successfully retrieved schema: $ref: "#/definitions/ItemResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Items for this User-License post: tags: - Items summary: Create new Items operationId: postItems description: Create new Items parameters: - in: body name: itemRequest description: The New Items schema: $ref: "#/definitions/ItemRequest" responses: "200": description: An array of Items records with the new IDs schema: $ref: "#/definitions/ItemResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" put: tags: - Items summary: Update existing Items operationId: putItems description: Update existing Items parameters: - in: body name: itemRequest description: The Existing Items with Ids schema: $ref: "#/definitions/ItemRequest" responses: "200": description: An array of Items records schema: $ref: "#/definitions/ItemResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" delete: tags: - Items operationId: Delete Item description: | Delete a Item for this User-License parameters: - $ref: "#/parameters/itemNumberQueryRequired" - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: Item were successfully Deleted schema: $ref: "#/definitions/ItemResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Item for this User-License /items/brands: get: tags: - Items operationId: getBrands description: | Get Item Brands for this User parameters: - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Items Brands for User /items/productcategories: get: tags: - Items operationId: getItemProductCategories description: | Item Product Categories for this User parameters: - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: A list of Item Product Categories was succefully retrieved schema: $ref: "#/definitions/ProductCategoryResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Item Product Categories for User /labtests/states: get: tags: - Lab Tests operationId: getLabtestStates description: | Get The Lab Test States parameters: - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/productionQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: A list of Item Product Categories was succefully retrieved schema: $ref: "#/definitions/LabTestStateResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Item Product Categories for User /labtests/types: get: tags: - Lab Tests operationId: getLabtestTypes description: | Get The Lab Test States parameters: - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/productionQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: A list of Item Product Categories was succefully retrieved schema: $ref: "#/definitions/LabTestTypeResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Item Product Categories for User /packages: get: tags: - Packages operationId: getPackages description: | Get a single Item for this User-License parameters: - $ref: "#/parameters/activeStatusQuery" - $ref: "#/parameters/itemNumberQuery" - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/onholdStatusQuery" - $ref: "#/parameters/packageLabelQuery" - $ref: "#/parameters/productionQuery" - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: A list of Packages was retrieved schema: $ref: "#/definitions/PackageResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Get Packages post: tags: - Packages summary: Create new Packages operationId: postPackages description: Create new Packages parameters: - in: body name: packageRequest description: The New Packages schema: $ref: "#/definitions/PackageRequest" responses: "200": description: An array of Items records with the new IDs schema: $ref: "#/definitions/PackageResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" put: tags: - Packages summary: Update existing Packages operationId: putPackages description: Update existing Packages parameters: - in: body name: packageRequest description: The Existing Items with Ids schema: $ref: "#/definitions/PackageRequest" responses: "200": description: An array of Package records schema: $ref: "#/definitions/PackageResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" /packages/types: get: tags: - Packages operationId: getPackageTypes description: | Get Package Types parameters: - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: A list of Package Types was succefully retrieved schema: $ref: "#/definitions/PackageTypeResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Package Types /packages/adjustmentreasons: get: tags: - Packages operationId: getPackageAdjustmentReasons description: | Get Package Types parameters: - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: A list of Package Types was succefully retrieved schema: $ref: "#/definitions/PackageAdjustmentReasonResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Package Types /plants: get: tags: - Plants operationId: getPlants description: | Get Plants for this User-License parameters: - $ref: "#/parameters/activeStatusQuery" - $ref: "#/parameters/itemNumberQuery" - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/productionQuery" - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: Plants were successfully retrieved schema: $ref: "#/definitions/PlantResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Plants for this User-License post: tags: - Plants summary: Create new Plants operationId: postPlants description: Create new Plants parameters: - in: body name: plantRequest description: The New Plants schema: $ref: "#/definitions/PlantRequest" responses: "200": description: An array of Plants records with the new IDs schema: $ref: "#/definitions/PlantResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" put: tags: - Plants summary: Update existing Plants operationId: putPlants description: Update existing Plants parameters: - in: body name: plantRequest description: The Existing Plants with Ids schema: $ref: "#/definitions/PlantRequest" responses: "200": description: An array of Plants records schema: $ref: "#/definitions/PlantResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" delete: tags: - Plants operationId: deletePlant description: | Delete a plant for this User-License parameters: - $ref: "#/parameters/itemNumberQueryRequired" - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: Plants were successfully Deleted schema: $ref: "#/definitions/PlantResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Plants for this User-License /plants/growthphases: get: tags: - Plants operationId: getPlantGrowthPhases description: Get available Plant Growth Phases for this User-License parameters: - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/productionQuery" - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: Plant Growth Phases were successfully retrieved schema: $ref: "#/definitions/PlantGrowthPhaseResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Plant Growth Phases for this User-License /plants/wastemethods: get: tags: - Plants operationId: getPlantWasteMethods description: Get available Plant Waste Methods for this User-License parameters: - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: Plant Waste Methods were successfully retrieved schema: $ref: "#/definitions/PlantWasteMethodResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Plant Waste Methods for this User-License /plants/wastereasons: get: tags: - Plants operationId: getPlantWasteReasons description: Get available Plant Waste Reasons for this User-License parameters: - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: Plant Waste Reasons were successfully retrieved schema: $ref: "#/definitions/PlantWasteReasonResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Plant Waste Methods for this User-License /plantbatches: get: tags: - Plant Batches operationId: getPlantBatches description: | Get Plant Batches for this User-License parameters: - $ref: "#/parameters/activeStatusQuery" - $ref: "#/parameters/itemNumberQuery" - $ref: "#/parameters/productionQuery" - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: Plant Batches were successfully retrieved schema: $ref: "#/definitions/PlantBatchResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Plant Batches for this User-License post: tags: - Plant Batches summary: Create new Plant Batches operationId: postPlantBatches description: Create new Plant Batches parameters: - in: body name: plantBatchRequest description: The New Plant Batches schema: $ref: "#/definitions/PlantBatchRequest" responses: "200": description: An array of Plant Batches records with the new IDs schema: $ref: "#/definitions/PlantBatchResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" put: tags: - Plant Batches summary: Update existing Plant Batches operationId: putPlantBatches description: Update existing Plant Batches parameters: - in: body name: plantBatchRequest description: The Existing Plant Batches with Ids schema: $ref: "#/definitions/PlantBatchRequest" responses: "200": description: An array of Plant Batches records schema: $ref: "#/definitions/PlantBatchResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" delete: tags: - Plant Batches operationId: deletePlantBatch description: | Delete a plant for this User-License parameters: - $ref: "#/parameters/itemNumberQueryRequired" - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: Plants were successfully Deleted schema: $ref: "#/definitions/PlantBatchResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Plants for this User-License /rooms: get: tags: - Rooms operationId: getRooms description: | Get Rooms for this User-License parameters: - $ref: "#/parameters/activeStatusQuery" - $ref: "#/parameters/itemNumberQuery" - $ref: "#/parameters/productionQuery" - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: Rooms were successfully retrieved schema: $ref: "#/definitions/RoomResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Rooms for this User-License post: tags: - Rooms summary: Create new Rooms operationId: postRooms description: Create new Rooms parameters: - in: body name: roomRequest description: The New Rooms schema: $ref: "#/definitions/RoomRequest" responses: "200": description: An array of Room records with the new IDs schema: $ref: "#/definitions/RoomResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" put: tags: - Rooms summary: Update existing Rooms operationId: putRooms description: Update existing Rooms parameters: - in: body name: roomRequest description: The Existing Rooms with Ids schema: $ref: "#/definitions/RoomRequest" responses: "200": description: An array of Room records schema: $ref: "#/definitions/RoomResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" delete: tags: - Rooms operationId: deleteRoom description: | Delete a Room for this User-License parameters: - $ref: "#/parameters/roomNumberQueryRequired" - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: Rooms were successfully deleted schema: $ref: "#/definitions/RoomResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Rooms for this User-License /strains: get: tags: - Strains operationId: getStrains description: | Get Strains for this User-License parameters: - $ref: "#/parameters/activeStatusQuery" - $ref: "#/parameters/productionQuery" - $ref: "#/parameters/itemNumberQuery" - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/onholdStatusQuery" - $ref: "#/parameters/packageLabelQuery" - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: Strains were successfully retrieved schema: $ref: "#/definitions/StrainResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Strains for this User-License post: tags: - Strains summary: Create new Strains operationId: postStrains description: Create new Strains parameters: - in: body name: strainRequest description: The New Strains schema: $ref: "#/definitions/StrainRequest" responses: "200": description: An array of Strain records with the new IDs schema: $ref: "#/definitions/StrainResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" put: tags: - Strains summary: Update existing Strains operationId: putStrains description: Update existing Strains parameters: - in: body name: strainRequest description: The Existing Strains with Ids schema: $ref: "#/definitions/StrainRequest" responses: "200": description: An array of Strain records schema: $ref: "#/definitions/StrainResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" delete: tags: - Strains operationId: deleteStrain description: | Delete a Strain for this User-License parameters: - $ref: "#/parameters/itemNumberQueryRequired" - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: Strains were successfully retrieved schema: $ref: "#/definitions/StrainResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Strains for this User-License /sales/customertypes: get: tags: - Sales operationId: getCustomerTypes description: | Get Customer Types for this User parameters: - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/productionQuery" - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: A list of active Customer Types was succefully retrieved schema: $ref: "#/definitions/CustomerTypeResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Customer Types for User /sales/deliveries: get: tags: - Sales operationId: getSalesDeliveries description: | Deliveries for this User-License parameters: - $ref: "#/parameters/salesDeliveryNumberQuery" - $ref: "#/parameters/productionQuery" - $ref: "#/parameters/lastModifiedEndQuery" - $ref: "#/parameters/lastModifiedStartQuery" - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: A list of Deliveries was succefully retrieved schema: $ref: "#/definitions/SalesDeliveryResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Deliveries for User-License post: tags: - Sales summary: Create new Sales Deliveries operationId: postSalesDeliveries description: Create new Sales Deliveries parameters: - in: body name: salesDeliveryRequest description: The New Sales Deliveries schema: $ref: "#/definitions/SalesDeliveryRequest" responses: "200": description: An array of Sales Delivery records with the new IDs schema: $ref: "#/definitions/SalesDeliveryResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" put: tags: - Sales summary: Create new Sales Deliveries operationId: putSalesDeliveries description: Create new Sales Deliveries parameters: - in: body name: salesDeliveryRequest description: The New Sales Deliveries schema: $ref: "#/definitions/SalesDeliveryRequest" responses: "200": description: An array of Sales Delivery records with the new IDs schema: $ref: "#/definitions/SalesDeliveryResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" delete: tags: - Sales operationId: deleteSalesDelivery description: | Delete a Sales Delivery for this User-License parameters: - $ref: "#/parameters/salesDeliveryNumberQueryRequired" - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: Sales Delivery was successfully deleted schema: $ref: "#/definitions/SalesDeliveryResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Sales Delivery deleted for this User-License /sales/deliveries/returnreasons: get: tags: - Sales operationId: getSalesDeliveryReturnReasons description: | Delivery Return Reasons for this User-License parameters: - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/productionQuery" - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: A list of active Sales Delivery Return Reasons was succefully retrieved schema: $ref: "#/definitions/SalesDeliveryReturnReasonResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Delivery Return Reasons for User-License /sales/receipts: get: tags: - Sales operationId: getSalesReceipts description: | Sales Receipts for this User-License parameters: - $ref: "#/parameters/lastModifiedEndQuery" - $ref: "#/parameters/lastModifiedStartQuery" - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/productionQuery" - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/salesReceiptNumberQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: A list of active Sales Receipts was succefully retrieved schema: $ref: "#/definitions/SalesReceiptResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Sales Receipts for User-License post: tags: - Sales summary: Create new Sales Receipts operationId: postSalesReceipts description: Create new Sales Receipts parameters: - in: body name: salesReceiptRequest description: The New Sales Receipts schema: $ref: "#/definitions/SalesReceiptRequest" responses: "200": description: An array of Sales Receipt records with the new IDs schema: $ref: "#/definitions/SalesReceiptResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" put: tags: - Sales summary: Create new Sales Receipts operationId: putSalesReceipts description: Create new Sales Receipts parameters: - in: body name: salesReceiptRequest description: The Existing Sales Receipts schema: $ref: "#/definitions/SalesReceiptRequest" responses: "200": description: An array of Sales Receipt records with the existing IDs schema: $ref: "#/definitions/SalesReceiptResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" delete: tags: - Sales operationId: deleteSalesReceipts description: | Delete a Sales Receipt for this User-License parameters: - $ref: "#/parameters/salesReceiptNumberQueryRequired" - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: Sales Receipt was successfully deleted schema: $ref: "#/definitions/SalesReceiptResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Sales Receipts for this User-License /sales/transactions: get: tags: - Sales operationId: getSalesTransactions description: | Sales Transactions for this User-License parameters: - $ref: "#/parameters/lastModifiedEndQuery" - $ref: "#/parameters/lastModifiedStartQuery" - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/salesReceiptNumberQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: A list of active Sales Receipts was succefully retrieved schema: $ref: "#/definitions/TransactionResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Sales Receipts for User-License post: tags: - Sales summary: Create new Sales Transactions operationId: postSalesTransactions description: Create new Sales Transactions parameters: - in: body name: salesTransactionRequest description: The New Sales Transactions schema: $ref: "#/definitions/TransactionRequest" responses: "200": description: An array of Sales Transaction records with the new IDs schema: $ref: "#/definitions/TransactionResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" put: tags: - Sales summary: Create new Sales Transactions operationId: putSalesTransactions description: Create new Sales Transactions parameters: - in: body name: salesTransactionRequest description: The New Sales Transactions schema: $ref: "#/definitions/TransactionRequest" responses: "200": description: An array of Sales Transaction records with the existing IDs schema: $ref: "#/definitions/TransactionResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" /sales/transactiondates: get: tags: - Sales operationId: getSalesTransactionDates description: | Get A list of Sales Transaction Dates for this User-License parameters: - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/productionQuery" - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: A list of Sales Transaction Dates was succefully retrieved schema: $ref: "#/definitions/SalesTransactionDateResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: A list of Sales Transaction Dates for this User-License /transfers: get: tags: - Transfers operationId: getTransfers description: | Get Transfers for this User-License parameters: - $ref: "#/parameters/lastModifiedEndQuery" - $ref: "#/parameters/lastModifiedStartQuery" - $ref: "#/parameters/activeStatusQuery" - $ref: "#/parameters/salesDeliveryNumberQuery" - $ref: "#/parameters/productionQuery" - $ref: "#/parameters/itemNumberQuery" - $ref: "#/parameters/licenseNumberQuery" - $ref: "#/parameters/onholdStatusQuery" - $ref: "#/parameters/packageNumberQuery" - $ref: "#/parameters/packageLabelQuery" - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: Transfers were successfully retrieved schema: $ref: "#/definitions/TransferResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Transfers for this User-License /unitsofmeasure: get: tags: - Units of Measure operationId: getUnitsOfMeasure description: | Units of Measure parameters: - $ref: "#/parameters/resellerKeyQuery" - $ref: "#/parameters/productionQuery" - $ref: "#/parameters/stateCodeQuery" - $ref: "#/parameters/userKeyQuery" responses: "200": description: A list of Units of Measure was succefully retrieved schema: $ref: "#/definitions/UnitsOfMeasureResponse" "401": $ref: "#/responses/Unauthorized" "403": $ref: "#/responses/AccessForbidden" "404": $ref: "#/responses/NotFound" "500": $ref: "#/responses/ServerError" summary: Units of Measure definitions: CustomerType: type: "object" properties: name: type: "string" CustomerTypeResponse: type: "object" properties: meta: $ref: "#/definitions/ResponseMeta" data: type: "array" items: $ref: "#/definitions/CustomerType" Error: type: "object" properties: error: type: "string" status: maximum: 600 minimum: 100 type: "integer" Facility: properties: HireDate: type: "string" example: "2017-08-14" IsOwner: type: "boolean" example: true 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" 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" Harvest: properties: Id: type: "number" example: 2 Name: type: "string" example: "2014-11-19-Harvest Room-H" HarvestType: type: "string" example: "WholePlant" SourceStrainCount: type: "number" example: 0 DryingRoomId: type: "number" example: 1 DryingRoomName: type: "string" example: "Harvest Room" CurrentWeight: type: "number" example: 0 TotalWasteWeight: type: "number" example: 0 PlantCount: type: "number" example: 70 TotalWetWeight: type: "number" example: 40 TotalRestoredWeight: type: "number" example: 0 PackageCount: type: "number" example: 0 TotalPackagedWeight: type: "number" example: 0 UnitOfWeightName: type: "string" example: "Ounces" IsOnHold: type: "boolean" example: false 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" HarvestWasteType: properties: Name: type: "string" example: "Plant Material" HarvestWasteTypeResponse: type: "object" properties: meta: $ref: "#/definitions/ResponseMeta" 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" Item: properties: Id: type: "number" example: 34904 Name: type: "string" example: "Ak-47 Shatter 2" ProductCategoryName: type: "string" example: "Extracts (each)" ProductCategoryType: type: "string" example: "Concentrate" QuantityType: type: "string" example: "CountBased" DefaultLabTestingState: type: "string" example: "NotSubmitted" UnitOfMeasureName: type: "string" example: "Each" ApprovalStatus: type: "string" example: "Approved" AdministrationMethod: type: "string" example: "" UnitWeight: type: "number" example: 50 UnitWeightUnitOfMeasureName: type: "string" example: "Milligrams" ServingSize: type: "string" example: "" Ingredients: type: "string" example: "" ItemRequest: type: "object" properties: meta: $ref: "#/definitions/RequestMeta" data: type: "array" items: $ref: "#/definitions/Item" ItemResponse: type: "object" properties: meta: $ref: "#/definitions/ResponseMeta" data: type: "array" items: $ref: "#/definitions/Item" LabTestState: type: "object" properties: name: type: "string" LabTestStateResponse: type: "object" properties: meta: $ref: "#/definitions/ResponseMeta" data: type: "array" items: $ref: "#/definitions/LabTestState" 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" data: type: "array" items: $ref: "#/definitions/LabTestType" 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" 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" PackageTypeResponse: type: "object" properties: meta: $ref: "#/definitions/ResponseMeta" data: type: "array" items: $ref: "#/definitions/PackageType" Pagination: type: "object" properties: p_offset: 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: type: "integer" format: "int64" description: "The number of records in a Response" set_size: type: "integer" format: "int64" description: "The total number of records available for a Response" next_link: type: "string" Plant: type: "object" properties: Id: type: "number" Label: type: "string" State: type: "string" GrowthPhase: type: "string" PlantBatchId: type: "number" PlantBatchName: type: "string" PlantBatchTypeName: type: "string" StrainId: type: "number" StrainName: type: "string" RoomId: type: "number" RoomName: type: "string" HarvestCount: type: "number" IsOnHold: type: "boolean" PlantedDate: type: "string" VegetativeDate: type: "string" LastModified: type: "string" PlantRequest: type: "object" properties: meta: $ref: "#/definitions/RequestMeta" data: type: "array" items: $ref: "#/definitions/Plant" PlantResponse: type: "object" properties: meta: $ref: "#/definitions/ResponseMeta" data: type: "array" items: $ref: "#/definitions/Plant" PlantGrowthPhase: type: "object" properties: name: type: "string" PlantGrowthPhaseResponse: type: "object" properties: meta: $ref: "#/definitions/ResponseMeta" data: type: "array" items: $ref: "#/definitions/PlantGrowthPhase" 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: meta: $ref: "#/definitions/RequestMeta" data: type: "array" items: $ref: "#/definitions/PlantBatch" PlantBatchResponse: type: "object" properties: meta: $ref: "#/definitions/ResponseMeta" data: type: "array" items: $ref: "#/definitions/PlantBatch" PlantWasteMethod: type: "object" properties: name: type: "string" PlantWasteMethodResponse: type: "object" properties: meta: $ref: "#/definitions/ResponseMeta" data: type: "array" items: $ref: "#/definitions/PlantWasteMethod" PlantWasteReasonResponse: type: "object" properties: meta: $ref: "#/definitions/ResponseMeta" 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" RequestMeta: type: "object" required: - "license" - "production" - "reseller" - "state" - "user" properties: taxnexus_account: type: "string" example: "T0000001" description: "Taxnexus Account Number for recording transactions" license: 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" Name: type: "string" RoomRequest: type: "object" properties: meta: $ref: "#/definitions/RequestMeta" data: type: "array" items: $ref: "#/definitions/Room" RoomResponse: type: "object" properties: meta: $ref: "#/definitions/ResponseMeta" data: type: "array" items: $ref: "#/definitions/Room" SalesDelivery: type: "object" properties: Id: type: "number" example: 51 SalesDateTime: type: "string" example: "2017-04-04T10:10:19.000" 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" SalesDeliveryRequest: type: "object" properties: meta: $ref: "#/definitions/RequestMeta" data: type: "array" items: $ref: "#/definitions/SalesDelivery" SalesDeliveryResponse: type: "object" properties: meta: $ref: "#/definitions/ResponseMeta" data: type: "array" items: $ref: "#/definitions/SalesDelivery" SalesDeliveryReturnReason: type: "object" properties: Name: type: "string" RequiresNote: type: "boolean" SalesDeliveryReturnReasonResponse: type: "object" properties: meta: $ref: "#/definitions/ResponseMeta" data: type: "array" items: $ref: "#/definitions/SalesDeliveryReturnReason" SalesReceipt: type: "object" properties: Id: type: "number" example: 38304110 ReceiptNumber: type: "string" example: "0038304110" SalesDateTime: type: "string" example: "2019-02-14T15:50:45.000" SalesCustomerType: type: "string" example: "Consumer" PatientLicenseNumber: type: "string" example: "" CaregiverLicenseNumber: type: "string" example: "" IdentificationMethod: type: "string" example: "" TotalPackages: type: "number" example: 3 TotalPrice: type: "number" example: 60.83 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" SalesReceiptRequest: type: "object" properties: meta: $ref: "#/definitions/RequestMeta" data: type: "array" items: $ref: "#/definitions/SalesReceipt" SalesReceiptResponse: type: "object" properties: meta: $ref: "#/definitions/ResponseMeta" data: type: "array" items: $ref: "#/definitions/SalesReceipt" SalesTransactionDateResponse: type: "object" properties: meta: $ref: "#/definitions/ResponseMeta" data: type: "array" items: $ref: "#/definitions/Room" Strain: type: "object" properties: Id: type: "number" example: 2426 Name: type: "string" example: "0 Test" TestingStatus: type: "string" example: "None" IndicaPercentage: type: "number" example: 0 SativaPercentage: type: "number" example: 100 Genetics: type: "string" example: "100% Sativa" StrainRequest: type: "object" properties: meta: $ref: "#/definitions/RequestMeta" data: type: "array" items: $ref: "#/definitions/Strain" StrainResponse: type: "object" properties: meta: $ref: "#/definitions/ResponseMeta" data: type: "array" items: $ref: "#/definitions/Strain" 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" data: type: "array" items: $ref: "#/definitions/Transaction" TransactionRequest: type: "object" properties: meta: $ref: "#/definitions/RequestMeta" data: type: "array" items: $ref: "#/definitions/Transaction" 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" data: type: "array" items: $ref: "#/definitions/Transfer" UnitsOfMeasure: properties: QuantityType: type: "string" example: "CountBased" Name: type: "string" example: "Each" Abbreviation: type: "string" example: "ea" UnitsOfMeasureResponse: type: "object" properties: meta: $ref: "#/definitions/ResponseMeta" data: type: "array" items: $ref: "#/definitions/UnitsOfMeasure"