Sample Responses
Get Endpoints
Distributor Endpoint
{
"resultCode": "SUCCESS",
"resultReason": null,
"totalPages": 1,
"totalElements": 17,
"resultDetail": null,
"data": [
{
"id": "12846edd-a097-491a-a61e-f369e589dc0c",
"type": "NON_ARMS_LENGTH",
"company": "JIMMY'S DISTRIBUTION",
"doing_business_as": null,
"address": "999 STREET, CA",
"phone": "8888888888",
"email": "[email protected]",
"default_payment_term": "PIA",
"lead_time": "10",
"delivery_days": "MON, TUE, SAT",
"preferred_payment_method": "ACH",
"active": "true",
"available_credit": 0.000000,
"licenses": [
{
"id": "84162573-9938-4170-b116-65ef71224774",
"label": "DISTRIBUTOR",
"type": "ALL",
"license_number": "LC-956C",
"expiration_date": "2024-12-31T23:01:59.000-08:00",
"status": "active"
}
]
},
{
"id": "1615f64d-cbf4-47b7-a4eb-566dd2fb523e",
"type": "ARMS_LENGTH",
"company": "CANNABIS SALES & SERVICES",
"doing_business_as": null,
"address": "",
"phone": "510-780-0777",
"email": "[email protected]",
"default_payment_term": "COD",
"lead_time": null,
"delivery_days": null,
"preferred_payment_method": null,
"active": "true",
"available_credit": 0.000000,
"licenses": []
}
]
}
Location Endpoint
{
"resultCode": "SUCCESS",
"resultReason": null,
"totalPages": 1,
"totalElements": 45,
"resultDetail": null,
"data": [
{
"id": "03b2249e-e70a-4ab9-80b8-25bb8c804a81",
"active": true,
"inventory_type": "ALL",
"name": "GREENBOX",
"parent_location_id": "dee203b0-6ff7-11e9-b685-0280fd4571a6",
"sellable": false
},
{
"id": "0937001d-915b-4a3e-85a9-40a4a33293bf",
"active": true,
"inventory_type": "ALL",
"name": "DOWNTOWN-VEHICLE-1",
"parent_location_id": "0ecade63-bd35-4bed-a4d9-5d5978643b2f",
"sellable": true
},
{
"id": "0ecade63-bd35-4bed-a4d9-5d5978643b2f",
"active": true,
"inventory_type": "ALL",
"name": "EXPRESS",
"parent_location_id": "dee203b0-6ff7-11e9-b685-0280fd4571a6",
"sellable": false
},
{
"id": "0ecb95a9-5b14-4582-a286-5b69da30d97b",
"active": true,
"inventory_type": "ALL",
"name": "IVAN TEST",
"parent_location_id": "810bae8a-ae15-4e77-838b-0aa1860f9734",
"sellable": true
},
{
"id": "1b5f9fb4-bb00-11ec-86b3-0a9e30450f4d",
"active": true,
"inventory_type": "ALL",
"name": "AWAITING TRANSFER",
"parent_location_id": "dee203b0-6ff7-11e9-b685-0280fd4571a6",
"sellable": false
},
{
"id": "1fc30304-f959-4765-9768-b1b0072866a5",
"active": true,
"inventory_type": "ALL",
"name": "BUDSENSE",
"parent_location_id": "dee203b0-6ff7-11e9-b685-0280fd4571a6",
"sellable": false
}
]
}
Payment Term Endpoint
{
"resultCode": "SUCCESS",
"resultReason": null,
"totalPages": 1,
"totalElements": 8,
"resultDetail": null,
"data": [
{
"id": "636bc474-49b4-11e9-8035-774805423a5c",
"label": "COD",
"payment_due": "Cash on Delivery"
},
{
"id": "636bd702-49b4-11e9-8035-774805423a5c",
"label": "PIA",
"payment_due": "Pay in Advance"
},
{
"id": "636be440-49b4-11e9-8035-774805423a5c",
"label": "EOM",
"payment_due": "End of Month"
},
{
"id": "636bf570-49b4-11e9-8035-774805423a5c",
"label": "Net 7",
"payment_due": "Net 7"
},
{
"id": "636c03a8-49b4-11e9-8035-774805423a5c",
"label": "Net 10",
"payment_due": "Net 10"
},
{
"id": "636c1230-49b4-11e9-8035-774805423a5c",
"label": "Net 14",
"payment_due": "Net 14"
},
{
"id": "636c248c-49b4-11e9-8035-774805423a5c",
"label": "Net 30",
"payment_due": "Net 30"
},
{
"id": "dce54787-7282-4865-9189-d2825bce318c",
"label": "Locker",
"payment_due": "Locker"
}
]
}
Invoice Endpoint
{
"resultCode": "SUCCESS",
"resultReason": null,
"resultDetail": null,
"data": {
"id": "f563773a-aa5a-48fb-869b-1d53f2a7daad",
"visible_id": "1574",
"total_cost": 3250.00,
"outstanding_balance": 2750.00,
"payment_status": "PARTIALLY PAID",
"payments": [
{
"payment_date": "2023-12-04T10:52:44.000-0800",
"payment_user": "TreezScottThacher",
"payment_amount": 500.00,
"transaction_type": "Cash Handling",
"payment_source": "TPB TEST",
"payment_notes": "Making a partial payment per agreement"
}
],
"distributor_id": "0caa57fb-a1a6-4dc7-93c6-e1a720c54104",
"inventory_location": "QUINCY",
"inventory_type": "CUSTOM",
"external_invoice_id": "FG558",
"status": "ACCEPTED",
"note": null,
"payment_terms": "Net 30",
"created_date": "2023-11-07T22:00:00.000-08:00",
"last_updated_date": "2023-12-04T10:50:28.000-08:00",
"accepted_date": "2023-12-04T10:50:28.000-08:00",
"due_date": "2023-12-07T22:00:00.000-08:00",
"discounts": [],
"fees": [],
"custom_invoice_fields": [],
"invoice_line_list": [
{
"id": "0202722c-d724-461d-86f3-d47178be1f1a",
"product_id": "71220234-f91c-4bae-a737-ecfc8aebd9b1",
"quantity": "100.000000",
"base_cost_unit": "32.500000",
"excise_tax_unit": "0.000000",
"true_cost_unit": 32.500000,
"total_cost": 3250.000000,
"manifest_number": null,
"dispensary_license": null,
"harvest_date": "2022-04-18",
"received_date": "2023-12-04",
"expiration_date": null,
"lot_number": null,
"production_run": null,
"inventory_type": "RECREATIONAL",
"external_batch_id": "13442",
"barcode": [
"5iL",
"A7048"
],
"discounts": [],
"fees": [],
"open_label_field_1": "490",
"open_label_field_2": null,
"open_label_field_3": null
}
]
}
}
Post/Put Endpoints
Distributor Endpoints
{
"resultCode": "SUCCESS",
"resultReason": null,
"resultDetail": null,
"data": {
"id": "d7c76d90-6dcf-437e-9c16-c01cda43eddb",
"type": "NON_ARMS_LENGTH",
"company": "JIMMY'S DISTRUBTION",
"doing_business_as": "MAGIC PUFF",
"address": "999 STREET, CA",
"phone": "8888888888",
"email": "[email protected]",
"default_payment_term": "PIA",
"lead_time": "10",
"delivery_days": "MON, TUE, SAT",
"preferred_payment_method": "ACH",
"active": "false",
"available_credit": 0,
"licenses": [
{
"id": "f93c5ae9-36d9-470d-ab08-49d1b8c85250",
"label": "DISTRIBUTOR",
"type": "ALL",
"license_number": "LC-956C",
"expiration_date": "2024-12-31T23:01:59.000-08:00",
"status": "active"
}
]
}
}
Invoice Endpoint
{
"resultCode": "SUCCESS",
"resultReason": null,
"resultDetail": null,
"data": {
"id": "0f64da06-51b0-42af-ac3c-e058035d0883",
"visible_id": "702",
"total_cost": 1987.45,
"distributor_id": "12846edd-a097-491a-a61e-f369e589dc0c",
"inventory_location": "BACK OF HOUSE",
"inventory_type": "CUSTOM",
"external_invoice_id": "JD13625",
"status": "DRAFT",
"note": "This is a note",
"payment_terms": "Net 30",
"created_date": "2022-09-23T10:00:01.000-07:00",
"last_updated_date": "2022-10-06T16:43:49.468-07:00",
"accepted_date": null,
"due_date": "2022-11-08T09:00:01.000-08:00",
"discounts": [
{
"id": "2cf64969-9745-40d3-87e8-bce88362ea63",
"label": "10% Discount",
"discount_type": "PERCENTAGE",
"discount_amount": "10"
}
],
"fees": [
{
"id": "af5a3b0e-7dba-4ae7-be79-a799c65d7fd0",
"label": "10 Fee",
"fee_type": "DOLLAR",
"fee_amount": "10"
}
],
"invoice_line_list": [
{
"id": "b6f7dbeb-2cf4-41b7-86e5-e730860f2f11",
"product_id": "d87091bb-9b33-4081-8400-c2d4e982a0df",
"quantity": "10",
"base_cost_unit": "20.000000",
"excise_tax_unit": "0.000000",
"true_cost_unit": 18.089566,
"total_cost": 180.895660,
"manifest_number": null,
"dispensary_license": null,
"harvest_date": "2022-06-16",
"received_date": "2022-08-20",
"expiration_date": null,
"inventory_type": "RECREATIONAL",
"external_batch_id": "8669SJZSLE901227ASIN8914",
"barcode": [
"5ghyq"
],
"discounts": [],
"fees": [],
"open_label_field_1": null,
"open_label_field_2": "Merch label",
"open_label_field_3": null
},
{
"id": "1ceb9642-2a09-4319-bc90-39cfb5ab9514",
"product_id": "71220234-f91c-4bae-a737-ecfc8aebd9b1",
"quantity": "15",
"base_cost_unit": "17.000000",
"excise_tax_unit": "0.000000",
"true_cost_unit": 17.892797,
"total_cost": 268.391955,
"manifest_number": "125M",
"dispensary_license": "C23423-LIC",
"harvest_date": "2022-06-15",
"received_date": "2022-08-20",
"expiration_date": "2023-10-28",
"inventory_type": "RECREATIONAL",
"external_batch_id": "8I4SAZ4IOFZTPM1UH1TOY0LT",
"barcode": [
"60ift"
],
"discounts": [
{
"id": "c0f616f2-9ff0-4623-a473-c85a0cf2f8a8",
"label": "Invoice Line 5% Discount",
"discount_type": "PERCENTAGE",
"discount_amount": "-5"
}
],
"fees": [
{
"id": "5a8ae23f-1a2e-4a47-a605-67c01f26c26a",
"label": "Invoice Line 25 Fee",
"fee_type": "DOLLAR",
"fee_amount": "25"
}
],
"open_label_field_1": "Label 1",
"open_label_field_2": null,
"open_label_field_3": "Label 3"
},
{
"id": "6d1df701-a2ce-41dc-8645-5030e090124e",
"product_id": "565c5d35-8a51-400a-bd64-4e3e5f3a6d02",
"quantity": "100",
"base_cost_unit": "14.000000",
"excise_tax_unit": "0.000000",
"true_cost_unit": 11.962696,
"total_cost": 1196.269600,
"manifest_number": null,
"dispensary_license": null,
"harvest_date": null,
"received_date": "2022-08-20",
"expiration_date": null,
"inventory_type": "MEDICAL",
"external_batch_id": "43NI2URAPXS4E33CYINH25P1",
"barcode": [
"314jf"
],
"discounts": [
{
"id": "b4fd1c43-3c96-43b4-9a17-a7ac6bf7291e",
"label": "Medical Discount",
"discount_type": "PERCENTAGE",
"discount_amount": "5"
}
],
"fees": [],
"open_label_field_1": null,
"open_label_field_2": "Preroll",
"open_label_field_3": null
},
{
"id": "a11a1eac-03c2-406b-b83b-702b7390e479",
"product_id": "84b11da6-52c1-48aa-8d08-0ccd0ead72fc",
"quantity": "28",
"base_cost_unit": "13.500000",
"excise_tax_unit": "0.000000",
"true_cost_unit": 12.210457,
"total_cost": 341.892796,
"manifest_number": null,
"dispensary_license": "C12-1000010-LIC",
"harvest_date": null,
"received_date": null,
"expiration_date": "2023-02-27",
"inventory_type": "RECREATIONAL",
"external_batch_id": "1A4FF0100000022000000048",
"barcode": [
"3pr1x"
],
"discounts": [],
"fees": [],
"open_label_field_1": null,
"open_label_field_2": null,
"open_label_field_3": null
}
]
}
}
Updated 5 months ago
What’s Next