Retrieve an order

cURL

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>'

{
  "data": {
    "id": "1471684654",
    "organizationId": 1,
    "totalPrice": 4000,
    "netPrice": 3140,
    "createdAt": "2022-12-15T21:13:14.500Z",
    "packedAt": null,
    "fulfilledAt": null,
    "customerGrandTotal": 3140,
    "type": "in-store",
    "source": "web-admin",
    "status": "new",
    "cancelationReason": null,
    "cancelAdminId": null,
    "canceledAt": null,
    "taxExempt": true,
    "refundTotal": 0,
    "isMedical": false,
    "customerName": null,
    "deliveryFee": null,
    "deliveryFeeDescription": null,
    "lineItems": [
      {
        "id": 1234,
        "quantity": 1,
        "productId": 398,
        "productName": "50 Dose Pen",
        "productUnit": "item",
        "productStrainType": "mixed",
        "optionId": 1112,
        "optionName": "Calm",
        "optionAmount": 1,
        "optionPrice": 4500,
        "optionSalesPrice": null,
        "productBrandId": 37,
        "productBrand": "Dosist",
        "unitPrice": 4500,
        "subtotalPrice": 4500,
        "finalPrice": 4000,
        "productMovingAverageCostPerUnit": null,
        "optionMovingAverageCostPerUnit": 25,
        "packageLineCost": null,
        "primaryCategory": {
          "id": 8,
          "name": "Flowers",
          "cannabisType": "non-concentrated"
        },
        "fulfillAs": [
          {
            "pkg": {
              "unit": "Grams",
              "label": "1A4FF0300000029000008338",
              "costPerUnit": "0"
            },
            "optionSum": -3,
            "productOptionId": 1112,
            "quantityFulfilled": "3"
          }
        ],
        "discounts": [
          {
            "discountId": 29,
            "type": "flat",
            "amount": 500,
            "amountUsed": 500,
            "description": "$ 5 Discount"
          }
        ]
      }
    ],
    "payments": [
      {
        "id": 1547,
        "paymentTypeId": 1,
        "amount": 3140,
        "finalAmount": 3140,
        "name": "Cash",
        "fee": 0,
        "feePercent": "0",
        "feeAmount": 0,
        "feeDescription": null
      }
    ],
    "customer": {},
    "placedBy": {
      "id": 1,
      "email": "[email protected]",
      "firstName": "Rick",
      "lastName": "Harrison"
    },
    "fulfilledBy": {
      "id": 2983,
      "email": "[email protected]",
      "firstName": "Rick",
      "lastName": "Harrison"
    },
    "adjustments": [
      {
        "amount": -327,
        "description": "City Tax Exemption",
        "isTaxExemption": true,
        "taxId": 134
      }
    ],
    "credits": [
      {
        "creditId": 361,
        "type": "store-credit",
        "amountUsed": 133,
        "description": "Store credit"
      }
    ],
    "discounts": [
      {
        "discountId": 7,
        "type": "percent",
        "amount": 10,
        "amountUsed": 400,
        "description": "Seniors"
      }
    ],
    "loyaltyRedemptions": [
      {
        "type": "cash-back",
        "description": "2% Cash Back",
        "pointsRequirement": "1",
        "pointsAmount": "-500.0",
        "discountAmount": "2",
        "amountUsed": 1000,
        "productOptionId": null
      }
    ],
    "taxes": [
      {
        "taxId": 59,
        "amount": 0,
        "description": "State Sales Tax",
        "rate": "9.5",
        "amountBeforeExemption": 311,
        "amountExempted": 311,
        "included": false,
        "exemptable": true,
        "tier": "1",
        "type": "standard",
        "normalRate": "9.5"
      },
      {
        "taxId": 134,
        "amount": 0,
        "description": "City Tax (Included)",
        "rate": "10",
        "amountBeforeExemption": 327,
        "amountExempted": 327,
        "included": true,
        "exemptable": true,
        "tier": "1",
        "type": "standard",
        "normalRate": "10"
      }
    ],
    "returns": [
      {
        "id": 364,
        "refundType": "payment-method",
        "refundInitial": -4500,
        "refundTotal": -4905,
        "creditsTotal": 0,
        "discountsTotal": 0,
        "adjustmentAmount": 0,
        "adjustmentDescription": "",
        "paymentTypeName": "Cash",
        "loyaltyTotal": 0,
        "voidedAt": "2023-05-04T20:48:41.508Z",
        "voidedReason": "void reason here",
        "createdAt": "2023-05-04T20:34:48.387Z",
        "lineItems": [
          {
            "orderLineItemId": 15368,
            "type": "return",
            "inventoryAction": "waste",
            "quantity": 1,
            "reason": "Product was defective",
            "fulfillAs": []
          }
        ],
        "taxes": [
          {
            "taxId": 59,
            "amount": -225,
            "description": "State Sales Tax",
            "refunded": true,
            "rate": "5",
            "included": false,
            "exemptable": false,
            "type": "standard",
            "tier": "1"
          },
          {
            "taxId": 134,
            "amount": -180,
            "description": "City Tax (Included)",
            "refunded": true,
            "rate": "10",
            "included": false,
            "exemptable": false,
            "type": "standard",
            "tier": "1"
          }
        ],
        "createdBy": {
          "id": 1,
          "email": "[email protected]",
          "firstName": "Rick",
          "lastName": "Harrison"
        },
        "voidedBy": {
          "id": 1,
          "email": "[email protected]",
          "firstName": "Rick",
          "lastName": "Harrison"
        }
      }
    ],
    "address": null,
    "shift": {
      "name": "POS Station 3"
    }
  }
}

GET

api

orders

{orderId}

detail

cURL

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>'

{
  "data": {
    "id": "1471684654",
    "organizationId": 1,
    "totalPrice": 4000,
    "netPrice": 3140,
    "createdAt": "2022-12-15T21:13:14.500Z",
    "packedAt": null,
    "fulfilledAt": null,
    "customerGrandTotal": 3140,
    "type": "in-store",
    "source": "web-admin",
    "status": "new",
    "cancelationReason": null,
    "cancelAdminId": null,
    "canceledAt": null,
    "taxExempt": true,
    "refundTotal": 0,
    "isMedical": false,
    "customerName": null,
    "deliveryFee": null,
    "deliveryFeeDescription": null,
    "lineItems": [
      {
        "id": 1234,
        "quantity": 1,
        "productId": 398,
        "productName": "50 Dose Pen",
        "productUnit": "item",
        "productStrainType": "mixed",
        "optionId": 1112,
        "optionName": "Calm",
        "optionAmount": 1,
        "optionPrice": 4500,
        "optionSalesPrice": null,
        "productBrandId": 37,
        "productBrand": "Dosist",
        "unitPrice": 4500,
        "subtotalPrice": 4500,
        "finalPrice": 4000,
        "productMovingAverageCostPerUnit": null,
        "optionMovingAverageCostPerUnit": 25,
        "packageLineCost": null,
        "primaryCategory": {
          "id": 8,
          "name": "Flowers",
          "cannabisType": "non-concentrated"
        },
        "fulfillAs": [
          {
            "pkg": {
              "unit": "Grams",
              "label": "1A4FF0300000029000008338",
              "costPerUnit": "0"
            },
            "optionSum": -3,
            "productOptionId": 1112,
            "quantityFulfilled": "3"
          }
        ],
        "discounts": [
          {
            "discountId": 29,
            "type": "flat",
            "amount": 500,
            "amountUsed": 500,
            "description": "$ 5 Discount"
          }
        ]
      }
    ],
    "payments": [
      {
        "id": 1547,
        "paymentTypeId": 1,
        "amount": 3140,
        "finalAmount": 3140,
        "name": "Cash",
        "fee": 0,
        "feePercent": "0",
        "feeAmount": 0,
        "feeDescription": null
      }
    ],
    "customer": {},
    "placedBy": {
      "id": 1,
      "email": "[email protected]",
      "firstName": "Rick",
      "lastName": "Harrison"
    },
    "fulfilledBy": {
      "id": 2983,
      "email": "[email protected]",
      "firstName": "Rick",
      "lastName": "Harrison"
    },
    "adjustments": [
      {
        "amount": -327,
        "description": "City Tax Exemption",
        "isTaxExemption": true,
        "taxId": 134
      }
    ],
    "credits": [
      {
        "creditId": 361,
        "type": "store-credit",
        "amountUsed": 133,
        "description": "Store credit"
      }
    ],
    "discounts": [
      {
        "discountId": 7,
        "type": "percent",
        "amount": 10,
        "amountUsed": 400,
        "description": "Seniors"
      }
    ],
    "loyaltyRedemptions": [
      {
        "type": "cash-back",
        "description": "2% Cash Back",
        "pointsRequirement": "1",
        "pointsAmount": "-500.0",
        "discountAmount": "2",
        "amountUsed": 1000,
        "productOptionId": null
      }
    ],
    "taxes": [
      {
        "taxId": 59,
        "amount": 0,
        "description": "State Sales Tax",
        "rate": "9.5",
        "amountBeforeExemption": 311,
        "amountExempted": 311,
        "included": false,
        "exemptable": true,
        "tier": "1",
        "type": "standard",
        "normalRate": "9.5"
      },
      {
        "taxId": 134,
        "amount": 0,
        "description": "City Tax (Included)",
        "rate": "10",
        "amountBeforeExemption": 327,
        "amountExempted": 327,
        "included": true,
        "exemptable": true,
        "tier": "1",
        "type": "standard",
        "normalRate": "10"
      }
    ],
    "returns": [
      {
        "id": 364,
        "refundType": "payment-method",
        "refundInitial": -4500,
        "refundTotal": -4905,
        "creditsTotal": 0,
        "discountsTotal": 0,
        "adjustmentAmount": 0,
        "adjustmentDescription": "",
        "paymentTypeName": "Cash",
        "loyaltyTotal": 0,
        "voidedAt": "2023-05-04T20:48:41.508Z",
        "voidedReason": "void reason here",
        "createdAt": "2023-05-04T20:34:48.387Z",
        "lineItems": [
          {
            "orderLineItemId": 15368,
            "type": "return",
            "inventoryAction": "waste",
            "quantity": 1,
            "reason": "Product was defective",
            "fulfillAs": []
          }
        ],
        "taxes": [
          {
            "taxId": 59,
            "amount": -225,
            "description": "State Sales Tax",
            "refunded": true,
            "rate": "5",
            "included": false,
            "exemptable": false,
            "type": "standard",
            "tier": "1"
          },
          {
            "taxId": 134,
            "amount": -180,
            "description": "City Tax (Included)",
            "refunded": true,
            "rate": "10",
            "included": false,
            "exemptable": false,
            "type": "standard",
            "tier": "1"
          }
        ],
        "createdBy": {
          "id": 1,
          "email": "[email protected]",
          "firstName": "Rick",
          "lastName": "Harrison"
        },
        "voidedBy": {
          "id": 1,
          "email": "[email protected]",
          "firstName": "Rick",
          "lastName": "Harrison"
        }
      }
    ],
    "address": null,
    "shift": {
      "name": "POS Station 3"
    }
  }
}

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

Path Parameters

orderId

string

required

ID of order to retrieve

Response

Orders detail 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

Show child attributes

payments

object[]

All of the payments applied to this order

Show child attributes

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)

Show child attributes

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.

Show child attributes

fulfilledBy

object

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

Show child attributes

adjustments

object[]

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

Show child attributes

credits

object[]

Credits used on this order

Show child attributes

discounts

object[]

The discounts applied to this order

Show child attributes

loyaltyRedemptions

object[]

The loyalty redemptions used on this order

Show child attributes

taxes

object[]

The taxes applied to this order

Show child attributes

returns

object[]

The returns applied to this order

Show child attributes

address

object

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

Show child attributes

shift

object

The shift this order is attached to. Otherwise null

Show child attributes

List orders List order returns

⌘I

Using the API

Guides

Endpoints: Analytics

Endpoints: Create Orders

Endpoints: Customers

Endpoints: Menu

Endpoints: Products & Inventory

Authorizations

Path Parameters

Response