# Products

Products

## GET /v1/products/find

>

```json
{"openapi":"3.0.0","info":{"title":"Supply'd API","version":"1.0"},"tags":[{"name":"Products","description":"Products"}],"paths":{"/v1/products/find":{"get":{"tags":["Products"],"operationId":"bf3f2a8eba591046b7c7e2348dcb211c","parameters":[{"name":"sku","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}}}}}},"components":{"schemas":{"Product":{"properties":{"id":{"type":"integer"},"company_id":{"type":"integer"},"sku":{"type":"string"},"barcode":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string","nullable":true},"type":{"type":"string"},"category":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"size":{"type":"number"},"size_measure":{"type":"string"},"carton_barcode":{"type":"string","nullable":true},"carton_width":{"type":"number"},"carton_height":{"type":"number"},"carton_depth":{"type":"number"},"carton_weight":{"type":"number"},"carton_price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"ingredients":{"type":"string","nullable":true},"allergens":{"type":"string","nullable":true},"allergens_may_contain":{"type":"string","nullable":true},"storage_type":{"type":"string"},"manufacture_country":{"type":"string","nullable":true},"percentage_australian":{"type":"string","nullable":true},"buy_product":{"type":"boolean"},"sell_product":{"type":"boolean"},"avg_unit_cost":{"type":"number","nullable":true},"default_price":{"type":"number","nullable":true},"default_sale_price":{"type":"number","nullable":true},"tax_type":{"type":"string"},"tax_percentage":{"type":"number"},"last_modified_at":{"type":"string","nullable":true},"custom_fields":{"type":"object"},"suppliers":{"type":"array","items":{"$ref":"#/components/schemas/SupplierProduct"}},"sales_channels":{"type":"array","items":{"$ref":"#/components/schemas/SalesChannel"}},"inventory":{"type":"array","items":{"$ref":"#/components/schemas/ProductInventoryLevel"}}},"type":"object"},"SupplierProduct":{"properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/SupplierType"},"name":{"type":"string"},"carton_qty":{"type":"number"},"carton_price":{"type":"number"},"tax_type":{"type":"string"},"tax_percentage":{"type":"number"},"as_product_id":{"type":"number"},"sku":{"type":"string","nullable":true},"barcode":{"type":"string","nullable":true},"product_name":{"type":"string","nullable":true},"brand":{"type":"string","nullable":true},"size":{"type":"number"},"size_measure":{"type":"string"}},"type":"object"},"SupplierType":{"type":"string","enum":["Internal","External","Store"]},"SalesChannel":{"properties":{"id":{"type":"number"},"name":{"type":"string"},"price":{"type":"number","nullable":true},"sale_price":{"type":"number","nullable":true},"carton_qty":{"type":"number","nullable":true},"tax_type":{"type":"string"},"tax_percentage":{"type":"number","nullable":true}},"type":"object"},"ProductInventoryLevel":{"properties":{"id":{"type":"integer"},"product_id":{"type":"integer"},"company_id":{"type":"integer"},"location_id":{"type":"string"},"location_name":{"type":"string"},"manage_stock":{"type":"boolean"},"in_stock":{"type":"boolean"},"stock_on_hand":{"type":"number"},"stock_on_order":{"type":"number"},"stock_to_be_picked":{"type":"number"},"stock_available":{"type":"number"}},"type":"object"}}}}
```

## GET /v1/products/get

>

```json
{"openapi":"3.0.0","info":{"title":"Supply'd API","version":"1.0"},"tags":[{"name":"Products","description":"Products"}],"paths":{"/v1/products/get":{"get":{"tags":["Products"],"operationId":"eb125ea1863c5bc1b71e4e8e42fa7fe8","parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}}}}}},"components":{"schemas":{"Product":{"properties":{"id":{"type":"integer"},"company_id":{"type":"integer"},"sku":{"type":"string"},"barcode":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string","nullable":true},"type":{"type":"string"},"category":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"size":{"type":"number"},"size_measure":{"type":"string"},"carton_barcode":{"type":"string","nullable":true},"carton_width":{"type":"number"},"carton_height":{"type":"number"},"carton_depth":{"type":"number"},"carton_weight":{"type":"number"},"carton_price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"ingredients":{"type":"string","nullable":true},"allergens":{"type":"string","nullable":true},"allergens_may_contain":{"type":"string","nullable":true},"storage_type":{"type":"string"},"manufacture_country":{"type":"string","nullable":true},"percentage_australian":{"type":"string","nullable":true},"buy_product":{"type":"boolean"},"sell_product":{"type":"boolean"},"avg_unit_cost":{"type":"number","nullable":true},"default_price":{"type":"number","nullable":true},"default_sale_price":{"type":"number","nullable":true},"tax_type":{"type":"string"},"tax_percentage":{"type":"number"},"last_modified_at":{"type":"string","nullable":true},"custom_fields":{"type":"object"},"suppliers":{"type":"array","items":{"$ref":"#/components/schemas/SupplierProduct"}},"sales_channels":{"type":"array","items":{"$ref":"#/components/schemas/SalesChannel"}},"inventory":{"type":"array","items":{"$ref":"#/components/schemas/ProductInventoryLevel"}}},"type":"object"},"SupplierProduct":{"properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/SupplierType"},"name":{"type":"string"},"carton_qty":{"type":"number"},"carton_price":{"type":"number"},"tax_type":{"type":"string"},"tax_percentage":{"type":"number"},"as_product_id":{"type":"number"},"sku":{"type":"string","nullable":true},"barcode":{"type":"string","nullable":true},"product_name":{"type":"string","nullable":true},"brand":{"type":"string","nullable":true},"size":{"type":"number"},"size_measure":{"type":"string"}},"type":"object"},"SupplierType":{"type":"string","enum":["Internal","External","Store"]},"SalesChannel":{"properties":{"id":{"type":"number"},"name":{"type":"string"},"price":{"type":"number","nullable":true},"sale_price":{"type":"number","nullable":true},"carton_qty":{"type":"number","nullable":true},"tax_type":{"type":"string"},"tax_percentage":{"type":"number","nullable":true}},"type":"object"},"ProductInventoryLevel":{"properties":{"id":{"type":"integer"},"product_id":{"type":"integer"},"company_id":{"type":"integer"},"location_id":{"type":"string"},"location_name":{"type":"string"},"manage_stock":{"type":"boolean"},"in_stock":{"type":"boolean"},"stock_on_hand":{"type":"number"},"stock_on_order":{"type":"number"},"stock_to_be_picked":{"type":"number"},"stock_available":{"type":"number"}},"type":"object"}}}}
```

## GET /v1/products/inventory

>

```json
{"openapi":"3.0.0","info":{"title":"Supply'd API","version":"1.0"},"tags":[{"name":"Products","description":"Products"},{"name":"Inventory","description":"Inventory"}],"paths":{"/v1/products/inventory":{"get":{"tags":["Products","Inventory"],"operationId":"839ec54ded7700ba53b90269dfe6ed2b","parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"integer"}},{"name":"location_id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProductInventoryLevel"}}}}}}}}},"components":{"schemas":{"ProductInventoryLevel":{"properties":{"id":{"type":"integer"},"product_id":{"type":"integer"},"company_id":{"type":"integer"},"location_id":{"type":"string"},"location_name":{"type":"string"},"manage_stock":{"type":"boolean"},"in_stock":{"type":"boolean"},"stock_on_hand":{"type":"number"},"stock_on_order":{"type":"number"},"stock_to_be_picked":{"type":"number"},"stock_available":{"type":"number"}},"type":"object"}}}}
```

## PUT /v1/inventory/set

>

```json
{"openapi":"3.0.0","info":{"title":"Supply'd API","version":"1.0"},"tags":[{"name":"Products","description":"Products"},{"name":"Inventory","description":"Inventory"}],"paths":{"/v1/inventory/set":{"put":{"tags":["Products","Inventory"],"operationId":"b3c5e2930cf90e11ea29a949a56769c4","requestBody":{"content":{"application/json":{"schema":{"properties":{"batch_id":{"type":"integer"},"stock_on_hand":{"type":"number"}},"type":"object"}}}},"responses":{"202":{"description":"Accepted"}}}}}}
```

## GET /v1/products/

>

```json
{"openapi":"3.0.0","info":{"title":"Supply'd API","version":"1.0"},"tags":[{"name":"Products","description":"Products"}],"paths":{"/v1/products/":{"get":{"tags":["Products"],"operationId":"c87246323b2c6eaea824778f461cf9ee","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"filter","in":"query","required":false,"schema":{"properties":{"date_after":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"OK","headers":{"Link":{"description":"Next page of results","schema":{"type":"string","format":"uri-reference"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Product"}}}}}}}}},"components":{"schemas":{"Product":{"properties":{"id":{"type":"integer"},"company_id":{"type":"integer"},"sku":{"type":"string"},"barcode":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string","nullable":true},"type":{"type":"string"},"category":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"size":{"type":"number"},"size_measure":{"type":"string"},"carton_barcode":{"type":"string","nullable":true},"carton_width":{"type":"number"},"carton_height":{"type":"number"},"carton_depth":{"type":"number"},"carton_weight":{"type":"number"},"carton_price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"ingredients":{"type":"string","nullable":true},"allergens":{"type":"string","nullable":true},"allergens_may_contain":{"type":"string","nullable":true},"storage_type":{"type":"string"},"manufacture_country":{"type":"string","nullable":true},"percentage_australian":{"type":"string","nullable":true},"buy_product":{"type":"boolean"},"sell_product":{"type":"boolean"},"avg_unit_cost":{"type":"number","nullable":true},"default_price":{"type":"number","nullable":true},"default_sale_price":{"type":"number","nullable":true},"tax_type":{"type":"string"},"tax_percentage":{"type":"number"},"last_modified_at":{"type":"string","nullable":true},"custom_fields":{"type":"object"},"suppliers":{"type":"array","items":{"$ref":"#/components/schemas/SupplierProduct"}},"sales_channels":{"type":"array","items":{"$ref":"#/components/schemas/SalesChannel"}},"inventory":{"type":"array","items":{"$ref":"#/components/schemas/ProductInventoryLevel"}}},"type":"object"},"SupplierProduct":{"properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/SupplierType"},"name":{"type":"string"},"carton_qty":{"type":"number"},"carton_price":{"type":"number"},"tax_type":{"type":"string"},"tax_percentage":{"type":"number"},"as_product_id":{"type":"number"},"sku":{"type":"string","nullable":true},"barcode":{"type":"string","nullable":true},"product_name":{"type":"string","nullable":true},"brand":{"type":"string","nullable":true},"size":{"type":"number"},"size_measure":{"type":"string"}},"type":"object"},"SupplierType":{"type":"string","enum":["Internal","External","Store"]},"SalesChannel":{"properties":{"id":{"type":"number"},"name":{"type":"string"},"price":{"type":"number","nullable":true},"sale_price":{"type":"number","nullable":true},"carton_qty":{"type":"number","nullable":true},"tax_type":{"type":"string"},"tax_percentage":{"type":"number","nullable":true}},"type":"object"},"ProductInventoryLevel":{"properties":{"id":{"type":"integer"},"product_id":{"type":"integer"},"company_id":{"type":"integer"},"location_id":{"type":"string"},"location_name":{"type":"string"},"manage_stock":{"type":"boolean"},"in_stock":{"type":"boolean"},"stock_on_hand":{"type":"number"},"stock_on_order":{"type":"number"},"stock_to_be_picked":{"type":"number"},"stock_available":{"type":"number"}},"type":"object"}}}}
```

## POST /v1/products/

>

```json
{"openapi":"3.0.0","info":{"title":"Supply'd API","version":"1.0"},"tags":[{"name":"Products","description":"Products"}],"paths":{"/v1/products/":{"post":{"tags":["Products"],"operationId":"11654f9d883bb732012c7e4056216b1f","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveProduct"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}}}}}},"components":{"schemas":{"SaveProduct":{"required":["name","category"],"properties":{"brand":{"type":"string"},"name":{"type":"string"},"size":{"type":"number","nullable":true},"size_measure":{"description":"g, kg, ml, lt, oz, floz, lb","type":"string","nullable":true},"sku":{"type":"string","nullable":true},"barcode":{"type":"string","nullable":true},"carton_barcode":{"type":"string","nullable":true},"category":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"carton_width":{"type":"number","nullable":true},"carton_height":{"type":"number","nullable":true},"carton_dept":{"type":"number","nullable":true},"carton_weight":{"type":"number","nullable":true},"ingredients":{"type":"string","nullable":true},"allergens":{"type":"string","nullable":true},"allergens_may_contain":{"type":"string","nullable":true},"storage_type":{"type":"string","nullable":true},"manufacture_country":{"type":"string","nullable":true},"percentage_australian":{"type":"number","nullable":true},"buy_product":{"type":"boolean"},"sell_product":{"type":"boolean"},"default_price":{"type":"number","nullable":true},"default_sale_price":{"type":"number","nullable":true},"tax_type":{"description":"CSV of tax rate names from Settings > Tax","type":"string"},"suppliers":{"type":"array","items":{"$ref":"#/components/schemas/SaveProductSupplier"}},"sales_channels":{"type":"array","items":{"$ref":"#/components/schemas/SaveProductSalesChannel"}}},"type":"object"},"SaveProductSupplier":{"required":["id"],"properties":{"id":{"type":"string"},"carton_qty":{"type":"number","default":1},"carton_price":{"type":"number","default":0},"tax_type":{"description":"CSV of tax rate names from Settings > Tax","type":"string"},"sku":{"type":"string","nullable":true},"barcode":{"type":"string","nullable":true},"size":{"type":"number","nullable":true},"size_measure":{"type":"string","nullable":true}},"type":"object"},"SaveProductSalesChannel":{"required":["id"],"properties":{"id":{"type":"number"},"price":{"type":"number","nullable":true},"sale_price":{"type":"number","nullable":true},"carton_qty":{"type":"number","nullable":true},"tax_type":{"description":"CSV of tax rate names from Settings > Tax, or \"DEFAULT\" to use the product default tax rates","type":"string","nullable":true}},"type":"object"},"Product":{"properties":{"id":{"type":"integer"},"company_id":{"type":"integer"},"sku":{"type":"string"},"barcode":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string","nullable":true},"type":{"type":"string"},"category":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"size":{"type":"number"},"size_measure":{"type":"string"},"carton_barcode":{"type":"string","nullable":true},"carton_width":{"type":"number"},"carton_height":{"type":"number"},"carton_depth":{"type":"number"},"carton_weight":{"type":"number"},"carton_price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"ingredients":{"type":"string","nullable":true},"allergens":{"type":"string","nullable":true},"allergens_may_contain":{"type":"string","nullable":true},"storage_type":{"type":"string"},"manufacture_country":{"type":"string","nullable":true},"percentage_australian":{"type":"string","nullable":true},"buy_product":{"type":"boolean"},"sell_product":{"type":"boolean"},"avg_unit_cost":{"type":"number","nullable":true},"default_price":{"type":"number","nullable":true},"default_sale_price":{"type":"number","nullable":true},"tax_type":{"type":"string"},"tax_percentage":{"type":"number"},"last_modified_at":{"type":"string","nullable":true},"custom_fields":{"type":"object"},"suppliers":{"type":"array","items":{"$ref":"#/components/schemas/SupplierProduct"}},"sales_channels":{"type":"array","items":{"$ref":"#/components/schemas/SalesChannel"}},"inventory":{"type":"array","items":{"$ref":"#/components/schemas/ProductInventoryLevel"}}},"type":"object"},"SupplierProduct":{"properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/SupplierType"},"name":{"type":"string"},"carton_qty":{"type":"number"},"carton_price":{"type":"number"},"tax_type":{"type":"string"},"tax_percentage":{"type":"number"},"as_product_id":{"type":"number"},"sku":{"type":"string","nullable":true},"barcode":{"type":"string","nullable":true},"product_name":{"type":"string","nullable":true},"brand":{"type":"string","nullable":true},"size":{"type":"number"},"size_measure":{"type":"string"}},"type":"object"},"SupplierType":{"type":"string","enum":["Internal","External","Store"]},"SalesChannel":{"properties":{"id":{"type":"number"},"name":{"type":"string"},"price":{"type":"number","nullable":true},"sale_price":{"type":"number","nullable":true},"carton_qty":{"type":"number","nullable":true},"tax_type":{"type":"string"},"tax_percentage":{"type":"number","nullable":true}},"type":"object"},"ProductInventoryLevel":{"properties":{"id":{"type":"integer"},"product_id":{"type":"integer"},"company_id":{"type":"integer"},"location_id":{"type":"string"},"location_name":{"type":"string"},"manage_stock":{"type":"boolean"},"in_stock":{"type":"boolean"},"stock_on_hand":{"type":"number"},"stock_on_order":{"type":"number"},"stock_to_be_picked":{"type":"number"},"stock_available":{"type":"number"}},"type":"object"}}}}
```

## PUT /v1/products/modify

>

```json
{"openapi":"3.0.0","info":{"title":"Supply'd API","version":"1.0"},"tags":[{"name":"Products","description":"Products"}],"paths":{"/v1/products/modify":{"put":{"tags":["Products"],"operationId":"7de238437c162a70f1a5ead8704da12f","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveProduct"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}}}}}},"components":{"schemas":{"SaveProduct":{"required":["name","category"],"properties":{"brand":{"type":"string"},"name":{"type":"string"},"size":{"type":"number","nullable":true},"size_measure":{"description":"g, kg, ml, lt, oz, floz, lb","type":"string","nullable":true},"sku":{"type":"string","nullable":true},"barcode":{"type":"string","nullable":true},"carton_barcode":{"type":"string","nullable":true},"category":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"carton_width":{"type":"number","nullable":true},"carton_height":{"type":"number","nullable":true},"carton_dept":{"type":"number","nullable":true},"carton_weight":{"type":"number","nullable":true},"ingredients":{"type":"string","nullable":true},"allergens":{"type":"string","nullable":true},"allergens_may_contain":{"type":"string","nullable":true},"storage_type":{"type":"string","nullable":true},"manufacture_country":{"type":"string","nullable":true},"percentage_australian":{"type":"number","nullable":true},"buy_product":{"type":"boolean"},"sell_product":{"type":"boolean"},"default_price":{"type":"number","nullable":true},"default_sale_price":{"type":"number","nullable":true},"tax_type":{"description":"CSV of tax rate names from Settings > Tax","type":"string"},"suppliers":{"type":"array","items":{"$ref":"#/components/schemas/SaveProductSupplier"}},"sales_channels":{"type":"array","items":{"$ref":"#/components/schemas/SaveProductSalesChannel"}}},"type":"object"},"SaveProductSupplier":{"required":["id"],"properties":{"id":{"type":"string"},"carton_qty":{"type":"number","default":1},"carton_price":{"type":"number","default":0},"tax_type":{"description":"CSV of tax rate names from Settings > Tax","type":"string"},"sku":{"type":"string","nullable":true},"barcode":{"type":"string","nullable":true},"size":{"type":"number","nullable":true},"size_measure":{"type":"string","nullable":true}},"type":"object"},"SaveProductSalesChannel":{"required":["id"],"properties":{"id":{"type":"number"},"price":{"type":"number","nullable":true},"sale_price":{"type":"number","nullable":true},"carton_qty":{"type":"number","nullable":true},"tax_type":{"description":"CSV of tax rate names from Settings > Tax, or \"DEFAULT\" to use the product default tax rates","type":"string","nullable":true}},"type":"object"},"Product":{"properties":{"id":{"type":"integer"},"company_id":{"type":"integer"},"sku":{"type":"string"},"barcode":{"type":"string"},"name":{"type":"string"},"brand":{"type":"string","nullable":true},"type":{"type":"string"},"category":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"size":{"type":"number"},"size_measure":{"type":"string"},"carton_barcode":{"type":"string","nullable":true},"carton_width":{"type":"number"},"carton_height":{"type":"number"},"carton_depth":{"type":"number"},"carton_weight":{"type":"number"},"carton_price":{"type":"number"},"images":{"type":"array","items":{"type":"string"}},"ingredients":{"type":"string","nullable":true},"allergens":{"type":"string","nullable":true},"allergens_may_contain":{"type":"string","nullable":true},"storage_type":{"type":"string"},"manufacture_country":{"type":"string","nullable":true},"percentage_australian":{"type":"string","nullable":true},"buy_product":{"type":"boolean"},"sell_product":{"type":"boolean"},"avg_unit_cost":{"type":"number","nullable":true},"default_price":{"type":"number","nullable":true},"default_sale_price":{"type":"number","nullable":true},"tax_type":{"type":"string"},"tax_percentage":{"type":"number"},"last_modified_at":{"type":"string","nullable":true},"custom_fields":{"type":"object"},"suppliers":{"type":"array","items":{"$ref":"#/components/schemas/SupplierProduct"}},"sales_channels":{"type":"array","items":{"$ref":"#/components/schemas/SalesChannel"}},"inventory":{"type":"array","items":{"$ref":"#/components/schemas/ProductInventoryLevel"}}},"type":"object"},"SupplierProduct":{"properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/SupplierType"},"name":{"type":"string"},"carton_qty":{"type":"number"},"carton_price":{"type":"number"},"tax_type":{"type":"string"},"tax_percentage":{"type":"number"},"as_product_id":{"type":"number"},"sku":{"type":"string","nullable":true},"barcode":{"type":"string","nullable":true},"product_name":{"type":"string","nullable":true},"brand":{"type":"string","nullable":true},"size":{"type":"number"},"size_measure":{"type":"string"}},"type":"object"},"SupplierType":{"type":"string","enum":["Internal","External","Store"]},"SalesChannel":{"properties":{"id":{"type":"number"},"name":{"type":"string"},"price":{"type":"number","nullable":true},"sale_price":{"type":"number","nullable":true},"carton_qty":{"type":"number","nullable":true},"tax_type":{"type":"string"},"tax_percentage":{"type":"number","nullable":true}},"type":"object"},"ProductInventoryLevel":{"properties":{"id":{"type":"integer"},"product_id":{"type":"integer"},"company_id":{"type":"integer"},"location_id":{"type":"string"},"location_name":{"type":"string"},"manage_stock":{"type":"boolean"},"in_stock":{"type":"boolean"},"stock_on_hand":{"type":"number"},"stock_on_order":{"type":"number"},"stock_to_be_picked":{"type":"number"},"stock_available":{"type":"number"}},"type":"object"}}}}
```

## GET /v1/products/sales\_channels

>

```json
{"openapi":"3.0.0","info":{"title":"Supply'd API","version":"1.0"},"tags":[{"name":"Products","description":"Products"}],"paths":{"/v1/products/sales_channels":{"get":{"tags":["Products"],"operationId":"7d0498aac49b9333b495fddc2f05c3cd","parameters":[{"name":"product","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SalesChannel"}}}}}}}}},"components":{"schemas":{"SalesChannel":{"properties":{"id":{"type":"number"},"name":{"type":"string"},"price":{"type":"number","nullable":true},"sale_price":{"type":"number","nullable":true},"carton_qty":{"type":"number","nullable":true},"tax_type":{"type":"string"},"tax_percentage":{"type":"number","nullable":true}},"type":"object"}}}}
```

## POST /v1/products/sales\_channels

>

```json
{"openapi":"3.0.0","info":{"title":"Supply'd API","version":"1.0"},"tags":[{"name":"Products","description":"Products"}],"paths":{"/v1/products/sales_channels":{"post":{"tags":["Products"],"operationId":"5e78e11313c0cabf2dc62ddc563713a4","parameters":[{"name":"product","in":"query","schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveProductSalesChannel"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesChannel"}}}}}}}},"components":{"schemas":{"SaveProductSalesChannel":{"required":["id"],"properties":{"id":{"type":"number"},"price":{"type":"number","nullable":true},"sale_price":{"type":"number","nullable":true},"carton_qty":{"type":"number","nullable":true},"tax_type":{"description":"CSV of tax rate names from Settings > Tax, or \"DEFAULT\" to use the product default tax rates","type":"string","nullable":true}},"type":"object"},"SalesChannel":{"properties":{"id":{"type":"number"},"name":{"type":"string"},"price":{"type":"number","nullable":true},"sale_price":{"type":"number","nullable":true},"carton_qty":{"type":"number","nullable":true},"tax_type":{"type":"string"},"tax_percentage":{"type":"number","nullable":true}},"type":"object"}}}}
```

## GET /v1/products/sales\_channels/modify

>

```json
{"openapi":"3.0.0","info":{"title":"Supply'd API","version":"1.0"},"tags":[{"name":"Products","description":"Products"}],"paths":{"/v1/products/sales_channels/modify":{"get":{"tags":["Products"],"operationId":"302803dbc14359cfb6c6c190c4ea016d","parameters":[{"name":"product","in":"query","schema":{"type":"integer"}}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SalesChannel"}}}}}}}}},"components":{"schemas":{"SalesChannel":{"properties":{"id":{"type":"number"},"name":{"type":"string"},"price":{"type":"number","nullable":true},"sale_price":{"type":"number","nullable":true},"carton_qty":{"type":"number","nullable":true},"tax_type":{"type":"string"},"tax_percentage":{"type":"number","nullable":true}},"type":"object"}}}}
```

## POST /v1/products/sales\_channels/modify

>

```json
{"openapi":"3.0.0","info":{"title":"Supply'd API","version":"1.0"},"tags":[{"name":"Products","description":"Products"}],"paths":{"/v1/products/sales_channels/modify":{"post":{"tags":["Products"],"operationId":"ae4a9d5d5f5d77eb018679065a6ecc4b","parameters":[{"name":"product","in":"query","schema":{"type":"integer"}},{"name":"id","in":"query","schema":{"type":"integer"}}],"responses":{"202":{"description":"Accepted"}}}}}}
```

## GET /v1/products/suppliers

>

```json
{"openapi":"3.0.0","info":{"title":"Supply'd API","version":"1.0"},"tags":[{"name":"Products","description":"Products"}],"paths":{"/v1/products/suppliers":{"get":{"tags":["Products"],"operationId":"c2d676b5f85b9b6b8a67439dba02bae6","parameters":[{"name":"product","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Supplier"}}}}}}}}},"components":{"schemas":{"Supplier":{"properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/SupplierType"},"name":{"type":"string"},"abn":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"account_number":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"payment_terms":{"type":"integer"},"payment_terms_period":{"type":"string"},"currency":{"type":"string"},"notes":{"type":"string","nullable":true},"last_modified_at":{"type":"string","nullable":true},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/Contact"}},"locations":{"type":"array","items":{"$ref":"#/components/schemas/Location"}},"groups":{"type":"array","items":{"$ref":"#/components/schemas/SupplierGroup"}}},"type":"object"},"SupplierType":{"type":"string","enum":["Internal","External","Store"]},"Contact":{"properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"mobile_area":{"type":"string","nullable":true},"mobile_number":{"type":"string","nullable":true},"role":{"type":"string","nullable":true}},"type":"object"},"Location":{"properties":{"id":{"type":"string","nullable":true},"name":{"type":"string"},"is_billing":{"type":"boolean"},"is_shipping":{"type":"boolean"},"manage_stock":{"type":"boolean"},"address":{"type":"string"},"suburb":{"type":"string"},"state":{"type":"string"},"postcode":{"type":"string"},"country":{"type":"string"},"location":{"type":"object","nullable":true},"opening_hours":{"type":"object","nullable":true}},"type":"object"},"SupplierGroup":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"}}}}
```

## POST /v1/products/suppliers

>

```json
{"openapi":"3.0.0","info":{"title":"Supply'd API","version":"1.0"},"tags":[{"name":"Products","description":"Products"}],"paths":{"/v1/products/suppliers":{"post":{"tags":["Products"],"operationId":"cccf5f7c24f00f8884e04380d24e6056","parameters":[{"name":"product","in":"query","schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveProductSupplier"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierProduct"}}}}}}}},"components":{"schemas":{"SaveProductSupplier":{"required":["id"],"properties":{"id":{"type":"string"},"carton_qty":{"type":"number","default":1},"carton_price":{"type":"number","default":0},"tax_type":{"description":"CSV of tax rate names from Settings > Tax","type":"string"},"sku":{"type":"string","nullable":true},"barcode":{"type":"string","nullable":true},"size":{"type":"number","nullable":true},"size_measure":{"type":"string","nullable":true}},"type":"object"},"SupplierProduct":{"properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/SupplierType"},"name":{"type":"string"},"carton_qty":{"type":"number"},"carton_price":{"type":"number"},"tax_type":{"type":"string"},"tax_percentage":{"type":"number"},"as_product_id":{"type":"number"},"sku":{"type":"string","nullable":true},"barcode":{"type":"string","nullable":true},"product_name":{"type":"string","nullable":true},"brand":{"type":"string","nullable":true},"size":{"type":"number"},"size_measure":{"type":"string"}},"type":"object"},"SupplierType":{"type":"string","enum":["Internal","External","Store"]}}}}
```

## GET /v1/products/suppliers/modify

>

```json
{"openapi":"3.0.0","info":{"title":"Supply'd API","version":"1.0"},"tags":[{"name":"Products","description":"Products"}],"paths":{"/v1/products/suppliers/modify":{"get":{"tags":["Products"],"operationId":"67acf644446b19eceac2edb920730302","parameters":[{"name":"product","in":"query","schema":{"type":"integer"}}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Supplier"}}}}}}}}},"components":{"schemas":{"Supplier":{"properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/SupplierType"},"name":{"type":"string"},"abn":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"account_number":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"payment_terms":{"type":"integer"},"payment_terms_period":{"type":"string"},"currency":{"type":"string"},"notes":{"type":"string","nullable":true},"last_modified_at":{"type":"string","nullable":true},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/Contact"}},"locations":{"type":"array","items":{"$ref":"#/components/schemas/Location"}},"groups":{"type":"array","items":{"$ref":"#/components/schemas/SupplierGroup"}}},"type":"object"},"SupplierType":{"type":"string","enum":["Internal","External","Store"]},"Contact":{"properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"mobile_area":{"type":"string","nullable":true},"mobile_number":{"type":"string","nullable":true},"role":{"type":"string","nullable":true}},"type":"object"},"Location":{"properties":{"id":{"type":"string","nullable":true},"name":{"type":"string"},"is_billing":{"type":"boolean"},"is_shipping":{"type":"boolean"},"manage_stock":{"type":"boolean"},"address":{"type":"string"},"suburb":{"type":"string"},"state":{"type":"string"},"postcode":{"type":"string"},"country":{"type":"string"},"location":{"type":"object","nullable":true},"opening_hours":{"type":"object","nullable":true}},"type":"object"},"SupplierGroup":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"}}}}
```

## POST /v1/products/suppliers/modify

>

```json
{"openapi":"3.0.0","info":{"title":"Supply'd API","version":"1.0"},"tags":[{"name":"Products","description":"Products"}],"paths":{"/v1/products/suppliers/modify":{"post":{"tags":["Products"],"operationId":"67d8211be0d4bb58f2233fefba8a0b1f","parameters":[{"name":"product","in":"query","schema":{"type":"integer"}},{"name":"id","in":"query","schema":{"type":"string"}}],"responses":{"202":{"description":"Accepted"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.supplyd.co/api/products.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.