If this package is for an option tracking product, this value will be set. You can lookup which product option has inventory for this package in product.options[].id of this response.
The amount of inventory this package had in Metrc when it was first imported into Meadow. This does not reflect how much inventory is currently available in Meadow.
This number represents the relationship between 1 unit of inventory in Meadow and how many units that represents in the Metrc package. For example, if a Metrc package has a unit of Grams, then the multiplier may be something like 3.5 to represent that one pre-packed eighth in Meadow will use 3.5g of the Metrc package. This is only applicable for option tracking products. product tracking will always have a value of 1. Please refer to the Inventory Guide for information on option and product tracking.
Information about the product this package has inventory for. This will be null if the package has not had its inventory received to a Meadow product yet.
One of the following values:
non-concentrated - Flower or other non-concentrated THC products
concentrated - Concentrated THC products (Example: Edibles, Concentrates)
immature-plant - Cannabis plants
none - This product does not contain cannabis
mi-infused-solids - Cannabis infused solids (only in Michigan) (Example: edibles)
mi-infused-fluids - Cannabis infused fluids (only in Michigan) (Example: drinks)
edibles - Edible product (only used in New Jersey & Massachusetts)
The moving average cost per unit for this product option
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Meadow API","colors":{"primary":"#8019e4","light":"#63dde8","dark":"#8019e4"},"logo":{"light":"https://mintcdn.com/meadow/A0jpawTy4WMsQxOO/images/logo-purple.png?fit=max\u0026auto=format\u0026n=A0jpawTy4WMsQxOO\u0026q=85\u0026s=26b8bb6925801507b6d0261692862020","dark":"https://mintcdn.com/meadow/A0jpawTy4WMsQxOO/images/logo-white.png?fit=max\u0026auto=format\u0026n=A0jpawTy4WMsQxOO\u0026q=85\u0026s=eb8877f4f190be7b8d47933a5c7d63df"},"favicon":"https://mintcdn.com/meadow/molh9Q4nZYYp5-8-/images/favicon.svg?fit=max\u0026auto=format\u0026n=molh9Q4nZYYp5-8-\u0026q=85\u0026s=26b57b66d963938e507d084a5943cd02","api":{"params":{"expanded":"all"}},"footer":{"socials":{"github":"https://github.com/meadow","website":"https://getmeadow.com"}},"styling":{"codeblocks":"system","latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"meadow","hasAudioNarration":false,"actualSubdomain":"meadow","customDomains":["api-docs.getmeadow.com"],"gitSource":{"type":"github","owner":"meadow","repo":"open-api-documentation","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae4d17d7d6c6138a24d0322","collectionId":"a9998361-20d4-45cb-b1f2-37e63f7fc94a","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4d17d7d6c6138a24d0322"},"entitlements":{},"buildId":"6ae4d17d7d6c6138a24d0322","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Endpoints: Analytics","count":11},{"language":"default","tag":"Endpoints: Products \u0026 Inventory","count":8},{"language":"default","tag":"Using the API","count":7},{"language":"default","tag":"Endpoints: Customers","count":6},{"language":"default","tag":"Endpoints: Create Orders","count":6},{"language":"default","tag":"Endpoints: Menu","count":2},{"language":"default","tag":"Guides","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"endpoints/analytics/retrieve-package","slug":"/endpoints/analytics/retrieve-package","pageMetadata":{"title":"Retrieve a package","openapi":"GET /api/v1/packages/{label}","description":"Retrieve package information for a specific label/tag","href":"/endpoints/analytics/retrieve-package"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve package information for a specific label/tag\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Retrieve a package","openapi":"GET /api/v1/packages/{label}","description":"Retrieve package information for a specific label/tag","href":"/endpoints/analytics/retrieve-package"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Retrieve package information for a specific label/tag","parameters":["45cc1609-8883-43df-b8e9-8ffe7dc95a0e"],"responses":{"200":"95d07c1f-5967-4357-bd43-87e4ae7fa0d4","4XX":"e43acfa0-96bd-4616-8181-49aae5701a72"},"method":"get","type":"path","servers":["51c520a1-a658-421f-927a-7fcae986ba8c","5091d89b-c8ff-49bd-ac28-f40b834142b1"],"security":["1c0263ad-f012-431c-98fb-cf88e02a4593"],"path":"/api/v1/packages/{label}","baseUrlOptions":["https://api-staging.getmeadow.com","https://api.getmeadow.com"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"45cc1609-8883-43df-b8e9-8ffe7dc95a0e":{"name":"label","in":"path","description":"The label of the package to retrieve","required":true,"schema":{"type":"string","isRequired":true,"description":"The label of the package to retrieve","uniqueKey":"","typeLabel":"string"}}},"responses":{"95d07c1f-5967-4357-bd43-87e4ae7fa0d4":{"description":"Packages detail response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"The id for the package","uniqueKey":"id","typeLabel":"number"},"productOptionId":{"oneOf":[{"type":"number","description":"If this package is for an `option` tracking product, this value will be set. You can lookup which product option has inventory for this package in `product.options[].id` of this response.","uniqueKey":"productOptionId.oneOf.0","typeLabel":"number"},{"type":"null","description":"If this package is for an `option` tracking product, this value will be set. You can lookup which product option has inventory for this package in `product.options[].id` of this response.","uniqueKey":"productOptionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"productOptionId","typeLabel":"number | null"},"type":{"type":"string","description":"The compliance system for this package. Only `metrc` is supported currently.","enum":["metrc"],"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"externalId":{"oneOf":[{"type":"string","description":"The ID of the package in the external compliance system (Metrc)","uniqueKey":"externalId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the package in the external compliance system (Metrc)","uniqueKey":"externalId.oneOf.1","typeLabel":"null"}],"uniqueKey":"externalId","typeLabel":"string | null"},"externalProductName":{"oneOf":[{"type":"string","description":"The name of the product for this package in the external compliance system (Metrc)","uniqueKey":"externalProductName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the product for this package in the external compliance system (Metrc)","uniqueKey":"externalProductName.oneOf.1","typeLabel":"null"}],"uniqueKey":"externalProductName","typeLabel":"string | null"},"label":{"type":"string","description":"The tag/label identifier for the package","uniqueKey":"label","typeLabel":"string"},"status":{"type":"string","description":"The status of the package\n\n- `ready` is a package that has not been received into inventory yet.\n- `received` is a package that has been accepted into inventory for sale\n- `finished` is a package with 0 inventory and has been marked as finished\n- `shipped` is a package that is currently being shipped to another license and not available for sale\n- `transferred` is a package that was transferred out of this license and no longer has inventory\n- `transfer-returned` is a package that has been transferred back, but has not been received into inventory yet\n- `syncing` is a package that has been created, but not synced to Metrc yet","enum":["ready","received","finished","shipped","transferred","transfer-returned","syncing"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"initialAmount":{"type":"string","description":"The amount of inventory this package had in Metrc when it was first imported into Meadow. This does not reflect how much inventory is currently available in Meadow.","uniqueKey":"initialAmount","typeLabel":"string"},"unit":{"type":"string","description":"The Metrc unit of the package. (Example: `Each` or `Grams`)","uniqueKey":"unit","typeLabel":"string"},"createdAt":{"type":"string","description":"When this package was first created in Meadow","uniqueKey":"createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"The last time this package had a modification made to it or an inventory transaction associated with it","uniqueKey":"updatedAt","typeLabel":"string"},"receivedAt":{"oneOf":[{"type":"string","description":"When this package was received into inventory","uniqueKey":"receivedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"When this package was received into inventory","uniqueKey":"receivedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"receivedAt","typeLabel":"string | null"},"finishedAt":{"oneOf":[{"type":"string","description":"When this package was set as finished","uniqueKey":"finishedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"When this package was set as finished","uniqueKey":"finishedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"finishedAt","typeLabel":"string | null"},"multiplier":{"oneOf":[{"type":"string","description":"This number represents the relationship between 1 unit of inventory in Meadow and how many units that represents in the Metrc package. For example, if a Metrc package has a unit of `Grams`, then the multiplier may be something like `3.5` to represent that one pre-packed eighth in Meadow will use 3.5g of the Metrc package. This is only applicable for `option` tracking products. `product` tracking will always have a value of `1`. Please refer to the [Inventory Guide](/guides/inventory) for information on `option` and `product` tracking.","uniqueKey":"multiplier.oneOf.0","typeLabel":"string"},{"type":"null","description":"This number represents the relationship between 1 unit of inventory in Meadow and how many units that represents in the Metrc package. For example, if a Metrc package has a unit of `Grams`, then the multiplier may be something like `3.5` to represent that one pre-packed eighth in Meadow will use 3.5g of the Metrc package. This is only applicable for `option` tracking products. `product` tracking will always have a value of `1`. Please refer to the [Inventory Guide](/guides/inventory) for information on `option` and `product` tracking.","uniqueKey":"multiplier.oneOf.1","typeLabel":"null"}],"uniqueKey":"multiplier","typeLabel":"string | null"},"expirationDate":{"oneOf":[{"type":"string","description":"The expiration date of the package","uniqueKey":"expirationDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"The expiration date of the package","uniqueKey":"expirationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"expirationDate","typeLabel":"string | null"},"transferredAt":{"oneOf":[{"type":"string","description":"When this package was transferred out of this organization","uniqueKey":"transferredAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"When this package was transferred out of this organization","uniqueKey":"transferredAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"transferredAt","typeLabel":"string | null"},"transferReturnedAt":{"oneOf":[{"type":"string","description":"When this package was transferred back to this organization","uniqueKey":"transferReturnedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"When this package was transferred back to this organization","uniqueKey":"transferReturnedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"transferReturnedAt","typeLabel":"string | null"},"shippedAt":{"oneOf":[{"type":"string","description":"When this package was shipped out of this organization","uniqueKey":"shippedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"When this package was shipped out of this organization","uniqueKey":"shippedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"shippedAt","typeLabel":"string | null"},"costPerUnit":{"oneOf":[{"type":"string","description":"The cost per unit for this package","uniqueKey":"costPerUnit.oneOf.0","typeLabel":"string"},{"type":"null","description":"The cost per unit for this package","uniqueKey":"costPerUnit.oneOf.1","typeLabel":"null"}],"uniqueKey":"costPerUnit","typeLabel":"string | null"},"voidReason":{"oneOf":[{"type":"string","description":"If this package has been voided, it will always have a reason","uniqueKey":"voidReason.oneOf.0","typeLabel":"string"},{"type":"null","description":"If this package has been voided, it will always have a reason","uniqueKey":"voidReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"voidReason","typeLabel":"string | null"},"thcPercent":{"oneOf":[{"type":"string","description":"The THC percent of this package","uniqueKey":"thcPercent.oneOf.0","typeLabel":"string"},{"type":"null","description":"The THC percent of this package","uniqueKey":"thcPercent.oneOf.1","typeLabel":"null"}],"uniqueKey":"thcPercent","typeLabel":"string | null"},"thcMg":{"oneOf":[{"type":"string","description":"The THC contents in mg of this package","uniqueKey":"thcMg.oneOf.0","typeLabel":"string"},{"type":"null","description":"The THC contents in mg of this package","uniqueKey":"thcMg.oneOf.1","typeLabel":"null"}],"uniqueKey":"thcMg","typeLabel":"string | null"},"cbdPercent":{"oneOf":[{"type":"string","description":"The CBD percent of this package","uniqueKey":"cbdPercent.oneOf.0","typeLabel":"string"},{"type":"null","description":"The CBD percent of this package","uniqueKey":"cbdPercent.oneOf.1","typeLabel":"null"}],"uniqueKey":"cbdPercent","typeLabel":"string | null"},"cbdMg":{"oneOf":[{"type":"string","description":"The CBD contents in mg of this package","uniqueKey":"cbdMg.oneOf.0","typeLabel":"string"},{"type":"null","description":"The CBD contents in mg of this package","uniqueKey":"cbdMg.oneOf.1","typeLabel":"null"}],"uniqueKey":"cbdMg","typeLabel":"string | null"},"producerName":{"oneOf":[{"type":"string","description":"The name of the producer of this package","uniqueKey":"producerName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the producer of this package","uniqueKey":"producerName.oneOf.1","typeLabel":"null"}],"uniqueKey":"producerName","typeLabel":"string | null"},"producerLicense":{"oneOf":[{"type":"string","description":"The state license # of the producer","uniqueKey":"producerLicense.oneOf.0","typeLabel":"string"},{"type":"null","description":"The state license # of the producer","uniqueKey":"producerLicense.oneOf.1","typeLabel":"null"}],"uniqueKey":"producerLicense","typeLabel":"string | null"},"harvestDate":{"oneOf":[{"type":"string","description":"The harvest date of this package","uniqueKey":"harvestDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"The harvest date of this package","uniqueKey":"harvestDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"harvestDate","typeLabel":"string | null"},"harvestFacilityName":{"oneOf":[{"type":"string","description":"The name of the facility that harvested this package","uniqueKey":"harvestFacilityName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the facility that harvested this package","uniqueKey":"harvestFacilityName.oneOf.1","typeLabel":"null"}],"uniqueKey":"harvestFacilityName","typeLabel":"string | null"},"harvestFacilityLicense":{"oneOf":[{"type":"string","description":"The state license # of the harvest facility","uniqueKey":"harvestFacilityLicense.oneOf.0","typeLabel":"string"},{"type":"null","description":"The state license # of the harvest facility","uniqueKey":"harvestFacilityLicense.oneOf.1","typeLabel":"null"}],"uniqueKey":"harvestFacilityLicense","typeLabel":"string | null"},"labName":{"oneOf":[{"type":"string","description":"The name of the lab testing facility","uniqueKey":"labName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the lab testing facility","uniqueKey":"labName.oneOf.1","typeLabel":"null"}],"uniqueKey":"labName","typeLabel":"string | null"},"labLicense":{"oneOf":[{"type":"string","description":"The state license # of the lab testing facility","uniqueKey":"labLicense.oneOf.0","typeLabel":"string"},{"type":"null","description":"The state license # of the lab testing facility","uniqueKey":"labLicense.oneOf.1","typeLabel":"null"}],"uniqueKey":"labLicense","typeLabel":"string | null"},"labDate":{"oneOf":[{"type":"string","description":"The date of the lab testing results for this package","uniqueKey":"labDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"The date of the lab testing results for this package","uniqueKey":"labDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"labDate","typeLabel":"string | null"},"onHold":{"type":"boolean","description":"Whether this package is on \"administrative hold\" in Metrc","uniqueKey":"onHold","typeLabel":"boolean"},"tradeSample":{"type":"boolean","description":"Whether this package is designated as a trade sample","uniqueKey":"tradeSample","typeLabel":"boolean"},"originalSourceLabel":{"oneOf":[{"type":"string","description":"The original source label for this package's root parent. Provided by Metrc for use in Retail ID context","uniqueKey":"originalSourceLabel.oneOf.0","typeLabel":"string"},{"type":"null","description":"The original source label for this package's root parent. Provided by Metrc for use in Retail ID context","uniqueKey":"originalSourceLabel.oneOf.1","typeLabel":"null"}],"uniqueKey":"originalSourceLabel","typeLabel":"string | null"},"locationInventory":{"type":"array","description":"The Meadow inventory for this package broken out by inventory location. An empty array `[]` means that this package does not have any inventory.","items":{"type":"object","properties":{"inventoryLocationId":{"type":"number","description":"The id for this inventory location","uniqueKey":"locationInventory.items.[INDEX].inventoryLocationId","typeLabel":"number"},"amount":{"type":"string","description":"The amount of inventory available for sale","uniqueKey":"locationInventory.items.[INDEX].amount","typeLabel":"string"}},"uniqueKey":"locationInventory.items.[INDEX]","typeLabel":"object"},"uniqueKey":"locationInventory","typeLabel":"object[]"},"product":{"oneOf":[{"type":"object","description":"Information about the product this package has inventory for. This will be `null` if the package has not had its inventory received to a Meadow product yet.","properties":{"id":{"type":"number","description":"The ID of the product","uniqueKey":"product.oneOf.0.id","typeLabel":"number"},"name":{"type":"string","description":"The name of the product","uniqueKey":"product.oneOf.0.name","typeLabel":"string"},"unit":{"type":"string","description":"Either `gram` or `item`","uniqueKey":"product.oneOf.0.unit","typeLabel":"string"},"strainType":{"type":"string","description":"The strain type of the product","enum":["sativa","indica","hybrid","hybrid-sativa","hybrid-indica","cbd","mixed","none"],"uniqueKey":"product.oneOf.0.strainType","typeLabel":"enum\u003cstring>"},"isActive":{"type":"boolean","description":"Whether the product is active on menus or not","uniqueKey":"product.oneOf.0.isActive","typeLabel":"boolean"},"isFeatured":{"type":"boolean","description":"Whether the product is featured or not","uniqueKey":"product.oneOf.0.isFeatured","typeLabel":"boolean"},"inventoryType":{"type":"string","description":"Either `option` or `product`. Please refer to the [Inventory Guide](/guides/inventory) for more information.","uniqueKey":"product.oneOf.0.inventoryType","typeLabel":"string"},"movingAverageCostPerUnit":{"oneOf":[{"type":"boolean","description":"The moving average cost per unit for this product if this products inventoryType is `product`","uniqueKey":"product.oneOf.0.movingAverageCostPerUnit.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"The moving average cost per unit for this product if this products inventoryType is `product`","uniqueKey":"product.oneOf.0.movingAverageCostPerUnit.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.movingAverageCostPerUnit","typeLabel":"boolean | null"},"brandName":{"oneOf":[{"type":"string","description":"The brand name of this product","uniqueKey":"product.oneOf.0.brandName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The brand name of this product","uniqueKey":"product.oneOf.0.brandName.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.brandName","typeLabel":"string | null"},"primaryCategory":{"type":"object","description":"The category for this product","properties":{"id":{"type":"number","description":"ID of the category","uniqueKey":"product.oneOf.0.primaryCategory.id","typeLabel":"number"},"name":{"type":"string","description":"The name of the category","uniqueKey":"product.oneOf.0.primaryCategory.name","typeLabel":"string"},"cannabisType":{"type":"string","description":"One of the following values:\n`non-concentrated` - Flower or other non-concentrated THC products\n`concentrated` - Concentrated THC products (Example: Edibles, Concentrates)\n`immature-plant` - Cannabis plants\n`none` - This product does not contain cannabis\n`mi-infused-solids` - Cannabis infused solids (only in Michigan) (Example: edibles)\n`mi-infused-fluids` - Cannabis infused fluids (only in Michigan) (Example: drinks)\n`edibles` - Edible product (only used in New Jersey \u0026 Massachusetts)","uniqueKey":"product.oneOf.0.primaryCategory.cannabisType","typeLabel":"string"}},"uniqueKey":"product.oneOf.0.primaryCategory","typeLabel":"object"},"options":{"type":"array","description":"All of the pricing options for this product","items":{"properties":{"id":{"type":"number","description":"The ID of this option","uniqueKey":"product.oneOf.0.options.items.[INDEX].id","typeLabel":"number"},"name":{"oneOf":[{"type":"string","description":"The name of this option","uniqueKey":"product.oneOf.0.options.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of this option","uniqueKey":"product.oneOf.0.options.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.options.items.[INDEX].name","typeLabel":"string | null"},"amount":{"type":"number","description":"The amount of the underlying unit of this product","uniqueKey":"product.oneOf.0.options.items.[INDEX].amount","typeLabel":"number"},"price":{"type":"number","description":"The price in cents of this option","uniqueKey":"product.oneOf.0.options.items.[INDEX].price","typeLabel":"number"},"salesPrice":{"oneOf":[{"type":"number","description":"The sales price in cents if one exists","uniqueKey":"product.oneOf.0.options.items.[INDEX].salesPrice.oneOf.0","typeLabel":"number"},{"type":"null","description":"The sales price in cents if one exists","uniqueKey":"product.oneOf.0.options.items.[INDEX].salesPrice.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.options.items.[INDEX].salesPrice","typeLabel":"number | null"},"content":{"type":"string","description":"The cannabis content of this option","uniqueKey":"product.oneOf.0.options.items.[INDEX].content","typeLabel":"string"},"movingAverageCostPerUnit":{"oneOf":[{"type":"string","description":"The moving average cost per unit for this product option","uniqueKey":"product.oneOf.0.options.items.[INDEX].movingAverageCostPerUnit.oneOf.0","typeLabel":"string"},{"type":"null","description":"The moving average cost per unit for this product option","uniqueKey":"product.oneOf.0.options.items.[INDEX].movingAverageCostPerUnit.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.options.items.[INDEX].movingAverageCostPerUnit","typeLabel":"string | null"}},"type":"object","uniqueKey":"product.oneOf.0.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"product.oneOf.0.options","typeLabel":"object[]"}},"uniqueKey":"product.oneOf.0","typeLabel":"object"},{"type":"null","description":"Information about the product this package has inventory for. This will be `null` if the package has not had its inventory received to a Meadow product yet.","properties":{"id":{"type":"number","description":"The ID of the product"},"name":{"type":"string","description":"The name of the product"},"unit":{"type":"string","description":"Either `gram` or `item`"},"strainType":{"type":"string","description":"The strain type of the product","enum":["sativa","indica","hybrid","hybrid-sativa","hybrid-indica","cbd","mixed","none"]},"isActive":{"type":"boolean","description":"Whether the product is active on menus or not"},"isFeatured":{"type":"boolean","description":"Whether the product is featured or not"},"inventoryType":{"type":"string","description":"Either `option` or `product`. Please refer to the [Inventory Guide](/guides/inventory) for more information."},"movingAverageCostPerUnit":{"oneOf":[{"type":"boolean","description":"The moving average cost per unit for this product if this products inventoryType is `product`"},{"type":"null","description":"The moving average cost per unit for this product if this products inventoryType is `product`"}]},"brandName":{"oneOf":[{"type":"string","description":"The brand name of this product"},{"type":"null","description":"The brand name of this product"}]},"primaryCategory":{"type":"object","description":"The category for this product","properties":{"id":{"type":"number","description":"ID of the category"},"name":{"type":"string","description":"The name of the category"},"cannabisType":{"type":"string","description":"One of the following values:\n`non-concentrated` - Flower or other non-concentrated THC products\n`concentrated` - Concentrated THC products (Example: Edibles, Concentrates)\n`immature-plant` - Cannabis plants\n`none` - This product does not contain cannabis\n`mi-infused-solids` - Cannabis infused solids (only in Michigan) (Example: edibles)\n`mi-infused-fluids` - Cannabis infused fluids (only in Michigan) (Example: drinks)\n`edibles` - Edible product (only used in New Jersey \u0026 Massachusetts)"}}},"options":{"type":"array","description":"All of the pricing options for this product","items":{"properties":{"id":{"type":"number","description":"The ID of this option"},"name":{"oneOf":[{"type":"string","description":"The name of this option"},{"type":"null","description":"The name of this option"}]},"amount":{"type":"number","description":"The amount of the underlying unit of this product"},"price":{"type":"number","description":"The price in cents of this option"},"salesPrice":{"oneOf":[{"type":"number","description":"The sales price in cents if one exists"},{"type":"null","description":"The sales price in cents if one exists"}]},"content":{"type":"string","description":"The cannabis content of this option"},"movingAverageCostPerUnit":{"oneOf":[{"type":"string","description":"The moving average cost per unit for this product option"},{"type":"null","description":"The moving average cost per unit for this product option"}]}},"type":"object"}}},"uniqueKey":"product.oneOf.1","typeLabel":"null"}],"uniqueKey":"product","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"data":{"id":150,"organizationId":1,"type":"metrc","externalId":null,"externalProductName":"OG Kush - Eighth","label":"STAGING01234567200000001","status":"received","initialAmount":"150","unit":"Each","createdAt":"2023-01-10T21:35:10.732Z","updatedAt":"2023-05-05 10:17:56.561-07","receivedAt":"2023-05-05T17:17:56.561Z","finishedAt":null,"multiplier":"1","expirationDate":"2024-03-07","transferredAt":null,"transferReturnedAt":null,"shippedAt":null,"costPerUnit":"24.9567","voidReason":null,"thcPercent":"24.5","thcMg":null,"cbdPercent":"2.7","cbdMg":null,"producerName":null,"producerLicense":null,"harvestDate":null,"harvestFacilityName":null,"harvestFacilityLicense":null,"labName":null,"labLicense":null,"labDate":null,"onHold":false,"tradeSample":false,"originalSourceLabel":null,"productOptionId":1250,"locationInventory":[{"inventoryLocationId":3,"amount":"90"},{"inventoryLocationId":41,"amount":"9"}],"product":{"id":798,"name":"OG Kush","unit":"item","strainType":"hybrid-indica","isActive":true,"isFeatured":false,"inventoryType":"option","movingAverageCostPerUnit":null,"brandName":"Meadow Farms","primaryCategory":{"id":8,"name":"Flower","cannabisType":"non-concentrated"},"options":[{"id":1250,"name":"","amount":1,"price":2400,"salesPrice":null,"content":3.5,"movingAverageCostPerUnit":0}]}}},"examples":{"Example":{"title":"Example","value":{"data":{"id":150,"organizationId":1,"type":"metrc","externalId":null,"externalProductName":"OG Kush - Eighth","label":"STAGING01234567200000001","status":"received","initialAmount":"150","unit":"Each","createdAt":"2023-01-10T21:35:10.732Z","updatedAt":"2023-05-05 10:17:56.561-07","receivedAt":"2023-05-05T17:17:56.561Z","finishedAt":null,"multiplier":"1","expirationDate":"2024-03-07","transferredAt":null,"transferReturnedAt":null,"shippedAt":null,"costPerUnit":"24.9567","voidReason":null,"thcPercent":"24.5","thcMg":null,"cbdPercent":"2.7","cbdMg":null,"producerName":null,"producerLicense":null,"harvestDate":null,"harvestFacilityName":null,"harvestFacilityLicense":null,"labName":null,"labLicense":null,"labDate":null,"onHold":false,"tradeSample":false,"originalSourceLabel":null,"productOptionId":1250,"locationInventory":[{"inventoryLocationId":3,"amount":"90"},{"inventoryLocationId":41,"amount":"9"}],"product":{"id":798,"name":"OG Kush","unit":"item","strainType":"hybrid-indica","isActive":true,"isFeatured":false,"inventoryType":"option","movingAverageCostPerUnit":null,"brandName":"Meadow Farms","primaryCategory":{"id":8,"name":"Flower","cannabisType":"non-concentrated"},"options":[{"id":1250,"name":"","amount":1,"price":2400,"salesPrice":null,"content":3.5,"movingAverageCostPerUnit":0}]}}}}},"exampleType":"examples"}},"exampleType":"examples"},"e43acfa0-96bd-4616-8181-49aae5701a72":{"description":"Unexpected error","content":{"application/json":{"schema":{"required":["error","message"],"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","example":"A description of the error code","uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","example":"CODE_OF_ERROR_WILL_BE_HERE","uniqueKey":"error.code","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"A description of the error code","code":"CODE_OF_ERROR_WILL_BE_HERE"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"1c0263ad-f012-431c-98fb-cf88e02a4593":{"meadowConsumer":{"type":"apiKey","name":"X-Consumer-Key","description":"The key assigned to your company and provided via Meadow","in":"header","scopes":[],"schemeName":"meadowConsumer"},"meadowClient":{"type":"apiKey","name":"X-Client-Key","description":"The key generated and provided by our mutual client","in":"header","scopes":[],"schemeName":"meadowClient"}}},"servers":{"51c520a1-a658-421f-927a-7fcae986ba8c":{"url":"https://api-staging.getmeadow.com"},"5091d89b-c8ff-49bd-ac28-f40b834142b1":{"url":"https://api.getmeadow.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"X-Consumer-Key","description":"The key assigned to your company and provided via Meadow","in":"header","scopes":[],"schemeName":"meadowConsumer"},"schema":{"title":"X-Consumer-Key","type":"string","description":"The key assigned to your company and provided via Meadow","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"meadowConsumer","name":"X-Consumer-Key"},{"scheme":{"type":"apiKey","name":"X-Client-Key","description":"The key generated and provided by our mutual client","in":"header","scopes":[],"schemeName":"meadowClient"},"schema":{"title":"X-Client-Key","type":"string","description":"The key generated and provided by our mutual client","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"meadowClient","name":"X-Client-Key"}],"title":"meadowConsumer \u0026 meadowClient"}]},"originalFileLocation":"endpoints/openapi.json"},"subdomain":"meadow","siteName":"Meadow API","title":"Retrieve a package - Meadow API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-24T21:40:25.791Z","originalFileLocation":"endpoints/analytics/retrieve-package.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve package information for a specific label/tag\">\u003cmeta data-mint-head name=\"application-name\" content=\"Meadow API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/meadow/ZyOpgKgnc39DMFWW/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/meadow/ZyOpgKgnc39DMFWW/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/meadow/ZyOpgKgnc39DMFWW/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/meadow/ZyOpgKgnc39DMFWW/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/meadow/ZyOpgKgnc39DMFWW/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/meadow/ZyOpgKgnc39DMFWW/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/meadow/ZyOpgKgnc39DMFWW/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/meadow/ZyOpgKgnc39DMFWW/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/meadow/ZyOpgKgnc39DMFWW/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a package - Meadow API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve package information for a specific label/tag\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Meadow API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://api-docs.getmeadow.com/endpoints/analytics/retrieve-package\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://meadow.mintlify.app/_mintlify/api/og/v2?division=Endpoints%3A+Analytics\u0026amp;title=Retrieve+a+package\u0026amp;description=Retrieve+package+information+for+a+specific+label%2Ftag\u0026amp;theme=3516b74799b31165bc48cba6\u0026amp;signature=28c8bec453cb1cd7004c7fd14c2a6fd9a57bedab581220ef0a8bc4aff777e918\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Retrieve a package - Meadow API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve package information for a specific label/tag\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://meadow.mintlify.app/_mintlify/api/og/v2?division=Endpoints%3A+Analytics\u0026amp;title=Retrieve+a+package\u0026amp;description=Retrieve+package+information+for+a+specific+label%2Ftag\u0026amp;theme=3516b74799b31165bc48cba6\u0026amp;signature=28c8bec453cb1cd7004c7fd14c2a6fd9a57bedab581220ef0a8bc4aff777e918\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/meadow/ZyOpgKgnc39DMFWW/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Meadow API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#8019e4\">\u003clink data-mint-head rel=\"canonical\" href=\"https://api-docs.getmeadow.com/endpoints/analytics/retrieve-package\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/endpoints/analytics/retrieve-package.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://api-docs.getmeadow.com/#organization\",\"name\":\"Meadow API\",\"url\":\"https://api-docs.getmeadow.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/meadow/A0jpawTy4WMsQxOO/images/logo-purple.png?fit=max\u0026auto=format\u0026n=A0jpawTy4WMsQxOO\u0026q=85\u0026s=26b8bb6925801507b6d0261692862020\"}},{\"@type\":\"WebSite\",\"@id\":\"https://api-docs.getmeadow.com#website\",\"name\":\"Meadow API\",\"url\":\"https://api-docs.getmeadow.com\",\"publisher\":{\"@id\":\"https://api-docs.getmeadow.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://api-docs.getmeadow.com/endpoints/analytics/retrieve-package#webpage\",\"url\":\"https://api-docs.getmeadow.com/endpoints/analytics/retrieve-package\",\"name\":\"Retrieve a package\",\"description\":\"Retrieve package information for a specific label/tag\",\"dateModified\":\"2026-04-24T21:40:25.791Z\",\"isPartOf\":{\"@id\":\"https://api-docs.getmeadow.com#website\"},\"breadcrumb\":{\"@id\":\"https://api-docs.getmeadow.com/endpoints/analytics/retrieve-package#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://api-docs.getmeadow.com/endpoints/analytics/retrieve-package#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints: Analytics\",\"item\":\"https://api-docs.getmeadow.com/endpoints/analytics/list-orders\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retrieve a package\",\"item\":\"https://api-docs.getmeadow.com/endpoints/analytics/retrieve-package\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://api-docs.getmeadow.com/endpoints/analytics/retrieve-package#apireference\",\"headline\":\"Retrieve a package\",\"name\":\"Retrieve a package\",\"description\":\"Retrieve package information for a specific label/tag\",\"url\":\"https://api-docs.getmeadow.com/endpoints/analytics/retrieve-package\",\"mainEntityOfPage\":{\"@id\":\"https://api-docs.getmeadow.com/endpoints/analytics/retrieve-package#webpage\"},\"dateModified\":\"2026-04-24T21:40:25.791Z\",\"publisher\":{\"@id\":\"https://api-docs.getmeadow.com/#organization\"},\"isPartOf\":{\"@id\":\"https://api-docs.getmeadow.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Meadow API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Meadow API","nav":{"global":null,"groups":[{"group":"Using the API","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Authentication","href":"/authentication"},{"title":"Responses","href":"/responses"},{"title":"Errors","href":"/errors"},{"title":"Permissions","href":"/permissions"},{"title":"Rate Limits","href":"/rate-limits"},{"title":"Changelog","href":"/changelog"}]},{"group":"Guides","pages":[{"title":"Inventory","href":"/guides/inventory"}]},{"group":"Endpoints: Analytics","pages":[{"title":"List orders","openapi":"GET /api/v1/orders","href":"/endpoints/analytics/list-orders"},{"title":"Retrieve an order","openapi":"GET /api/v1/orders/{orderId}/detail","href":"/endpoints/analytics/retrieve-order"},{"title":"List order returns","openapi":"GET /api/v1/order-returns","href":"/endpoints/analytics/list-order-returns"},{"title":"List instore queues","openapi":"GET /api/v1/instore-queues","href":"/endpoints/analytics/list-instore-queues"},{"title":"List inventory locations","openapi":"GET /api/v1/inventory-locations","href":"/endpoints/analytics/list-inventory-locations"},{"title":"Retrieve the organization","openapi":"GET /api/v1/organization","href":"/endpoints/analytics/retrieve-organization"},{"title":"List all products","openapi":"GET /api/v1/products/all","href":"/endpoints/analytics/list-all-products"},{"title":"List purchase orders","openapi":"GET /api/v1/purchase-orders","href":"/endpoints/analytics/list-purchase-orders"},{"title":"List compliance transfers","openapi":"GET /api/v1/compliance-transfers","href":"/endpoints/analytics/list-compliance-transfers"},{"title":"List packages","openapi":"GET /api/v1/packages","description":"Retrieve all packages for an organization in ascending order by when the package was most recently updated. 50 packages will be returned at a time and may be paginated using the `startingAfterUpdatedAt` and `startingAfterId` query parameters.","href":"/endpoints/analytics/list-packages"},{"title":"Retrieve a package","openapi":"GET /api/v1/packages/{label}","href":"/endpoints/analytics/retrieve-package"}]},{"group":"Endpoints: Create Orders","pages":[{"title":"Customer Matching","description":null,"href":"/endpoints/orders/customer-matching"},{"title":"Retrieve order status","openapi":"GET /api/v1/orders/{orderId}","href":"/endpoints/orders/retrieve-status"},{"title":"Retrieve cart pricing","openapi":"POST /api/v1/orders/pricing","href":"/endpoints/orders/retrieve-pricing"},{"title":"Create an order","openapi":"POST /api/v1/orders","href":"/endpoints/orders/create-order"},{"title":"List payment types","openapi":"GET /api/v1/payment-types","href":"/endpoints/orders/list-payment-types"},{"title":"Upload customer document","openapi":"POST /api/v1/documents/{customerId}/{documentType}","href":"/endpoints/orders/upload-document"}]},{"group":"Endpoints: Customers","pages":[{"title":"List customers","openapi":"GET /api/v1/customers","href":"/endpoints/customers/list-customers"},{"title":"Retrieve a customer","openapi":"GET /api/v1/customers/{identifier}","href":"/endpoints/customers/retrieve-customer"},{"title":"List customer groups","openapi":"GET /api/v1/customer-groups","href":"/endpoints/customers/list-customer-groups"},{"title":"Add customer to group","openapi":"PUT /api/v1/customer-groups/{customerGroupId}/add-customer","href":"/endpoints/customers/add-customer-to-group"},{"title":"Remove customer from group","openapi":"PUT /api/v1/customer-groups/{customerGroupId}/remove-customer","href":"/endpoints/customers/remove-customer-from-group"},{"title":"Add loyalty points","openapi":"POST /api/v1/loyalty-events","href":"/endpoints/customers/add-loyalty-points"}]},{"group":"Endpoints: Menu","pages":[{"title":"List all menu products","openapi":"GET /api/v1/menu","href":"/endpoints/menu/list-menu"},{"title":"List tags","openapi":"GET /api/v1/products/tags","href":"/endpoints/menu/list-tags"}]},{"group":"Endpoints: Products \u0026 Inventory","pages":[{"title":"Create a product","openapi":"POST /api/v1/products","href":"/endpoints/products/create-product"},{"title":"Update a product","openapi":"PUT /api/v1/products/{productId}","href":"/endpoints/products/update-product"},{"title":"Update product options","openapi":"PUT /api/v1/products/{productId}/options","href":"/endpoints/products/update-product-options"},{"title":"List categories","openapi":"GET /api/v1/product-categories","href":"/endpoints/products/list-categories"},{"title":"List sub-categories","openapi":"GET /api/v1/product-sub-categories","href":"/endpoints/products/list-sub-categories"},{"title":"Create purchase order","openapi":"POST /api/v1/purchase-orders","href":"/endpoints/products/create-purchase-order"},{"title":"Update purchase order","openapi":"PUT /api/v1/purchase-orders/{purchaseOrderId}","href":"/endpoints/products/update-purchase-order"},{"title":"Update UPCs","openapi":"PUT /api/v1/products/{productId}/options/upc","href":"/endpoints/products/update-upcs"}]}]},"basePath":"","title":"Retrieve a package - Meadow API","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}