Changelog

Adds ability to retrieve a customer via email or phone to GET /api/v1/customers/{identifier}

Adds availableDelivery to GET /api/v1/payment-types

Adds onfleetTask and apiConsumerName to GET /api/v1/orders and GET /api/v1/orders/{orderId}/detail

Adds GET /api/v1/packages
Adds GET /api/v1/packages/{label}

Adds POST /api/v1/documents/{customerId}/{documentType}

Adds POST /api/v1/loyalty-events

Adds shift to response body of GET /api/v1/orders and GET /api/v1/orders/{orderId}/detail

Adds new endpoint: GET /api/v1/compliance-transfers

Adds address to response body of GET /api/v1/orders and GET /api/v1/orders/{orderId}/detail

Adds userId query parameter to GET /api/v1/orders
Adds customer object to response body of POST /api/v1/orders

Meadow added support for multiple payments on a single order from our e-commerce menu and iPad point of sale. Please look at the following changes to support multiple payments:

Adds payments property to GET /api/v1/orders
Adds payments property to GET /api/v1/orders/{orderId}/detail

We’ve added a slew of new endpoints to our Products & Inventory section. This will allow you to create purchase orders for a client along with all of their associated product information.

Adds POST /api/v1/products
Adds PUT /api/v1/products/{productId}
Adds PUT /api/v1/products/{productId}/options
Adds GET /api/v1/product-categories
Adds GET /api/v1/product-sub-categories
Adds POST /api/v1/purchase-orders
Adds PUT /api/v1/purchase-orders/{purchaseOrderId}

Adds type query parameter to GET /api/v1/orders

Adds primaryCategory to order line items returned from GET /api/v1/orders and GET /api/v1/orders/{orderId}/detail

Adds sortBy query parameter to GET /api/v1/customers
Adds GET /api/v1/order-returns

Adds GET /api/v1/purchase-orders

Adds GET /api/v1/orders/{orderId}/detail
Adds GET /api/v1/customers/{customerId}
Adds GET /api/v1/inventory-locations
Adds fulfilledOnly query parameter to GET /api/v1/orders
- When set to true, only fulfilled orders will be returned in reverse chronological order

Adds the following fields to GET /api/v1/customers

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

Adds the following fields to GET /api/v1/orders

customer.licenseExpiry - The expiration date of this customer’s drivers license or null if it is not recorded.
customer.medicalExpiration - The expiration date of their medical recommendation or null if they are an adult use customer

Adds the following fields to GET /api/v1/customers

marketingOptIn - Whether this customer has opted in to receive marketing
marketingOptInAt - When the customer opted in if they did

Adds the following fields to GET /api/v1/customers

updatedAt - The time this customer was last updated
customerGroups An array of strings for customer groups this customer is a part of (Example: Veterans, Seniors, etc.)
medicalExpiration - The expiration date of their medical recommendation or null if they are an adult use customer

Adds the following fields to GET /api/v1/orders

returns - Please see documentation for full definition
lineItems[].fulfillAs - Please see documentation for full definition

Using the API

Guides

Endpoints: Analytics

Endpoints: Create Orders

Endpoints: Customers

Endpoints: Menu

Endpoints: Products & Inventory