How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
LeafLink

LeafLink API

The current LeafLink REST API, version 2022-10-31. 182 paths and 269 operations covering products and catalog, customers, brands, inventory (CQRS commands + measurement queries), payments and invoices, logistics and transportation, traceability, compliance and licensing, taxes, pricing and chats. JSON only, snake_case, JWT bearer auth, date-versioned via the LeafLink-Version header.

Documentation Provider Profile APIs.io OpenAPI GitHub

LeafLink API is one of 2 APIs that LeafLink publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Cannabis, Wholesale, Marketplace, Inventory, and Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and rate-limit docs.

This API exposes 269 operations across 182 paths, organized into 64 resource areas, and defines 415 schemas. It is described by OpenAPI 3.0.3, at version 2022-10-31.

Requests are made against 2 base URLs: https://api.leaflink.com, https://staging-api.leaflink.com.

269 operations 182 paths 415 schemas 21 DELETE150 GET30 PATCH58 POST10 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2022-10-31
Base URL
https://api.leaflink.com
Authentication
HTTP Bearer, API Key
Contact
support@leaflink.com
Terms of Service
View terms
Resource Areas
64

Authentication & Security 2

LeafLink API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as Authorization (tokenAuth). By default, every request must be authenticated.

  • bearerAuth — Authentication is done via access tokens (JWTs). See the [API authentication doc](/api/getting-started/authentication) for more information.
  • tokenAuth — Token-based authentication with required prefix "Token"

Paths & Operations 269

Across 182 paths, the API surfaces 269 operations — 21 DELETE, 150 GET, 30 PATCH, 58 POST, 10 PUT. They span 64 resource areas, including Company, Invoice Recorded Payment, managed_companies, Payment Contract, batch, batches, Customer Group, Brand, and 56 more. Each is listed below with its method, path, parameters, and response codes.

Company 1
GET
/companies/{marketplace_slug}/stats_cashback
Provide potential cashback earnings for the given marketplace company slug.
companies_stats_cashback_retrieve 2 params → 200429
Invoice Recorded Payment 1
POST
/invoice_recorded_payments
Create an Invoice Recorded Payment
invoice_recorded_payments_create body → 201429
managed_companies 4
GET
/managed_companies
Managed Companies collection view. Companies you are the admin of
managed_companies_list 5 params → 200429
GET
/managed_companies/{id}
Managed Companies collection view. Companies you are the admin of
managed_companies_retrieve 2 params → 200429
GET
/managed_companies/{id}/licenses
Licenses for a company
managed_companies_licenses_list 6 params → 200429
GET
/managed_companies/{marketplace_slug}
Managed Companies collection view. Companies you are the admin of
managed_companies_retrieve_2 2 params → 200429
Payment Contract 6
GET
/payment_contracts
List Payment Contracts
payment_contracts_list 5 params → 200429
POST
/payment_contracts
Create a Payment Contract
payment_contracts_create body → 201429
GET
/payment_contracts/{contract_id}
Get a Payment Contract
payment_contracts_retrieve 2 params → 200429
PUT
/payment_contracts/{contract_id}
Replace a Payment Contract
payment_contracts_update 2 params body → 200429
PATCH
/payment_contracts/{contract_id}
Update a Payment Contract
payment_contracts_partial_update 2 params body → 200429
DELETE
/payment_contracts/{contract_id}
Delete a Payment Contract
payment_contracts_destroy 2 params → 204429
batch 4
GET
/batches
List Batches
batches_list 10 params → 200400429
POST
/batches
Create a Batch
batches_create 2 params body → 201400409429
GET
/batches/{id}
Retrieve a Batch
batches_retrieve 3 params → 200400404429
PUT
/batches/{id}
Update a Batch
batches_update 3 params body → 200400404429
batches 2
PATCH
/batches/{id}
LeafLink Unified API for Batches.
batches_partial_update 2 params body → 200429
DELETE
/batches/{id}
LeafLink Unified API for Batches.
batches_destroy 2 params → 204429
Customer Group 7
GET
/brand_owner/customer_groups
List Brand Owner Customer Groups
brand_owner_customer_groups_list 7 params → 200429
GET
/brand_owner/customer_groups/{id}
Get Brand Owner Customer Group
brand_owner_customer_groups_retrieve 3 params → 200429
GET
/customer_groups
List Customer Groups
customer_groups_list 7 params → 200429
POST
/customer_groups
Create Customer Group
customer_groups_create 2 params body → 201429
GET
/customer_groups/{id}
Get Customer Group
customer_groups_retrieve 3 params → 200429
PATCH
/customer_groups/{id}
Update Customer Group
customer_groups_partial_update 3 params body → 200429
DELETE
/customer_groups/{id}
Delete Customer Group
customer_groups_destroy 3 params → 204429
Brand 4
GET
/brands
List Brands
brands_list 5 params → 200429
GET
/brands/{id}
Get Brand
brands_retrieve 2 params → 200429
GET
/brands/recommended
List Recently Purchased Brands
brands_recommended_list 6 params → 200429
GET
/content/brands/listing
Shop Brands
content_brands_listing_list 11 params → 200429
brands 1
GET
/brands/recommended/{id}
brands_recommended_retrieve 2 params → 200429
Buyer Product Image 2
GET
/buyers/product_images
List Product Images
buyers_product_images_list 7 params → 200429
GET
/buyers/product_images/{id}
Get Product Image
buyers_product_images_retrieve 2 params → 200429
chats 8
GET
/chats
List all discussions
chats_list 8 params → 200429
POST
/chats
Create a new discussion with the first message.
chats_create body → 201429
GET
/chats/{id}
LeafLink API for Marketplace discussions.
chats_retrieve 2 params → 200429
PUT
/chats/{id}
LeafLink API for Marketplace discussions.
chats_update 2 params body → 200429
PATCH
/chats/{id}
LeafLink API for Marketplace discussions.
chats_partial_update 2 params body → 200429
DELETE
/chats/{id}
LeafLink API for Marketplace discussions.
chats_destroy 2 params → 204429
PATCH
/chats/{id}/messages/{message_id}/read
Mark a specific message as read
chats_messages_read_partial_update 3 params body → 200429
PATCH
/chats/bulk_update
Bulk update chat status
chats_bulk_update_partial_update body → 200429
Messages 2
GET
/chats/{id}/messages
Get or post messages for a discussion
chats_messages_list 9 params → 200201400404429
POST
/chats/{id}/messages
Get or post messages for a discussion
chats_messages_create 9 params body → 200201400404429
company_messages 2
GET
/company_messages/find_seller
Unified API Buyer Notification Settings.
company_messages_find_seller_list 4 params → 200429
GET
/company_messages/find_seller/{id}
Unified API Buyer Notification Settings.
company_messages_find_seller_retrieve 2 params → 200429
compliance 5
GET
/compliance/license_types
Ignore type because the ViewSet class is not typed and the UnifiedApiReadOnlyModelViewSet is.
compliance_license_types_list 9 params → 200429
GET
/compliance/license_types/{id}
Ignore type because the ViewSet class is not typed and the UnifiedApiReadOnlyModelViewSet is.
compliance_license_types_retrieve 2 params → 200429
GET
/compliance/licenses
Unified API to list company licenses
compliance_licenses_list 6 params → 200429
POST
/compliance/licenses
Create new licenses from a list of licenses directly from a seed-to-sale vendor.
compliance_licenses_create 2 params body → 200429
GET
/compliance/licenses/{id}
Unified API to list company licenses
compliance_licenses_retrieve 2 params → 200429
Contact 2
GET
/contacts
List Contacts
contacts_list 28 params → 200429
GET
/contacts/{id}
Get Contact
contacts_retrieve 2 params → 200429
contacts 4
POST
/contacts
LeafLink API for Marketplace contacts.
contacts_create body → 201429
PUT
/contacts/{id}
LeafLink API for Marketplace contacts.
contacts_update 2 params body → 200429
PATCH
/contacts/{id}
LeafLink API for Marketplace contacts.
contacts_partial_update 2 params body → 200429
DELETE
/contacts/{id}
Perform a 'DELETE' on a contact. It will mark the specified contact as Deleted.
contacts_destroy 2 params → 204429
Dashboard 1
GET
/content/sponsored
Sponsorships
content_sponsored_retrieve 3 params → 200429
Customer 4
GET
/customer_statuses
List Company Customer Status
customer_statuses_list 13 params → 200429
GET
/customer_statuses/{id}
Get Company Customer Status
customer_statuses_retrieve 2 params → 200429
GET
/customers
List Customers
customers_list 86 params → 200429
GET
/customers/{id}
Get Customer
customers_retrieve 2 params → 200429
customer_statuses 4
POST
/customer_statuses
LeafLink API for Marketplace company customer status.
customer_statuses_create body → 201429
PUT
/customer_statuses/{id}
LeafLink API for Marketplace company customer status.
customer_statuses_update 2 params body → 200429
PATCH
/customer_statuses/{id}
LeafLink API for Marketplace company customer status.
customer_statuses_partial_update 2 params body → 200429
DELETE
/customer_statuses/{id}
LeafLink API for Marketplace company customer status.
customer_statuses_destroy 2 params → 204429
customers 11
POST
/customers
LeafLink API for Marketplace customers.
customers_create body → 201429
PUT
/customers/{id}
LeafLink API for Marketplace customers.
customers_update 2 params body → 200429
PATCH
/customers/{id}
LeafLink API for Marketplace customers.
customers_partial_update 2 params body → 200429
DELETE
/customers/{id}
For delete request
customers_destroy 2 params → 204429
POST
/customers/{id}/corporate_address
Action route for interfacing with the corporate address
customers_corporate_address_create 2 params body → 200429
PATCH
/customers/{id}/corporate_address
Action route for interfacing with the corporate address
customers_corporate_address_partial_update 2 params body → 200429
DELETE
/customers/{id}/corporate_address
Action route for interfacing with the corporate address
customers_corporate_address_destroy 2 params → 204429
POST
/customers/{id}/delivery_address
Action route for interfacing with the delivery address
customers_delivery_address_create 2 params body → 200429
PATCH
/customers/{id}/delivery_address
Action route for interfacing with the delivery address
customers_delivery_address_partial_update 2 params body → 200429
DELETE
/customers/{id}/delivery_address
Action route for interfacing with the delivery address
customers_delivery_address_destroy 2 params → 204429
DELETE
/customers/active_entries/{id}
Delete an Active Entry for a company
customers_active_entries_destroy 2 params → 204429
ActiveEntry 2
GET
/customers/active_entries
List Company Active Entries
customers_active_entries_list 39 params → 200429
GET
/customers/active_entries/{id}
Get Active Entry
customers_active_entries_retrieve 2 params → 200429
Product 7
GET
/dashboard/product_spotlight
Featured Products
dashboard_product_spotlight_list 6 params → 200429
GET
/express_menus
List Express Product Menus
express_menus_list 6 params → 200429
GET
/products
List Products
products_list 48 params → 200429
GET
/products/{id}
Get Product
products_retrieve 2 params → 200429
GET
/products/{id}/audit_log
Get Product Audit Log
products_audit_log_retrieve 4 params → 200404429
POST
/products/bulk/update
Bulk Product Update
products_bulk_update body → 200400408429
GET
/products/recommended
Recommended Products
products_recommended_list 13 params → 200429
deliveries 2
GET
/deliveries
Unified API product categories.
deliveries_list 12 params → 200429
POST
/deliveries
Unified API product categories.
deliveries_create body → 201429
Logistics Transport 11
GET
/deliveries/{id}
Get Transport Order
deliveries_retrieve 2 params → 200429
GET
/transportation/companies
List Transport Companies
transportation_companies_list 6 params → 200429
GET
/transportation/drivers
List Drivers
transportation_drivers_list 6 params → 200429
POST
/transportation/drivers
Create Driver
transportation_drivers_create 7 params body → 201429
GET
/transportation/orders
List Transport Order
transportation_orders_list 12 params → 200429
GET
/transportation/orders/{id}
Get Transport Order
transportation_orders_retrieve 2 params → 200429
GET
/transportation/partners
List Company Transport Partner
transportation_partners_list 6 params → 200429
POST
/transportation/partners
Create Company Transport Partner
transportation_partners_create body → 201429
PATCH
/transportation/partners/{id}
Update Company Transport Partner
transportation_partners_partial_update 2 params body → 200429
GET
/transportation/vehicles
List Vehicles
transportation_vehicles_list 5 params → 200429
POST
/transportation/vehicles
Create Vehicle
transportation_vehicles_create 7 params body → 201429
distribution-zones 5
GET
/distribution-zones
Distribution Zones defined by the seller
distribution_zones_list 6 params → 200429
POST
/distribution-zones
Create a Distribution Zone
distribution_zones_create 2 params body → 201429
GET
/distribution-zones/{id}
Get a Distribution Zone
distribution_zones_retrieve 4 params → 200429
PATCH
/distribution-zones/{id}
Update a Distribution Zone
distribution_zones_partial_update 4 params body → 200429
DELETE
/distribution-zones/{id}
Delete a Distribution Zone
distribution_zones_destroy 4 params → 204429
express_menus 5
POST
/express_menus
LeafLink API for Marketplace Express Product Menus.
express_menus_create body → 201429
GET
/express_menus/{id}
LeafLink API for Marketplace Express Product Menus.
express_menus_retrieve 2 params → 200429
PUT
/express_menus/{id}
LeafLink API for Marketplace Express Product Menus.
express_menus_update 2 params body → 200429
PATCH
/express_menus/{id}
LeafLink API for Marketplace Express Product Menus.
express_menus_partial_update 2 params body → 200429
DELETE
/express_menus/{id}
LeafLink API for Marketplace Express Product Menus.
express_menus_destroy 2 params → 204429
facilities 5
GET
/facilities
List Facilities
facilities_list 6 params → 200429
POST
/facilities
Create a Facility
facilities_create 2 params body → 201429
GET
/facilities/{id}
Get a Facility
facilities_retrieve 4 params → 200429
PATCH
/facilities/{id}
Patch a Facility
facilities_partial_update 4 params body → 200429
DELETE
/facilities/{id}
Archive a Facility
facilities_destroy 4 params → 204429
inventory-v2 12
GET
/inventory-v2/debug/celery/tasks/{task_id}
Read-only drift-debugging endpoints. Dev/staging/local only.
inventory_v2_debug_celery_tasks_retrieve 2 params → 200429
GET
/inventory-v2/debug/commands/{command_id}
Read-only drift-debugging endpoints. Dev/staging/local only.
inventory_v2_debug_commands_retrieve 2 params → 200429
GET
/inventory-v2/debug/compare
GET mirror of compare-inventory; shares its logic verbatim.
inventory_v2_debug_compare_retrieve → 200429
GET
/inventory-v2/debug/v1/inventory-item-audit-logs
Read-only drift-debugging endpoints. Dev/staging/local only.
inventory_v2_debug_v1_inventory_item_audit_logs_retrieve → 200429
GET
/inventory-v2/debug/v1/inventory-items
Read-only drift-debugging endpoints. Dev/staging/local only.
inventory_v2_debug_v1_inventory_items_retrieve → 200429
GET
/inventory-v2/debug/v1/ordered-products
Read-only drift-debugging endpoints. Dev/staging/local only.
inventory_v2_debug_v1_ordered_products_retrieve → 200429
GET
/inventory-v2/debug/v1/product-audit-logs
Read-only drift-debugging endpoints. Dev/staging/local only.
inventory_v2_debug_v1_product_audit_logs_retrieve → 200429
GET
/inventory-v2/debug/v2/allocations
Read-only drift-debugging endpoints. Dev/staging/local only.
inventory_v2_debug_v2_allocations_retrieve → 200429
GET
/inventory-v2/debug/v2/commands
Read-only drift-debugging endpoints. Dev/staging/local only.
inventory_v2_debug_v2_commands_retrieve → 200429
GET
/inventory-v2/debug/v2/events
Read-only drift-debugging endpoints. Dev/staging/local only.
inventory_v2_debug_v2_events_retrieve → 200429
GET
/inventory-v2/debug/v2/measurements
Read-only drift-debugging endpoints. Dev/staging/local only.
inventory_v2_debug_v2_measurements_retrieve → 200429
GET
/inventory-v2/debug/v2/reservations
Read-only drift-debugging endpoints. Dev/staging/local only.
inventory_v2_debug_v2_reservations_retrieve → 200429
inventory-query 10
GET
/inventory/buyers/{buyer_id}/allocations
List allocations for a buyer
inventory_buyers_allocations_list 5 params → 200429
GET
/inventory/groups/{group_id}/allocations
List allocations for a group
inventory_groups_allocations_list 5 params → 200429
GET
/inventory/measurements/by-batch
List measurements by batch
inventory_measurements_by_batch_retrieve 3 params → 200429
GET
/inventory/measurements/by-facility
List measurements by facility
inventory_measurements_by_facility_retrieve 3 params → 200429
GET
/inventory/measurements/by-facility-and-batch
List measurements by facility and batch
inventory_measurements_by_facility_and_batch_retrieve 4 params → 200429
GET
/inventory/measurements/by-product
List measurements by product
inventory_measurements_by_product_retrieve 3 params → 200429
GET
/inventory/measurements/by-product-and-batch
List measurements by product and batch
inventory_measurements_by_product_and_batch_retrieve 4 params → 200429
GET
/inventory/measurements/by-product-and-facility
List measurements by product and facility
inventory_measurements_by_product_and_facility_retrieve 4 params → 200429
GET
/inventory/measurements/by-product-facility-and-batch
List measurements by product, facility, and batch
inventory_measurements_by_product_facility_and_batch_retrieve 5 params → 200429
GET
/inventory/orders/{order_id}/reservations
List reservations for an order
inventory_orders_reservations_list 5 params → 200429
inventory-command 13
GET
/inventory/commands/{id}/status
Get command status
inventory_commands_status_retrieve 2 params → 200404429
POST
/inventory/commands/archive
Submit archive command
inventory_commands_archive_create body → 202400429
POST
/inventory/commands/destroy
Submit destroy command
inventory_commands_destroy_create body → 202400429
POST
/inventory/commands/fulfillment
Submit fulfillment command
inventory_commands_fulfillment_create body → 202400429
POST
/inventory/commands/hold
Submit hold command
inventory_commands_hold_create body → 202400429
POST
/inventory/commands/putaway
Submit putaway command
inventory_commands_putaway_create body → 202400429
POST
/inventory/commands/rebuild-projections
Rebuild projections for matching streams
inventory_commands_rebuild_projections_create body → 202400429
POST
/inventory/commands/reconcile
Submit reconcile command
inventory_commands_reconcile_create body → 202400429
POST
/inventory/commands/transfer
Submit transfer command
inventory_commands_transfer_create body → 202400429
POST
/inventory/commands/unarchive
Submit unarchive command
inventory_commands_unarchive_create body → 202400429
POST
/inventory/commands/unfulfillment
Submit unfulfillment command
inventory_commands_unfulfillment_create body → 202400429
POST
/inventory/commands/unhold
Submit unhold command
inventory_commands_unhold_create body → 202400429
POST
/inventory/commands/unreserve
Submit unreserve command
inventory_commands_unreserve_create body → 202400429
inventory 4
POST
/inventory/commands/compare-inventory
POST /inventory/commands/compare-inventory Staff-only endpoint for drift investigation. Compares V1 vs V2 inventory state for a given scope. At least one of sellerid, productid, facilityid, or batchi…
inventory_commands_compare_inventory_create → 200429
POST
/inventory/commands/initialize-history
POST /inventory/commands/initialize-history Staff-only endpoint to trigger proactive V2 item history initialization for a seller's entire product catalog. Body: {"sellerid": }
inventory_commands_initialize_history_create → 200429
POST
/inventory/commands/initialize-product-streams
POST /inventory/commands/initialize-product-streams Initialize all inventory streams for a product. View fetches Django data via getlegacystreamsforproduct and passes to command service.
inventory_commands_initialize_product_streams_create → 200429
POST
/inventory/commands/initialize-streams-for-seller
POST /inventory/commands/initialize-streams Staff-only endpoint to trigger proactive V2 stream initialization for a seller's entire product catalog. Dispatches a background Celery task on the low-pri…
inventory_commands_initialize_streams_for_seller_create → 200429
Notification Preferences 3
GET
/notification/preferences
List Notification Preferences Groups
notification_preferences_list 5 params → 200429
GET
/notification/preferences/user/{user_id}
Get a user's notification preferences.
2 params → 200404429
PATCH
/notification/preferences/user/{user_id}
Update a user's notification preferences.
2 params body → 200404429
notification 1
GET
/notification/preferences/{id}
Unified Notification Preferences view set.
notification_preferences_retrieve 2 params → 200429
package 2
GET
/packages
List Packages
packages_list 8 params → 200429500
POST
/packages
Assign Packages to Products
packages_create 2 params body → 200400429
payments 3
GET
/payments
ViewSet for handling requests related to order payments.
payments_list 7 params → 200429
POST
/payments
ViewSet for handling requests related to order payments.
payments_create body → 201429
GET
/payments/{id}
ViewSet for handling requests related to order payments.
payments_retrieve 2 params → 200429
poms 1
POST
/poms/orders/approval
Handle the 'APPROVAL' endpoint for a POMS Order. See the CartOrderApprovalAction choices for supported actions that can be performed.
poms_orders_approval_create body → 200429
Pricing 2
GET
/pricing/custom-menus
List Custom Menus
pricing_custom_menus_list 5 params → 200429
GET
/pricing/custom-menus/{id}
Get Custom Menu
pricing_custom_menus_retrieve 2 params → 200429
product-assigned-to-buyer 2
GET
/product-assigned-to-buyer
List Product Assignments by Seller
product_assigned_to_buyer_list 7 params → 200429
PUT
/product-assigned-to-buyer
Update Product Assignments
product_assigned_to_buyer_update 2 params body → 200429
product-assignment-products 1
GET
/product-assignments
List Products with Product Assignments
product_assignments_list 11 params → 200429
Product Category 2
GET
/product_categories
List Product Categories
product_categories_list 5 params → 200429
GET
/product_categories/{id}
Get a Product Category
product_categories_retrieve 2 params → 200429
Product Dosage Unit 2
GET
/product_dosage_units
List Product Dosage Units
product_dosage_units_list 5 params → 200429
GET
/product_dosage_units/{id}
Get a Product Dosage Unit
product_dosage_units_retrieve 2 params → 200429
Product Grow Operation Type 1
GET
/product_grow_operation_types
List Grow Operation Types
product_grow_operation_types_list 3 params → 200429
Product Image 6
GET
/product_images
List Product Images
product_images_list 10 params → 200429
POST
/product_images
Create Product Image
product_images_create body → 201429
GET
/product_images/{id}
Get Product Image
product_images_retrieve 2 params → 200429
DELETE
/product_images/{id}
Delete Product Image
product_images_destroy 2 params → 204429
POST
/product_images/{id}/clone
Clone Product Image
product_images_clone_create 2 params body → 200429
POST
/product_images/bulk_create
Bulk Create Product Images
product_images_bulk_create_create body → 200429
Product Line 5
GET
/product_lines
List Product Lines
product_lines_list 9 params → 200429
POST
/product_lines
Create Product Line
product_lines_create body → 201429
GET
/product_lines/{id}
Get Product Line
product_lines_retrieve 2 params → 200429
PATCH
/product_lines/{id}
Update Product Line
product_lines_partial_update 2 params body → 200429
DELETE
/product_lines/{id}
Delete Product Line
product_lines_destroy 2 params → 204429
Product Listing State 1
GET
/product_listing_states
List Listing States
product_listing_states_list 3 params → 200429
Product Promotion 4
GET
/product_promotions
List Product Promotions
product_promotions_list 5 params → 200429
POST
/product_promotions
Create a Product Promotion
product_promotions_create body → 201429
GET
/product_promotions/{id}
Get a Product Promotion
product_promotions_retrieve 2 params → 200429
PATCH
/product_promotions/{id}
Update a Product Promotion
product_promotions_partial_update 2 params body → 200429
product_promotions 2
PUT
/product_promotions/{id}
API endpoint to create, view, and edit ProductPromotions for a company.
product_promotions_update 2 params body → 200429
DELETE
/product_promotions/{id}
API endpoint to create, view, and edit ProductPromotions for a company.
product_promotions_destroy 2 params → 204429
Product Specification 2
GET
/product_specifications
List Product Specifications
product_specifications_list 5 params → 200429
GET
/product_specifications/{id}
Get a Product Specification
product_specifications_retrieve 2 params → 200429
Product Subcategory 2
GET
/product_subcategories
List Product Subcategories
product_subcategories_list 8 params → 200429
GET
/product_subcategories/{id}
Get a Product Subcategory
product_subcategories_retrieve 2 params → 200429
Product Template 5
GET
/product_templates
List Product Templates
product_templates_list 8 params → 200429
POST
/product_templates
Create Product Template
product_templates_create 2 params body → 201429
GET
/product_templates/{id}
Retrieve Product Template
product_templates_retrieve 3 params → 200429
PATCH
/product_templates/{id}
Update Product Template
product_templates_partial_update 3 params body → 200429
DELETE
/product_templates/{id}
Delete Product Template
product_templates_destroy 3 params → 204429
products 4
POST
/products
LeafLink API for Marketplace products.
products_create body → 201429
PUT
/products/{id}
LeafLink API for Marketplace products.
products_update 2 params body → 200429
PATCH
/products/{id}
LeafLink API for Marketplace products.
products_partial_update 2 params body → 200429
DELETE
/products/{id}
Perform a 'DELETE' on a product. It will mark the specified product as Archived. Logic is put here as the ModelViewSet destroy function doesn't use the serializer.
products_destroy 2 params → 204429
Product MVP 8
GET
/products_mvp
List Products
products_mvp_list 47 params → 200429
POST
/products_mvp
Create Product
products_mvp_create body → 201429
GET
/products_mvp/{id}
Get Product
products_mvp_retrieve 2 params → 200429
PATCH
/products_mvp/{id}
Update Product
products_mvp_partial_update 2 params body → 200429
GET
/products_mvp/{id}/clone
Clone Product
products_mvp_clone_retrieve 2 params → 200429
POST
/products_mvp/{id}/clone
Clone Product
products_mvp_clone_create 2 params body → 200429
GET
/products_mvp/{template_id}/add_from_template
Add Product from Template
products_mvp_add_from_template_retrieve 2 params → 200429
POST
/products_mvp/{template_id}/add_from_template
Add Product from Template
products_mvp_add_from_template_create 2 params body → 200429
sales_invoices 2
GET
/sales_invoices
sales_invoices_list 7 params → 200429
GET
/sales_invoices/{id}
sales_invoices_retrieve 2 params → 200429
settings 3
GET
/settings/companies/buyer_notifications
Get buyer notification settings.
settings_companies_buyer_notifications_list 5 params → 200429
POST
/settings/companies/buyer_notifications
Update buyer notification settings.
settings_companies_buyer_notifications_create body → 201429
GET
/settings/companies/buyer_notifications/{id}
Unified API Buyer Notification Settings.
settings_companies_buyer_notifications_retrieve 2 params → 200429
SplitIO 1
GET
/splits
Get split treatments
splits_retrieve 3 params → 200400429
States 1
GET
/states
List States
states_list 7 params → 200429
states 1
GET
/states/{id}
State view set.
states_retrieve 2 params → 200429
Strain 3
GET
/strain_classifications
List Strain Clasifications
strain_classifications_list 3 params → 200429
GET
/strains
List Strains
strains_list 11 params → 200429
GET
/strains/{id}
Get Strain
strains_retrieve 2 params → 200429
taxes 5
GET
/taxes/tax_schedules
Get tax schedules for company.
taxes_tax_schedules_list 6 params → 200429
POST
/taxes/tax_schedules
Create a new TaxSchedule.
taxes_tax_schedules_create 2 params body → 201429
GET
/taxes/tax_schedules/{id}
Get tax schedule by ID for company.
taxes_tax_schedules_retrieve 3 params → 200429
PATCH
/taxes/tax_schedules/{id}
Update a TaxSchedule by marking it as archived and creating a new one.
taxes_tax_schedules_partial_update 3 params body → 200429
DELETE
/taxes/tax_schedules/{id}
Delete a TaxSchedule... well, mark it as archived.
taxes_tax_schedules_destroy 3 params → 204429
traceability 28
PATCH
/traceability/actions/refresh_products_packages
Reconcile inventory for products, utilizes marketplace celery tasks + traceability service data.
traceability_actions_refresh_products_packages_partial_update 2 params body → 200429
GET
/traceability/actions/refresh_resources
Perform refresh for specified resource types and optional datetime.
traceability_actions_refresh_resources_retrieve 5 params → 200429
POST
/traceability/companies
Create a new company in the traceability service.
traceability_companies_create 2 params body → 201429
GET
/traceability/companies/{id}
Get company by ID.
traceability_companies_retrieve 3 params → 200429
PATCH
/traceability/companies/{id}
Update a company in the traceability service.
traceability_companies_partial_update 3 params body → 200429
GET
/traceability/company_customers
Get company customers.
traceability_company_customers_list 6 params → 200429
GET
/traceability/company_customers/{id}
Get company customer by ID.
traceability_company_customers_retrieve 3 params → 200429
POST
/traceability/company_licenses/
Get company licenses
traceability_company_licenses_create 2 params body → 200429
DELETE
/traceability/company_setting/{id}
Delete a company's integration.
traceability_company_setting_destroy 3 params → 200429
GET
/traceability/drivers
Get all drivers for company
traceability_drivers_list 6 params → 200429
POST
/traceability/drivers
Create a new driver in the traceability service.
traceability_drivers_create 2 params body → 200429
PATCH
/traceability/drivers/{external_id}
Update a driver in the traceability service.
traceability_drivers_partial_update 3 params body → 200429
GET
/traceability/items
Get all items from the traceability service for a company.
traceability_items_list 7 params → 200429
GET
/traceability/orders_by_package_labels
Unified API Orders by Package Labels.
traceability_orders_by_package_labels_list 5 params → 200429
GET
/traceability/orders_by_package_labels/{id}
Unified API Orders by Package Labels.
traceability_orders_by_package_labels_retrieve 2 params → 200429
GET
/traceability/packages
Get company packages
traceability_packages_list 26 params → 200429
GET
/traceability/refresh_requests
Get all refreshrequests from the traceability service for a company.
traceability_refresh_requests_list 8 params → 200429
GET
/traceability/templates
Get templates from the traceability service for company.
traceability_templates_list 8 params → 200429
POST
/traceability/templates
Create a new Template in the traceability service.
traceability_templates_create 2 params body → 201429
GET
/traceability/templates/{id}
Get template by ID for company.
traceability_templates_retrieve 3 params → 200429
PATCH
/traceability/templates/{id}
Update a template in the traceability service.
traceability_templates_partial_update 3 params body → 200429
GET
/traceability/transfer_companies
Get origin/destination companies of a transfer + their associated license
traceability_transfer_companies_list 9 params → 200429
GET
/traceability/transfers
Get traceability transfer data. Note: resourcetype fields will not be present in the payloads. They are just needed to help define polymorphic fields.
traceability_transfers_list 24 params → 200429
POST
/traceability/transfers
Create a new manifest in the traceability service.
traceability_transfers_create 2 params body → 201429
PATCH
/traceability/transfers/{id}
Update a transfer in the traceability service.
traceability_transfers_partial_update 3 params body → 200429
GET
/traceability/vehicles
Get all vehicles
traceability_vehicles_list 6 params → 200429
POST
/traceability/vehicles
Create a new vehicle in the traceability service.
traceability_vehicles_create 2 params body → 200429
PATCH
/traceability/vehicles/{external_id}
Update a vehicle in the traceability service.
traceability_vehicles_partial_update 3 params body → 200429
transportation 8
GET
/transportation/companies/{id}
Transport Company view set.
transportation_companies_retrieve 2 params → 200429
GET
/transportation/drivers/{id}
Transport partner drivers view set.
transportation_drivers_retrieve 2 params → 200429
PATCH
/transportation/drivers/{id}
Transport partner drivers view set.
transportation_drivers_partial_update 2 params body → 200429
POST
/transportation/orders
Unified API product categories.
transportation_orders_create body → 201429
GET
/transportation/partners/{id}
Company transport partner view set.
transportation_partners_retrieve 2 params → 200429
GET
/transportation/vehicles/{id}
Transport partner vehicle view set.
transportation_vehicles_retrieve 2 params → 200429
PATCH
/transportation/vehicles/{id}
Transport partner vehicle view set.
transportation_vehicles_partial_update 2 params body → 200429
DELETE
/transportation/vehicles/{id}
Transport partner vehicle view set.
transportation_vehicles_destroy 2 params → 204429
Unit Denomination 2
GET
/unit_denominations
List Unit Denominations
unit_denominations_list 5 params → 200429
GET
/unit_denominations/{id}
Get a Unit Denomination
unit_denominations_retrieve 2 params → 200429
Unit of Measure 2
GET
/units_of_measure
List Unit of Measures
units_of_measure_list 5 params → 200429
GET
/units_of_measure/{id}
Get a Unit of Measure
units_of_measure_retrieve 2 params → 200429
vendors 3
GET
/vendor/{id}
Get Vendor Company Profile
vendor_retrieve 3 params → 200429
GET
/vendors/recommended
vendors_recommended_list 5 params → 200429
GET
/vendors/recommended/{id}
vendors_recommended_retrieve 2 params → 200429

Schemas 415

The contract defines 415 schemas that model the data the API accepts and returns. The most detailed are SplitTreatment (82 properties), UnifiedCustomer (41 properties), Seller (36 properties), UnifiedProductAssignmentProduct (35 properties). Each schema is shown below with its type and property counts.

BlankEnum
Buyer
object
Used to serialize buyer data (a buyer is a company where type = buyer)
35 properties 9 required
BuyerRequest
object
Used to serialize buyer data (a buyer is a company where type = buyer)
29 properties 2 required
CollectionDayPreferenceEnum
string
Company
object
Used to validate the company creation request.
4 properties 2 required
CompanyCashbackStats
object
Serializer for CompanyStats focusing on cashback-related statistics.
2 properties
Contract
object
Serializer for Contract
12 properties 6 required
ContractRequest
object
Serializer for Contract
8 properties 2 required
ContractStats
object
Serializer for CompanyStats
10 properties
ContractStatsRequest
object
Serializer for CompanyStats
10 properties
DefaultFlexiblePaymentStrategyEnum
string
DefaultPaymentProgramEnum
string
LegalEntity
object
Serializer for LegalEntity
13 properties 1 required
LegalEntityRequest
object
Serializer for LegalEntity
13 properties 1 required
License
object
Licenses Serializer
8 properties 3 required
LicenseRequest
object
Serializer for License
6 properties 1 required
LicenseTypeEnum
string
NullEnum
PaginatedCompanyList
object
4 properties 2 required
PaginatedContractList
object
4 properties 2 required
PaginatedLicenseList
object
4 properties 2 required
PatchedContractRequest
object
Serializer for Contract
8 properties
PreferredPaymentProgramEnum
string
RecordInvoicePayment
object
Creating a recorded payment on an Invoice
6 properties 5 required
RecordInvoicePaymentRequest
object
Creating a recorded payment on an Invoice
6 properties 5 required
Seller
object
Used to serialize seller data (a seller is a company where type = seller)
36 properties 10 required
SellerRequest
object
Used to serialize seller data (a seller is a company where type = seller)
30 properties 2 required
State
object
State Serializer
2 properties 2 required
StatusEnum
string
Type7a8Enum
string
VerificationStatusEnum
string
AdPlacement
object
Serializer for ll.ads.datamodels.AdPlacement
3 properties 3 required
Address
object
Serializer for Address models via the internal API. This includes but is not limited to delivery and corporate addresses for Companies.
6 properties 4 required
AddressInputRequest
object
Nested serializer for the address payload required on facility creation.
8 properties 4 required
AddressRequest
object
Serializer for Address models via the internal API. This includes but is not limited to delivery and corporate addresses for Companies.
6 properties 4 required
Allocation
object
Serializes an AllocationItem for the API response.
7 properties 7 required
ArchiveRequestRequest
object
Request body for POST .../commands/archive.
7 properties 6 required
Author
object
Author serializer
5 properties 5 required
AuthorRequest
object
Author serializer
2 properties 2 required
Badge
object
Serializer for Badges.
4 properties 3 required
BatchCreateRequest
object
Serializer for creating a batch. companyid is injected by the view.
4 properties 2 required
BatchListPaginatedResponse
object
5 properties 4 required
BatchMeasurementResponse
object
Response shape for GET .../measurements/by-batch.
3 properties 3 required
BatchMetaPayload
object
3 properties 3 required
BatchUpdateRequest
object
Serializer for updating a batch (PUT, full replace). id and companyid are injected by the view.
13 properties 6 required
BiotrackDeliveryPackage
object
BioTrack-specific DeliveryPackage fields serializer.
6 properties 6 required
BiotrackDriver
object
6 properties 6 required
BiotrackTransfer
object
1 property 1 required
BiotrackVehicle
object
6 properties 6 required
BrandListingContent
object
2 properties 2 required
BrandResource
object
Serializer for Brand resource.
12 properties 11 required
BuyerNotificationSetting
object
Buyer Notification Setting Serializer for managing email notifications.
7 properties
BuyerNotificationSettingEvent
object
1 property
BuyerNotificationSettingEventRequest
object
1 property
BuyerNotificationSettingRequest
object
Buyer Notification Setting Serializer for managing email notifications.
7 properties
BuyerOrder
object
Order serializer (buyer side).
27 properties 22 required
BuyerOrderStatusEnum
string
Choice
object
Unified Strain Classification serializer.
2 properties 2 required
CommandAcceptedResponse
object
Response body for 202 Accepted when a command is queued.
1 property 1 required
CommandStatusResponse
object
Response body for GET .../commands/ /status.
6 properties 6 required
CompanyApiKeyRequest
object
3 properties 2 required
CompanyCreateRequest
object
7 properties 4 required
CompanyLicense
object
Unified serializer for License models.
5 properties 5 required
CompanyLicenseType
object
Unified serializer for LicenseType models.
14 properties 7 required
CompanyRequest
object
API v2 serializer for the Company model.
23 properties 9 required
CompanyResource
object
Serializer for Company resource.
5 properties 4 required
CompanyTransportPartner
object
Seriazlier for Company Transport Partner Model.
3 properties 3 required
CompanyTransportPartnerRequest
object
Seriazlier for Company Transport Partner Model.
2 properties 1 required
CompanyWriteSuccessResponse
object
1 property 1 required
ComplianceLicense
object
Serializer for License models via the v2 API
5 properties 5 required
ComplianceLicenseRequest
object
Serializer for License models via the v2 API
1 property 1 required
Country
object
Serializer for Country models via the internal API Note: The code - isocode is alias is intentional
4 properties 4 required
CountryRequest
object
Serializer for Country models via the internal API Note: The code - isocode is alias is intentional
3 properties 3 required
CreateInputRequest
object
5 properties 5 required
CreateUpdateSuccessResponse
object
1 property 1 required
CustomMenuItem
object
A single custom menu (Price Schedule) price assignment for a product.
3 properties 2 required
CustomMenuItemRequest
object
A single custom menu (Price Schedule) price assignment for a product.
3 properties 2 required
CustomerPaymentOptionSerializerV2
object
External serializer class for Customers payment options.
6 properties
CustomerPaymentOptionSerializerV2Request
object
External serializer class for Customers payment options.
8 properties 2 required
DestroyRequestRequest
object
Request body for POST .../commands/destroy.
7 properties 6 required
DiscussionCompany
object
Company serializer
3 properties 2 required
DiscussionCompanyRequest
object
Company serializer
2 properties 1 required
DistributionZone
object
Serializer for a Distribution Zone. DistributionZone replaces the Django App's zoneszone where zonetype=facility.
5 properties 4 required
DistributionZoneCreateRequest
object
Serializer to create a Distribution Zone. DistributionZone replaces the Django App's zoneszone where zonetype=facility.
5 properties 5 required
Driver
object
serializer for Driver Model.
8 properties 7 required
DriverRequest
object
serializer for Driver Model.
6 properties 5 required
Facility
object
Serializer for a Facility.
2 properties 2 required
FacilityBatchMeasurementResponse
object
Response shape for GET .../measurements/by-facility-and-batch.
4 properties 4 required
FacilityCreateRequest
object
Serializer for creating a facility.
6 properties 2 required
FacilityMeasurementResponse
object
Response shape for GET .../measurements/by-facility.
3 properties 3 required
FacilityRequest
object
Serializer for a Facility.
2 properties 2 required
FeaturedBrand
object
Serializer for Product Spotlight brands
3 properties 3 required
FeaturedProduct
object
Serializer for Product Spotlight featured products
25 properties 22 required
FieldEnum
string
FulfillmentRequestRequest
object
Request body for POST .../commands/fulfillment.
6 properties 5 required
GrowTypeEnum
string
HoldRequestRequest
object
Request body for POST .../commands/hold.
7 properties 6 required
InternalCompanyAPIConfig
object
Internal serializer for traceability API config.
5 properties 5 required
InternalCompanyLicense
object
Serializer for the Company License model.
9 properties 7 required
InternalDriver
object
Internal serializer for Driver Model.
8 properties 7 required
InternalDriverRequest
object
Internal serializer for Driver Model.
6 properties 5 required
InternalLicenseTypeResponse
object
Internal serializer for LicenseTypes filtered by state.
7 properties 5 required
InternalLogisticsCompany
object
Internal serializer for the Company model to be used by L3 endpoints.
5 properties 5 required
InternalLogisticsCompanyRequest
object
Internal serializer for the Company model to be used by L3 endpoints.
1 property 1 required
InternalTransportCompany
object
Internal serializer for TransportCompany Model.
4 properties 1 required
InternalTransportCompanyRequest
object
Internal serializer for TransportCompany Model.
3 properties
InternalVehicle
object
Internal serializer for Vehicle Model.
7 properties 1 required
InternalVehicleRequest
object
Internal serializer for Vehicle Model.
6 properties
InventoryManagementEnum
string
LicenseApiKeyRequest
object
1 property 1 required
LicenseCreateUpdateRequest
object
4 properties 4 required
LicenseTypeInternalResponse
object
Serializer for LicenseType models via the internal API
13 properties 7 required
LicensesCreateUpdateResponse
object
Serializer for returning a list of created or updated license IDs.
1 property 1 required
LightCompany
object
Company serializer contains only basic fields.
3 properties 2 required
ListingStateEnum
string
MeasurementData
object
Nested measurement quantities; field names match MeasurementData.
6 properties 6 required
Message
object
Discussion Message serializer
6 properties 6 required
MessageRequest
object
Discussion Message serializer
1 property 1 required
MetrcDelivery
object
Metrc-specific transfer fields serializer.
9 properties 6 required
MetrcDeliveryPackage
object
Metrc-specific DeliveryPackage fields serializer.
20 properties 20 required
MetrcDriver
object
4 properties 4 required
MetrcLocation
object
Metrc specific location fields from the Traceability.metrclocation table.
7 properties 3 required
MetrcPackage
object
Metrc package fields from the Traceability.metrcpackage table.
28 properties 27 required
MetrcTransfer
object
Metrc-specific transfer fields serializer.
7 properties 1 required
MetrcVehicle
object
1 property 1 required
NestedCompany
object
Company serializer to use as a nested value.
10 properties 8 required
NestedLicense
object
License serializer to use as a nested value.
4 properties 4 required
NestedOrderSeller
object
Serializer for seller info on a buyer order.
4 properties 3 required
NestedOrderedProduct
object
Ordered Product serializer to use as a nested value.
6 properties 5 required
NestedProduct
object
Product serializer to use as a nested value.
13 properties 10 required
NotificationPreferences
object
Schema for notification preferences payload.
3 properties 3 required
NotificationTopic
object
Serializer for NotificationTopic model.
4 properties 4 required
OrderPaymentUnifiedCustomer
object
Serializer for company data focusing on name and ID.
2 properties 2 required
OrderPaymentUnifiedCustomerRequest
object
Serializer for company data focusing on name and ID.
1 property 1 required
PackageAssignRequest
object
Serializer for bulk assigning packages to products.
1 property 1 required
PackageAssignResponse
object
Response serializer for assign packages - returns assigned packages.
2 properties 2 required
PackageAssignmentInputRequest
object
Serializer for a single package-to-product assignment.
2 properties 2 required
PaginatedBrandListingContentList
object
4 properties
PaginatedBuyerNotificationSettingList
object
4 properties 2 required
PaginatedCompanyLicenseList
object
4 properties 2 required
PaginatedCompanyTransportPartnerList
object
4 properties 2 required
PaginatedDistributionZoneList
object
4 properties 2 required
PaginatedFacilityList
object
4 properties 2 required
PaginatedFeaturedProductList
object
4 properties 2 required
PaginatedInternalDriverList
object
4 properties 2 required
PaginatedLicenseTypeInternalResponseList
object
4 properties 2 required
PaginatedMessageList
object
5 properties
PaginatedNotificationPreferencesList
object
4 properties 2 required
PaginatedProductAuditLogResponse
object
4 properties 4 required
PaginatedProductCategoryList
object
4 properties 2 required
PaginatedProductPromotionList
object
4 properties 2 required
PaginatedRecommendedProductList
object
4 properties 2 required
PaginatedStateList
object
4 properties 2 required
PaginatedTraceabilityDriverList
object
4 properties 2 required
PaginatedTraceabilityItemList
object
4 properties 2 required
PaginatedTraceabilityPackageList
object
4 properties 2 required
PaginatedTraceabilityRefreshRequestList
object
4 properties 2 required
PaginatedTraceabilityTemplateList
object
4 properties 2 required
PaginatedTraceabilityTransferList
object
5 properties 2 required
PaginatedTraceabilityVehicleList
object
4 properties 2 required
PaginatedTransferCompanyList
object
4 properties 2 required
PaginatedTransportCompanyList
object
4 properties 2 required
PaginatedUnifiedBuyerProductImageList
object
4 properties 2 required
PaginatedUnifiedChatsList
object
5 properties
PaginatedUnifiedCustomMenuList
object
4 properties 2 required
PaginatedUnifiedCustomerGroupList
object
4 properties 2 required
PaginatedUnifiedL3OrderList
object
4 properties 2 required
PaginatedUnifiedMessagingFindSellerList
object
4 properties 2 required
PaginatedUnifiedOrderAsSalesInvoiceList
object
4 properties 2 required
PaginatedUnifiedOrderPaymentList
object
4 properties 2 required
PaginatedUnifiedPackageList
object
4 properties 2 required
PaginatedUnifiedProductAssignmentProductList
object
4 properties 2 required
PaginatedUnifiedProductAssignmentWithItemsList
object
4 properties 2 required
PaginatedUnifiedProductDosageUnitList
object
4 properties 2 required
PaginatedUnifiedProductImageList
object
4 properties 2 required
PaginatedUnifiedProductLineList
object
4 properties 2 required
PaginatedUnifiedProductMVPList
object
4 properties 2 required
PaginatedUnifiedProductSpecificationList
object
4 properties 2 required
PaginatedUnifiedProductSubCategoryList
object
4 properties 2 required
PaginatedUnifiedProductTemplateList
object
4 properties 2 required
PaginatedUnifiedRecommendedBrandList
object
4 properties 2 required
PaginatedUnifiedRecommendedCompanyList
object
4 properties 2 required
PaginatedUnifiedStrainList
object
4 properties 2 required
PaginatedUnifiedTaxScheduleList
object
4 properties 2 required
PaginatedUnifiedTraceabilityCompanyCustomerList
object
4 properties 2 required
PaginatedUnifiedTraceabilityPackageOrdersList
object
4 properties 2 required
PaginatedUnifiedUnitDenominationList
object
4 properties 2 required
PaginatedUnifiedUnitOfMeasureList
object
4 properties 2 required
PaginatedVehicleList
object
4 properties 2 required
PatchedBulkChatUpdateRequest
object
Chat status serializer
2 properties
PatchedCompanyTransportPartnerRequest
object
Seriazlier for Company Transport Partner Model.
2 properties
PatchedCompanyUpdateRequest
object
7 properties
PatchedDistributionZoneUpdateRequest
object
Serializer to update a Distribution Zone. DistributionZone replaces the Django App's zoneszone where zonetype=facility.
6 properties
PatchedFacilityPatchRequest
object
Serializer for patching a facility.
5 properties
PatchedInternalDriverRequest
object
Internal serializer for Driver Model.
6 properties
PatchedMessageReadRequest
object
Discussion Message read serializer
2 properties
PatchedProductPromotionRequest
object
13 properties
PatchedTemplateUpdateRequest
object
9 properties
PatchedTraceabilityDriverCreateUpdateInputRequest
object
6 properties
PatchedTraceabilityRefreshProductsPackagesRequest
object
1 property
PatchedTraceabilityVehicleCreateUpdateInputRequest
object
7 properties
PatchedTransferUpdateInputRequest
object
11 properties
PatchedUnifiedAddressRequest
object
Inherits AddressSerializer but sets the FK relation on the resource Model
6 properties
PatchedUnifiedBatchRequest
object
Serializer for Batch - read/response only.
15 properties
PatchedUnifiedChatsRequest
object
Unified Chats serializer
6 properties
PatchedUnifiedCompanyCustomerStatusRequest
object
Unified serializer for the CompanyCustomerStatus model.
6 properties
PatchedUnifiedContactRequest
object
Unified Contact serializer
12 properties
PatchedUnifiedCustomerGroupRequest
object
Serializer for Customer Group.
4 properties
PatchedUnifiedCustomerRequest
object
UnifiedCustomerSerializer inherits existing v2 CompanyCustomerSerializer for validations
28 properties
PatchedUnifiedExpressProductMenuRequest
object
3 properties
PatchedUnifiedProductLineCreateRequest
object
Serializer for creating product lines.
4 properties
PatchedUnifiedProductMVPRequest
object
Unified Product serializer.
22 properties
PatchedUnifiedProductRequest
object
Unified Product serializer.
13 properties
PatchedUnifiedProductTemplateRequest
object
Base serializer class to rename createdon and modified fields to follow new naming standard of createddate and modifieddate
28 properties
PatchedUpdateInputRequest
object
5 properties
PatchedVehicleRequest
object
Internal serializer for Vehicle Model.
6 properties
PaymentMethod
object
Serialize payment method.
5 properties 5 required
PaymentMethodRequest
object
Serialize payment method.
2 properties 2 required
PaymentProgramEnum
string
PaymentStrategyEnum
string
PaymentTerm
object
Serialize payment term.
6 properties 6 required
PaymentTermRequest
object
Serialize payment term.
3 properties 3 required
PaymentTypeEnum
string
PeriodEnum
string
PolymorphicCreateUpdateTransferResponse
PolymorphicDeliveryPackageVendorFields
PolymorphicDriverVendorFields
PolymorphicTransferVendorFields
PolymorphicVehicleVendorFields
PricingStrategyInputRequest
object
Serializer for pricing strategy input (nested in batch update).
3 properties 2 required
ProductAuditLogEntry
object
Polymorphic serializer for product audit log entries.
9 properties 9 required
ProductBatchMeasurementResponse
object
Response shape for GET .../measurements/by-product-and-batch.
4 properties 4 required
ProductBulkUpdateResponse
object
3 properties 3 required
ProductBulkUpdateResponseErrorDetail
object
2 properties 2 required
ProductBulkUpdateResponseProduct
object
3 properties 3 required
ProductCategory
object
Product category serializer.
4 properties 4 required
ProductFacilityBatchMeasurementResponse
object
Response shape for GET .../measurements/by-product-facility-and-batch.
5 properties 5 required
ProductFacilityMeasurementResponse
object
Response shape for GET .../measurements/by-product-and-facility.
4 properties 4 required
ProductMeasurementResponse
object
Response shape for GET .../measurements/by-product.
3 properties 3 required
ProductPromotion
object
14 properties 10 required
ProductPromotionRequest
object
13 properties 8 required
ProductSubCategory
object
Product subcategory serializer.
5 properties 4 required
PutawayRequestRequest
object
Request body for POST .../commands/putaway.
6 properties 5 required
RebuildProjectionsRequestRequest
object
Request body for POST .../commands/rebuild-projections. Accepts any combination of sellerids, productids, facilityids, and batchids. At least one filter list m…
4 properties
RebuildProjectionsResponse
object
Response body for POST .../commands/rebuild-projections.
3 properties 3 required
RebuildProjectionsStream
object
Single stream identifier in the rebuild-projections response.
3 properties 3 required
RecommendedProduct
object
Serializer for Recommended Products
27 properties 24 required
ReconcileRequestRequest
object
Request body for POST .../commands/reconcile.
7 properties 6 required
Reservation
object
Serializes a ReservationItem for the API response.
8 properties 8 required
ResultStatusEnum
string
SelectorEnum
string
ServiceZone
object
Serializer for the ServiceZone model.
4 properties 3 required
ServiceZoneRequest
object
Serializer for the ServiceZone model.
3 properties 2 required
ShortPaymentMethod
object
Short serializer for payment methods.
2 properties 2 required
ShortPaymentMethodRequest
object
Short serializer for payment methods.
1 property 1 required
ShortPaymentTerm
object
Short serializer for payment terms.
4 properties 3 required
ShortPaymentTermRequest
object
Short serializer for payment terms.
3 properties 2 required
SkyscraperBrand
object
Serializer for Brand resource.
6 properties 6 required
SkyscraperSponsorshipContent
object
Serializer for an individual Skyscraper style sponsorship result.
13 properties 13 required
SkyscraperSponsorshipItem
object
Serializer for ll.ads.datamodels.SkyscraperSponsorshipItem
6 properties 6 required
SourceTypeEnum
string
SplitNameEnum
string
SplitTreatment
object
Serializer for Split.io overrides request Shape of the request is { 'commerceacceptpaymentspaymentevents': 'on', 'firepodmpautopausing': 'on' }
82 properties
Sponsorship
object
Serializer for ll.ads.datamodels.Sponsorship
15 properties 15 required
SponsorshipContent
object
Serializer for an individual sponsorship result.
1 property 1 required
SponsorshipItem
object
Serializer for ll.ads.datamodels.SponsorshipItem
3 properties 3 required
SponsorshipPayload
object
Serializer for sponsorship content. "sponsorships": { "banners": [ {"sponsorship": {}}, {"sponsorship": {}}, … ], "listing": [ {"resource": {}, "sponsorship":…
3 properties 3 required
SponsorshipResource
object
Serializer for an individual sponsorship with Brand details.
2 properties 2 required
SponsorshipsContent
object
1 property 1 required
SpotlightBadgesEnum
string
StateRequest
object
Serializer for State models via the internal API
3 properties 3 required
StrainClassificationEnum
string
SubCategory
object
4 properties 4 required
TemplateCreateRequest
object
12 properties 1 required
TemplateWriteSuccessResponse
object
1 property 1 required
Terpene
object
Serializer for Terpene (nested in Batch)
2 properties 2 required
TerpeneRequest
object
Serializer for Terpene (nested in Batch)
2 properties 2 required
Threshold
object
4 properties
ThresholdActionEnum
string
ThresholdRequest
object
4 properties
TierEnum
integer
TraceabilityCompany
object
13 properties 11 required
TraceabilityCompanyIncludedLocation
object
4 properties 4 required
TraceabilityDelivery
object
Serializer for traceability Deliveries. Uses CommonDelivery + vendor-specific data. Metrc will return one instance and BioTrack will have none as there is no u…
11 properties 8 required
TraceabilityDeliveryPackage
object
Serializer for traceability DeliveryPackages.
12 properties 11 required
TraceabilityDriver
object
10 properties 10 required
TraceabilityDriverCreateUpdateInputRequest
object
6 properties 6 required
TraceabilityItem
object
28 properties 28 required
TraceabilityLicense
object
4 properties 4 required
TraceabilityLicenses
object
2 properties 2 required
TraceabilityLocation
object
Location object from the Traceability.commonlocation and Traceability.(vendor)location tables.
10 properties 9 required
TraceabilityOrder
object
3 properties 3 required
TraceabilityPackage
object
Traceability package fields from the Traceability.commonpackage and Traceability.metrcpackage tables.
19 properties 19 required
TraceabilityRefreshRequest
object
6 properties 6 required
TraceabilityStrain
object
10 properties 10 required
TraceabilityTemplate
object
25 properties 22 required
TraceabilityTemplateDetail
object
25 properties 25 required
TraceabilityTransfer
object
Serializer for traceability transfers. Composed of CommonTransfer + vendor-specific transfer data.
28 properties 14 required
TraceabilityTransferBuyer
object
1 property 1 required
TraceabilityVehicle
object
11 properties 11 required
TraceabilityVehicleCreateUpdateInputRequest
object
7 properties 7 required
TransferCompany
object
Name + licensenumber combination of a shipper or recipient from the Traceability.transfer table.
2 properties 2 required
TransferCreateInputRequest
object
9 properties 9 required
TransferCreateUpdatePackageRequest
object
1 property 1 required
TransferRequestRequest
object
Request body for POST .../commands/transfer.
9 properties 8 required
TransportCompany
object
Serializer for TransportCompany model
5 properties 5 required
TypeCodeEnum
string
TypeEnum
string
UnarchiveRequestRequest
object
Request body for POST .../commands/unarchive.
7 properties 6 required
UnfulfillmentRequestRequest
object
Request body for POST .../commands/unfulfillment.
6 properties 5 required
UnholdRequestRequest
object
Request body for POST .../commands/unhold.
7 properties 6 required
UnifiedAddress
object
Inherits AddressSerializer but sets the FK relation on the resource Model
6 properties 4 required
UnifiedAddressRequest
object
Inherits AddressSerializer but sets the FK relation on the resource Model
6 properties 4 required
UnifiedBatch
object
Serializer for Batch - read/response only.
23 properties 9 required
UnifiedBrand
object
2 properties 2 required
UnifiedBrandRequest
object
1 property 1 required
UnifiedBuyerProductImage
object
Unified ProductImage serializer.
6 properties 5 required
UnifiedChats
object
Unified Chats serializer
7 properties 6 required
UnifiedChatsRequest
object
Unified Chats serializer
6 properties 4 required
UnifiedCloneProductImage
object
Unified Product Image serializer for cloning product images.
10 properties 6 required
UnifiedCloneProductImageRequest
object
Unified Product Image serializer for cloning product images.
6 properties 2 required
UnifiedCompany
object
2 properties 2 required
UnifiedCompanyCustomerStatus
object
Unified serializer for the CompanyCustomerStatus model.
7 properties 2 required
UnifiedCompanyCustomerStatusRequest
object
Unified serializer for the CompanyCustomerStatus model.
6 properties 1 required
UnifiedCompanyRequest
object
1 property 1 required
UnifiedContact
object
Unified Contact serializer
15 properties 5 required
UnifiedContactRequest
object
Unified Contact serializer
12 properties 2 required
UnifiedCustomMenu
object
Unified Custom Menu (Price Schedule) serializer.
6 properties 6 required
UnifiedCustomer
object
UnifiedCustomerSerializer inherits existing v2 CompanyCustomerSerializer for validations
41 properties 17 required
UnifiedCustomerGroup
object
Serializer for Customer Group.
7 properties 4 required
UnifiedCustomerGroupRequest
object
Serializer for Customer Group.
4 properties 1 required
UnifiedCustomerGroupStatusEnum
string
UnifiedCustomerRequest
object
UnifiedCustomerSerializer inherits existing v2 CompanyCustomerSerializer for validations
28 properties 2 required
UnifiedExpressProductMenu
object
7 properties 7 required
UnifiedExpressProductMenuRequest
object
3 properties 3 required
UnifiedInvoiceCustomer
object
2 properties 2 required
UnifiedL3Order
object
Internal serializer for L3Order Model.
33 properties 20 required
UnifiedL3OrderRequest
object
Internal serializer for L3Order Model.
21 properties 8 required
UnifiedL3OrderStatusEnum
string
UnifiedLicenseCreateUpdateRequest
object
Unified serializer for creating or updating licenses supplied by seed-to-sale vendors.
4 properties 4 required
UnifiedMessagingFindSeller
object
11 properties 5 required
UnifiedOrderAsSalesInvoice
object
Base serializer class to rename createdon and modified fields to follow new naming standard of createddate and modifieddate
11 properties 7 required
UnifiedOrderPayment
object
Serializer for handling order payment data and validations.
9 properties 7 required
UnifiedOrderPaymentRequest
object
Serializer for handling order payment data and validations.
4 properties 2 required
UnifiedOrderedProductAsInvoiceLineItem
object
4 properties 3 required
UnifiedPackage
object
Serializer for TraceabilityPackage - read/response only.
11 properties 4 required
UnifiedPomsOrderApprovalRequestData
object
Unified POMS Order Approval serializer for request data.
4 properties 2 required
UnifiedPomsOrderApprovalRequestDataRequest
object
Unified POMS Order Approval serializer for request data.
4 properties 2 required
UnifiedProduct
object
Unified Product serializer.
17 properties 15 required
UnifiedProductAssignmentBuyerItem
object
Serializer for Product Assignment Buyer Item
4 properties
UnifiedProductAssignmentBuyerItemInputRequest
object
Serializer for Product Assignment Buyer Item input (PUT request)
4 properties 1 required
UnifiedProductAssignmentGroupItem
object
Serializer for Product Assignment Group Item
4 properties
UnifiedProductAssignmentGroupItemInputRequest
object
Serializer for Product Assignment Group Item input (PUT request)
4 properties 1 required
UnifiedProductAssignmentProduct
object
Serializer for ProductListing (product + assignment) to API shape. Extracts product fields from ProductListing.product and assignment from ProductListing.assig…
35 properties 35 required
UnifiedProductAssignmentUpdateRequest
object
Serializer for updating product assignments (PUT request)
4 properties 1 required
UnifiedProductAssignmentWithItems
object
Serializer for Product Assignment with buyer and group items
5 properties 5 required
UnifiedProductBulkCreate
object
Unified ProductImage bulk create serializer.
3 properties 3 required
UnifiedProductBulkCreateRequest
object
Unified ProductImage bulk create serializer.
3 properties 3 required
UnifiedProductBulkUpdateDataRequest
object
Unified Product Bulk Update Data Serializer
3 properties 3 required
UnifiedProductBulkUpdateRequest
object
Unified Product Bulk Update Serializer
3 properties 3 required
UnifiedProductCategory
object
Unified Product category serializer
2 properties 2 required
UnifiedProductCategoryRequest
object
Unified Product category serializer
1 property 1 required
UnifiedProductDosageUnit
object
Unified Product Dosage Unit serializer.
6 properties 6 required
UnifiedProductImage
object
Unified ProductImage serializer.
10 properties 6 required
UnifiedProductImageRequest
object
Unified ProductImage serializer.
7 properties 3 required
UnifiedProductInventory
object
Unified Product inventory serializer
2 properties 2 required
UnifiedProductInventoryRequest
object
Unified Product inventory serializer
1 property 1 required
UnifiedProductLine
object
Base Unified ProductLine serializer.
8 properties 7 required
UnifiedProductLineCreate
object
Serializer for creating product lines.
8 properties 7 required
UnifiedProductLineCreateRequest
object
Serializer for creating product lines.
4 properties 2 required
UnifiedProductLineProduct
object
Serializer for a product in a product line.
2 properties 2 required
UnifiedProductMVP
object
Unified Product serializer.
27 properties 18 required
UnifiedProductMVPFromTemplate
object
Unified Product serializer for adding from template.
27 properties 18 required
UnifiedProductMVPRequest
object
Unified Product serializer.
22 properties 10 required
UnifiedProductRequest
object
Unified Product serializer.
13 properties 10 required
UnifiedProductSpecification
object
Unified Product Specification serializer.
7 properties 7 required
UnifiedProductSpecificationItem
object
Serializer for a product data item.
6 properties 2 required
UnifiedProductSpecificationItemRequest
object
Serializer for a product data item.
6 properties 2 required
UnifiedProductSubCategory
object
Unified Product Subcategory serializer
4 properties 3 required
UnifiedProductTemplate
object
Base serializer class to rename createdon and modified fields to follow new naming standard of createddate and modifieddate
33 properties 7 required
UnifiedProductTemplateRequest
object
Base serializer class to rename createdon and modified fields to follow new naming standard of createddate and modifieddate
28 properties 2 required
UnifiedRecommendedBrand
object
4 properties 4 required
UnifiedRecommendedCompany
object
4 properties 4 required
UnifiedStrain
object
Unified Strain serializer.
6 properties 5 required
UnifiedSubProductMVP
object
Unified Sub Product serializer.
9 properties 7 required
UnifiedSubProductMVPRequest
object
Unified Sub Product serializer.
7 properties 5 required
UnifiedTaxSchedule
object
TaxSchedule GET Serializer
6 properties 6 required
UnifiedTraceabilityCompanyCustomer
object
Traceability Company Customer Serializer - returns very limited information
4 properties 4 required
UnifiedTraceabilityPackageOrders
object
3 properties 3 required
UnifiedUnitDenomination
object
Unified UnitDenomination serializer.
7 properties 7 required
UnifiedUnitOfMeasure
object
Unified UnitOfMeasure serializer.
11 properties 11 required
UnifiedVendorBrand
object
3 properties 2 required
UnifiedVendorCompany
object
Unified API Vendor Company Serializer.
14 properties 9 required
UnreserveRequestRequest
object
Request body for POST .../commands/unreserve.
6 properties 5 required
User
object
3 properties
UserRequest
object
3 properties
Vehicle
object
Internal serializer for Vehicle Model.
8 properties 2 required
VehicleRequest
object
Internal serializer for Vehicle Model.
6 properties
ZipCode
object
Serializer for a zip code with optional polygon in a distribution zone.
3 properties 2 required
ZipCodeRequest
object
Serializer for a zip code with optional polygon in a distribution zone.
3 properties 2 required
_SponsorshipsContent
object
1 property 1 required
ChatStatusEnum
string
PromotionStatusEnum
string
ProductThresholdActionEnum
string
ProductReverseThresholdActionEnum
string
CartOrderPomsStatusEnum
string
BlankEnum-unified-upstream-marketplace
Company-unified-upstream-marketplace
object
API v2 serializer for the Company model.
31 properties 17 required
NullEnum-unified-upstream-marketplace
State-unified-upstream-marketplace
object
Serializer for State models via the internal API
4 properties 4 required
ErrorSource
object
2 properties
Error
object
7 properties 1 required
MultipleErrors
object
1 property 1 required
NotificationPreferencesPayloadSchema
object
3 properties 3 required
NotificationPreferences-unified-upstream-notification-service
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

leaflink-api-openapi-original.yml Raw ↑

Other APIs LeafLink publishes across the network.

LeafLink Marketplace V2 API
AE Profile APIs.io
#Cannabis#Wholesale#Marketplace#Inventory#Payments#Logistics#Compliance
← Back to L APIs
API Details
ID
leaflink:api
Base URL
https://api.leaflink.com
Docs
https://developer.leaflink.com/api/
Provider
LeafLink
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=api-2&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/api-2"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of LeafLink API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.