Guides
Endpoints: Analytics
Endpoints: Create Orders
Endpoints: Customers
Endpoints: Menu
curl --request GET \
--url https://api-staging.getmeadow.com/api/v1/orders/{orderId}/detail \
--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>"
}
}Retrieve an order
Retrieve information about a specific order
curl --request GET \
--url https://api-staging.getmeadow.com/api/v1/orders/{orderId}/detail \
--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
The key assigned to your company and provided via Meadow
The key generated and provided by our mutual client
Path Parameters
ID of order to retrieve
Response
Orders detail response
The ID of the order
The subtotal price before discounts, credits, adjustments are taken into account.
The final price of the order before payment & delivery fees. Includes taxes
The final price of the order after all fees
The datetime the order was created
The datetime the order was packed on
The date the order was fulfilled
The type of this order
delivery, pickup, in-store The status of the order.
draftis an order submitted without inventory taken outnewis an order that has had inventory associated with itpackedsignifies an order has been processed and is waiting for pickup/deliveryfulfilledis an order that has been fully completedcanceledis an order that has been canceled
draft, new, packed, fulfilled, canceled A description of why the order was canceled
When the order was canceled
Whether this order was marked as tax exempt or not
The amount refunded by returns on this order
Whether this order was for a medical customer or not
The name of the customer for express pickup or kiosk orders.
The delivery fee for the order
A description of the delivery fee that can be shown to the customer
All of the products purchased with this order
Hide child attributes
Hide child attributes
The ID of this line item
The quantity of this line item
The id of the product purchased
The name of the product purchased
The id of the product option purchased
The name of the product option
The price of the product option at time of purchase
The sales price of the product option at time of purchase if it was on sale
The brand id of the product
The name of the brand of the product
The price per unit of this line item
The subtotal of this line item before discounts
The final price for this line item after all discounts
The moving average cost per unit of the product
The moving average cost per unit of the product option
The total cost for all metrc packages used to fulfill this line item
An array of discounts applied to this line item (may be empty)
Hide child attributes
Hide child attributes
The ID for this discount. This value will be null for a custom discount added by a budtender
Either flat for a dollar amount or percent for a percent amount off
The amount of the discount before being applied. Either in cents or a percent depending on the type.
The amount that was taken off of the line item by this discount, represented in cents
The description of the discount, which may be shown to the customer
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
Hide child attributes
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
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.
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.
The quantity of the underlying lineItem that this fulfillment is responsible for
All of the payments applied to this order
Hide child attributes
Hide child attributes
The ID of this payment
The ID of the payment type used for this payment
The amount of the payment before fees in cents
The final amount of the payment after fees are included
The name of the payment type being used to make this payment
The amount of a flat fee in cents added to this payment
The % fee that this payment type has for all payments
The fee in cents the customer is paying. This is the flat fee + the feePercent multiplied by the payment amount.
The description of the fee that was shown to the customer.
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
Hide child attributes
The ID of the customer
The first name of the customer
The last name of the customer
The email of the customer
The phone of the customer
The birthday of the customer
An ID used to display to the customer and dispensary instead of the id number
One of male, female, tertiary
The postal code for the customer
The expiration date of this customer’s drivers license or null if it is not recorded.
The expiration date of this customer’s medical recommendation or null if they are an adult use customer
The employee that created this order. Will be an empty object {} if this order was created by a customer and not an employee.
The employee that fulfilled this order. Will be an empty object {} if there is no employee that fulfilled it.
Adjustments either made automatically such as even dollar rounding or custom adjustments by an employee
Hide child attributes
Hide child attributes
The amount of the adjustment in cents. May be either negative or positive.
A description for the adjustment
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
The ID of the tax exempted or null
The discounts applied to this order
Hide child attributes
Hide child attributes
The ID for this discount. This value will be null for a custom discount added by a budtender.
Either flat for a dollar amount or percent for a percent amount off
The amount of the discount before being applied. Either in cents or a percent depending on the type.
The amount of the discount that was applied to the order represented in cents.
The description of the discount, which may be shown to the customer
The loyalty redemptions used on this order
Hide child attributes
Hide child attributes
One of cash-back, flat, percent, or free-product
A description of the reward that was redeemed
The minimum number of loyalty points required to redeem this reward
The amount of points used in this redemption
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
The amount of the discount applied to the order in cents
The product option id for a free-product redemption
The taxes applied to this order
Hide child attributes
Hide child attributes
The ID for this tax
The amount applied to the order in cents
A description of the tax
A numeric value for the percentage of a tax
The amount of the tax as calculated before determining what was exempted in cents
The amount of the tax reduction due to an exemption in cents
Whether the amount of this tax was already included in the product of the line items
Whether this tax is able to be exempted
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.
Either standard or california-excise
The rate of this tax before it was overriden by an employee
The returns applied to this order
Hide child attributes
Hide child attributes
The ID of this return
One of payment-method, store-credit or none
The initial refund before taxes, credits, adjustments, loyalty, and discounts
The final refund total of the return
The amount of credits refunded from the order
The amount of discounts refunded from the order
A manual adjustment of the refund for this return
A description for the adjustment if there is one
The name of the payment type this refund was processed as
The amount of a loyalty redemption returned
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
The reason this return was voided
The date this return was created
An array of line items for this return
Hide child attributes
Hide child attributes
The ID of the lineItems[].id that is being returned
Either return or exchange
One of waste, inventory , or vendor.
The quantity of the order line item being returned
A reason this line item is being returned
Fulfillment information for the packages on this return. See lineItems[].fulfillAs for possible properties
An array of tax information about this return
Hide child attributes
Hide child attributes
The amount of tax proportionally applied to this return
A description of the tax
A boolean of whether this tax was refunded to the customer or not
The tax rate
Whether this tax was included in the price of the products
Whether this tax was exemptable or not
The employee that created this return
The employee that voided this return (or {} if it is not voided)