post https://api.server.test/v1/public/integrations/subscribe
IN DEVELOPMENT: This endpoint subscribes integrations to webhook events. Once
subscribed, events will trigger a POST callback to an integrator for the
subscriber. Note that this endpoint is not currently accessible externally.
ORDER CALLBACKS
post{$request.body#/callbackUrl}
This is a synchronous call for verifying the customer's order totals and item availability prior to submitting the order to the integration.
Request body
Example Value / Schema
{
"orderId": "99998888000",
"version": "2020-04-20",
"status": "IN_PROGRESS",
"createdAt": "2020-04-20T16:20:00Z",
"lastModifiedAt": "2020-04-20T16:20:00Z",
"currency": "USD",
"customer": {
"id": "123456789",
"firstName": "Geovanni",
"lastName": "Feil",
"phone": "+15555556852",
"dob": "1980-01-01",
"hasMedicalRecommendation": false,
"medicalRecommendation": {
"id": "123456789",
"expires": "2025-01-01",
"caregiverId": "12345",
"province": "CA"
}
},
"seller": {
"id": "string",
"address1": "4 Pacocha Groves",
"address2": "Apt. 307",
"city": "Barrett",
"province": "NY",
"countryCode": "US",
"phone": "+15555556852",
"postalCode": "10000"
},
"customerNote": "I'll pick it up tomorrow",
"documents": [
{
"documentType": "GOVERNMENT_ISSUED_ID",
"url": "https://example.com/photo.jpg?sig=1234abc"
}
],
"lineItems": [
{
"id": "123456789",
"externalId": "abc12345",
"wmProductId": "123456789",
"name": "Mendo Berries Refined Live Resin™ 0.5g Cartridge",
"weightBreakpoint": "GRAM",
"brand": "Raw Garden™",
"quantity": 2,
"originalPrice": "99.99",
"adjustedPrice": "75.99",
"url": "https://weedmaps.com/dispensaries/awesome-dispensary/menu/golden-pineapple",
"imageUrl": "https://images.weedmaps.com/products/000/106/848/avatar/large/1563555258-RG-vapecart-01.jpg"
}
],
"discounts": [
{
"appliesTo": "SUBTOTAL",
"discountType": "PERCENTAGE",
"value": "5",
"amount": "4.99",
"description": "5% off flower",
"discountCode": "5FLOWER"
}
],
"taxes": [
{
"name": "City excise tax",
"taxType": "EXCISE",
"amount": "4.99"
}
],
"fees": [
{
"name": "Weedmaps Service/Tech Fee",
"feeType": "wm_service_fee",
"amount": "4.99"
}
],
"fulfillmentMethod": "DELIVERY",
"deliveryPackages": [
{
"serviceIdentifier": "DISPATCH",
"id": "A8919616",
"statusUrl": "https://dispatch.weedmaps.com/A8919616/status"
}
],
"payments": [
{
"paymentType": "CASH",
"amount": "99.99"
}
],
"shippingAddress": {
"address1": "4 Pacocha Groves",
"address2": "Apt. 307",
"city": "Barrett",
"province": "WY",
"countryCode": "US",
"postalCode": "10000",
"latitude": "33.666633",
"longitude": "-117.7584978"
},
"source": "WEEDMAPS",
"subtotal": "99.99",
"feeTotal": "4.99",
"discountTotal": "4.99",
"taxTotal": "4.99",
"grandTotal": "99.99"
}
Responses
Code | Description |
|---|---|
200 | OK |
Response body
Example Value / Schema
{
"orderId": "99998888000",
"version": "2020-04-20",
"status": "IN_PROGRESS",
"createdAt": "2020-04-20T16:20:00Z",
"lastModifiedAt": "2020-04-20T16:20:00Z",
"currency": "USD",
"customer": {
"id": "123456789",
"firstName": "Geovanni",
"lastName": "Feil",
"phone": "+15555556852",
"dob": "1980-01-01",
"hasMedicalRecommendation": false,
"medicalRecommendation": {
"id": "123456789",
"expires": "2025-01-01",
"caregiverId": "12345",
"province": "CA"
}
},
"seller": {
"id": "string",
"address1": "4 Pacocha Groves",
"address2": "Apt. 307",
"city": "Barrett",
"province": "NY",
"countryCode": "US",
"phone": "+15555556852",
"postalCode": "10000"
},
"customerNote": "I'll pick it up tomorrow",
"documents": [
{
"documentType": "GOVERNMENT_ISSUED_ID",
"url": "https://example.com/photo.jpg?sig=1234abc"
}
],
"lineItems": [
{
"id": "123456789",
"externalId": "abc12345",
"wmProductId": "123456789",
"name": "Mendo Berries Refined Live Resin™ 0.5g Cartridge",
"weightBreakpoint": "GRAM",
"brand": "Raw Garden™",
"quantity": 2,
"originalPrice": "99.99",
"adjustedPrice": "75.99",
"url": "https://weedmaps.com/dispensaries/awesome-dispensary/menu/golden-pineapple",
"imageUrl": "https://images.weedmaps.com/products/000/106/848/avatar/large/1563555258-RG-vapecart-01.jpg"
}
],
"discounts": [
{
"appliesTo": "SUBTOTAL",
"discountType": "PERCENTAGE",
"value": "5",
"amount": "4.99",
"description": "5% off flower",
"discountCode": "5FLOWER"
}
],
"taxes": [
{
"name": "City excise tax",
"taxType": "EXCISE",
"amount": "4.99"
}
],
"fees": [
{
"name": "Weedmaps Service/Tech Fee",
"feeType": "wm_service_fee",
"amount": "4.99"
}
],
"fulfillmentMethod": "DELIVERY",
"deliveryPackages": [
{
"serviceIdentifier": "DISPATCH",
"id": "A8919616",
"statusUrl": "https://dispatch.weedmaps.com/A8919616/status"
}
],
"payments": [
{
"paymentType": "CASH",
"amount": "99.99"
}
],
"shippingAddress": {
"address1": "4 Pacocha Groves",
"address2": "Apt. 307",
"city": "Barrett",
"province": "WY",
"countryCode": "US",
"postalCode": "10000",
"latitude": "33.666633",
"longitude": "-117.7584978"
},
"source": "WEEDMAPS",
"subtotal": "99.99",
"feeTotal": "4.99",
"discountTotal": "4.99",
"taxTotal": "4.99",
"grandTotal": "99.99"
}
post{$request.body#/callbackUrl}
This is an asynchronous call for submitting a customer's order for an integration.
{
"orderId": "99998888000",
"version": "2020-04-20",
"status": "IN_PROGRESS",
"createdAt": "2020-04-20T16:20:00Z",
"lastModifiedAt": "2020-04-20T16:20:00Z",
"currency": "USD",
"customer": {
"id": "123456789",
"firstName": "Geovanni",
"lastName": "Feil",
"phone": "+15555556852",
"dob": "1980-01-01",
"hasMedicalRecommendation": false,
"medicalRecommendation": {
"id": "123456789",
"expires": "2025-01-01",
"caregiverId": "12345",
"province": "CA"
}
},
"seller": {
"id": "string",
"address1": "4 Pacocha Groves",
"address2": "Apt. 307",
"city": "Barrett",
"province": "NY",
"countryCode": "US",
"phone": "+15555556852",
"postalCode": "10000"
},
"customerNote": "I'll pick it up tomorrow",
"documents": [
{
"documentType": "GOVERNMENT_ISSUED_ID",
"url": "https://example.com/photo.jpg?sig=1234abc"
}
],
"lineItems": [
{
"id": "123456789",
"externalId": "abc12345",
"wmProductId": "123456789",
"name": "Mendo Berries Refined Live Resin™ 0.5g Cartridge",
"weightBreakpoint": "GRAM",
"brand": "Raw Garden™",
"quantity": 2,
"originalPrice": "99.99",
"adjustedPrice": "75.99",
"url": "https://weedmaps.com/dispensaries/awesome-dispensary/menu/golden-pineapple",
"imageUrl": "https://images.weedmaps.com/products/000/106/848/avatar/large/1563555258-RG-vapecart-01.jpg"
}
],
"discounts": [
{
"appliesTo": "SUBTOTAL",
"discountType": "PERCENTAGE",
"value": "5",
"amount": "4.99",
"description": "5% off flower",
"discountCode": "5FLOWER"
}
],
"taxes": [
{
"name": "City excise tax",
"taxType": "EXCISE",
"amount": "4.99"
}
],
"fees": [
{
"name": "Weedmaps Service/Tech Fee",
"feeType": "wm_service_fee",
"amount": "4.99"
}
],
"fulfillmentMethod": "DELIVERY",
"deliveryPackages": [
{
"serviceIdentifier": "DISPATCH",
"id": "A8919616",
"statusUrl": "https://dispatch.weedmaps.com/A8919616/status"
}
],
"payments": [
{
"paymentType": "CASH",
"amount": "99.99"
}
],
"shippingAddress": {
"address1": "4 Pacocha Groves",
"address2": "Apt. 307",
"city": "Barrett",
"province": "WY",
"countryCode": "US",
"postalCode": "10000",
"latitude": "33.666633",
"longitude": "-117.7584978"
},
"source": "WEEDMAPS",
"subtotal": "99.99",
"feeTotal": "4.99",
"discountTotal": "4.99",
"taxTotal": "4.99",
"grandTotal": "99.99"
}
Responses
Code | Description |
|---|---|
200 | OK |
201 | Order created |
204 | No Content |