Products

Products

get

Query parameters

skustringOptional

Responses

200

OK

application/json

idintegerOptional

company_idintegerOptional

skustringOptional

barcodestringOptional

namestringOptional

brandstring · nullableOptional

typestringOptional

categorystringOptional

tagsstring[]Optional

sizenumberOptional

size_measurestringOptional

carton_barcodestring · nullableOptional

carton_widthnumberOptional

carton_heightnumberOptional

carton_depthnumberOptional

carton_weightnumberOptional

carton_pricenumberOptional

imagesstring[]Optional

ingredientsstring · nullableOptional

allergensstring · nullableOptional

allergens_may_containstring · nullableOptional

storage_typestringOptional

manufacture_countrystring · nullableOptional

percentage_australianstring · nullableOptional

buy_productbooleanOptional

sell_productbooleanOptional

avg_unit_costnumber · nullableOptional

default_pricenumber · nullableOptional

default_sale_pricenumber · nullableOptional

tax_typestringOptional

tax_percentagenumberOptional

last_modified_atstring · nullableOptional

custom_fieldsobjectOptional

get

/v1/products/find

HTTPcURLJavaScriptPython

GET /v1/products/find HTTP/1.1
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,
  "last_modified_at": "text",
  "custom_fields": {},
  "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

Responses

200

OK

application/json

idintegerOptional

company_idintegerOptional

skustringOptional

barcodestringOptional

namestringOptional

brandstring · nullableOptional

typestringOptional

categorystringOptional

tagsstring[]Optional

sizenumberOptional

size_measurestringOptional

carton_barcodestring · nullableOptional

carton_widthnumberOptional

carton_heightnumberOptional

carton_depthnumberOptional

carton_weightnumberOptional

carton_pricenumberOptional

imagesstring[]Optional

ingredientsstring · nullableOptional

allergensstring · nullableOptional

allergens_may_containstring · nullableOptional

storage_typestringOptional

manufacture_countrystring · nullableOptional

percentage_australianstring · nullableOptional

buy_productbooleanOptional

sell_productbooleanOptional

avg_unit_costnumber · nullableOptional

default_pricenumber · nullableOptional

default_sale_pricenumber · nullableOptional

tax_typestringOptional

tax_percentagenumberOptional

last_modified_atstring · nullableOptional

custom_fieldsobjectOptional

get

/v1/products/get

HTTPcURLJavaScriptPython

GET /v1/products/get?id=1 HTTP/1.1
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,
  "last_modified_at": "text",
  "custom_fields": {},
  "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

idintegerOptional

product_idintegerOptional

company_idintegerOptional

location_idstringOptional

location_namestringOptional

manage_stockbooleanOptional

in_stockbooleanOptional

stock_on_handnumberOptional

stock_on_ordernumberOptional

stock_to_be_pickednumberOptional

stock_availablenumberOptional

get

/v1/products/inventory

HTTPcURLJavaScriptPython

GET /v1/products/inventory?id=1&location_id=text HTTP/1.1
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

application/json

batch_idintegerOptional

stock_on_handnumberOptional

Responses

202

Accepted

put

/v1/inventory/set

HTTPcURLJavaScriptPython

PUT /v1/inventory/set HTTP/1.1
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

/v1/products/

HTTPcURLJavaScriptPython

GET /v1/products/ HTTP/1.1
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,
    "last_modified_at": "text",
    "custom_fields": {},
    "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
      }
    ]
  }
]

post

Body

application/json

brandstringOptional

namestringRequired

sizenumber · nullableOptional

size_measurestring · nullableOptional

g, kg, ml, lt, oz, floz, lb

skustring · nullableOptional

barcodestring · nullableOptional

carton_barcodestring · nullableOptional

categorystringRequired

tagsstring[]Optional

carton_widthnumber · nullableOptional

carton_heightnumber · nullableOptional

carton_deptnumber · nullableOptional

carton_weightnumber · nullableOptional

ingredientsstring · nullableOptional

allergensstring · nullableOptional

allergens_may_containstring · nullableOptional

storage_typestring · nullableOptional

manufacture_countrystring · nullableOptional

percentage_australiannumber · nullableOptional

buy_productbooleanOptional

sell_productbooleanOptional

default_pricenumber · nullableOptional

default_sale_pricenumber · nullableOptional

tax_typestringOptional

CSV of tax rate names from Settings > Tax

Responses

201

Created

application/json

post

/v1/products/

HTTPcURLJavaScriptPython

POST /v1/products/ HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 692

{
  "brand": "text",
  "name": "text",
  "size": 1,
  "size_measure": "text",
  "sku": "text",
  "barcode": "text",
  "carton_barcode": "text",
  "category": "text",
  "tags": [
    "text"
  ],
  "carton_width": 1,
  "carton_height": 1,
  "carton_dept": 1,
  "carton_weight": 1,
  "ingredients": "text",
  "allergens": "text",
  "allergens_may_contain": "text",
  "storage_type": "text",
  "manufacture_country": "text",
  "percentage_australian": 1,
  "buy_product": true,
  "sell_product": true,
  "default_price": 1,
  "default_sale_price": 1,
  "tax_type": "text",
  "suppliers": [
    {
      "id": "text",
      "carton_qty": 1,
      "carton_price": 0,
      "tax_type": "text",
      "sku": "text",
      "barcode": "text",
      "size": null,
      "size_measure": "text"
    }
  ],
  "sales_channels": [
    {
      "id": 1,
      "price": 1,
      "sale_price": 1,
      "carton_qty": 1,
      "tax_type": "text"
    }
  ]
}

201

Created

{
  "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,
  "last_modified_at": "text",
  "custom_fields": {},
  "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
    }
  ]
}

put

Body

application/json

brandstringOptional

namestringRequired

sizenumber · nullableOptional

size_measurestring · nullableOptional

g, kg, ml, lt, oz, floz, lb

skustring · nullableOptional

barcodestring · nullableOptional

carton_barcodestring · nullableOptional

categorystringRequired

tagsstring[]Optional

carton_widthnumber · nullableOptional

carton_heightnumber · nullableOptional

carton_deptnumber · nullableOptional

carton_weightnumber · nullableOptional

ingredientsstring · nullableOptional

allergensstring · nullableOptional

allergens_may_containstring · nullableOptional

storage_typestring · nullableOptional

manufacture_countrystring · nullableOptional

percentage_australiannumber · nullableOptional

buy_productbooleanOptional

sell_productbooleanOptional

default_pricenumber · nullableOptional

default_sale_pricenumber · nullableOptional

tax_typestringOptional

CSV of tax rate names from Settings > Tax

Responses

202

Accepted

application/json

put

/v1/products/modify

HTTPcURLJavaScriptPython

PUT /v1/products/modify HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 692

{
  "brand": "text",
  "name": "text",
  "size": 1,
  "size_measure": "text",
  "sku": "text",
  "barcode": "text",
  "carton_barcode": "text",
  "category": "text",
  "tags": [
    "text"
  ],
  "carton_width": 1,
  "carton_height": 1,
  "carton_dept": 1,
  "carton_weight": 1,
  "ingredients": "text",
  "allergens": "text",
  "allergens_may_contain": "text",
  "storage_type": "text",
  "manufacture_country": "text",
  "percentage_australian": 1,
  "buy_product": true,
  "sell_product": true,
  "default_price": 1,
  "default_sale_price": 1,
  "tax_type": "text",
  "suppliers": [
    {
      "id": "text",
      "carton_qty": 1,
      "carton_price": 0,
      "tax_type": "text",
      "sku": "text",
      "barcode": "text",
      "size": null,
      "size_measure": "text"
    }
  ],
  "sales_channels": [
    {
      "id": 1,
      "price": 1,
      "sale_price": 1,
      "carton_qty": 1,
      "tax_type": "text"
    }
  ]
}

202

Accepted

{
  "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,
  "last_modified_at": "text",
  "custom_fields": {},
  "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

productintegerOptional

Responses

200

OK

application/json

idnumberOptional

namestringOptional

pricenumber · nullableOptional

sale_pricenumber · nullableOptional

carton_qtynumber · nullableOptional

tax_typestringOptional

tax_percentagenumber · nullableOptional

get

/v1/products/sales_channels

HTTPcURLJavaScriptPython

GET /v1/products/sales_channels HTTP/1.1
Accept: */*

200

OK

[
  {
    "id": 1,
    "name": "text",
    "price": 1,
    "sale_price": 1,
    "carton_qty": 1,
    "tax_type": "text",
    "tax_percentage": 1
  }
]

post

Query parameters

productintegerOptional

Body

application/json

idnumberRequired

pricenumber · nullableOptional

sale_pricenumber · nullableOptional

carton_qtynumber · nullableOptional

tax_typestring · nullableOptional

CSV of tax rate names from Settings > Tax, or "DEFAULT" to use the product default tax rates

Responses

202

Accepted

application/json

post

/v1/products/sales_channels

HTTPcURLJavaScriptPython

POST /v1/products/sales_channels HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "id": 1,
  "price": 1,
  "sale_price": 1,
  "carton_qty": 1,
  "tax_type": "text"
}

202

Accepted

{
  "id": 1,
  "name": "text",
  "price": 1,
  "sale_price": 1,
  "carton_qty": 1,
  "tax_type": "text",
  "tax_percentage": 1
}

get

Query parameters

productintegerOptional

Responses

202

Accepted

application/json

get

/v1/products/sales_channels/modify

HTTPcURLJavaScriptPython

GET /v1/products/sales_channels/modify HTTP/1.1
Accept: */*

202

Accepted

[
  {
    "id": 1,
    "name": "text",
    "price": 1,
    "sale_price": 1,
    "carton_qty": 1,
    "tax_type": "text",
    "tax_percentage": 1
  }
]

post

Query parameters

productintegerOptional

idintegerOptional

Responses

202

Accepted

post

/v1/products/sales_channels/modify

HTTPcURLJavaScriptPython

POST /v1/products/sales_channels/modify HTTP/1.1
Accept: */*

202

Accepted

No content

get

Query parameters

productintegerOptional

Responses

200

OK

application/json

idstringOptional

typestring · enumOptionalPossible values:

namestringOptional

abnstring · nullableOptional

emailstring · nullableOptional

phonestring · nullableOptional

account_numberstring · nullableOptional

websitestring · nullableOptional

payment_termsintegerOptional

payment_terms_periodstringOptional

currencystringOptional

notesstring · nullableOptional

last_modified_atstring · nullableOptional

get

/v1/products/suppliers

HTTPcURLJavaScriptPython

GET /v1/products/suppliers HTTP/1.1
Accept: */*

200

OK

[
  {
    "id": "text",
    "type": "Internal",
    "name": "text",
    "abn": "text",
    "email": "text",
    "phone": "text",
    "account_number": "text",
    "website": "text",
    "payment_terms": 1,
    "payment_terms_period": "text",
    "currency": "text",
    "notes": "text",
    "last_modified_at": "text",
    "contacts": [
      {
        "first_name": "text",
        "last_name": "text",
        "email": "text",
        "phone": "text",
        "mobile_area": "text",
        "mobile_number": "text",
        "role": "text"
      }
    ],
    "locations": [
      {
        "id": "text",
        "name": "text",
        "is_billing": true,
        "is_shipping": true,
        "manage_stock": true,
        "address": "text",
        "suburb": "text",
        "state": "text",
        "postcode": "text",
        "country": "text",
        "location": {},
        "opening_hours": {}
      }
    ],
    "groups": [
      {
        "id": 1,
        "name": "text"
      }
    ]
  }
]

post

Query parameters

productintegerOptional

Body

application/json

idstringRequired

carton_qtynumberOptionalDefault: 1

carton_pricenumberOptionalDefault: 0

tax_typestringOptional

CSV of tax rate names from Settings > Tax

skustring · nullableOptional

barcodestring · nullableOptional

sizesize · nullableOptional

size_measurestring · nullableOptional

Responses

202

Accepted

application/json

post

/v1/products/suppliers

HTTPcURLJavaScriptPython

POST /v1/products/suppliers HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 127

{
  "id": "text",
  "carton_qty": 1,
  "carton_price": 0,
  "tax_type": "text",
  "sku": "text",
  "barcode": "text",
  "size": null,
  "size_measure": "text"
}

202

Accepted

No content

get

Query parameters

productintegerOptional

Responses

202

Accepted

application/json

get

/v1/products/suppliers/modify

HTTPcURLJavaScriptPython

GET /v1/products/suppliers/modify HTTP/1.1
Accept: */*

202

Accepted

[
  {
    "id": "text",
    "type": "Internal",
    "name": "text",
    "abn": "text",
    "email": "text",
    "phone": "text",
    "account_number": "text",
    "website": "text",
    "payment_terms": 1,
    "payment_terms_period": "text",
    "currency": "text",
    "notes": "text",
    "last_modified_at": "text",
    "contacts": [
      {
        "first_name": "text",
        "last_name": "text",
        "email": "text",
        "phone": "text",
        "mobile_area": "text",
        "mobile_number": "text",
        "role": "text"
      }
    ],
    "locations": [
      {
        "id": "text",
        "name": "text",
        "is_billing": true,
        "is_shipping": true,
        "manage_stock": true,
        "address": "text",
        "suburb": "text",
        "state": "text",
        "postcode": "text",
        "country": "text",
        "location": {},
        "opening_hours": {}
      }
    ],
    "groups": [
      {
        "id": 1,
        "name": "text"
      }
    ]
  }
]

post

Query parameters

productintegerOptional

idstringOptional

Responses

202

Accepted

post

/v1/products/suppliers/modify

HTTPcURLJavaScriptPython

POST /v1/products/suppliers/modify HTTP/1.1
Accept: */*

202

Accepted

No content