Skip to main content
GET
/
api
/
v1
/
compliance-transfers
cURL
curl --request GET \
  --url https://api-staging.getmeadow.com/api/v1/compliance-transfers \
  --header 'X-Client-Key: <api-key>' \
  --header 'X-Consumer-Key: <api-key>'
{
  "id": 123,
  "externalId": "<string>",
  "type": "<string>",
  "manifestNumber": "<string>",
  "shipperName": "<string>",
  "shipperLicenseNumber": "<string>",
  "createdAt": "<string>",
  "packages": [
    {
      "id": 123,
      "type": "<string>",
      "externalId": "<string>",
      "externalProductName": "<string>",
      "label": "<string>",
      "status": "ready",
      "initialAmount": "<string>",
      "unit": "<string>",
      "createdAt": "<string>",
      "onHold": true,
      "tradeSample": true,
      "product": {
        "id": 123,
        "name": "<string>",
        "unit": "<string>",
        "strainType": "sativa",
        "archivedAt": "<string>",
        "deletedAt": "<string>"
      },
      "productOption": {
        "id": 123,
        "name": "<string>",
        "amount": "<string>",
        "price": "<string>",
        "salesPrice": "<string>",
        "upc": "<string>",
        "deletedAt": "<string>"
      }
    }
  ]
}

Authorizations

X-Consumer-Key
string
header
required

The key assigned to your company and provided via Meadow

X-Client-Key
string
header
required

The key generated and provided by our mutual client

Query Parameters

startingAfter
integer<int64>

The id for a transfer that you want to retrieve all transfers after this one. Pass in the last id in a response to retrieve the next page.

Response

List compliance transfers response

id
number

The ID of the compliance transfer

externalId
string

The ID of the transfer in the compliance system (metrc)

type
string

The compliance system this transfer came from

manifestNumber
string

The manifest number of the transfer in the compliance system

shipperName
string | null

The name of the shipper

shipperLicenseNumber
string | null

The state license number of the shipper

createdAt
string

When this transfer was imported into Meadow

packages
object[]

The packages within this transfer