We continue to enhance our ordering system, and the Order object may change over time. Multiple versions of the Order object may become available when breaking changes are unavoidable.
As an integrated platform, you will need to specify which version of the Order object you want to receive in callbacks, and which version is included in an update request.
The following changes are considered to be backwards-compatible:
Adding new API resources
Adding new optional request parameters to existing API methods
Adding new properties to existing API responses
Changing the order of properties in existing API responses
Changing the length or format of opaque strings, such as object IDs, error messages, and other human-readable strings
Adding or removing fixed prefixes (such as
Adding new event types (your webhook listener should gracefully handle unfamiliar event types)
📘 You can safely assume the object IDs we generate will never exceed 255 characters, but you should be able to handle IDs of up to that length. If, for example, you’re using MySQL, you should store IDs in a VARCHAR(255) COLLATE utf8_bin column (the COLLATE configuration ensures case-sensitivity in lookups).
JSON
Scroll down for code samples, example requests, and responses.
Name Type Required Restrictions Description id string false none none firstName string true none none lastName string true none none phone string¦null false none none dob string(date) true none YYYY-MM-DD hasMedicalRecommendation boolean false none none medicalRecommendation MedicalRecommendation false none none
Name Type Required Restrictions Description id string false none none expires string(date)¦null false none none caregiverId string false none none province string false none none
The Order's Customer ID — This value is provided by the party that created the order.
Name Type Required Restrictions Description anonymous string false none The Order's Customer ID.
Name Type Required Restrictions Description appliesTo string true none What part of the order the discount applies to. discountType string false none none value string(decimal) false none The discount value, either monetary amount or percentage. For example, 5% would be "5". $2.00 would be "2.00". amount string(decimal) false none The total amount of discount applied description string false none none discountCode string false none none
Property Value appliesTo DELIVERY_FEE appliesTo WM_SERVICE_FEE appliesTo SUBTOTAL discountType FIXED_AMOUNT discountType PERCENTAGE
Name Type Required Restrictions Description documentType string false none none url string(uri) false none none
Property Value documentType MEDICAL_RECOMMENDATION documentType GOVERNMENT_ISSUED_ID
Name Type Required Restrictions Description name string false none none feeType string false none Fee type. Delivery fee will be DELIVERY_FEE. amount string(decimal) false none none
Name Type Required Restrictions Description id string false none none externalId string true none Product external identifier as provided by POS wmProductId string false none Weedmaps Product ID name string true none none weightBreakpoint* string true none Product weight breakpoint (such as 1/8th, unit, and so on) brand string false none none quantity integer true none quantity of units for this line item. If set to zero, the line item is rendered as unavailable originalPrice string(decimal) false none Item original price (gross) adjustedPrice string(decimal) true none Price after adjustments. Supersedes originalPrice if both have non-null values. This is the value rendered to the customer as the amount they will pay for this line item per single unit quantity. url string false none none imageUrl string false none none unitOfMeasure UnitOfMeasure false none The unit of measure for the line item
*deprecation note: unitOfMeasure will be replacing weightBreakpoint in the future. For now, when wightBreakpoint has a value of CUSTOM unitOfMeasure should be populated.
Property Value weightBreakpoint UNIT weightBreakpoint HALF_GRAM weightBreakpoint GRAM weightBreakpoint TWO_GRAM weightBreakpoint EIGHTH_OUNCE weightBreakpoint QUARTER_OUNCE weightBreakpoint HALF_OUNCE weightBreakpoint OUNCE weightBreakpoint CUSTOM
Name Type Required Restrictions Description unit string true none Units for the unit of measure of the product value integer true none Number of the units above in the unit of measure
Weedmaps identifier representing the merchant
Name Type Required Restrictions Description anonymous string false none Weedmaps identifier representing the merchant
Name Type Required Restrictions Description orderId OrderId false none The Order ID. The party that generates the order decides the value for this field. version string(date) true none Version release date status string true none Current status for the order - READY_FOR_ATTAINMENT should be used when the order is ready for pickup or to send out for delivery. createdAt string(date-time) false none none lastModifiedAt string(date-time) false none none currency string false none none customer Customer true Required for Order updates but not required during a Draft response Customer information seller Seller false none Information about the originating seller customerNote string false none Free-form field for Customer to communicate to the Vendor documents [Document ] false none Documents supporting the order lineItems [LineItem ] true none A non empty array of line items discounts [Discount ] false none Array of order level discounts taxes [Tax ] true none Array of taxes applied to the order. An empty array is acceptable fees [Fee ] true none Array of fees applied to the order. An empty array is acceptable fulfillmentMethod string false none The customer selected attainment option deliveryPackages [Package ] false none Array of packages encapsulating individual delivery tasks. Orders may be satisfied through multiple delivery tasks. payments [PaymentMethod ] false none none requestedSchedulingInfo Schedule Information false none If the user selected a scheduled window then this object will be non-null. If there is no selected scheduled window then this will be null. shippingAddress ShippingAddress false none The destination for packages from the order source string true none none subtotal string(decimal) true none none feeTotal string(decimal) true none none discountTotal string(decimal) true none none taxTotal string(decimal) true none none grandTotal string(decimal) true none none
Property Value status DRAFT status PENDING status IN_PROGRESS status READY_FOR_ATTAINMENT status COMPLETE status CANCELED_CUSTOMER status CANCELED_SELLER currency USD currency CAD fulfillmentMethod PICKUP fulfillmentMethod DELIVERY source WEEDMAPS
The Order ID — The party that generates the order decides the value for this field.
Name Type Required Restrictions Description anonymous string false none The Order ID. The party that generates the order decides the value for this field.
📘 As of May 27, 2020, this is reserved for future use.
Name Type Required Restrictions Description serviceIdentifier string false none Custom identifier for the delivery service utilized, set by the POS id string false none Identifier for the package/tasks record in the delivery service utilized statusUrl string false none Fully formed URL intended to be presented to the customer/patient to view a more detailed status of their delivery
Name Type Required Restrictions Description paymentType string false none none amount string(decimal) false none none processor string false none none transactionId string false none none
Property Value paymentType CASH paymentType CREDIT paymentType DEBIT processor MERRCO
Name Type Required Restrictions Description windowStartAt UTC DateTime in ISO 8601 format true none This date time represents the start of the time window the user selected for their order, required if the 'requestedSchedulingInfo' field is non null windowEndAt UTC DateTime in ISO 8601 format true none This date time represents the end of the time window the user selected for their order, required if the 'requestedSchedulingInfo' field is non null
Information about the originating seller
Name Type Required Restrictions Description id string false none If this originates from WM, it will be the Listing ID name string false none The listing name address1 string false none none address2 string¦null false none none city string false none none province string false none Two-letter state or province code countryCode string false none none phone string false none none postalCode string false none none
Property Value countryCode US countryCode CA
The destination for packages from the order
Name Type Required Restrictions Description address1 string false none none address2 string false none none city string false none none province string false none Two-letter state or province code county string false none Name of the county or similar regional locality countryCode string false none none postalCode string false none none latitude string false none none longitude string false none none
Property Value countryCode US countryCode CA
Name Type Required Restrictions Description name string false none none taxType string false none none amount string(decimal) false none none
Property Value taxType EXCISE taxType SALES
