List orders

cURL

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

{
  "id": "<string>",
  "totalPrice": 123,
  "netPrice": 123,
  "customerGrandTotal": 123,
  "createdAt": "<string>",
  "packedAt": "<string>",
  "fulfilledAt": "<string>",
  "type": "delivery",
  "status": "draft",
  "cancelationReason": "<string>",
  "canceledAt": "<string>",
  "taxExempt": true,
  "refundTotal": 123,
  "isMedical": true,
  "customerName": "<string>",
  "deliveryFee": 123,
  "deliveryFeeDescription": "<string>",
  "lineItems": [
    {
      "id": 123,
      "quantity": 123,
      "productId": 123,
      "productName": "<string>",
      "optionId": 123,
      "optionName": "<string>",
      "optionPrice": 123,
      "optionSalesPrice": 123,
      "productBrandId": 123,
      "productBrand": "<string>",
      "unitPrice": 123,
      "subtotalPrice": 123,
      "finalPrice": 123,
      "productMovingAverageCostPerUnit": 123,
      "optionMovingAverageCostPerUnit": "<string>",
      "packageLineCost": "<string>",
      "primaryCategory": {
        "id": 123,
        "name": "<string>"
      },
      "discounts": [
        {
          "discountId": 123,
          "type": "<string>",
          "amount": 123,
          "amountUsed": 123,
          "description": "<string>"
        }
      ],
      "fulfillAs": [
        {
          "pkg": {
            "unit": "<string>",
            "label": "<string>",
            "costPerUnit": "<string>"
          },
          "optionSum": 123,
          "productOptionId": 123,
          "quantityFulfilled": "<string>"
        }
      ]
    }
  ],
  "payments": [
    {
      "id": 123,
      "paymentTypeId": 123,
      "amount": 123,
      "finalAmount": 123,
      "name": "<string>",
      "fee": 123,
      "feePercent": "<string>",
      "feeAmount": 123,
      "feeDescription": "<string>"
    }
  ],
  "customer": {
    "id": 123,
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "birthday": "<string>",
    "hashId": "<string>",
    "sex": "<string>",
    "zip": "<string>",
    "licenseExpiry": "<string>",
    "medicalExpiration": "<string>"
  },
  "placedBy": {
    "id": 123,
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "fulfilledBy": {
    "id": 123,
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "adjustments": [
    {
      "amount": 123,
      "description": "<string>",
      "isTaxExemption": true,
      "taxid": 123
    }
  ],
  "credits": [
    {
      "creditId": 123,
      "type": "<string>",
      "amountUsed": 123,
      "description": "<string>"
    }
  ],
  "discounts": [
    {
      "discountId": 123,
      "type": "<string>",
      "amount": 123,
      "amountUsed": 123,
      "description": "<string>"
    }
  ],
  "loyaltyRedemptions": [
    {
      "type": "<string>",
      "description": "<string>",
      "pointsRequirement": "<string>",
      "pointsAmount": "<string>",
      "discountAmount": "<string>",
      "amountUsed": 123,
      "productOptionId": 123
    }
  ],
  "taxes": [
    {
      "taxId": 123,
      "amount": 123,
      "description": "<string>",
      "rate": "<string>",
      "amountBeforeExemption": 123,
      "amountExempted": 123,
      "included": true,
      "exemptable": true,
      "tier": "<string>",
      "type": "<string>",
      "normalRate": "<string>"
    }
  ],
  "returns": [
    {
      "id": 123,
      "refundType": "<string>",
      "refundInitial": 123,
      "refundTotal": 123,
      "creditsTotal": 123,
      "discountsTotal": 123,
      "adjustmentAmount": 123,
      "adjustmentDescription": "<string>",
      "paymentTypeName": "<string>",
      "loyaltyTotal": 123,
      "voidedAt": "<string>",
      "voidedReason": "<string>",
      "createdAt": "<string>",
      "lineItems": [
        {
          "orderLineItemId": 123,
          "type": "<string>",
          "inventoryAction": "<string>",
          "quantity": 123,
          "reason": "<string>",
          "fulfillAs": [
            {}
          ]
        }
      ],
      "taxes": [
        {
          "amount": 123,
          "description": "<string>",
          "refunded": true,
          "rate": 123,
          "included": true,
          "exemptable": true
        }
      ],
      "createdBy": {
        "id": 123,
        "email": "<string>",
        "firstName": "<string>",
        "lastName": "<string>"
      },
      "voidedBy": {
        "id": 123,
        "email": "<string>",
        "firstName": "<string>",
        "lastName": "<string>"
      }
    }
  ],
  "address": {
    "street1": "<string>",
    "street2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>"
  },
  "shift": {
    "name": "<string>"
  }
}

GET

api

orders

cURL

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

{
  "id": "<string>",
  "totalPrice": 123,
  "netPrice": 123,
  "customerGrandTotal": 123,
  "createdAt": "<string>",
  "packedAt": "<string>",
  "fulfilledAt": "<string>",
  "type": "delivery",
  "status": "draft",
  "cancelationReason": "<string>",
  "canceledAt": "<string>",
  "taxExempt": true,
  "refundTotal": 123,
  "isMedical": true,
  "customerName": "<string>",
  "deliveryFee": 123,
  "deliveryFeeDescription": "<string>",
  "lineItems": [
    {
      "id": 123,
      "quantity": 123,
      "productId": 123,
      "productName": "<string>",
      "optionId": 123,
      "optionName": "<string>",
      "optionPrice": 123,
      "optionSalesPrice": 123,
      "productBrandId": 123,
      "productBrand": "<string>",
      "unitPrice": 123,
      "subtotalPrice": 123,
      "finalPrice": 123,
      "productMovingAverageCostPerUnit": 123,
      "optionMovingAverageCostPerUnit": "<string>",
      "packageLineCost": "<string>",
      "primaryCategory": {
        "id": 123,
        "name": "<string>"
      },
      "discounts": [
        {
          "discountId": 123,
          "type": "<string>",
          "amount": 123,
          "amountUsed": 123,
          "description": "<string>"
        }
      ],
      "fulfillAs": [
        {
          "pkg": {
            "unit": "<string>",
            "label": "<string>",
            "costPerUnit": "<string>"
          },
          "optionSum": 123,
          "productOptionId": 123,
          "quantityFulfilled": "<string>"
        }
      ]
    }
  ],
  "payments": [
    {
      "id": 123,
      "paymentTypeId": 123,
      "amount": 123,
      "finalAmount": 123,
      "name": "<string>",
      "fee": 123,
      "feePercent": "<string>",
      "feeAmount": 123,
      "feeDescription": "<string>"
    }
  ],
  "customer": {
    "id": 123,
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "birthday": "<string>",
    "hashId": "<string>",
    "sex": "<string>",
    "zip": "<string>",
    "licenseExpiry": "<string>",
    "medicalExpiration": "<string>"
  },
  "placedBy": {
    "id": 123,
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "fulfilledBy": {
    "id": 123,
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "adjustments": [
    {
      "amount": 123,
      "description": "<string>",
      "isTaxExemption": true,
      "taxid": 123
    }
  ],
  "credits": [
    {
      "creditId": 123,
      "type": "<string>",
      "amountUsed": 123,
      "description": "<string>"
    }
  ],
  "discounts": [
    {
      "discountId": 123,
      "type": "<string>",
      "amount": 123,
      "amountUsed": 123,
      "description": "<string>"
    }
  ],
  "loyaltyRedemptions": [
    {
      "type": "<string>",
      "description": "<string>",
      "pointsRequirement": "<string>",
      "pointsAmount": "<string>",
      "discountAmount": "<string>",
      "amountUsed": 123,
      "productOptionId": 123
    }
  ],
  "taxes": [
    {
      "taxId": 123,
      "amount": 123,
      "description": "<string>",
      "rate": "<string>",
      "amountBeforeExemption": 123,
      "amountExempted": 123,
      "included": true,
      "exemptable": true,
      "tier": "<string>",
      "type": "<string>",
      "normalRate": "<string>"
    }
  ],
  "returns": [
    {
      "id": 123,
      "refundType": "<string>",
      "refundInitial": 123,
      "refundTotal": 123,
      "creditsTotal": 123,
      "discountsTotal": 123,
      "adjustmentAmount": 123,
      "adjustmentDescription": "<string>",
      "paymentTypeName": "<string>",
      "loyaltyTotal": 123,
      "voidedAt": "<string>",
      "voidedReason": "<string>",
      "createdAt": "<string>",
      "lineItems": [
        {
          "orderLineItemId": 123,
          "type": "<string>",
          "inventoryAction": "<string>",
          "quantity": 123,
          "reason": "<string>",
          "fulfillAs": [
            {}
          ]
        }
      ],
      "taxes": [
        {
          "amount": 123,
          "description": "<string>",
          "refunded": true,
          "rate": 123,
          "included": true,
          "exemptable": true
        }
      ],
      "createdBy": {
        "id": 123,
        "email": "<string>",
        "firstName": "<string>",
        "lastName": "<string>"
      },
      "voidedBy": {
        "id": 123,
        "email": "<string>",
        "firstName": "<string>",
        "lastName": "<string>"
      }
    }
  ],
  "address": {
    "street1": "<string>",
    "street2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>"
  },
  "shift": {
    "name": "<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

string

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

startingOn

string

A date that must be formatted as YYYY-MM-DD. When submitted, the response will return the latest order on that day and continue in reverse chronological order. I.E. if 2022-11-25 is passed in, the first order will be as close to 11:59pm November 25th, 2022 as possible.

fulfilledOnly

boolean

When passed in as true, only fulfilled orders will be returned. The response will be ordered in reverse chronological order of fulfilled date. Also, this will cause startingOn to use fulfilledAt instead of createdAt for determining what orders to return.

type

enum<string>

Only orders of that type will be returned if this parameter is sent.

Available options:

delivery,

pickup,

in-store

userId

number

Retrieves orders by user. You can get user IDs from List customers or after Creating an order.

Response

List orders response

string

The ID of the order

totalPrice

number

The subtotal price before discounts, credits, adjustments are taken into account.

netPrice

number

The final price of the order before payment & delivery fees. Includes taxes

customerGrandTotal

number

The final price of the order after all fees

createdAt

string

The datetime the order was created

packedAt

string | null

The datetime the order was packed on

fulfilledAt

string | null

The date the order was fulfilled

type

enum<string>

The type of this order

Available options:

delivery,

pickup,

in-store

status

enum<string>

The status of the order.

draft is an order submitted without inventory taken out
new is an order that has had inventory associated with it
packed signifies an order has been processed and is waiting for pickup/delivery
fulfilled is an order that has been fully completed
canceled is an order that has been canceled

Available options:

draft,

new,

packed,

fulfilled,

canceled

cancelationReason

string | null

A description of why the order was canceled

canceledAt

string | null

When the order was canceled

taxExempt

boolean

Whether this order was marked as tax exempt or not

refundTotal

number

The amount refunded by returns on this order

isMedical

boolean

Whether this order was for a medical customer or not

customerName

string | null

The name of the customer for express pickup or kiosk orders.

deliveryFee

number

The delivery fee for the order

deliveryFeeDescription

string | null

A description of the delivery fee that can be shown to the customer

lineItems

object[]

All of the products purchased with this order

Hide child attributes

lineItems.id

number

The ID of this line item

lineItems.quantity

number

The quantity of this line item

lineItems.productId

number

The id of the product purchased

lineItems.productName

string

The name of the product purchased

lineItems.optionId

number

The id of the product option purchased

lineItems.optionName

string | null

The name of the product option

lineItems.optionPrice

number

The price of the product option at time of purchase

lineItems.optionSalesPrice

number | null

The sales price of the product option at time of purchase if it was on sale

lineItems.productBrandId

number | null

The brand id of the product

lineItems.productBrand

string | null

The name of the brand of the product

lineItems.unitPrice

number

The price per unit of this line item

lineItems.subtotalPrice

number

The subtotal of this line item before discounts

lineItems.finalPrice

number

The final price for this line item after all discounts

lineItems.productMovingAverageCostPerUnit

number | null

The moving average cost per unit of the product

lineItems.optionMovingAverageCostPerUnit

string | null

The moving average cost per unit of the product option

lineItems.packageLineCost

string | null

The total cost for all metrc packages used to fulfill this line item

lineItems.primaryCategory

object

The primary category for the product of this line item

Hide child attributes

lineItems.primaryCategory.id

number

The ID of this product category

lineItems.primaryCategory.name

string

The name of the primary category

lineItems.discounts

object[]

An array of discounts applied to this line item (may be empty)

Hide child attributes

lineItems.discounts.discountId

number | null

The ID for this discount. This value will be null for a custom discount added by a budtender

lineItems.discounts.type

string

Either flat for a dollar amount or percent for a percent amount off

lineItems.discounts.amount

number

The amount of the discount before being applied. Either in cents or a percent depending on the type.

lineItems.discounts.amountUsed

number

The amount that was taken off of the line item by this discount, represented in cents

lineItems.discounts.description

string

The description of the discount, which may be shown to the customer

lineItems.fulfillAs

object[]

An array of objects showing what packages or product options fulfilled this order. Could also be null if the line item does not have any packages or substitutions associated with it.

Hide child attributes

lineItems.fulfillAs.pkg

object

An object about the compliance package for this fulfillment. Please handle both null and an empty object {} for times when there is not a package

Hide child attributes

lineItems.fulfillAs.pkg.unit

string

The metrc unit of this package

lineItems.fulfillAs.pkg.label

string

The metrc package tag

lineItems.fulfillAs.pkg.costPerUnit

string

The cost per unit of this package

lineItems.fulfillAs.optionSum

number

A negative number showing how much quantity of the underlying product option was used for this fulfillment. For option tracking this will be an integer, but for product tracking it could be a decimal.

lineItems.fulfillAs.productOptionId

number

The ID of the product option used for this fulfillment. For most cases, it will be the same as lineItems[].optionId, but in cases where another option is substituted to fulfill another (Example: 2 eighths fulfilling a quarter option), this productOptionId could be different.

lineItems.fulfillAs.quantityFulfilled

string

The quantity of the underlying lineItem that this fulfillment is responsible for

payments

object[]

All of the payments applied to this order

Hide child attributes

payments.id

number

The ID of this payment

payments.paymentTypeId

number

The ID of the payment type used for this payment

payments.amount

number

The amount of the payment before fees in cents

payments.finalAmount

number

The final amount of the payment after fees are included

payments.name

string

The name of the payment type being used to make this payment

payments.fee

number

The amount of a flat fee in cents added to this payment

payments.feePercent

string

The % fee that this payment type has for all payments

payments.feeAmount

number

The fee in cents the customer is paying. This is the flat fee + the feePercent multiplied by the payment amount.

payments.feeDescription

string | null

The description of the fee that was shown to the customer.

customer

object

The customer attached to this order. Will be an empty object {} if there is no customer associated with this order (i.e. it is an anonymous order)

Hide child attributes

customer.id

number

The ID of the customer

customer.firstName

string

The first name of the customer

customer.lastName

string

The last name of the customer

customer.email

string | null

The email of the customer

customer.phone

string | null

The phone of the customer

customer.birthday

string | null

The birthday of the customer

customer.hashId

string

An ID used to display to the customer and dispensary instead of the id number

customer.sex

string

One of male, female, tertiary

customer.zip

string | null

The postal code for the customer

customer.licenseExpiry

string | null

The expiration date of this customer’s drivers license or null if it is not recorded.

customer.medicalExpiration

string | null

The expiration date of this customer’s medical recommendation or null if they are an adult use customer

placedBy

object

The employee that created this order. Will be an empty object {} if this order was created by a customer and not an employee.

Hide child attributes

placedBy.id

number

The ID of the employee who created this order

placedBy.email

string

The email of the employee

placedBy.firstName

string

The first name of the employee

placedBy.lastName

string

The last name of the employee

fulfilledBy

object

The employee that fulfilled this order. Will be an empty object {} if there is no employee that fulfilled it.

Hide child attributes

fulfilledBy.id

number

The ID of the employee who fulfilled this order

fulfilledBy.email

string

The email of the employee

fulfilledBy.firstName

string

The first name of the employee

fulfilledBy.lastName

string

The last name of the employee

adjustments

object[]

Adjustments either made automatically such as even dollar rounding or custom adjustments by an employee

Hide child attributes

adjustments.amount

number

The amount of the adjustment in cents. May be either negative or positive.

adjustments.description

string

A description for the adjustment

adjustments.isTaxExemption

boolean

Set to true if this adjustment was automatically added to offset taxes that were included in the price of a product when a customer is tax exempt

adjustments.taxid

number

The ID of the tax exempted or null

credits

object[]

Credits used on this order

Hide child attributes

credits.creditId

number

The ID for the credit applied

credits.type

string

Either promo-code or store-credit

credits.amountUsed

number

The credit amount applied to the order in cents

credits.description

string

A description of the credit

discounts

object[]

The discounts applied to this order

Hide child attributes

discounts.discountId

number

The ID for this discount. This value will be null for a custom discount added by a budtender.

discounts.type

string

Either flat for a dollar amount or percent for a percent amount off

discounts.amount

number

The amount of the discount before being applied. Either in cents or a percent depending on the type.

discounts.amountUsed

number

The amount of the discount that was applied to the order represented in cents.

discounts.description

string

The description of the discount, which may be shown to the customer

loyaltyRedemptions

object[]

The loyalty redemptions used on this order

Hide child attributes

loyaltyRedemptions.type

string

One of cash-back, flat, percent, or free-product

loyaltyRedemptions.description

string

A description of the reward that was redeemed

loyaltyRedemptions.pointsRequirement

string

The minimum number of loyalty points required to redeem this reward

loyaltyRedemptions.pointsAmount

string

The amount of points used in this redemption

loyaltyRedemptions.discountAmount

string

The discount amount of the reward. For cash-back this is the amount in cents per point used. For flat it is a flat amount in cents, percent would be a percent off

loyaltyRedemptions.amountUsed

number

The amount of the discount applied to the order in cents

loyaltyRedemptions.productOptionId

number | null

The product option id for a free-product redemption

taxes

object[]

The taxes applied to this order

Hide child attributes

taxes.taxId

number

The ID for this tax

taxes.amount

number

The amount applied to the order in cents

taxes.description

string

A description of the tax

taxes.rate

string

A numeric value for the percentage of a tax

taxes.amountBeforeExemption

number

The amount of the tax as calculated before determining what was exempted in cents

taxes.amountExempted

number

The amount of the tax reduction due to an exemption in cents

taxes.included

boolean

Whether the amount of this tax was already included in the product of the line items

taxes.exemptable

boolean

Whether this tax is able to be exempted

taxes.tier

string

The order of tax compounding. Will be a value between 1 and 5 indicating the order the tax was applied. Each tier may have multiple taxes in it.

taxes.type

string

Either standard or california-excise

taxes.normalRate

string

The rate of this tax before it was overriden by an employee

returns

object[]

The returns applied to this order

Hide child attributes

returns.id

number

The ID of this return

returns.refundType

string

One of payment-method, store-credit or none

returns.refundInitial

number

The initial refund before taxes, credits, adjustments, loyalty, and discounts

returns.refundTotal

number

The final refund total of the return

returns.creditsTotal

number

The amount of credits refunded from the order

returns.discountsTotal

number

The amount of discounts refunded from the order

returns.adjustmentAmount

number

A manual adjustment of the refund for this return

returns.adjustmentDescription

string | null

A description for the adjustment if there is one

returns.paymentTypeName

string

The name of the payment type this refund was processed as

returns.loyaltyTotal

number

The amount of a loyalty redemption returned

returns.voidedAt

string | null

The date that this return was voided or null. If there is a value here, it means the return was canceled and is no longer applicable

returns.voidedReason

string | null

The reason this return was voided

returns.createdAt

string

The date this return was created

returns.lineItems

object[]

An array of line items for this return

Hide child attributes

returns.lineItems.orderLineItemId

number

The ID of the lineItems[].id that is being returned

returns.lineItems.type

string

Either return or exchange

returns.lineItems.inventoryAction

string

One of waste, inventory , or vendor.

returns.lineItems.quantity

number

The quantity of the order line item being returned

returns.lineItems.reason

string

A reason this line item is being returned

returns.lineItems.fulfillAs

object[]

Fulfillment information for the packages on this return. See lineItems[].fulfillAs for possible properties

returns.taxes

object[]

An array of tax information about this return

Hide child attributes

returns.taxes.amount

number

The amount of tax proportionally applied to this return

returns.taxes.description

string

A description of the tax

returns.taxes.refunded

boolean

A boolean of whether this tax was refunded to the customer or not

returns.taxes.rate

number

The tax rate

returns.taxes.included

boolean

Whether this tax was included in the price of the products

returns.taxes.exemptable

boolean

Whether this tax was exemptable or not

returns.createdBy

object

The employee that created this return

Hide child attributes

returns.createdBy.id

number

The id of the employee who created this return

returns.createdBy.email

string

The email of the employee

returns.createdBy.firstName

string

The first name of the employee

returns.createdBy.lastName

string

The last name of the employee

returns.voidedBy

object

The employee that voided this return (or {} if it is not voided)

Hide child attributes

returns.voidedBy.id

number

The id of the employee who voided this return

returns.voidedBy.email

string

The email of the employee

returns.voidedBy.firstName

string

The first name of the employee

returns.voidedBy.lastName

string

The last name of the employee

address

object

The address if this order is a delivery order. Otherwise, null

Hide child attributes

address.street1

string

address.street2

string | null

address.city

string

address.state

string

address.postalCode

string

shift

object

The shift this order is attached to. Otherwise null

Hide child attributes

shift.name

string | null

The name of the shift. This will most commonly be attributed to the name of the iPad station.

Inventory Retrieve an order

⌘I

Using the API

Guides

Endpoints: Analytics

Endpoints: Create Orders

Endpoints: Customers

Endpoints: Menu

Endpoints: Products & Inventory

Authorizations

Query Parameters

Response