t3api.ReportsApi

All URIs are relative to https://api.trackandtrace.tools

Method	HTTP request	Description
v2_auth_secretkey_post	POST /v2/auth/secretkey	Generate a secret key that can be used for special T3 routes that support secrey key authentication.
v2_harvests_active_report_get	GET /v2/harvests/active/report	Generate a report of all active harvests
v2_harvests_inactive_report_get	GET /v2/harvests/inactive/report	Generate a report of all active harvests
v2_items_report_get	GET /v2/items/report	Generate a report of all active items
v2_packages_active_report_get	GET /v2/packages/active/report	Generate a report of all active packages
v2_packages_intransit_report_get	GET /v2/packages/intransit/report	Generate a report of all in-transit packages
v2_packages_transferred_report_get	GET /v2/packages/transferred/report	Generate a report of all transferred packages
v2_plantbatches_active_report_get	GET /v2/plantbatches/active/report	Generate a report of all active plant batches
v2_plants_flowering_report_get	GET /v2/plants/flowering/report	Generate a report of all flowering plants
v2_plants_vegetative_report_get	GET /v2/plants/vegetative/report	Generate a report of all vegetative plants
v2_sales_active_report_get	GET /v2/sales/active/report	Generate a report of all active sales
v2_strains_report_get	GET /v2/strains/report	Generate a report of all active strains
v2_transfers_incoming_manifest_report_get	GET /v2/transfers/incoming/manifest/report	Generate a report of all incoming transfer manifests
v2_transfers_outgoing_manifest_report_get	GET /v2/transfers/outgoing/manifest/report	Generate a report of all outgoing transfer manifests

v2_auth_secretkey_post

V2AuthSecretkeyPost200Response v2_auth_secretkey_post(v2_auth_secretkey_post_request)

Generate a secret key that can be used for special T3 routes that support secrey key authentication.

Note: generating a new secret key will invalidate all previously generated keys

The T3 API includes a page for generating secret keys here

Example

import t3api
from t3api.models.v2_auth_secretkey_post200_response import V2AuthSecretkeyPost200Response
from t3api.models.v2_auth_secretkey_post_request import V2AuthSecretkeyPostRequest
from t3api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.trackandtrace.tools
# See configuration.py for a list of all supported configuration parameters.
configuration = t3api.Configuration(
    host = "https://api.trackandtrace.tools"
)


# Enter a context with an instance of the API client
with t3api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = t3api.ReportsApi(api_client)
    v2_auth_secretkey_post_request = t3api.V2AuthSecretkeyPostRequest() # V2AuthSecretkeyPostRequest | JSON object containing your Metrc secret key details  Note: The `otpSeed` field is only needed if you are authenticating in Michigan. Otherwise, omit this property. 

    try:
        # Generate a secret key that can be used for special T3 routes that support secrey key authentication.
        api_response = api_instance.v2_auth_secretkey_post(v2_auth_secretkey_post_request)
        print("The response of ReportsApi->v2_auth_secretkey_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ReportsApi->v2_auth_secretkey_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
v2_auth_secretkey_post_request	V2AuthSecretkeyPostRequest	JSON object containing your Metrc secret key details Note: The `otpSeed` field is only needed if you are authenticating in Michigan. Otherwise, omit this property.

Return type

V2AuthSecretkeyPost200Response

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Your secret key	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_harvests_active_report_get

V2HarvestsActiveReportGet200Response v2_harvests_active_report_get(license_number, secret_key=secret_key, filter_logic=filter_logic, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, sort=sort, filter=filter, fieldnames=fieldnames)

Generate a report of all active harvests

Note: this endpoint supports secret key authentication.

Example

Bearer (JWT) Authentication (BearerAuth):

import t3api
from t3api.models.v2_harvests_active_report_get200_response import V2HarvestsActiveReportGet200Response
from t3api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.trackandtrace.tools
# See configuration.py for a list of all supported configuration parameters.
configuration = t3api.Configuration(
    host = "https://api.trackandtrace.tools"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): BearerAuth
configuration = t3api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with t3api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = t3api.ReportsApi(api_client)
    license_number = 'LIC-00001' # str | The unique identifier for the license associated with this request.
    secret_key = '2616ec56-fa2a-4c5b-86c0-acacf23c9ef7' # str | Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated [here](/v2/pages/secret-key).  (optional)
    filter_logic = and # str | Describes how the filters, if any, should be applied (optional) (default to and)
    content_type = json # str | Specifies how the report should be formatted. Can be returned as json or csv. *This can also be defined in the Content-Type header*  (optional) (default to json)
    prepend_csv_metadata = true # str | Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.  (optional) (default to true)
    sort = 'label:asc' # str | Defines the collection sort order. (optional)
    filter = ['label__endswith:0003'] # List[str] | One or more collection filters. (optional)
    fieldnames = 'name,harvestStartDate,dryingLocationName,plantCount,currentWeight,totalWetWeight,totalPackagedWeight,totalWasteWeight,unitOfWeightAbbreviation' # str | Defines which plant fields should appear in the report data. (optional) (default to 'name,harvestStartDate,dryingLocationName,plantCount,currentWeight,totalWetWeight,totalPackagedWeight,totalWasteWeight,unitOfWeightAbbreviation')

    try:
        # Generate a report of all active harvests
        api_response = api_instance.v2_harvests_active_report_get(license_number, secret_key=secret_key, filter_logic=filter_logic, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, sort=sort, filter=filter, fieldnames=fieldnames)
        print("The response of ReportsApi->v2_harvests_active_report_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ReportsApi->v2_harvests_active_report_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
license_number	str	The unique identifier for the license associated with this request.
secret_key	str	Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated here.	[optional]
filter_logic	str	Describes how the filters, if any, should be applied	[optional] [default to and]
content_type	str	Specifies how the report should be formatted. Can be returned as json or csv. This can also be defined in the Content-Type header	[optional] [default to json]
prepend_csv_metadata	str	Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.	[optional] [default to true]
sort	str	Defines the collection sort order.	[optional]
filter	List[str]	One or more collection filters.	[optional]
fieldnames	str	Defines which plant fields should appear in the report data.	[optional] [default to 'name,harvestStartDate,dryingLocationName,plantCount,currentWeight,totalWetWeight,totalPackagedWeight,totalWasteWeight,unitOfWeightAbbreviation']

Return type

V2HarvestsActiveReportGet200Response

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/csv

HTTP response details

Status code	Description	Response headers
200	A list of active harvests for this license	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_harvests_inactive_report_get

V2HarvestsActiveReportGet200Response v2_harvests_inactive_report_get(license_number, secret_key=secret_key, filter_logic=filter_logic, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, sort=sort, filter=filter, fieldnames=fieldnames)

Generate a report of all active harvests

Note: this endpoint supports secret key authentication.

Example

Bearer (JWT) Authentication (BearerAuth):

import t3api
from t3api.models.v2_harvests_active_report_get200_response import V2HarvestsActiveReportGet200Response
from t3api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.trackandtrace.tools
# See configuration.py for a list of all supported configuration parameters.
configuration = t3api.Configuration(
    host = "https://api.trackandtrace.tools"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): BearerAuth
configuration = t3api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with t3api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = t3api.ReportsApi(api_client)
    license_number = 'LIC-00001' # str | The unique identifier for the license associated with this request.
    secret_key = '2616ec56-fa2a-4c5b-86c0-acacf23c9ef7' # str | Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated [here](/v2/pages/secret-key).  (optional)
    filter_logic = and # str | Describes how the filters, if any, should be applied (optional) (default to and)
    content_type = json # str | Specifies how the report should be formatted. Can be returned as json or csv. *This can also be defined in the Content-Type header*  (optional) (default to json)
    prepend_csv_metadata = true # str | Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.  (optional) (default to true)
    sort = 'label:asc' # str | Defines the collection sort order. (optional)
    filter = ['label__endswith:0003'] # List[str] | One or more collection filters. (optional)
    fieldnames = 'name,harvestStartDate,dryingLocationName,plantCount,currentWeight,totalWetWeight,totalPackagedWeight,totalWasteWeight,unitOfWeightAbbreviation' # str | Defines which plant fields should appear in the report data. (optional) (default to 'name,harvestStartDate,dryingLocationName,plantCount,currentWeight,totalWetWeight,totalPackagedWeight,totalWasteWeight,unitOfWeightAbbreviation')

    try:
        # Generate a report of all active harvests
        api_response = api_instance.v2_harvests_inactive_report_get(license_number, secret_key=secret_key, filter_logic=filter_logic, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, sort=sort, filter=filter, fieldnames=fieldnames)
        print("The response of ReportsApi->v2_harvests_inactive_report_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ReportsApi->v2_harvests_inactive_report_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
license_number	str	The unique identifier for the license associated with this request.
secret_key	str	Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated here.	[optional]
filter_logic	str	Describes how the filters, if any, should be applied	[optional] [default to and]
content_type	str	Specifies how the report should be formatted. Can be returned as json or csv. This can also be defined in the Content-Type header	[optional] [default to json]
prepend_csv_metadata	str	Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.	[optional] [default to true]
sort	str	Defines the collection sort order.	[optional]
filter	List[str]	One or more collection filters.	[optional]
fieldnames	str	Defines which plant fields should appear in the report data.	[optional] [default to 'name,harvestStartDate,dryingLocationName,plantCount,currentWeight,totalWetWeight,totalPackagedWeight,totalWasteWeight,unitOfWeightAbbreviation']

Return type

V2HarvestsActiveReportGet200Response

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/csv

HTTP response details

Status code	Description	Response headers
200	A list of active harvests for this license	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_items_report_get

V2ItemsReportGet200Response v2_items_report_get(license_number, secret_key=secret_key, filter_logic=filter_logic, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, sort=sort, filter=filter, fieldnames=fieldnames)

Generate a report of all active items

Note: this endpoint supports secret key authentication.

Example

Bearer (JWT) Authentication (BearerAuth):

import t3api
from t3api.models.v2_items_report_get200_response import V2ItemsReportGet200Response
from t3api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.trackandtrace.tools
# See configuration.py for a list of all supported configuration parameters.
configuration = t3api.Configuration(
    host = "https://api.trackandtrace.tools"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): BearerAuth
configuration = t3api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with t3api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = t3api.ReportsApi(api_client)
    license_number = 'LIC-00001' # str | The unique identifier for the license associated with this request.
    secret_key = '2616ec56-fa2a-4c5b-86c0-acacf23c9ef7' # str | Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated [here](/v2/pages/secret-key).  (optional)
    filter_logic = and # str | Describes how the filters, if any, should be applied (optional) (default to and)
    content_type = json # str | Specifies how the report should be formatted. Can be returned as json or csv. *This can also be defined in the Content-Type header*  (optional) (default to json)
    prepend_csv_metadata = true # str | Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.  (optional) (default to true)
    sort = 'label:asc' # str | Defines the collection sort order. (optional)
    filter = ['label__endswith:0003'] # List[str] | One or more collection filters. (optional)
    fieldnames = 'name,productCategoryName,productCategoryTypeName,strainName' # str | Defines which item fields should appear in the report data. (optional) (default to 'name,productCategoryName,productCategoryTypeName,strainName')

    try:
        # Generate a report of all active items
        api_response = api_instance.v2_items_report_get(license_number, secret_key=secret_key, filter_logic=filter_logic, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, sort=sort, filter=filter, fieldnames=fieldnames)
        print("The response of ReportsApi->v2_items_report_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ReportsApi->v2_items_report_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
license_number	str	The unique identifier for the license associated with this request.
secret_key	str	Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated here.	[optional]
filter_logic	str	Describes how the filters, if any, should be applied	[optional] [default to and]
content_type	str	Specifies how the report should be formatted. Can be returned as json or csv. This can also be defined in the Content-Type header	[optional] [default to json]
prepend_csv_metadata	str	Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.	[optional] [default to true]
sort	str	Defines the collection sort order.	[optional]
filter	List[str]	One or more collection filters.	[optional]
fieldnames	str	Defines which item fields should appear in the report data.	[optional] [default to 'name,productCategoryName,productCategoryTypeName,strainName']

Return type

V2ItemsReportGet200Response

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/csv

HTTP response details

Status code	Description	Response headers
200	A list of active items for this license	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_packages_active_report_get

V2PackagesActiveReportGet200Response v2_packages_active_report_get(license_number, secret_key=secret_key, filter_logic=filter_logic, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, sort=sort, filter=filter, fieldnames=fieldnames)

Generate a report of all active packages

Note: this endpoint supports secret key authentication.

Example

Bearer (JWT) Authentication (BearerAuth):

import t3api
from t3api.models.v2_packages_active_report_get200_response import V2PackagesActiveReportGet200Response
from t3api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.trackandtrace.tools
# See configuration.py for a list of all supported configuration parameters.
configuration = t3api.Configuration(
    host = "https://api.trackandtrace.tools"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): BearerAuth
configuration = t3api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with t3api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = t3api.ReportsApi(api_client)
    license_number = 'LIC-00001' # str | The unique identifier for the license associated with this request.
    secret_key = '2616ec56-fa2a-4c5b-86c0-acacf23c9ef7' # str | Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated [here](/v2/pages/secret-key).  (optional)
    filter_logic = and # str | Describes how the filters, if any, should be applied (optional) (default to and)
    content_type = json # str | Specifies how the report should be formatted. Can be returned as json or csv. *This can also be defined in the Content-Type header*  (optional) (default to json)
    prepend_csv_metadata = true # str | Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.  (optional) (default to true)
    sort = 'label:asc' # str | Defines the collection sort order. (optional)
    filter = ['label__endswith:0003'] # List[str] | One or more collection filters. (optional)
    fieldnames = 'label,locationName,item.name,quantity,unitOfMeasureAbbreviation' # str | Defines which package fields should appear in the report data. (optional) (default to 'label,locationName,item.name,quantity,unitOfMeasureAbbreviation')

    try:
        # Generate a report of all active packages
        api_response = api_instance.v2_packages_active_report_get(license_number, secret_key=secret_key, filter_logic=filter_logic, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, sort=sort, filter=filter, fieldnames=fieldnames)
        print("The response of ReportsApi->v2_packages_active_report_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ReportsApi->v2_packages_active_report_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
license_number	str	The unique identifier for the license associated with this request.
secret_key	str	Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated here.	[optional]
filter_logic	str	Describes how the filters, if any, should be applied	[optional] [default to and]
content_type	str	Specifies how the report should be formatted. Can be returned as json or csv. This can also be defined in the Content-Type header	[optional] [default to json]
prepend_csv_metadata	str	Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.	[optional] [default to true]
sort	str	Defines the collection sort order.	[optional]
filter	List[str]	One or more collection filters.	[optional]
fieldnames	str	Defines which package fields should appear in the report data.	[optional] [default to 'label,locationName,item.name,quantity,unitOfMeasureAbbreviation']

Return type

V2PackagesActiveReportGet200Response

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/csv

HTTP response details

Status code	Description	Response headers
200	A list of active packages for this license	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_packages_intransit_report_get

V2PackagesActiveReportGet200Response v2_packages_intransit_report_get(license_number, secret_key=secret_key, sort=sort, filter_logic=filter_logic, filter=filter, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, fieldnames=fieldnames)

Generate a report of all in-transit packages

Note: this endpoint supports secret key authentication.

Example

Bearer (JWT) Authentication (BearerAuth):

import t3api
from t3api.models.v2_packages_active_report_get200_response import V2PackagesActiveReportGet200Response
from t3api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.trackandtrace.tools
# See configuration.py for a list of all supported configuration parameters.
configuration = t3api.Configuration(
    host = "https://api.trackandtrace.tools"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): BearerAuth
configuration = t3api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with t3api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = t3api.ReportsApi(api_client)
    license_number = 'LIC-00001' # str | The unique identifier for the license associated with this request.
    secret_key = '2616ec56-fa2a-4c5b-86c0-acacf23c9ef7' # str | Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated [here](/v2/pages/secret-key).  (optional)
    sort = 'label:asc' # str | Defines the collection sort order. (optional)
    filter_logic = and # str | Describes how the filters, if any, should be applied (optional) (default to and)
    filter = ['label__endswith:0003'] # List[str] | One or more collection filters. (optional)
    content_type = json # str | Specifies how the report should be formatted. Can be returned as json or csv. *This can also be defined in the Content-Type header*  (optional) (default to json)
    prepend_csv_metadata = true # str | Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.  (optional) (default to true)
    fieldnames = 'label,locationName,item.name,quantity,unitOfMeasureAbbreviation' # str | Defines which package fields should appear in the report data. (optional) (default to 'label,locationName,item.name,quantity,unitOfMeasureAbbreviation')

    try:
        # Generate a report of all in-transit packages
        api_response = api_instance.v2_packages_intransit_report_get(license_number, secret_key=secret_key, sort=sort, filter_logic=filter_logic, filter=filter, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, fieldnames=fieldnames)
        print("The response of ReportsApi->v2_packages_intransit_report_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ReportsApi->v2_packages_intransit_report_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
license_number	str	The unique identifier for the license associated with this request.
secret_key	str	Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated here.	[optional]
sort	str	Defines the collection sort order.	[optional]
filter_logic	str	Describes how the filters, if any, should be applied	[optional] [default to and]
filter	List[str]	One or more collection filters.	[optional]
content_type	str	Specifies how the report should be formatted. Can be returned as json or csv. This can also be defined in the Content-Type header	[optional] [default to json]
prepend_csv_metadata	str	Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.	[optional] [default to true]
fieldnames	str	Defines which package fields should appear in the report data.	[optional] [default to 'label,locationName,item.name,quantity,unitOfMeasureAbbreviation']

Return type

V2PackagesActiveReportGet200Response

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/csv

HTTP response details

Status code	Description	Response headers
200	A list of in-transit packages for this license	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_packages_transferred_report_get

V2PackagesTransferredReportGet200Response v2_packages_transferred_report_get(license_number, secret_key=secret_key, sort=sort, filter_logic=filter_logic, filter=filter, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, fieldnames=fieldnames)

Generate a report of all transferred packages

Note: this endpoint supports secret key authentication.

Example

Bearer (JWT) Authentication (BearerAuth):

import t3api
from t3api.models.v2_packages_transferred_report_get200_response import V2PackagesTransferredReportGet200Response
from t3api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.trackandtrace.tools
# See configuration.py for a list of all supported configuration parameters.
configuration = t3api.Configuration(
    host = "https://api.trackandtrace.tools"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): BearerAuth
configuration = t3api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with t3api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = t3api.ReportsApi(api_client)
    license_number = 'LIC-00001' # str | The unique identifier for the license associated with this request.
    secret_key = '2616ec56-fa2a-4c5b-86c0-acacf23c9ef7' # str | Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated [here](/v2/pages/secret-key).  (optional)
    sort = 'label:asc' # str | Defines the collection sort order. (optional)
    filter_logic = and # str | Describes how the filters, if any, should be applied (optional) (default to and)
    filter = ['label__endswith:0003'] # List[str] | One or more collection filters. (optional)
    content_type = json # str | Specifies how the report should be formatted. Can be returned as json or csv. *This can also be defined in the Content-Type header*  (optional) (default to json)
    prepend_csv_metadata = true # str | Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.  (optional) (default to true)
    fieldnames = 'manifestNumber,packageLabel,productName,shippedQuantity,shippedUnitOfMeasureAbbreviation,shipperWholesalePrice' # str | Defines which package fields should appear in the report data. (optional) (default to 'manifestNumber,packageLabel,productName,shippedQuantity,shippedUnitOfMeasureAbbreviation,shipperWholesalePrice')

    try:
        # Generate a report of all transferred packages
        api_response = api_instance.v2_packages_transferred_report_get(license_number, secret_key=secret_key, sort=sort, filter_logic=filter_logic, filter=filter, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, fieldnames=fieldnames)
        print("The response of ReportsApi->v2_packages_transferred_report_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ReportsApi->v2_packages_transferred_report_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
license_number	str	The unique identifier for the license associated with this request.
secret_key	str	Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated here.	[optional]
sort	str	Defines the collection sort order.	[optional]
filter_logic	str	Describes how the filters, if any, should be applied	[optional] [default to and]
filter	List[str]	One or more collection filters.	[optional]
content_type	str	Specifies how the report should be formatted. Can be returned as json or csv. This can also be defined in the Content-Type header	[optional] [default to json]
prepend_csv_metadata	str	Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.	[optional] [default to true]
fieldnames	str	Defines which package fields should appear in the report data.	[optional] [default to 'manifestNumber,packageLabel,productName,shippedQuantity,shippedUnitOfMeasureAbbreviation,shipperWholesalePrice']

Return type

V2PackagesTransferredReportGet200Response

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/csv

HTTP response details

Status code	Description	Response headers
200	A list of transferred packages for this license	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_plantbatches_active_report_get

V2PlantbatchesActiveReportGet200Response v2_plantbatches_active_report_get(license_number, secret_key=secret_key, filter_logic=filter_logic, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, sort=sort, filter=filter, fieldnames=fieldnames)

Generate a report of all active plant batches

Note: this endpoint supports secret key authentication.

Example

Bearer (JWT) Authentication (BearerAuth):

import t3api
from t3api.models.v2_plantbatches_active_report_get200_response import V2PlantbatchesActiveReportGet200Response
from t3api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.trackandtrace.tools
# See configuration.py for a list of all supported configuration parameters.
configuration = t3api.Configuration(
    host = "https://api.trackandtrace.tools"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): BearerAuth
configuration = t3api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with t3api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = t3api.ReportsApi(api_client)
    license_number = 'LIC-00001' # str | The unique identifier for the license associated with this request.
    secret_key = '2616ec56-fa2a-4c5b-86c0-acacf23c9ef7' # str | Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated [here](/v2/pages/secret-key).  (optional)
    filter_logic = and # str | Describes how the filters, if any, should be applied (optional) (default to and)
    content_type = json # str | Specifies how the report should be formatted. Can be returned as json or csv. *This can also be defined in the Content-Type header*  (optional) (default to json)
    prepend_csv_metadata = true # str | Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.  (optional) (default to true)
    sort = 'label:asc' # str | Defines the collection sort order. (optional)
    filter = ['label__endswith:0003'] # List[str] | One or more collection filters. (optional)
    fieldnames = 'name,locationName,strainName,plantedDate,untrackedCount' # str | Defines which plant fields should appear in the report data. (optional) (default to 'name,locationName,strainName,plantedDate,untrackedCount')

    try:
        # Generate a report of all active plant batches
        api_response = api_instance.v2_plantbatches_active_report_get(license_number, secret_key=secret_key, filter_logic=filter_logic, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, sort=sort, filter=filter, fieldnames=fieldnames)
        print("The response of ReportsApi->v2_plantbatches_active_report_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ReportsApi->v2_plantbatches_active_report_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
license_number	str	The unique identifier for the license associated with this request.
secret_key	str	Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated here.	[optional]
filter_logic	str	Describes how the filters, if any, should be applied	[optional] [default to and]
content_type	str	Specifies how the report should be formatted. Can be returned as json or csv. This can also be defined in the Content-Type header	[optional] [default to json]
prepend_csv_metadata	str	Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.	[optional] [default to true]
sort	str	Defines the collection sort order.	[optional]
filter	List[str]	One or more collection filters.	[optional]
fieldnames	str	Defines which plant fields should appear in the report data.	[optional] [default to 'name,locationName,strainName,plantedDate,untrackedCount']

Return type

V2PlantbatchesActiveReportGet200Response

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/csv

HTTP response details

Status code	Description	Response headers
200	A list of active plant batches for this license	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_plants_flowering_report_get

V2PlantsVegetativeReportGet200Response v2_plants_flowering_report_get(license_number, secret_key=secret_key, filter_logic=filter_logic, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, sort=sort, filter=filter, fieldnames=fieldnames)

Generate a report of all flowering plants

Note: this endpoint supports secret key authentication.

Example

Bearer (JWT) Authentication (BearerAuth):

import t3api
from t3api.models.v2_plants_vegetative_report_get200_response import V2PlantsVegetativeReportGet200Response
from t3api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.trackandtrace.tools
# See configuration.py for a list of all supported configuration parameters.
configuration = t3api.Configuration(
    host = "https://api.trackandtrace.tools"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): BearerAuth
configuration = t3api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with t3api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = t3api.ReportsApi(api_client)
    license_number = 'LIC-00001' # str | The unique identifier for the license associated with this request.
    secret_key = '2616ec56-fa2a-4c5b-86c0-acacf23c9ef7' # str | Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated [here](/v2/pages/secret-key).  (optional)
    filter_logic = and # str | Describes how the filters, if any, should be applied (optional) (default to and)
    content_type = json # str | Specifies how the report should be formatted. Can be returned as json or csv. *This can also be defined in the Content-Type header*  (optional) (default to json)
    prepend_csv_metadata = true # str | Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.  (optional) (default to true)
    sort = 'label:asc' # str | Defines the collection sort order. (optional)
    filter = ['label__endswith:0003'] # List[str] | One or more collection filters. (optional)
    fieldnames = 'label,locationName,strainName,plantedDate' # str | Defines which plant fields should appear in the report data. (optional) (default to 'label,locationName,strainName,plantedDate')

    try:
        # Generate a report of all flowering plants
        api_response = api_instance.v2_plants_flowering_report_get(license_number, secret_key=secret_key, filter_logic=filter_logic, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, sort=sort, filter=filter, fieldnames=fieldnames)
        print("The response of ReportsApi->v2_plants_flowering_report_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ReportsApi->v2_plants_flowering_report_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
license_number	str	The unique identifier for the license associated with this request.
secret_key	str	Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated here.	[optional]
filter_logic	str	Describes how the filters, if any, should be applied	[optional] [default to and]
content_type	str	Specifies how the report should be formatted. Can be returned as json or csv. This can also be defined in the Content-Type header	[optional] [default to json]
prepend_csv_metadata	str	Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.	[optional] [default to true]
sort	str	Defines the collection sort order.	[optional]
filter	List[str]	One or more collection filters.	[optional]
fieldnames	str	Defines which plant fields should appear in the report data.	[optional] [default to 'label,locationName,strainName,plantedDate']

Return type

V2PlantsVegetativeReportGet200Response

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/csv

HTTP response details

Status code	Description	Response headers
200	A list of flowering plants for this license	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_plants_vegetative_report_get

V2PlantsVegetativeReportGet200Response v2_plants_vegetative_report_get(license_number, secret_key=secret_key, filter_logic=filter_logic, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, sort=sort, filter=filter, fieldnames=fieldnames)

Generate a report of all vegetative plants

Note: this endpoint supports secret key authentication.

Example

Bearer (JWT) Authentication (BearerAuth):

import t3api
from t3api.models.v2_plants_vegetative_report_get200_response import V2PlantsVegetativeReportGet200Response
from t3api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.trackandtrace.tools
# See configuration.py for a list of all supported configuration parameters.
configuration = t3api.Configuration(
    host = "https://api.trackandtrace.tools"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): BearerAuth
configuration = t3api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with t3api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = t3api.ReportsApi(api_client)
    license_number = 'LIC-00001' # str | The unique identifier for the license associated with this request.
    secret_key = '2616ec56-fa2a-4c5b-86c0-acacf23c9ef7' # str | Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated [here](/v2/pages/secret-key).  (optional)
    filter_logic = and # str | Describes how the filters, if any, should be applied (optional) (default to and)
    content_type = json # str | Specifies how the report should be formatted. Can be returned as json or csv. *This can also be defined in the Content-Type header*  (optional) (default to json)
    prepend_csv_metadata = true # str | Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.  (optional) (default to true)
    sort = 'label:asc' # str | Defines the collection sort order. (optional)
    filter = ['label__endswith:0003'] # List[str] | One or more collection filters. (optional)
    fieldnames = 'label,locationName,strainName,plantedDate' # str | Defines which plant fields should appear in the report data. (optional) (default to 'label,locationName,strainName,plantedDate')

    try:
        # Generate a report of all vegetative plants
        api_response = api_instance.v2_plants_vegetative_report_get(license_number, secret_key=secret_key, filter_logic=filter_logic, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, sort=sort, filter=filter, fieldnames=fieldnames)
        print("The response of ReportsApi->v2_plants_vegetative_report_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ReportsApi->v2_plants_vegetative_report_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
license_number	str	The unique identifier for the license associated with this request.
secret_key	str	Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated here.	[optional]
filter_logic	str	Describes how the filters, if any, should be applied	[optional] [default to and]
content_type	str	Specifies how the report should be formatted. Can be returned as json or csv. This can also be defined in the Content-Type header	[optional] [default to json]
prepend_csv_metadata	str	Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.	[optional] [default to true]
sort	str	Defines the collection sort order.	[optional]
filter	List[str]	One or more collection filters.	[optional]
fieldnames	str	Defines which plant fields should appear in the report data.	[optional] [default to 'label,locationName,strainName,plantedDate']

Return type

V2PlantsVegetativeReportGet200Response

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/csv

HTTP response details

Status code	Description	Response headers
200	A list of vegetative plants for this license	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_sales_active_report_get

V2SalesActiveReportGet200Response v2_sales_active_report_get(license_number, secret_key=secret_key, filter_logic=filter_logic, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, sort=sort, filter=filter, fieldnames=fieldnames)

Generate a report of all active sales

Note: this endpoint supports secret key authentication.

Example

Bearer (JWT) Authentication (BearerAuth):

import t3api
from t3api.models.v2_sales_active_report_get200_response import V2SalesActiveReportGet200Response
from t3api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.trackandtrace.tools
# See configuration.py for a list of all supported configuration parameters.
configuration = t3api.Configuration(
    host = "https://api.trackandtrace.tools"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): BearerAuth
configuration = t3api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with t3api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = t3api.ReportsApi(api_client)
    license_number = 'LIC-00001' # str | The unique identifier for the license associated with this request.
    secret_key = '2616ec56-fa2a-4c5b-86c0-acacf23c9ef7' # str | Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated [here](/v2/pages/secret-key).  (optional)
    filter_logic = and # str | Describes how the filters, if any, should be applied (optional) (default to and)
    content_type = json # str | Specifies how the report should be formatted. Can be returned as json or csv. *This can also be defined in the Content-Type header*  (optional) (default to json)
    prepend_csv_metadata = true # str | Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.  (optional) (default to true)
    sort = 'label:asc' # str | Defines the collection sort order. (optional)
    filter = ['label__endswith:0003'] # List[str] | One or more collection filters. (optional)
    fieldnames = 'receiptNumber,salesDateTime,totalPackages,totalPrice' # str | Defines which sales receipt fields should appear in the report data. (optional) (default to 'receiptNumber,salesDateTime,totalPackages,totalPrice')

    try:
        # Generate a report of all active sales
        api_response = api_instance.v2_sales_active_report_get(license_number, secret_key=secret_key, filter_logic=filter_logic, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, sort=sort, filter=filter, fieldnames=fieldnames)
        print("The response of ReportsApi->v2_sales_active_report_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ReportsApi->v2_sales_active_report_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
license_number	str	The unique identifier for the license associated with this request.
secret_key	str	Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated here.	[optional]
filter_logic	str	Describes how the filters, if any, should be applied	[optional] [default to and]
content_type	str	Specifies how the report should be formatted. Can be returned as json or csv. This can also be defined in the Content-Type header	[optional] [default to json]
prepend_csv_metadata	str	Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.	[optional] [default to true]
sort	str	Defines the collection sort order.	[optional]
filter	List[str]	One or more collection filters.	[optional]
fieldnames	str	Defines which sales receipt fields should appear in the report data.	[optional] [default to 'receiptNumber,salesDateTime,totalPackages,totalPrice']

Return type

V2SalesActiveReportGet200Response

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/csv

HTTP response details

Status code	Description	Response headers
200	A list of active sales receipts for this license	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_strains_report_get

V2StrainsReportGet200Response v2_strains_report_get(license_number, secret_key=secret_key, filter_logic=filter_logic, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, sort=sort, filter=filter, fieldnames=fieldnames)

Generate a report of all active strains

Note: this endpoint supports secret key authentication.

Example

Bearer (JWT) Authentication (BearerAuth):

import t3api
from t3api.models.v2_strains_report_get200_response import V2StrainsReportGet200Response
from t3api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.trackandtrace.tools
# See configuration.py for a list of all supported configuration parameters.
configuration = t3api.Configuration(
    host = "https://api.trackandtrace.tools"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): BearerAuth
configuration = t3api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with t3api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = t3api.ReportsApi(api_client)
    license_number = 'LIC-00001' # str | The unique identifier for the license associated with this request.
    secret_key = '2616ec56-fa2a-4c5b-86c0-acacf23c9ef7' # str | Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated [here](/v2/pages/secret-key).  (optional)
    filter_logic = and # str | Describes how the filters, if any, should be applied (optional) (default to and)
    content_type = json # str | Specifies how the report should be formatted. Can be returned as json or csv. *This can also be defined in the Content-Type header*  (optional) (default to json)
    prepend_csv_metadata = true # str | Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.  (optional) (default to true)
    sort = 'label:asc' # str | Defines the collection sort order. (optional)
    filter = ['label__endswith:0003'] # List[str] | One or more collection filters. (optional)
    fieldnames = 'name,sativaPercentage,indicaPercentage,isUsed' # str | Defines which strain fields should appear in the report data. (optional) (default to 'name,sativaPercentage,indicaPercentage,isUsed')

    try:
        # Generate a report of all active strains
        api_response = api_instance.v2_strains_report_get(license_number, secret_key=secret_key, filter_logic=filter_logic, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, sort=sort, filter=filter, fieldnames=fieldnames)
        print("The response of ReportsApi->v2_strains_report_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ReportsApi->v2_strains_report_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
license_number	str	The unique identifier for the license associated with this request.
secret_key	str	Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated here.	[optional]
filter_logic	str	Describes how the filters, if any, should be applied	[optional] [default to and]
content_type	str	Specifies how the report should be formatted. Can be returned as json or csv. This can also be defined in the Content-Type header	[optional] [default to json]
prepend_csv_metadata	str	Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.	[optional] [default to true]
sort	str	Defines the collection sort order.	[optional]
filter	List[str]	One or more collection filters.	[optional]
fieldnames	str	Defines which strain fields should appear in the report data.	[optional] [default to 'name,sativaPercentage,indicaPercentage,isUsed']

Return type

V2StrainsReportGet200Response

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/csv

HTTP response details

Status code	Description	Response headers
200	A list of active strains for this license	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_transfers_incoming_manifest_report_get

V2TransfersIncomingManifestReportGet200Response v2_transfers_incoming_manifest_report_get(license_number, secret_key=secret_key, filter_logic=filter_logic, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, sort=sort, filter=filter, fieldnames=fieldnames)

Generate a report of all incoming transfer manifests

Note: this endpoint supports secret key authentication.

Example

Bearer (JWT) Authentication (BearerAuth):

import t3api
from t3api.models.v2_transfers_incoming_manifest_report_get200_response import V2TransfersIncomingManifestReportGet200Response
from t3api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.trackandtrace.tools
# See configuration.py for a list of all supported configuration parameters.
configuration = t3api.Configuration(
    host = "https://api.trackandtrace.tools"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): BearerAuth
configuration = t3api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with t3api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = t3api.ReportsApi(api_client)
    license_number = 'LIC-00001' # str | The unique identifier for the license associated with this request.
    secret_key = '2616ec56-fa2a-4c5b-86c0-acacf23c9ef7' # str | Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated [here](/v2/pages/secret-key).  (optional)
    filter_logic = and # str | Describes how the filters, if any, should be applied (optional) (default to and)
    content_type = json # str | Specifies how the report should be formatted. Can be returned as json or csv. *This can also be defined in the Content-Type header*  (optional) (default to json)
    prepend_csv_metadata = true # str | Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.  (optional) (default to true)
    sort = 'label:asc' # str | Defines the collection sort order. (optional)
    filter = ['label__endswith:0003'] # List[str] | One or more collection filters. (optional)
    fieldnames = 'transfer.manifestNumber,transfer.recipientFacilityLicenseNumber,transfer.recipientFacilityName,transporter.transporterFacilityName,transporter.transporterFacilityLicenseNumber,package.packageLabel,package.productName,package.shippedQuantity,package.shippedUnitOfMeasureAbbreviation' # str | Defines which transfer manifest fields should appear in the report data. (optional) (default to 'transfer.manifestNumber,transfer.recipientFacilityLicenseNumber,transfer.recipientFacilityName,transporter.transporterFacilityName,transporter.transporterFacilityLicenseNumber,package.packageLabel,package.productName,package.shippedQuantity,package.shippedUnitOfMeasureAbbreviation')

    try:
        # Generate a report of all incoming transfer manifests
        api_response = api_instance.v2_transfers_incoming_manifest_report_get(license_number, secret_key=secret_key, filter_logic=filter_logic, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, sort=sort, filter=filter, fieldnames=fieldnames)
        print("The response of ReportsApi->v2_transfers_incoming_manifest_report_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ReportsApi->v2_transfers_incoming_manifest_report_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
license_number	str	The unique identifier for the license associated with this request.
secret_key	str	Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated here.	[optional]
filter_logic	str	Describes how the filters, if any, should be applied	[optional] [default to and]
content_type	str	Specifies how the report should be formatted. Can be returned as json or csv. This can also be defined in the Content-Type header	[optional] [default to json]
prepend_csv_metadata	str	Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.	[optional] [default to true]
sort	str	Defines the collection sort order.	[optional]
filter	List[str]	One or more collection filters.	[optional]
fieldnames	str	Defines which transfer manifest fields should appear in the report data.	[optional] [default to 'transfer.manifestNumber,transfer.recipientFacilityLicenseNumber,transfer.recipientFacilityName,transporter.transporterFacilityName,transporter.transporterFacilityLicenseNumber,package.packageLabel,package.productName,package.shippedQuantity,package.shippedUnitOfMeasureAbbreviation']

Return type

V2TransfersIncomingManifestReportGet200Response

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/csv

HTTP response details

Status code	Description	Response headers
200	A list of transfer manifests for this license	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_transfers_outgoing_manifest_report_get

V2TransfersOutgoingManifestReportGet200Response v2_transfers_outgoing_manifest_report_get(license_number, secret_key=secret_key, filter_logic=filter_logic, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, sort=sort, filter=filter, fieldnames=fieldnames)

Generate a report of all outgoing transfer manifests

Note: this endpoint supports secret key authentication.

Example

Bearer (JWT) Authentication (BearerAuth):

import t3api
from t3api.models.v2_transfers_outgoing_manifest_report_get200_response import V2TransfersOutgoingManifestReportGet200Response
from t3api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.trackandtrace.tools
# See configuration.py for a list of all supported configuration parameters.
configuration = t3api.Configuration(
    host = "https://api.trackandtrace.tools"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): BearerAuth
configuration = t3api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with t3api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = t3api.ReportsApi(api_client)
    license_number = 'LIC-00001' # str | The unique identifier for the license associated with this request.
    secret_key = '2616ec56-fa2a-4c5b-86c0-acacf23c9ef7' # str | Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated [here](/v2/pages/secret-key).  (optional)
    filter_logic = and # str | Describes how the filters, if any, should be applied (optional) (default to and)
    content_type = json # str | Specifies how the report should be formatted. Can be returned as json or csv. *This can also be defined in the Content-Type header*  (optional) (default to json)
    prepend_csv_metadata = true # str | Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.  (optional) (default to true)
    sort = 'label:asc' # str | Defines the collection sort order. (optional)
    filter = ['label__endswith:0003'] # List[str] | One or more collection filters. (optional)
    fieldnames = 'transfer.manifestNumber,delivery.recipientFacilityLicenseNumber,delivery.recipientFacilityName,transporter.transporterFacilityName,transporter.transporterFacilityLicenseNumber,transporterDetails.driverName,transporterDetails.driverVehicleLicenseNumber,transporterDetails.vehicleMake,transporterDetails.vehicleModel,transporterDetails.vehicleLicensePlateNumber,package.packageLabel,package.productName,package.shippedQuantity,package.shippedUnitOfMeasureAbbreviation' # str | Defines which transfer manifest fields should appear in the report data. (optional) (default to 'transfer.manifestNumber,delivery.recipientFacilityLicenseNumber,delivery.recipientFacilityName,transporter.transporterFacilityName,transporter.transporterFacilityLicenseNumber,transporterDetails.driverName,transporterDetails.driverVehicleLicenseNumber,transporterDetails.vehicleMake,transporterDetails.vehicleModel,transporterDetails.vehicleLicensePlateNumber,package.packageLabel,package.productName,package.shippedQuantity,package.shippedUnitOfMeasureAbbreviation')

    try:
        # Generate a report of all outgoing transfer manifests
        api_response = api_instance.v2_transfers_outgoing_manifest_report_get(license_number, secret_key=secret_key, filter_logic=filter_logic, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, sort=sort, filter=filter, fieldnames=fieldnames)
        print("The response of ReportsApi->v2_transfers_outgoing_manifest_report_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ReportsApi->v2_transfers_outgoing_manifest_report_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
license_number	str	The unique identifier for the license associated with this request.
secret_key	str	Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated here.	[optional]
filter_logic	str	Describes how the filters, if any, should be applied	[optional] [default to and]
content_type	str	Specifies how the report should be formatted. Can be returned as json or csv. This can also be defined in the Content-Type header	[optional] [default to json]
prepend_csv_metadata	str	Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.	[optional] [default to true]
sort	str	Defines the collection sort order.	[optional]
filter	List[str]	One or more collection filters.	[optional]
fieldnames	str	Defines which transfer manifest fields should appear in the report data.	[optional] [default to 'transfer.manifestNumber,delivery.recipientFacilityLicenseNumber,delivery.recipientFacilityName,transporter.transporterFacilityName,transporter.transporterFacilityLicenseNumber,transporterDetails.driverName,transporterDetails.driverVehicleLicenseNumber,transporterDetails.vehicleMake,transporterDetails.vehicleModel,transporterDetails.vehicleLicensePlateNumber,package.packageLabel,package.productName,package.shippedQuantity,package.shippedUnitOfMeasureAbbreviation']

Return type

V2TransfersOutgoingManifestReportGet200Response

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/csv

HTTP response details

Status code	Description	Response headers
200	A list of transfer manifests for this license	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

ReportsApi.md

Latest commit

History

ReportsApi.md

File metadata and controls

t3api.ReportsApi

v2_auth_secretkey_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v2_harvests_active_report_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v2_harvests_inactive_report_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v2_items_report_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v2_packages_active_report_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v2_packages_intransit_report_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v2_packages_transferred_report_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v2_plantbatches_active_report_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v2_plants_flowering_report_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v2_plants_vegetative_report_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v2_sales_active_report_get

Example

Parameters