VendSoft API (2.0.0)
Download OpenAPI specification:
Create a new product
Operation description Markdown.
Authorizations:
Request Body schema: application/jsonrequired
requestBody description
| productCode | string non-empty Product SKU (should be unique) |
| productName | string non-empty Product name |
| productType | string non-empty Product type (category) |
| barcode | string Barcode |
| unitsPerCase | integer Number of items in a case / box |
| lastCost | number <double> Last cost |
Responses
Request samples
- Payload
{- "productCode": "COKE01",
- "productName": "Coca Cola Can",
- "productType": "Cold Drinks",
- "barcode": "5449000000996",
- "unitsPerCase": 24,
- "lastCost": 0.1
}Response samples
- 200
- 400
{- "productCode": "COKE01",
- "productName": "Coca Cola Can",
- "productType": "Cold Drinks",
- "barcode": "5449000000996",
- "unitsPerCase": 24,
- "lastCost": 0.1
}Update product
This can only be done by the logged in user.
Authorizations:
path Parameters
| productCode required | string The code of the product that needs to be updated |
Request Body schema: application/jsonrequired
Updated product object
| productCode | string non-empty Product SKU (should be unique) |
| productName | string non-empty Product name |
| productType | string non-empty Product type (category) |
| barcode | string Barcode |
| unitsPerCase | integer Number of items in a case / box |
| lastCost | number <double> Last cost |
Responses
Request samples
- Payload
{- "productCode": "COKE01",
- "productName": "Coca Cola Can",
- "productType": "Cold Drinks",
- "barcode": "5449000000996",
- "unitsPerCase": 24,
- "lastCost": 0.1
}Response samples
- 200
{- "productCode": "COKE01",
- "productName": "Coca Cola Can",
- "productType": "Cold Drinks",
- "barcode": "5449000000996",
- "unitsPerCase": 24,
- "lastCost": 0.1
}Create a new machine
Operation description Markdown.
Authorizations:
Request Body schema: application/jsonrequired
requestBody description
| machineCode | string non-empty Machine code (should be unique) |
| machineName | string non-empty Machine name |
| machineType | string non-empty Enum: "Soda" "Snack" "Coffee" "Soda/Snack" "Snack/Coffee" Machine type |
| machineModel | string Machine model |
| locationName | string Location name |
Responses
Request samples
- Payload
{- "machineCode": "CD001",
- "machineName": "Soda machine first floor",
- "machineType": "Soda",
- "machineModel": "Dixie Narco",
- "locationName": "string"
}Response samples
- 200
- 400
{- "machineCode": "CD001",
- "machineName": "Soda machine first floor",
- "machineType": "Soda",
- "machineModel": "Dixie Narco",
- "locationName": "string"
}Update machine
This can only be done by the logged in user.
Authorizations:
Request Body schema: application/jsonrequired
Updated machine object
| machineCode | string non-empty Machine code (should be unique) |
| machineName | string non-empty Machine name |
| machineType | string non-empty Enum: "Soda" "Snack" "Coffee" "Soda/Snack" "Snack/Coffee" Machine type |
| machineModel | string Machine model |
| locationName | string Location name |
Responses
Request samples
- Payload
{- "machineCode": "CD001",
- "machineName": "Soda machine first floor",
- "machineType": "Soda",
- "machineModel": "Dixie Narco",
- "locationName": "string"
}Response samples
- 200
{- "machineCode": "CD001",
- "machineName": "Soda machine first floor",
- "machineType": "Soda",
- "machineModel": "Dixie Narco",
- "locationName": "string"
}Get telemetry sales
Get sales transactions from telemetry data for a specific machine.
Authorizations:
path Parameters
| machineCode required | string The code of the machine |
query Parameters
| fromDate | string^\d{14}$ Example: fromDate=20250610000000 Start date in format yyyyMMddHHmmss |
| toDate | string^\d{14}$ Example: toDate=20250610235959 End date in format yyyyMMddHHmmss |
Responses
Response samples
- 200
[- {
- "telemetryId": "VK12345",
- "transactionId": 126290169,
- "transactionTime": "20250610225908",
- "productName": "Coca Cola Can",
- "machineCode": "CD001",
- "productCode": "COKE01",
- "creditCard": "*1234",
- "quantity": 1,
- "selection": "62",
- "price": 1.2,
- "machineName": "Cold drink 1"
}
]Get planogram
This can only be done by the logged in user.
Authorizations:
path Parameters
| machineCode required | string The code of the machine |
Responses
Response samples
- 200
[- {
- "column": "A1",
- "columnType": "soda",
- "productCode": "COKE01",
- "productName": "Coca Cola Can",
- "productType": "Cold Drinks",
- "vendPrice": 0.1,
- "maxCapacity": 0,
- "lastCount": 0
}
]Create or update planogram
This can only be done by the logged in user.
Authorizations:
path Parameters
| machineCode required | string The code of the machine that needs to be updated |
Request Body schema: application/jsonrequired
Updated machine object
| column | string non-empty The item selection (should be unique) |
| columnType | string Enum: "soda" "drink" "ingredient" The type of the column |
| productCode | string non-empty Product SKU (should be unique) |
| productName | string non-empty Product name |
| productType | string non-empty Product type (category) |
| vendPrice | number <double> Vend price |
| maxCapacity | integer Capacity of the column |
| lastCount | integer The last fill level (for soda columns) |
Responses
Request samples
- Payload
[- {
- "column": "A1",
- "columnType": "soda",
- "productCode": "COKE01",
- "productName": "Coca Cola Can",
- "productType": "Cold Drinks",
- "vendPrice": 0.1,
- "maxCapacity": 0,
- "lastCount": 0
}
]Refill machine
This can only be done by the logged in user.
Authorizations:
path Parameters
| machineCode required | string The code of the machine that needs to be updated |
Request Body schema: application/jsonrequired
Refill object
| refillTime | string <date-time> Timestamp of the refill |
| driverEmail | string The email of the driver |
| driverUsername | string The username of the driver |
| cashCollected | boolean A flag showing whether the cash has been collected during the visit |
| cashCollectedAmount | number <double> The cash collected from the machine |
Array of objects (RefillColumn) The item selection (should be unique) |
Responses
Request samples
- Payload
{- "refillTime": "2023-07-12 07:20:50",
- "driverEmail": "string",
- "driverUsername": "string",
- "cashCollected": true,
- "cashCollectedAmount": 0.1,
- "columns": [
- {
- "column": "A1",
- "newProductCode": "string",
- "newPrice": 0.1,
- "newCount": 0
}
]
}Response samples
- 200
- 400
[- {
- "locationCode": "L001",
- "locationName": "Casa Estates",
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "region": "string",
- "zipCode": "string"
}
]Create a new purchase
Operation description Markdown.
Authorizations:
Request Body schema: application/jsonrequired
requestBody description
| purchaseDate | string <date> non-empty Date of the purchase |
| supplierName | string non-empty Name of the supplier |
| invoiceNumber | string non-empty Invoice number |
| shippingCost | number <double> Shipping Cost |
| salesTax | number <double> Sales Tax |
Array of objects (PurchaseLineItem) Purchase line items |
Responses
Request samples
- Payload
{- "purchaseDate": "2023-07-12",
- "supplierName": "string",
- "invoiceNumber": "string",
- "shippingCost": 0.1,
- "salesTax": 0.1,
- "lineItems": [
- {
- "productCode": "COKE01",
- "productName": "Coca Cola Can",
- "productType": "Cold Drinks",
- "numberCases": 0,
- "costPerCase": 0.1,
- "unitsPerCase": 0,
- "numberUnits": 0,
- "unitCost": 0.1
}
]
}Response samples
- 200
- 400
{- "purchaseDate": "2023-07-12",
- "supplierName": "string",
- "invoiceNumber": "string",
- "shippingCost": 0.1,
- "salesTax": 0.1,
- "lineItems": [
- {
- "productCode": "COKE01",
- "productName": "Coca Cola Can",
- "productType": "Cold Drinks",
- "numberCases": 0,
- "costPerCase": 0.1,
- "unitsPerCase": 0,
- "numberUnits": 0,
- "unitCost": 0.1
}
]
}Create a new ticket
Operation description Markdown.
Authorizations:
Request Body schema: application/jsonrequired
requestBody description
| machineCode | string non-empty Machine Code |
| problemType | string non-empty Problem Type |
| description | string Description |
| clientEmail | string Client Email |
| clientPhone | string Client Phone |
Responses
Request samples
- Payload
{- "machineCode": "CD001",
- "problemType": "Refund/Machine Broken/Restock Required/Product Request/Other",
- "description": "string",
- "clientEmail": "string",
- "clientPhone": "string"
}Response samples
- 200
- 400
{- "machineCode": "CD001",
- "problemType": "Refund/Machine Broken/Restock Required/Product Request/Other",
- "description": "string",
- "clientEmail": "string",
- "clientPhone": "string"
}