logo
API docs by Redocly

VendSoft API (2.0.0)

Download OpenAPI specification:Download

URL: https://www.vendsoft.com/ License: Apache 2.0

Introduction

Product

Operations about products.

Get list of products

Returns a list of products

Authorizations:
api_keybasic_auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new product

Operation description Markdown.

Authorizations:
api_keybasic_auth
Request Body schema: application/json
required

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

Content type
application/json
{
  • "productCode": "COKE01",
  • "productName": "Coca Cola Can",
  • "productType": "Cold Drinks",
  • "barcode": "5449000000996",
  • "unitsPerCase": 24,
  • "lastCost": 0
}

Response samples

Content type
application/json
{
  • "productCode": "COKE01",
  • "productName": "Coca Cola Can",
  • "productType": "Cold Drinks",
  • "barcode": "5449000000996",
  • "unitsPerCase": 24,
  • "lastCost": 0
}

Update product

This can only be done by the logged in user.

Authorizations:
api_keybasic_auth
path Parameters
productCode
required
string

The code of the product that needs to be updated

Request Body schema: application/json
required

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

Content type
application/json
{
  • "productCode": "COKE01",
  • "productName": "Coca Cola Can",
  • "productType": "Cold Drinks",
  • "barcode": "5449000000996",
  • "unitsPerCase": 24,
  • "lastCost": 0
}

Response samples

Content type
application/json
{
  • "productCode": "COKE01",
  • "productName": "Coca Cola Can",
  • "productType": "Cold Drinks",
  • "barcode": "5449000000996",
  • "unitsPerCase": 24,
  • "lastCost": 0
}

Machine

Operations about machines.

Get list of machines

Returns a list of machines

Authorizations:
api_keybasic_auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new machine

Operation description Markdown.

Authorizations:
api_keybasic_auth
Request Body schema: application/json
required

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

Content type
application/json
{
  • "machineCode": "CD001",
  • "machineName": "Soda machine first floor",
  • "machineType": "Soda",
  • "machineModel": "Dixie Narco",
  • "locationName": "string"
}

Response samples

Content type
application/json
{
  • "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:
api_keybasic_auth
Request Body schema: application/json
required

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

Content type
application/json
{
  • "machineCode": "CD001",
  • "machineName": "Soda machine first floor",
  • "machineType": "Soda",
  • "machineModel": "Dixie Narco",
  • "locationName": "string"
}

Response samples

Content type
application/json
{
  • "machineCode": "CD001",
  • "machineName": "Soda machine first floor",
  • "machineType": "Soda",
  • "machineModel": "Dixie Narco",
  • "locationName": "string"
}

Planogram

Operations about machine planograms.

Get planogram

This can only be done by the logged in user.

Authorizations:
api_keybasic_auth
path Parameters
machineCode
required
string

The code of the machine

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create or update planogram

This can only be done by the logged in user.

Authorizations:
api_keybasic_auth
path Parameters
machineCode
required
string

The code of the machine that needs to be updated

Request Body schema: application/json
required

Updated machine object

Array
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

Content type
application/json
[
  • {
    }
]

Refill

Operations about refilling machines.

Refill machine

This can only be done by the logged in user.

Authorizations:
api_keybasic_auth
path Parameters
machineCode
required
string

The code of the machine that needs to be updated

Request Body schema: application/json
required

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

Content type
application/json
{
  • "refillTime": "2023-07-12 07:20:50",
  • "driverEmail": "string",
  • "driverUsername": "string",
  • "cashCollected": true,
  • "cashCollectedAmount": 0,
  • "columns": [
    ]
}

Location

Operations about locations.

Get list of locations

Returns a list of locations

Authorizations:
api_keybasic_auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Purchase

Operations about purchases.

Create a new purchase

Operation description Markdown.

Authorizations:
api_keybasic_auth
Request Body schema: application/json
required

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

Content type
application/json
{
  • "purchaseDate": "2023-07-12",
  • "supplierName": "string",
  • "invoiceNumber": "string",
  • "shippingCost": 0,
  • "salesTax": 0,
  • "lineItems": [
    ]
}

Response samples

Content type
application/json
{
  • "purchaseDate": "2023-07-12",
  • "supplierName": "string",
  • "invoiceNumber": "string",
  • "shippingCost": 0,
  • "salesTax": 0,
  • "lineItems": [
    ]
}