Products
Products
get
Query parameters
idintegerRequired
Responses
200
OK
application/json
get
GET /v1/products/get?id=1 HTTP/1.1
Host:
Accept: */*
200
OK
{
"id": 1,
"company_id": 1,
"sku": "text",
"barcode": "text",
"name": "text",
"brand": "text",
"type": "text",
"category": "text",
"tags": [
"text"
],
"size": 1,
"size_measure": "text",
"carton_barcode": "text",
"carton_width": 1,
"carton_height": 1,
"carton_depth": 1,
"carton_weight": 1,
"carton_price": 1,
"images": [
"text"
],
"ingredients": "text",
"allergens": "text",
"allergens_may_contain": "text",
"storage_type": "text",
"manufacture_country": "text",
"percentage_australian": "text",
"buy_product": true,
"sell_product": true,
"avg_unit_cost": 1,
"default_price": 1,
"default_sale_price": 1,
"tax_type": "text",
"tax_percentage": 1,
"suppliers": [
{
"id": "text",
"type": "Internal",
"name": "text",
"carton_qty": 1,
"carton_price": 1,
"tax_type": "text",
"tax_percentage": 1,
"as_product_id": 1,
"sku": "text",
"barcode": "text",
"product_name": "text",
"brand": "text",
"size": 1,
"size_measure": "text"
}
],
"sales_channels": [
{
"id": 1,
"name": "text",
"price": 1,
"sale_price": 1,
"carton_qty": 1,
"tax_type": "text",
"tax_percentage": 1
}
],
"inventory": [
{
"id": 1,
"product_id": 1,
"company_id": 1,
"location_id": "text",
"location_name": "text",
"manage_stock": true,
"in_stock": true,
"stock_on_hand": 1,
"stock_on_order": 1,
"stock_to_be_picked": 1,
"stock_available": 1
}
]
}get
Query parameters
idintegerRequired
location_idstringRequired
Responses
200
OK
application/json
get
GET /v1/products/inventory?id=1&location_id=text HTTP/1.1
Host:
Accept: */*
200
OK
[
{
"id": 1,
"product_id": 1,
"company_id": 1,
"location_id": "text",
"location_name": "text",
"manage_stock": true,
"in_stock": true,
"stock_on_hand": 1,
"stock_on_order": 1,
"stock_to_be_picked": 1,
"stock_available": 1
}
]put
Body
batch_idintegerOptional
stock_on_handnumberOptional
Responses
202
Accepted
No content
put
PUT /v1/inventory/set HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 32
{
"batch_id": 1,
"stock_on_hand": 1
}202
Accepted
No content
get
Query parameters
pageintegerOptional
Responses
200
OK
application/json
get
GET /v1/products/ HTTP/1.1
Host:
Accept: */*
200
OK
[
{
"id": 1,
"company_id": 1,
"sku": "text",
"barcode": "text",
"name": "text",
"brand": "text",
"type": "text",
"category": "text",
"tags": [
"text"
],
"size": 1,
"size_measure": "text",
"carton_barcode": "text",
"carton_width": 1,
"carton_height": 1,
"carton_depth": 1,
"carton_weight": 1,
"carton_price": 1,
"images": [
"text"
],
"ingredients": "text",
"allergens": "text",
"allergens_may_contain": "text",
"storage_type": "text",
"manufacture_country": "text",
"percentage_australian": "text",
"buy_product": true,
"sell_product": true,
"avg_unit_cost": 1,
"default_price": 1,
"default_sale_price": 1,
"tax_type": "text",
"tax_percentage": 1,
"suppliers": [
{
"id": "text",
"type": "Internal",
"name": "text",
"carton_qty": 1,
"carton_price": 1,
"tax_type": "text",
"tax_percentage": 1,
"as_product_id": 1,
"sku": "text",
"barcode": "text",
"product_name": "text",
"brand": "text",
"size": 1,
"size_measure": "text"
}
],
"sales_channels": [
{
"id": 1,
"name": "text",
"price": 1,
"sale_price": 1,
"carton_qty": 1,
"tax_type": "text",
"tax_percentage": 1
}
],
"inventory": [
{
"id": 1,
"product_id": 1,
"company_id": 1,
"location_id": "text",
"location_name": "text",
"manage_stock": true,
"in_stock": true,
"stock_on_hand": 1,
"stock_on_order": 1,
"stock_to_be_picked": 1,
"stock_available": 1
}
]
}
]