Products
These are the endpoints that are available under the /products path, which lists all the different products on an account.
Endpoint | Description |
|---|---|
GET /products | Returns all product objects on an account in array format. |
GET /products/{productId} | Returns a JSON object for specified product. |
| POST /products | Creates a new product object or updates an existing product object on an account. Request body/payload: Must pass a product object in the request body/payload. For these calls, you need to pass a product object with all required fields and any fields you want to set filled in the body of the payload. We have an example of a product object in the responses section below and have indicated the required fields in the object values table at the bottom of this page. |
| DELETE /products/{productId} | Removes a product object from view by setting its active property to false. |
| GET /productSupplierLine | Returns all product supplier line objects on an account in array format. |
| GET /productSupplierLine/{productSupplierLineId} | Returns a JSON object for specified product supplier line. |
| POST /productSupplierLine | Creates a new product supplier line object or updates an existing product supplier line object on an account. Request body/payload: Must pass a product supplier line object in the request body/payload. For these calls, you need to pass a product supplier line object with all required fields and any fields you want to set filled in the body of the payload. We have an example of a product supplier line object in the responses section below and have indicated the required fields in the object values table at the bottom of this page. |
| DELETE /productSupplierLine/{productSupplierLineId} | Removes a product supplier line object from view by setting its active property to false. |
| GET /productSupplier | Returns all productSupplier objects on an account in array format. |
| GET /productSupplier/{productSupplierId} | Returns a JSON object for specified product supplier. |
| POST /productSupplier | Creates a new product supplier object or updates an existing product supplier object on an account. Request body/payload: Must pass a product supplier object in the request body/payload. For these calls, you need to pass a product supplier object with all required fields and any fields you want to set filled in the body of the payload. We have an example of a product supplier object in the responses section below and have indicated the required fields in the object values table at the bottom of this page. |
| DELETE /productSupplier/{productSupplierId} | Removes a product supplier object from view by setting its active property to false. |
There are no parameters included with resource calls.
The objects below represent the minimum viable objects to pass that are needed to create or update a products, productSupplierLine or productSupplier object. Check whether or not a property can be written to by looking at the Object Values table below to see if the property is writable.
We have included object value tables for products, product supplier line, and product supplier objects, as they are all stored in unique tables on our database.
products
| Property name | Type | Required | Description |
|---|---|---|---|
| active | boolean | Yes | Indicates whether or not the specified product should return on GET calls. |
| barcode1 | string | Displays as barcode entered for the specified product. | |
| businessId | integer | Yes | Provides unique numeric ID of the business to which the specified product belongs. |
| costPrice | string | Displays as price that the specified product is set to cost. | |
| createdDate | integer | Displays as date the specified product was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. | |
| createdUser | string | Displays the username of user who created the specified product. | |
| currentLevel | integer | Provides the current stock level of the specified product. | |
| maxLevel | integer | Provides the maximum stock level of the specified product. | |
| minLevel | integer | Provides the minimum stock level of the specified product. | |
modifiedDate | integer | Displays as date the specified product was last modified in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. | |
| modifiedUser | string | Displays the username of user who last modified the specified product. | |
| noStock | boolean | Yes | Indicates whether or not stock is calculated on the back end. If stock is being calculated, this property will be set as false, and if not this property will be set to true. |
| packSize | integer | Provides a count of how many items of the specified product come in a pack. | |
| productId | integer | Yes (only if updating existing product with POST call) | Provides unique numeric ID of the specified product. |
| productName | string | Displays as name given to the specified product. | |
| productSupplier | object | Displays the product supplier object for product supplier connected to the specified product. | |
| productSupplierLine | object | Displays the product supplier line object for product supplier line connected to the specified product. | |
| salePrice | string | Displays as price that the specified product is set to cost after accounting for any discount. | |
| sortOrder | integer | Provides a number that is used to determine the primacy of the products. | |
| taxable | boolean | Indicates whether or not the specified product is taxable, which would impact the overall balance of the invoice. |
productSupplierLine
| Property name | Type | Required | Description |
|---|---|---|---|
| active | boolean | Yes | Indicates whether or not the specified product supplier line should return on GET calls. |
| businessId | integer | Yes | Provides unique numeric ID of the business to which the specified product supplier line belongs. |
| createdDate | integer | Displays as date the specified product supplier line was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. | |
| createdUser | string | Displays the username of user who created the specified product supplier line. | |
| modifiedDate | integer | Displays as date the specified product supplier line was last modified in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. | |
| modifiedUser | string | Displays the username of user who last modified the specified product supplier line. | |
| productSupplier | object | Displays the product supplier object for product supplier connected to the specified product line. | |
| productSupplierLineId | integer | Yes | Provides unique numeric ID of the specified product supplier line. |
| productSupplierLineName | string | Displays as name of the specified product supplier line. |
productSupplier
| Property name | Type | Required | Description |
|---|---|---|---|
| active | boolean | Yes | Indicates whether or not the specified product supplier should return on GET calls. |
| businessId | integer | Yes | Provides unique numeric ID of the business to which the specified product supplier belongs. |
| createdDate | integer | Displays as date the specified product supplier was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. | |
| createdUser | string | Displays the username of user who created the specified product supplier. | |
| modifiedDate | integer | Displays as date the specified product supplier was last modified in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. | |
| modifiedUser | string | Displays the username of user who last modified the specified product supplier. | |
| productSupplierId | integer | Yes | Provides unique numeric ID of the specified product supplier. |
| productSupplierName | string | Displays as name of the specified product supplier. |