Introduction

Welcome to the vintrace API workspace!

We’re thrilled that you want to explore the vintrace API. vintrace streamlines winery operations and captures data throughout every stage of production. Our API seamlessly integrates with other applications that you work with so that they can communicate with vintrace. Using the API, you’ll be able to get, add, or update your data in vintrace.

The vintrace APIs are designed using one of the most popular API languages in the industry: RESTful. You can also export the APIs using the OpenAPI Specification for your development team.

Getting Started

Each vintrace customer has a different base API URL that’s in the format: https://<region>.vintrace.net/<CustomerCode>

For example, if your URL after logging into vintrace is: https://oz50.vintrace.net/vinx2/

Your base API URL is: https://oz50.vintrace.net/vinx2/api/

If you wanted to use the account API to create purchase orders, your API URL would be: https://oz50.vintrace.net/vinx2/api/v7/account/purchase-orders

You might also want to create a new API token for the user. The token’s permissions are bound to the user’s permissions.

Available APIs and Endpoints

The endpoints for vintrace’s API v7 can be found here: http://api-docs.vintrace.com/docs/vintrace-server.

We recommend that you use v7 of the API. If you need functionality from v6 of the API, it will continue to work. However, it is in maintenance mode and will be deprecated.

V7 Endpoints

The endpoints and their schemas are organized by vintrace’s functional areas.

• Account - Access account-related data, such as purchase orders.
• Costs - Access bulk wine vessels and their details about their content.
• Harvest - Access, create, and update data related to vineyards, blocks, block assessments, and maturity samples.
• Identity - Access and update contacts in your vintrace address book.
• Operation - Access, create, update, and deactivate data related to operations.
• Report - Access details about vessels.
• Stock - Stock-related operations such as receiving stock.

V6 Endpoints

The endpoints are organized by vintrace’s functional areas.

• Jobs - Access and update data about work orders and jobs.
• Sales - Access, create and update sales order data.
• Bulk Wine - Access and update product data.
• Harvest - Access fruit intake and maturity sample data, and create block assessments.
• Stock - Access and update stock data.
• Search - Access grading, owner, program, varietal, vintage, product state, region, block, grower, product category, batch, product, tank, vessel, container equipment, barrel, and bin data.

V6 also provides a number of schemas.

Self-Service API Integration

Our API is built for self-service, allowing you to integrate at your own pace. For any technical questions, we recommend consulting with someone from your team or engaging a third-party expert to guide you through the documentation.

If you have requests for new API endpoints, you can submit them here. Please include a brief explanation of your need and specify the type of endpoint (e.g., POST, GET).

More information about usings our APIs can be found in our knowledge base here.