GuidesAPI EndpointsChangelog
Log In
API Endpoints
These docs are for v2024.01. Click to read the latest docs for v2025.07.

Update an order

put
https://api-g.weedmaps.com/oos/2024-01/merchants//orders/

Update an order. This action is idempotent. For a Payload example, click on the examples dropdown and select the Request Example

Path Params
string
required

Weedmaps identifier representing the merchant

string
required

The Order ID. The party that generates the order decides the value for this field.

Body Params

The order

string

ID for the cart in which the order was generated from.

date-time
string
enum
Allowed:
customer
object
required
string

Free formed field for Customer to communicate to the Vendor.

deliveryPackages
array of objects

Array of packages encapsulating individual delivery tasks. Orders may be satisfied through multiple delivery tasks.

deliveryPackages
string
required
discounts
array of objects

Array of order level discounts

discounts
documents
array of objects

Documents supporting the order

documents
string
required
fees
array of objects
required

Array of fees applied to the order

fees*
string
enum

The customer selected attainment option.

Allowed:
string
required
date-time
string
enum

The license type under which this order will be completed

Allowed:
lineItems
array of objects
required
length ≥ 1

Array of order line items

lineItems*
string
required

Price after adjustments. Supersedes originalPrice if both have non null values.

string | null
string | null

Product external identifier as provided by POS

string
string | null
string
string

Item original price (gross)

integer
required
unitOfMeasure
object
string | null
string
enum
required

Product weight breakpoint (e.g 1/8th, unit, etc)

string

Weedmaps Product ID

Initially, this represents a product with multiple breakpoints, but it
will eventually represent a single breakpoint.

string
string

The Order ID. The party that generates the order decides the value for this field.

payments
array of objects
payments
string
seller
object

Information about the originating seller

shippingAddress
object | null

The destination for packages from the order

string
enum
required
Allowed:
string
enum
required

Current status for the order - READY_FOR_ATTAINMENT should be used when the order is ready for pickup or to send out for delivery.

string
required
string
required
taxes
array of objects
required

Array of taxes applied to the order

taxes*
boolean
date
required

Version release date

Headers
string
enum
Defaults to application/vnd.api+json

Generated from available response content types

Allowed:
Responses
204

No Content

Updated about 2 years ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.api+json
application/json
Updated about 2 years ago