lib/swagger/metrc-gw-taxnexus.yaml

3081 lines
86 KiB
YAML
Raw Normal View History

2021-01-08 17:19:58 +00:00
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/"
2022-05-29 17:36:31 +00:00
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.
2021-01-08 17:19:58 +00:00
license:
name: "Proprietary"
termsOfService: "https://www.taxnexus.com/terms/"
2022-05-29 17:36:31 +00:00
title: "Metrc Gateway"
version: "1.2.6"
2021-01-08 17:19:58 +00:00
consumes:
- "application/json"
produces:
- "application/json"
parameters:
activeStatusQuery:
2022-05-29 17:36:31 +00:00
description: "Get Active objects?"
in: "query"
2021-01-08 17:19:58 +00:00
name: active
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
required: false
2022-05-29 17:36:31 +00:00
default: true
2021-01-08 17:19:58 +00:00
itemNumberPath:
2022-05-29 17:36:31 +00:00
description: "The Item Number"
2021-01-08 17:19:58 +00:00
in: path
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
name: itemId
required: true
itemNumberQuery:
description: The Item Number
2022-05-29 17:36:31 +00:00
in: "query"
type: "number"
2021-01-08 17:19:58 +00:00
name: itemId
required: false
itemNumberQueryRequired:
description: The Item Number
2022-05-29 17:36:31 +00:00
in: "query"
type: "number"
2021-01-08 17:19:58 +00:00
name: itemId
required: true
lastModifiedStartQuery:
description: The last modified start timestamp
2022-05-29 17:36:31 +00:00
in: "query"
type: "string"
2021-01-08 17:19:58 +00:00
name: lastModifiedStart
required: false
2022-05-29 17:36:31 +00:00
lastModifiedEndQuery:
description: The last modified end timestamp
in: "query"
type: "string"
name: lastModifiedEnd
required: false
2021-01-08 17:19:58 +00:00
licenseNumberQuery:
description: The Licnese Number for the query
2022-05-29 17:36:31 +00:00
in: "query"
type: "string"
2021-01-08 17:19:58 +00:00
name: license
required: true
mediaType:
2022-05-29 17:36:31 +00:00
default: "application/json"
2021-01-08 17:19:58 +00:00
description: The response media type
enum:
2022-05-29 17:36:31 +00:00
- "application/json"
2021-01-08 17:19:58 +00:00
in: header
name: Accept
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
onholdStatusQuery:
description: Get On Hold objects?
2022-05-29 17:36:31 +00:00
in: "query"
2021-01-08 17:19:58 +00:00
name: onhold
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
required: false
2022-05-29 17:36:31 +00:00
default: false
2021-01-08 17:19:58 +00:00
packageLabelQuery:
description: The METRC Package Label
2022-05-29 17:36:31 +00:00
in: "query"
type: "string"
2021-01-08 17:19:58 +00:00
name: label
required: false
packageNumberQuery:
description: The METRC Package Number
2022-05-29 17:36:31 +00:00
in: "query"
type: "string"
2021-01-08 17:19:58 +00:00
name: packageId
required: false
productionQuery:
description: Use Production API?
2022-05-29 17:36:31 +00:00
in: "query"
type: "boolean"
default: true
2021-01-08 17:19:58 +00:00
name: production
required: false
resellerKeyQuery:
description: The METRC Reseller Key
2022-05-29 17:36:31 +00:00
in: "query"
type: "string"
2021-01-08 17:19:58 +00:00
name: reseller
required: true
roomNumberQueryRequired:
description: The Room ID number
2022-05-29 17:36:31 +00:00
in: "query"
type: "string"
2021-01-08 17:19:58 +00:00
name: roomNumber
required: true
salesDeliveryNumberQuery:
description: The Sales Delivery Number
2022-05-29 17:36:31 +00:00
in: "query"
type: "string"
2021-01-08 17:19:58 +00:00
name: deliveryId
required: false
salesReceiptNumberQuery:
description: The Sales Receipt Number
2022-05-29 17:36:31 +00:00
in: "query"
type: "string"
2021-01-08 17:19:58 +00:00
name: salesReceiptId
required: false
salesReceiptNumberQueryRequired:
description: The Sales Receipt Number
2022-05-29 17:36:31 +00:00
in: "query"
type: "string"
2021-01-08 17:19:58 +00:00
name: salesReceiptId
required: true
salesTransactionNumberQueryRequired:
description: The Sales Transaction Number
2022-05-29 17:36:31 +00:00
in: "query"
type: "string"
2021-01-08 17:19:58 +00:00
name: transactionId
required: true
2022-05-29 17:36:31 +00:00
salesDeliveryNumberQueryRequired:
description: The Sales Delivery Number
in: "query"
type: "string"
name: salesDeliveryId
required: true
2021-01-08 17:19:58 +00:00
stateCodeQuery:
description: The 2-character State Code
2022-05-29 17:36:31 +00:00
in: "query"
type: "string"
2021-01-08 17:19:58 +00:00
name: state
required: true
userKeyQuery:
description: The METRC User Key
2022-05-29 17:36:31 +00:00
in: "query"
type: "string"
2021-01-08 17:19:58 +00:00
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
2022-05-29 17:36:31 +00:00
description: Provides application metrics to Prometheuus logging system
2021-01-08 17:19:58 +00:00
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":
2022-05-29 17:36:31 +00:00
description: A list of Harvest Waste Types was succefully retrieved
2021-01-08 17:19:58 +00:00
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":
2022-05-29 17:36:31 +00:00
description: An array of HarvestPackage records with the new IDs
2021-01-08 17:19:58 +00:00
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":
2022-05-29 17:36:31 +00:00
description: A list of Item Product Categories was succefully retrieved
2021-01-08 17:19:58 +00:00
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":
2022-05-29 17:36:31 +00:00
description: A list of Item Product Categories was succefully retrieved
2021-01-08 17:19:58 +00:00
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":
2022-05-29 17:36:31 +00:00
description: A list of Item Product Categories was succefully retrieved
2021-01-08 17:19:58 +00:00
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
2022-05-29 17:36:31 +00:00
description: Get available Plant Growth Phases for this User-License
2021-01-08 17:19:58 +00:00
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
2022-05-29 17:36:31 +00:00
description: Get available Plant Waste Methods for this User-License
2021-01-08 17:19:58 +00:00
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
2022-05-29 17:36:31 +00:00
description: Get available Plant Waste Reasons for this User-License
2021-01-08 17:19:58 +00:00
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":
2022-05-29 17:36:31 +00:00
description: An array of Plant Batches records with the new IDs
2021-01-08 17:19:58 +00:00
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":
2022-05-29 17:36:31 +00:00
description: A list of active Customer Types was succefully retrieved
2021-01-08 17:19:58 +00:00
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":
2022-05-29 17:36:31 +00:00
description: An array of Sales Delivery records with the new IDs
2021-01-08 17:19:58 +00:00
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":
2022-05-29 17:36:31 +00:00
description: An array of Sales Delivery records with the new IDs
2021-01-08 17:19:58 +00:00
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":
2022-05-29 17:36:31 +00:00
description: A list of active Sales Delivery Return Reasons was succefully retrieved
2021-01-08 17:19:58 +00:00
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":
2022-05-29 17:36:31 +00:00
description: A list of active Sales Receipts was succefully retrieved
2021-01-08 17:19:58 +00:00
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":
2022-05-29 17:36:31 +00:00
description: An array of Sales Receipt records with the new IDs
2021-01-08 17:19:58 +00:00
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":
2022-05-29 17:36:31 +00:00
description: An array of Sales Receipt records with the existing IDs
2021-01-08 17:19:58 +00:00
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":
2022-05-29 17:36:31 +00:00
description: A list of active Sales Receipts was succefully retrieved
2021-01-08 17:19:58 +00:00
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":
2022-05-29 17:36:31 +00:00
description: An array of Sales Transaction records with the new IDs
2021-01-08 17:19:58 +00:00
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":
2022-05-29 17:36:31 +00:00
description: An array of Sales Transaction records with the existing IDs
2021-01-08 17:19:58 +00:00
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":
2022-05-29 17:36:31 +00:00
description: A list of Sales Transaction Dates was succefully retrieved
2021-01-08 17:19:58 +00:00
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":
2022-05-29 17:36:31 +00:00
description: A list of Units of Measure was succefully retrieved
2021-01-08 17:19:58 +00:00
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:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
name:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
CustomerTypeResponse:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
meta:
$ref: "#/definitions/ResponseMeta"
2021-01-08 17:19:58 +00:00
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/CustomerType"
Error:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
error:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
status:
maximum: 600
minimum: 100
2022-05-29 17:36:31 +00:00
type: "integer"
2021-01-08 17:19:58 +00:00
Facility:
properties:
2022-05-29 17:36:31 +00:00
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"
2021-01-08 17:19:58 +00:00
Alias:
2022-05-29 17:36:31 +00:00
type: "string"
example: "OR Larger Rec-WHSLR 1"
DisplayName:
type: "string"
example: "OR Larger Rec-WHSLR 1"
2021-01-08 17:19:58 +00:00
CredentialedDate:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
example: "2017-08-13"
2022-05-29 17:36:31 +00:00
License:
$ref: "#/definitions/License"
2021-01-08 17:19:58 +00:00
FacilityType:
properties:
2022-05-29 17:36:31 +00:00
IsMedical:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
2022-05-29 17:36:31 +00:00
IsRetail:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: true
2022-05-29 17:36:31 +00:00
CanGrowPlants:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
2022-05-29 17:36:31 +00:00
CanTagPlantBatches:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
2022-05-29 17:36:31 +00:00
CanUpdatePlantStrains:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
2022-05-29 17:36:31 +00:00
CanAssignRoomsToPlantBatches:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
2022-05-29 17:36:31 +00:00
CanTrackVegetativePlants:
type: "boolean"
example: true
PlantsRequirePatientAffiliation:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
CanPackageVegetativePlants:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
CanReportHarvestSchedules:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
2022-05-29 17:36:31 +00:00
CanSubmitHarvestsForTesting:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
CanRequireHarvestSampleLabTestBatches:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
2022-05-29 17:36:31 +00:00
CanCreateOpeningBalancePackages:
type: "boolean"
example: true
CanCreateDerivedPackages:
type: "boolean"
example: true
CanAssignRoomsToPackages:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
2022-05-29 17:36:31 +00:00
PackagesRequirePatientAffiliation:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
2022-05-29 17:36:31 +00:00
CanSubmitPackagesForTesting:
type: "boolean"
example: true
CanCreateProcessValidationPackages:
type: "boolean"
example: true
CanRequirePackageSampleLabTestBatches:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
2022-05-29 17:36:31 +00:00
CanRequestProductRemediation:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
2022-05-29 17:36:31 +00:00
CanRemediatePackagesWithFailedLabResults:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
2022-05-29 17:36:31 +00:00
CanInfuseProducts:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
CanTestPackages:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
CanTransferFromExternalFacilities:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: true
2022-05-29 17:36:31 +00:00
CanSellToConsumers:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
2022-05-29 17:36:31 +00:00
CanSellToPatients:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
2022-05-29 17:36:31 +00:00
CanSellToExternalPatients:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
2022-05-29 17:36:31 +00:00
CanSellToCaregivers:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
2022-05-29 17:36:31 +00:00
AdvancedSales:
type: "boolean"
example: false
SalesRequirePatientNumber:
type: "boolean"
example: false
SalesRequireExternalPatientNumber:
type: "boolean"
example: false
SalesRequireExternalPatientIdentificationMethod:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
SalesRequireCaregiverNumber:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
SalesRequireCaregiverPatientNumber:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
2022-05-29 17:36:31 +00:00
CanDeliverSalesToConsumers:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
2022-05-29 17:36:31 +00:00
CanDeliverSalesToPatients:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
2022-05-29 17:36:31 +00:00
SalesDeliveryRequirePatientNumber:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
2022-05-29 17:36:31 +00:00
CanHaveMemberPatients:
type: "boolean"
example: false
CanReportPatientsAdverseResponses:
type: "boolean"
example: false
type: "object"
2021-01-08 17:19:58 +00:00
FacilityResponse:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
meta:
$ref: "#/definitions/ResponseMeta"
2021-01-08 17:19:58 +00:00
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/Facility"
Harvest:
properties:
Id:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 2
Name:
2022-05-29 17:36:31 +00:00
type: "string"
example: "2014-11-19-Harvest Room-H"
HarvestType:
type: "string"
example: "WholePlant"
2021-01-08 17:19:58 +00:00
SourceStrainCount:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 0
2022-05-29 17:36:31 +00:00
DryingRoomId:
type: "number"
example: 1
DryingRoomName:
type: "string"
example: "Harvest Room"
CurrentWeight:
type: "number"
2021-01-08 17:19:58 +00:00
example: 0
TotalWasteWeight:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 0
2022-05-29 17:36:31 +00:00
PlantCount:
type: "number"
example: 70
2021-01-08 17:19:58 +00:00
TotalWetWeight:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 40
2022-05-29 17:36:31 +00:00
TotalRestoredWeight:
type: "number"
example: 0
PackageCount:
type: "number"
example: 0
TotalPackagedWeight:
type: "number"
example: 0
2021-01-08 17:19:58 +00:00
UnitOfWeightName:
2022-05-29 17:36:31 +00:00
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"
2021-01-08 17:19:58 +00:00
HarvestPackage:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
ActualDate:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
example: "2015-12-15"
IsProductionBatch:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
Item:
2022-05-29 17:36:31 +00:00
type: "string"
example: "Buds"
2021-01-08 17:19:58 +00:00
PatientLicenseNumber:
2022-05-29 17:36:31 +00:00
type: "string"
example: "X00001"
ProductionBatchNumber:
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
ProductRequiresRemediation:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
RemediateProduct:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
RemediationDate:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
example: "2015-12-15"
RemediationMethodId:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
RemediationSteps:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
Room:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
Tag:
2022-05-29 17:36:31 +00:00
type: "string"
example: "ABCDEF012345670000020201"
2021-01-08 17:19:58 +00:00
UnitOfWeight:
2022-05-29 17:36:31 +00:00
type: "string"
example: "Grams"
Ingredients:
type: "array"
items:
$ref: "#/definitions/HarvestPackageIngredient"
2021-01-08 17:19:58 +00:00
HarvestPackageIngredient:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
HarvestId:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 2
HarvestName:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
Weight:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 100.23
2022-05-29 17:36:31 +00:00
UnitOfWeight:
type: "string"
example: "Grams"
2021-01-08 17:19:58 +00:00
HarvestPackageRequest:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
meta:
$ref: "#/definitions/RequestMeta"
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
2022-05-29 17:36:31 +00:00
$ref: "#/definitions/HarvestPackage"
2021-01-08 17:19:58 +00:00
HarvestUpdate:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
Id:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 34904
2022-05-29 17:36:31 +00:00
operationId:
type: "string"
example: "removeWaste"
ActualDate:
type: "string"
example: "2015-12-15"
2021-01-08 17:19:58 +00:00
UnitOfWeight:
2022-05-29 17:36:31 +00:00
type: "string"
example: "Grams"
2021-01-08 17:19:58 +00:00
WasteType:
2022-05-29 17:36:31 +00:00
type: "string"
example: "Plant Material"
2021-01-08 17:19:58 +00:00
WasteWeight:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 10.05
HarvestUpdateRequest:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
meta:
$ref: "#/definitions/RequestMeta"
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/HarvestUpdate"
2022-05-29 17:36:31 +00:00
HarvestUpdateResponse:
type: "object"
properties:
2021-01-08 17:19:58 +00:00
meta:
$ref: "#/definitions/ResponseMeta"
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
2022-05-29 17:36:31 +00:00
$ref: "#/definitions/HarvestUpdate"
2021-01-08 17:19:58 +00:00
InvalidError:
allOf:
- $ref: "#/definitions/Error"
- properties:
details:
items:
2022-05-29 17:36:31 +00:00
type: "string"
type: "array"
type: "object"
2021-01-08 17:19:58 +00:00
Item:
properties:
Id:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 34904
Name:
2022-05-29 17:36:31 +00:00
type: "string"
example: "Ak-47 Shatter 2"
2021-01-08 17:19:58 +00:00
ProductCategoryName:
2022-05-29 17:36:31 +00:00
type: "string"
example: "Extracts (each)"
2021-01-08 17:19:58 +00:00
ProductCategoryType:
2022-05-29 17:36:31 +00:00
type: "string"
example: "Concentrate"
2021-01-08 17:19:58 +00:00
QuantityType:
2022-05-29 17:36:31 +00:00
type: "string"
example: "CountBased"
DefaultLabTestingState:
type: "string"
example: "NotSubmitted"
2021-01-08 17:19:58 +00:00
UnitOfMeasureName:
2022-05-29 17:36:31 +00:00
type: "string"
example: "Each"
ApprovalStatus:
type: "string"
example: "Approved"
AdministrationMethod:
type: "string"
example: ""
2021-01-08 17:19:58 +00:00
UnitWeight:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 50
UnitWeightUnitOfMeasureName:
2022-05-29 17:36:31 +00:00
type: "string"
example: "Milligrams"
ServingSize:
type: "string"
example: ""
Ingredients:
type: "string"
example: ""
2021-01-08 17:19:58 +00:00
ItemRequest:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
meta:
$ref: "#/definitions/RequestMeta"
2021-01-08 17:19:58 +00:00
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/Item"
ItemResponse:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
meta:
$ref: "#/definitions/ResponseMeta"
2021-01-08 17:19:58 +00:00
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/Item"
LabTestState:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
name:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
LabTestStateResponse:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
meta:
$ref: "#/definitions/ResponseMeta"
2021-01-08 17:19:58 +00:00
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/LabTestState"
LabTestType:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
Id:
type: "number"
example: 1
2021-01-08 17:19:58 +00:00
AlwaysPasses:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
DependencyMode:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 0
Name:
2022-05-29 17:36:31 +00:00
type: "string"
example: "THC"
2021-01-08 17:19:58 +00:00
RequiresTestResult:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
LabTestTypeResponse:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
meta:
$ref: "#/definitions/ResponseMeta"
2021-01-08 17:19:58 +00:00
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/LabTestType"
License:
2022-05-29 17:36:31 +00:00
type: "object"
required:
- "Number"
- "StartDate"
- "EndDate"
- "LicenseType"
2021-01-08 17:19:58 +00:00
properties:
Number:
2022-05-29 17:36:31 +00:00
type: "string"
example: "060-X0001"
2021-01-08 17:19:58 +00:00
StartDate:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
example: "2013-01-28"
2022-05-29 17:36:31 +00:00
EndDate:
type: "string"
example: "2020-09-28"
LicenseType:
type: "string"
example: "Recreational Wholesaler"
2021-01-08 17:19:58 +00:00
Package:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
Id:
type: "number"
example: 2
2021-01-08 17:19:58 +00:00
ArchivedDate:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
example: "2014-11-29"
ContainsRemediatedProduct:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
FinishedDate:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
example: "2014-11-29"
InitialLabTestingState:
2022-05-29 17:36:31 +00:00
type: "string"
example: "NotSubmitted"
2021-01-08 17:19:58 +00:00
IsOnHold:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
IsProcessValidationTestingSample:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
IsProductionBatch:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
IsTestingSample:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
2022-05-29 17:36:31 +00:00
Label:
type: "string"
example: "ABCDEF012345670000010042"
2021-01-08 17:19:58 +00:00
LabTestingState:
2022-05-29 17:36:31 +00:00
type: "string"
example: "NotSubmitted"
2021-01-08 17:19:58 +00:00
LabTestingStateDate:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
example: "2014-11-29"
LastModified:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
example: "2019-01-30T02:52:15.0599079+00:00"
PackagedDate:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
example: "2014-11-29"
2022-05-29 17:36:31 +00:00
PackageType:
type: "string"
example: "Product"
2021-01-08 17:19:58 +00:00
PatientLicenseNumber:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
ProductCategoryName:
2022-05-29 17:36:31 +00:00
type: "string"
example: "Buds"
2021-01-08 17:19:58 +00:00
ProductId:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 1
2022-05-29 17:36:31 +00:00
ProductionBatchNumber:
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
ProductName:
2022-05-29 17:36:31 +00:00
type: "string"
example: "Buds"
2021-01-08 17:19:58 +00:00
ProductRequiresRemediation:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
Quantity:
2022-05-29 17:36:31 +00:00
type: "number"
format: "double"
example: 1.0
2021-01-08 17:19:58 +00:00
ReceivedDateTime:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
ReceivedFromFacilityLicenseNumber:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
ReceivedFromFacilityName:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
ReceivedFromManifestNumber:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
RemediationDate:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
example: "2014-11-29"
RoomId:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
RoomName:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
SourceHarvestNames:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
UnitOfMeasureAbbreviation:
2022-05-29 17:36:31 +00:00
type: "string"
example: "oz"
2021-01-08 17:19:58 +00:00
UnitOfMeasureName:
2022-05-29 17:36:31 +00:00
type: "string"
example: "Ounces"
2021-01-08 17:19:58 +00:00
PackageRequest:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
meta:
$ref: "#/definitions/RequestMeta"
2021-01-08 17:19:58 +00:00
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/Package"
PackageResponse:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
meta:
$ref: "#/definitions/ResponseMeta"
2021-01-08 17:19:58 +00:00
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/Package"
PackageType:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
name:
2022-05-29 17:36:31 +00:00
type: "string"
PackageAdjustmentReason:
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
"Name":
type: "string"
"RequiresNote":
type: "boolean"
PackageAdjustmentReasonResponse:
type: "object"
properties:
meta:
$ref: "#/definitions/ResponseMeta"
2021-01-08 17:19:58 +00:00
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
2022-05-29 17:36:31 +00:00
$ref: "#/definitions/PackageAdjustmentReason"
PackageTypeResponse:
type: "object"
properties:
2021-01-08 17:19:58 +00:00
meta:
$ref: "#/definitions/ResponseMeta"
2022-05-29 17:36:31 +00:00
data:
type: "array"
items:
$ref: "#/definitions/PackageType"
2021-01-08 17:19:58 +00:00
Pagination:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
p_offset:
2022-05-29 17:36:31 +00:00
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
2021-01-08 17:19:58 +00:00
page_size:
2022-05-29 17:36:31 +00:00
type: "integer"
format: "int64"
description: "The number of records in a Response"
2021-01-08 17:19:58 +00:00
set_size:
2022-05-29 17:36:31 +00:00
type: "integer"
format: "int64"
description: "The total number of records available for a Response"
next_link:
type: "string"
2021-01-08 17:19:58 +00:00
Plant:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
Id:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
Label:
2022-05-29 17:36:31 +00:00
type: "string"
State:
type: "string"
GrowthPhase:
type: "string"
2021-01-08 17:19:58 +00:00
PlantBatchId:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
PlantBatchName:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
PlantBatchTypeName:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
StrainId:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
StrainName:
2022-05-29 17:36:31 +00:00
type: "string"
RoomId:
type: "number"
RoomName:
type: "string"
HarvestCount:
type: "number"
IsOnHold:
type: "boolean"
PlantedDate:
type: "string"
2021-01-08 17:19:58 +00:00
VegetativeDate:
2022-05-29 17:36:31 +00:00
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"
2021-01-08 17:19:58 +00:00
PlantBatch:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
Id:
type: "number"
example: 5
2021-01-08 17:19:58 +00:00
Count:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 80
DestroyedCount:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 40
HarvestedCount:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 0
LastModified:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
example: "0001-01-01T00:00:00+00:00"
LiveCount:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 10
Name:
2022-05-29 17:36:31 +00:00
type: "string"
example: "Demo Plant Batch 1"
2021-01-08 17:19:58 +00:00
PackagedCount:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 0
PatientLicenseNumber:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
PlantedDate:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
example: "2014-10-10"
RoomId:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
RoomName:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
SourcePackageId:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 0
SourcePackageLabel:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
SourcePlantId:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 0
SourcePlantLabel:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
StrainId:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 1
StrainName:
2022-05-29 17:36:31 +00:00
type: "string"
example: "Spring Hill Kush"
2021-01-08 17:19:58 +00:00
TrackedCount:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 10
Type:
2022-05-29 17:36:31 +00:00
type: "string"
example: "Seed"
2021-01-08 17:19:58 +00:00
UntrackedCount:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 80
PlantBatchRequest:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
meta:
$ref: "#/definitions/RequestMeta"
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/PlantBatch"
2022-05-29 17:36:31 +00:00
PlantBatchResponse:
type: "object"
2021-01-08 17:19:58 +00:00
properties:
meta:
$ref: "#/definitions/ResponseMeta"
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
2022-05-29 17:36:31 +00:00
$ref: "#/definitions/PlantBatch"
2021-01-08 17:19:58 +00:00
PlantWasteMethod:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
name:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
PlantWasteMethodResponse:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
meta:
$ref: "#/definitions/ResponseMeta"
2021-01-08 17:19:58 +00:00
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/PlantWasteMethod"
PlantWasteReasonResponse:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
meta:
$ref: "#/definitions/ResponseMeta"
2021-01-08 17:19:58 +00:00
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/PlantWasteMethod"
ProductCategory:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
Name:
2022-05-29 17:36:31 +00:00
type: "string"
example: "Buds"
2021-01-08 17:19:58 +00:00
ProductCategoryType:
2022-05-29 17:36:31 +00:00
type: "string"
example: "Buds"
2021-01-08 17:19:58 +00:00
QuantityType:
2022-05-29 17:36:31 +00:00
type: "string"
example: "WeightBased"
RequiresStrain:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
RequiresItemBrand:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
2022-05-29 17:36:31 +00:00
RequiresAdministrationMethod:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
2022-05-29 17:36:31 +00:00
RequiresUnitCbdPercent:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
RequiresUnitCbdContent:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
2022-05-29 17:36:31 +00:00
RequiresUnitThcPercent:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
RequiresUnitThcContent:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
RequiresUnitVolume:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
RequiresUnitWeight:
2022-05-29 17:36:31 +00:00
type: "boolean"
example: false
RequiresServingSize:
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
2022-05-29 17:36:31 +00:00
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
2021-01-08 17:19:58 +00:00
ProductCategoryResponse:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
meta:
$ref: "#/definitions/ResponseMeta"
2021-01-08 17:19:58 +00:00
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/ProductCategory"
RequestMeta:
2022-05-29 17:36:31 +00:00
type: "object"
required:
- "license"
- "production"
- "reseller"
- "state"
- "user"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
taxnexus_account:
type: "string"
example: "T0000001"
description: "Taxnexus Account Number for recording transactions"
2021-01-08 17:19:58 +00:00
license:
2022-05-29 17:36:31 +00:00
type: "string"
example: "A12-0000015-LIC"
2021-01-08 17:19:58 +00:00
operation_id:
2022-05-29 17:36:31 +00:00
type: "string"
description: "Operation ID"
2021-01-08 17:19:58 +00:00
production:
2022-05-29 17:36:31 +00:00
type: "boolean"
example: true
default: true
2021-01-08 17:19:58 +00:00
reseller:
2022-05-29 17:36:31 +00:00
type: "string"
example: "<<unique key>>"
2021-01-08 17:19:58 +00:00
state:
2022-05-29 17:36:31 +00:00
type: "string"
example: "CA"
2021-01-08 17:19:58 +00:00
test_only:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: true
transaction_date:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
example: "2019-01-01"
user:
2022-05-29 17:36:31 +00:00
type: "string"
example: "<<unique key>>"
2021-01-08 17:19:58 +00:00
ResponseMeta:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
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"
2021-01-08 17:19:58 +00:00
contact:
2022-05-29 17:36:31 +00:00
type: "string"
description: "Contact Info"
2021-01-08 17:19:58 +00:00
copyright:
2022-05-29 17:36:31 +00:00
type: "string"
description: "Copyright Info"
info:
type: "string"
description: "Request Status and Error Information"
2021-01-08 17:19:58 +00:00
license:
2022-05-29 17:36:31 +00:00
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: "<<unique key>>"
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: "<<unique key>>"
description: "The User Key used for the transaction"
2021-01-08 17:19:58 +00:00
Room:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
Id:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
Name:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
RoomRequest:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
meta:
$ref: "#/definitions/RequestMeta"
2021-01-08 17:19:58 +00:00
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/Room"
RoomResponse:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
meta:
$ref: "#/definitions/ResponseMeta"
2021-01-08 17:19:58 +00:00
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/Room"
SalesDelivery:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
Id:
type: "number"
example: 51
SalesDateTime:
type: "string"
example: "2017-04-04T10:10:19.000"
SalesCustomerType:
type: "string"
example: "Consumer"
2021-01-08 17:19:58 +00:00
DriverName:
2022-05-29 17:36:31 +00:00
type: "string"
example: "John Doe"
2021-01-08 17:19:58 +00:00
DriverOccupationalLicenseNumber:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
example: "1"
DriverVehicleLicenseNumber:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
example: "1"
PhoneNumberForQuestions:
2022-05-29 17:36:31 +00:00
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"
2021-01-08 17:19:58 +00:00
RecipientAddressCity:
2022-05-29 17:36:31 +00:00
type: "string"
example: "Denver"
RecipientAddressState:
type: "string"
example: "CO"
2021-01-08 17:19:58 +00:00
RecipientAddressPostalCode:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
example: "11111"
2022-05-29 17:36:31 +00:00
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"
2021-01-08 17:19:58 +00:00
Transactions:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/Transaction"
SalesDeliveryRequest:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
meta:
$ref: "#/definitions/RequestMeta"
2021-01-08 17:19:58 +00:00
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/SalesDelivery"
SalesDeliveryResponse:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
meta:
$ref: "#/definitions/ResponseMeta"
2021-01-08 17:19:58 +00:00
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/SalesDelivery"
SalesDeliveryReturnReason:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
Name:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
RequiresNote:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
SalesDeliveryReturnReasonResponse:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
meta:
$ref: "#/definitions/ResponseMeta"
2021-01-08 17:19:58 +00:00
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/SalesDeliveryReturnReason"
SalesReceipt:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
Id:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 38304110
ReceiptNumber:
2022-05-29 17:36:31 +00:00
type: "string"
example: "0038304110"
2021-01-08 17:19:58 +00:00
SalesDateTime:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
example: "2019-02-14T15:50:45.000"
2022-05-29 17:36:31 +00:00
SalesCustomerType:
type: "string"
example: "Consumer"
PatientLicenseNumber:
type: "string"
example: ""
CaregiverLicenseNumber:
type: "string"
example: ""
IdentificationMethod:
type: "string"
example: ""
2021-01-08 17:19:58 +00:00
TotalPackages:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 3
TotalPrice:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 60.83
2022-05-29 17:36:31 +00:00
IsFinal:
type: "boolean"
example: false
ArchivedDate:
type: "string"
example: "string"
LastModified:
type: "string"
example: "2019-02-14T23:52:31+00:00"
2021-01-08 17:19:58 +00:00
Transactions:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/Transaction"
SalesReceiptRequest:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
meta:
$ref: "#/definitions/RequestMeta"
2021-01-08 17:19:58 +00:00
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/SalesReceipt"
SalesReceiptResponse:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
meta:
$ref: "#/definitions/ResponseMeta"
2021-01-08 17:19:58 +00:00
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/SalesReceipt"
SalesTransactionDateResponse:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
meta:
$ref: "#/definitions/ResponseMeta"
2021-01-08 17:19:58 +00:00
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/Room"
Strain:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
Id:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 2426
2022-05-29 17:36:31 +00:00
Name:
type: "string"
example: "0 Test"
TestingStatus:
type: "string"
example: "None"
2021-01-08 17:19:58 +00:00
IndicaPercentage:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 0
SativaPercentage:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 100
2022-05-29 17:36:31 +00:00
Genetics:
type: "string"
example: "100% Sativa"
2021-01-08 17:19:58 +00:00
StrainRequest:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
meta:
$ref: "#/definitions/RequestMeta"
2021-01-08 17:19:58 +00:00
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/Strain"
StrainResponse:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
meta:
$ref: "#/definitions/ResponseMeta"
2021-01-08 17:19:58 +00:00
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/Strain"
Transaction:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
PackageId:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 4081625
PackageLabel:
2022-05-29 17:36:31 +00:00
type: "string"
example: "1A401030001AD55000000426"
2021-01-08 17:19:58 +00:00
ProductName:
2022-05-29 17:36:31 +00:00
type: "string"
example: "Platinum Yeti"
2021-01-08 17:19:58 +00:00
QuantitySold:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 4
2022-05-29 17:36:31 +00:00
UnitOfMeasureName:
type: "string"
example: "Grams"
UnitOfMeasureAbbreviation:
type: "string"
example: "g"
2021-01-08 17:19:58 +00:00
TotalPrice:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 20
2022-05-29 17:36:31 +00:00
SalesDeliveryState:
type: "string"
example: "string"
ArchivedDate:
type: "string"
example: "string"
LastModified:
type: "string"
example: "2019-02-14T23:52:31+00:00"
TransactionResponse:
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
meta:
$ref: "#/definitions/ResponseMeta"
2021-01-08 17:19:58 +00:00
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/Transaction"
2022-05-29 17:36:31 +00:00
TransactionRequest:
type: "object"
properties:
2021-01-08 17:19:58 +00:00
meta:
$ref: "#/definitions/RequestMeta"
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/Transaction"
Transfer:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
Id:
type: "number"
example: 1
2021-01-08 17:19:58 +00:00
ActualArrivalDateTime:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
ActualDepartureDateTime:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
ContainsPlantPackage:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
ContainsProductPackage:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
ContainsProductRequiresRemediation:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
ContainsRemediatedProductPackage:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
ContainsTestingSample:
2022-05-29 17:36:31 +00:00
type: "boolean"
2021-01-08 17:19:58 +00:00
example: false
CreatedByUserName:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
CreatedDateTime:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
example: "2016-10-10T08:20:45-07:00"
DeliveryCount:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 0
DeliveryId:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 1
DeliveryPackageCount:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 7
DeliveryReceivedPackageCount:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 0
DriverName:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
DriverOccupationalLicenseNumber:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
DriverVehicleLicenseNumber:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
EstimatedArrivalDateTime:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
example: "2016-10-11T16:50:00.000"
EstimatedDepartureDateTime:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
example: "2016-10-11T14:48:30.000"
LastModified:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
example: "0001-01-01T00:00:00+00:00"
ManifestNumber:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
example: "0000000001"
Name:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
PackageCount:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 7
ReceivedDateTime:
2022-05-29 17:36:31 +00:00
type: "string"
2021-01-08 17:19:58 +00:00
example: "2016-10-11T16:42:19-07:00"
ReceivedDeliveryCount:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 0
ReceivedPackageCount:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 0
RecipientFacilityLicenseNumber:
2022-05-29 17:36:31 +00:00
type: "string"
example: "123-ABC"
2021-01-08 17:19:58 +00:00
RecipientFacilityName:
2022-05-29 17:36:31 +00:00
type: "string"
example: "Lofty Med-Cultivation A"
2021-01-08 17:19:58 +00:00
ShipmentLicenseType:
2022-05-29 17:36:31 +00:00
type: "number"
2021-01-08 17:19:58 +00:00
example: 0
ShipmentTransactionType:
2022-05-29 17:36:31 +00:00
type: "string"
example: "Standard"
2021-01-08 17:19:58 +00:00
ShipmentTypeName:
2022-05-29 17:36:31 +00:00
type: "string"
example: "Transfer"
2021-01-08 17:19:58 +00:00
ShipperFacilityLicenseNumber:
2022-05-29 17:36:31 +00:00
type: "string"
example: "123-ABC"
2021-01-08 17:19:58 +00:00
ShipperFacilityName:
2022-05-29 17:36:31 +00:00
type: "string"
example: "Lofty Med-Cultivation B"
2021-01-08 17:19:58 +00:00
TransporterFacilityLicenseNumber:
2022-05-29 17:36:31 +00:00
type: "string"
example: "123-BCD"
2021-01-08 17:19:58 +00:00
TransporterFacilityName:
2022-05-29 17:36:31 +00:00
type: "string"
example: "Lofty Med-Dispensary"
2021-01-08 17:19:58 +00:00
VehicleLicensePlateNumber:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
VehicleMake:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
VehicleModel:
2022-05-29 17:36:31 +00:00
type: "string"
example: "_string_"
2021-01-08 17:19:58 +00:00
TransferResponse:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
meta:
$ref: "#/definitions/ResponseMeta"
2021-01-08 17:19:58 +00:00
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/Transfer"
UnitsOfMeasure:
properties:
QuantityType:
2022-05-29 17:36:31 +00:00
type: "string"
example: "CountBased"
Name:
type: "string"
example: "Each"
Abbreviation:
type: "string"
example: "ea"
2021-01-08 17:19:58 +00:00
UnitsOfMeasureResponse:
2022-05-29 17:36:31 +00:00
type: "object"
2021-01-08 17:19:58 +00:00
properties:
2022-05-29 17:36:31 +00:00
meta:
$ref: "#/definitions/ResponseMeta"
2021-01-08 17:19:58 +00:00
data:
2022-05-29 17:36:31 +00:00
type: "array"
2021-01-08 17:19:58 +00:00
items:
$ref: "#/definitions/UnitsOfMeasure"