Code examples for products

invoiceninja · Jun 7, 2024 · a9046ca · a9046ca
1 parent 9c12131
commit a9046ca
Showing 1 changed file with 40 additions and 3 deletions.
diff --git a/api-docs.yaml b/api-docs.yaml
@@ -10175,10 +10175,28 @@ paths:
       tags:
         - products
       summary: "List products"
+      x-code-samples:
+      - lang: curl
+        label: Curl
+        source: |
+          curl -X GET 'https://invoicing.co/api/v1/products?filter=search&per_page=20&page=1&include=documents' \
+          -H "X-API-TOKEN:company-token-test" \
+          -H "X-Requested-With: XMLHttpRequest";
+      - lang: go
+        label: PHP
+        source: |
+          $ninja = new InvoiceNinja("your_token");
+          $products = $ninja->products->all([
+            'filter' => 'search',
+            'per_page' => 20,
+            'page' => 1,
+            'include' => 'documents'
+          ]);
       description: |
-        Lists products, search and filters allow fine grained lists to be generated.    
-        Query parameters can be added to perform fine grained filtering of the products list, these are handled by the ProductFilters class
-        which defines the methods available
+        Lists products within your company.
+
+        You can search and filter the result set using query parameters. These can be chained together allowing fine grained lists to be generated.    
+
       operationId: getProducts
       parameters:
         - $ref: "#/components/parameters/X-API-TOKEN"
@@ -10250,6 +10268,25 @@ paths:
       tags:
         - products
       summary: "Create Product"
+      x-code-samples:
+      - lang: curl
+        label: Curl
+        source: |
+          curl -X POST 'https://invoicing.co/api/v1/products' \
+          -H "X-API-TOKEN:company-token-test" \
+          -H "Content-Type:application/json" \
+          -d '{"product_key":"sku_1","notes":"product description","cost":1,"price":10}' \
+          -H "X-Requested-With: XMLHttpRequest";
+      - lang: go
+        label: PHP
+        source: |
+          $ninja = new InvoiceNinja("your_token");
+          $products = $ninja->products->create([
+            'product_key' => "sku_1",
+            'notes' => "product description",
+            'cost' => 1,
+            'price' => 10
+          ]);
       description: "Adds a product to a company"
       operationId: storeProduct
       parameters: