List purchase orders

cURL

curl --request GET \
  --url https://api-staging.getmeadow.com/api/v1/purchase-orders \
  --header 'X-Client-Key: <api-key>' \
  --header 'X-Consumer-Key: <api-key>'

{
  "id": 123,
  "status": "<string>",
  "notes": "<string>",
  "expectedAt": "<string>",
  "paymentStatus": "<string>",
  "paymentTerms": "<string>",
  "paymentTermsDueDate": "<string>",
  "totalAmount": "<string>",
  "totalAmountReceived": "<string>",
  "subtotal": 123,
  "finalTotal": 123,
  "caExciseTotal": 123,
  "shippingHandlingFee": 123,
  "shippingHandlingFeeExcise": 123,
  "amountPaid": 123,
  "amountOustanding": 123,
  "externalInvoiceNumber": "<string>",
  "createdAt": "<string>",
  "vendor": {
    "id": 123,
    "name": "<string>",
    "phone": "<string>",
    "notes": "<string>",
    "email": "<string>",
    "sellerPermitNumber": "<string>",
    "street1": "<string>",
    "street2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "createdAt": "<string>"
  },
  "lineItems": [
    {
      "id": 123,
      "amount": "<string>",
      "costPerUnit": "<string>",
      "subtotal": 123,
      "finalTotal": 123,
      "amountReceived": "<string>",
      "caExcisePerUnit": "<string>",
      "caExciseTotal": 123,
      "receptions": [
        {
          "inventoryLocationId": 123,
          "amount": "<string>",
          "createdAt": "<string>"
        }
      ],
      "product": {
        "id": 123,
        "name": "<string>",
        "unit": "<string>",
        "strainType": "<string>",
        "primaryCategory": {
          "id": 123,
          "name": "<string>",
          "cannabisType": "<string>"
        }
      }
    }
  ]
}

GET

api

purchase-orders

cURL

curl --request GET \
  --url https://api-staging.getmeadow.com/api/v1/purchase-orders \
  --header 'X-Client-Key: <api-key>' \
  --header 'X-Consumer-Key: <api-key>'

{
  "id": 123,
  "status": "<string>",
  "notes": "<string>",
  "expectedAt": "<string>",
  "paymentStatus": "<string>",
  "paymentTerms": "<string>",
  "paymentTermsDueDate": "<string>",
  "totalAmount": "<string>",
  "totalAmountReceived": "<string>",
  "subtotal": 123,
  "finalTotal": 123,
  "caExciseTotal": 123,
  "shippingHandlingFee": 123,
  "shippingHandlingFeeExcise": 123,
  "amountPaid": 123,
  "amountOustanding": 123,
  "externalInvoiceNumber": "<string>",
  "createdAt": "<string>",
  "vendor": {
    "id": 123,
    "name": "<string>",
    "phone": "<string>",
    "notes": "<string>",
    "email": "<string>",
    "sellerPermitNumber": "<string>",
    "street1": "<string>",
    "street2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "createdAt": "<string>"
  },
  "lineItems": [
    {
      "id": 123,
      "amount": "<string>",
      "costPerUnit": "<string>",
      "subtotal": 123,
      "finalTotal": 123,
      "amountReceived": "<string>",
      "caExcisePerUnit": "<string>",
      "caExciseTotal": 123,
      "receptions": [
        {
          "inventoryLocationId": 123,
          "amount": "<string>",
          "createdAt": "<string>"
        }
      ],
      "product": {
        "id": 123,
        "name": "<string>",
        "unit": "<string>",
        "strainType": "<string>",
        "primaryCategory": {
          "id": 123,
          "name": "<string>",
          "cannabisType": "<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 purchase order that you want to retrieve all purchase orders after this one. Pass in the last id in a response to retrieve the next page.

Response

List purchase orders response

number

The ID of the purchase order

status

string

Either open or closed

notes

string | null

User entered notes for this purchase order

expectedAt

string

A date for when this purchase order is expected in YYYY-MM-DD

paymentStatus

string

Either paid, unpaid, or partial

paymentTerms

string

One of net15, net30, net60, cod or custom

paymentTermsDueDate

string

The payment terms due date

totalAmount

string

The total amount (quantity) of product on this purchase order

totalAmountReceived

string

The total amount (quantity) of product received on this purchase order

subtotal

number

The subtotal of the purchase order in cents

finalTotal

number

The final total of the purchase order in cents

caExciseTotal

number

The number for pre-2023 California excise of this purchase order in cents

shippingHandlingFee

number

The shipping fee in cents

shippingHandlingFeeExcise

number

The number for pre-2023 California excise of the shipping and handling fee

amountPaid

number

The amount paid for this purchase order in cents

amountOustanding

number

The amount still left to be paid in cents

externalInvoiceNumber

string | null

The external invoice number

createdAt

string

When this purchase order was created

vendor

object

Information about the loyalty of the customer (Can be null)

Hide child attributes

vendor.id

number

The id for this vendor

vendor.name

string

The name of this vendor

vendor.phone

string

The phone for this vendor

vendor.notes

string

User entered notes about this vendor

vendor.email

string

The email of this vendor

vendor.sellerPermitNumber

string

The license number for this vendor

vendor.street1

string

vendor.street2

string

vendor.city

string

vendor.state

string

vendor.postalCode

string

vendor.createdAt

string

When this vendor was created

lineItems

object[]

All of the line items for this purchase order

Hide child attributes

lineItems.id

number

The id of this line item

lineItems.amount

string

The amount (quantity) for the product in this line item

lineItems.costPerUnit

string

The cost for each amount of this line item in dollars

lineItems.subtotal

number

The subtotal for this line item in cents

lineItems.finalTotal

number

The final total for this line item in cents

lineItems.amountReceived

string

The amount that has been received thus far

lineItems.caExcisePerUnit

string

The amount of pre-2023 California excise tax per unit in dollars

lineItems.caExciseTotal

number

The total amount of pre-2023 California excise tax for this line item in cents

lineItems.receptions

object[]

All of the receptions for this purchase order line item

Hide child attributes

lineItems.receptions.inventoryLocationId

number

The id of the inventory location where this inventory was received

lineItems.receptions.amount

string

The amount (quantity) of the reception

lineItems.receptions.createdAt

string

When this reception was created

lineItems.product

object

The product that this line item is for

Hide child attributes

lineItems.product.id

number

The ID of the product

lineItems.product.name

string

The name of the product

lineItems.product.unit

string

Either gram or item

lineItems.product.strainType

string

The strain type of the product

lineItems.product.primaryCategory

object

The category for this product

Hide child attributes

lineItems.product.primaryCategory.id

number

ID of the category

lineItems.product.primaryCategory.name

string

The name of the category

lineItems.product.primaryCategory.cannabisType

string

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)

List all products List compliance transfers

⌘I

Using the API

Guides

Endpoints: Analytics

Endpoints: Create Orders

Endpoints: Customers

Endpoints: Menu

Endpoints: Products & Inventory

List purchase orders

Authorizations

Query Parameters

Response