vintrace_list_work_orders
List work orders
List winery work orders (cellar jobs such as transfers, additions, bottling) with their jobs, assignee, status and scheduled time. Filter by scheduled time range, status and operation type. Reply: results plus next_offset. GET /v7/operation/work-orders.
Parameterslimitoffsetstatusoperation_typesscheduled_sincescheduled_before
vintrace_list_wine_batches
List wine batches
List wine batches (the named lots of wine) with volume, variety, vintage and owner. Use include=vessels,allocations to add where each batch sits. Reply: results plus next_offset. GET /v7/operation/wine-batches.
Parametersidlimitoffsetinclude
vintrace_get_vessel_details_report
Vessel contents report
The bulk wine report: every vessel (tank, barrel, bin, press, tanker) with its contents, volume, batch, owner and winery as at a date. Use extra_fields=composition,allocations,liveMetrics to add them. Covers every winery the token's user may access unless wineryId/wineryName narrows it. GET /v7/report/vessel-details-report.
Parametersas_atbatchlimitowneroffsetvesselvessel_idwinery_idproduct_idvessel_typewinery_nameextra_fields+1 more
vintrace_get_vessel
Get vessel
One vessel by id: a tank, barrel, barrel group, tanker or bin, with its details, dimensions and contents. GET /v7/vessel/<tanks|barrels|barrel-groups|tankers|bins>/{id}.
Parametersvessel_idrequiredvessel_typerequired
vintrace_list_lab_requests
List lab requests
The lab console: analysis tasks (samples to measure) with lab, template, vessel, batch, status and arrival. Completed tasks are left out unless status includes Completed. Reply: results plus next_offset. GET /v7/lab/lab-requests.
Parametersbatchlimitoffsetstatuslab_namedate_afterdate_beforevessel_namearrival_statusmodified_sincework_order_numberanalysis_template_name
vintrace_list_trial_blends
List trial blends
List trial blends (planned blend trials) with status and composition. Use composition_summary_by=variety,vintage to summarise. Reply: results plus next_offset. GET /v7/operation/trial-blends.
Parameterslimitoffsetstatusmodified_sincemodified_beforecomposition_summary_by
vintrace_search_transactions
Search winemaking transactions
Winemaking operations completed in a date range (transfers, additions, blends, racking...) with the from/to vessels and before/after volumes. Defaults to today when no dates are given. GET /v6/transaction/search.
Parametersdate_todate_frombatch_nameowner_namewinery_name
vintrace_list_barrel_treatments
List barrel treatments
Barrel move shipments / barrel treatments recorded in vintrace, with barrel states and treatment types. Reply: results plus next_offset. GET /v7/operation/barrel-treatments.
Parameterslimitoffsettreatmentmodified_sincemodified_before
vintrace_list_blocks
List vineyard blocks
List vineyard blocks (grower, vineyard, region, variety). To see fruit placements for a vintage pass include=fruitPlacements together with vintage. Reply: results plus next_offset. GET /v7/harvest/blocks.
Parametersidlimitoffsetincludevintage
vintrace_list_block_assessments
List block assessments
List vineyard block assessments (vine and fruit assessments by the viticulture team). Reply: results plus next_offset. GET /v7/harvest/assessments.
Parameterslimitoffsetassessed_byextra_fieldscreated_sincecreated_before
vintrace_list_bookings
List fruit bookings
List active fruit bookings (grape deliveries planned for a vintage) for one or more wineries: grower, block, variety, expected pick time and quantity. vintage and winery_ids are required. Reply: results plus next_offset. GET /v7/operation/bookings.
Parameterslimitoffsetvintagerequiredblock_namewinery_idsrequiredgrower_namearrival_aftervineyard_namearrival_beforebooking_numbermodified_since
vintrace_list_bulk_intakes
List bulk intakes
List bulk wine/juice intakes (wine bought or received in bulk) with batch, volume, owner and cost. Reply: results plus next_offset. GET /v7/operation/bulk-intakes.
Parameterslimitoffsetmodified_sincemodified_beforepurchase_reference
vintrace_search_fruit_intakes
Search fruit intakes
Fruit intake operations (grape deliveries weighed in at the winery): weights, grower, block, vineyard, vintage, docket numbers and metrics. Filter by vintage, grower, vineyard, block or recorded time. Page with first_result and max_results. GET /v6/intake-operations/search.
Parametersvintageblock_nameowner_namegrower_namemax_resultswinery_namefirst_resultintake_docketvineyard_namemodified_sincerecorded_afterdelivery_docket+1 more
vintrace_list_stock_dispatches
List stock dispatches
List stock dispatch actions (bottled goods and dry goods sent out) with routes, items and shipping information. Reply: results plus next_offset. GET /v7/stock/dispatches.
Parameterslimitoffset
vintrace_list_shipments
List bulk shipments
List shipments created by Bulk Dispatch and inter-winery dispatch operations, with destination and wine details. Reply: results plus next_offset. GET /v7/operation/shipments.
Parameterstypelimitoffsetincludefreight_codedispatch_typemodified_sincemodified_before
vintrace_list_cost_transactions
List bulk wine cost movements
Bulk wine cost movements between two times (cost of wine moved between batches and wineries), optionally for one winery or business unit. Needs the vintrace permission to view costs. Reply: results plus next_offset. GET /v7/costs/business-unit-transactions.
Parametersendrequiredlimitstartrequiredoffsetwinery_idwinery_namebusiness_unit
vintrace_list_brand_allocations
List brand allocations
List brand allocations of bulk wine (how much of a wine is promised to which brand), by status and vintage. Reply: results plus next_offset. GET /v7/allocations/brand-allocations.
Parameterslimitoffsetstatusvintagemodified_since
vintrace_get_purchase_order
Get purchase order
One purchase order with its lines, state and fulfilment. GET /v7/account/purchase-orders/{id}.
Parameterspurchase_order_idrequired
vintrace_list_inventory
List stock inventory
Stock on hand (bottled wine, dry goods, additives) up to a date: quantity, committed, on order and available per item, location, owner, tax class. breakout_costing needs the view-costs permission. GET /v6/inventory.
Parametersmaxdatefirstowner_namestock_typebreakout_costing
vintrace_lookup_stock_item
Look up stock item
Find one stock item by code (matched against the start of the code) or by id: type, unit, owner, accounts, tax class and sub-components. Give code or id. GET /v6/stock/lookup.
Parametersidcode
vintrace_get_stock_item
Get stock item details
One stock item by id with optional detail parts: expand=fields,distributions,notes,historyItems,rawComponents,bulkInfo. GET /v6/mrp/stock/{id}.
Parametersexpandstock_item_idrequired
vintrace_list_stock_item_notes
List stock item notes
The notes recorded on a stock item. GET /v6/mrp/stock/{id}/notes.
Parametersmax_resultfirst_resultstock_item_idrequired
vintrace_list_products
List products (wines in vessels)
List wine products as they sit in vessels: batch code, vessel, volume, colour, state and the latest lab metrics (TSO2, pH, Brix...). skip_metrics=true makes it faster. barcode matches a vessel code or asset id. GET /v6/products/list.
Parametersmaxfirstbarcodeskip_metrics
vintrace_get_product
Get product
One wine product by id (or by vessel barcode) with its vessel, volume and metrics. GET /v6/products/{id}.
Parametersbarcodeproduct_idrequired
vintrace_list_sales_orders
List sales orders
List sales orders with customer, status, price list, line items, totals and invoice date. Filter by status, customer, order date range or invoice date range. GET /v6/sales-order/list.
Parametersmaxfirststatusend_datestart_datestarts_withcustomer_nameinvoice_end_dateinvoice_start_dateexternal_transaction_id
vintrace_get_sales_order
Get sales order
One sales order by id, or by order code (for example VSO20): customer, items, prices, taxes and status. Give exactly one. GET /v6/sales-order/{id} or /v6/sales-order?code=.
Parameterscodesales_order_id
vintrace_list_parties
List parties (customers, growers, owners)
List parties: customers, growers, suppliers and owners, individuals or organisations, with address, phone and email. Filter by the start of the name and category. GET /v6/party/list.
Parametersmaxfirstcategorystarts_with
vintrace_get_party
Get party
One party (customer, grower, supplier, owner) by id, or by exact name. Give exactly one. GET /v6/party/{id} or /v6/party?name=.
Parametersnameparty_id
vintrace_get_work_order
Get work order
One work order by id: every job with its steps, summary text, status and assignee. Find the id with vintrace_list_work_orders or vintrace_list_work_orders_v6. GET /v6/workorders/{id}.
Parameterswork_order_idrequired
vintrace_list_work_orders_v6
List work orders (operator view)
Work orders from the operator's point of view (what is waiting for me / unassigned), with job counts, status and scheduled dates. Defaults to the last 7 days to 3 days ahead. GET /v6/workorders/list.
Parametersmaxfirststateto_datefrom_datewinery_idassigned_tostarts_with
vintrace_search_items
Search vintrace items by type
Look up names and ids of one kind of item: growers, owners, blocks, varietals, vintages, regions, programs, batches, products, tanks, barrels, bins and more. Use it to find the id or exact name another tool needs. GET /v6/search/list.
Parameterstyperequiredfirstexact_matchstarts_with
vintrace_add_stock_item_note
Add a note to a stock item
WRITE: adds a new note to a vintrace stock item (visible to everyone in the winery, recorded under the token's user). Adding the same note twice creates two notes. POST /v6/mrp/stock/{id}/notes.
Parametersdetailrequiredsubjectstock_item_idrequired
vintrace_assign_work_order
Assign a work order
WRITE: assigns a work order to the token's own vintrace user (or to assign_operator_id), so it shows up in that operator's list. With reassign=true it takes over a work order already assigned to someone else. Check the work order first with vintrace_get_work_order. POST /v6/workorders/assign.
Parametersjob_idreassignwork_order_idrequiredassign_operator_id
vintrace_deactivate_booking
Deactivate a fruit booking
WRITE: deactivates a fruit booking so it no longer counts as an active booking (the record is kept; it is not deleted). Use vintrace_list_bookings to find the booking id first. POST /v7/operation/bookings/{id}/deactivation.
Parametersbooking_idrequired