API Docs

Learn How to Connect Your Website, App and Data to Gro CRM With Our Developer API Documentation

Gro CRM Rest API
Eat. Sleep. Code.

Inventory
  1. Properties
  2. Get all inventory
  3. Create an inventory item
  4. Get an inventory item
  5. Update an inventory item
  6. Delete an inventory item
  7. Types
About the inventory API

The Inventory API allows you to fetch your existing inventory, create or edit products or services, and delete existing products or services.

Properties
Name Type Description
id integer The id of the inventory item. Read Only
type_id integer The id of the inventory type. For more information see Types
name string The name of the inventory item.
sku string The sku of the inventory item.
barcode string The barcode of the inventory item.
unit_cost decimal The unit cost of the inventory item.
list_code decimal The list cost of the inventory item.
qty integer The quantity of the items in your inventory.
is_taxable boolean Indicates if the item is taxable or not.
is_tracked boolean Indicates if the item is being tracked or not.
reorder integer The reorder level that you should be notified to order more items.
weight decimal The weight of the item.
vat string The VAT (value added tax) of the item.
description string Description of the item.
created_at string Date and time that the contact was created. Read Only
updated_at string Date and time that the contact was last updated. Read Only
List all inventory
Parameters
Name Type Description
page number Page number to start from. Default is 1.
ex. ?page=1
per_page number Number of items to retrieve per page. Default is 20. Max is 40.
ex. ?per_page=2
sort string Can be created, updated, name. Default updated.
ex. ?sort=updated
order string Can be asc or desc. Default desc.
ex. ?order=asc
search string The search keywords.
ex. ?search=modern
Curl Example
Response Headers
Response Body
Create an inventory item

Create a new product or service.

Parameters
Name Type Description
type_id integer The id of the inventory type. Required For more information see Types
ex. "type_id": 1
name string The name of the inventory item. Required
ex. "name": "Brown Dresser"
sku string The sku of the inventory item.
ex. "sku": 897526324
barcode string The barcode of the inventory item.
ex. "barcode": 556987065364
unit_cost decimal The unit cost of the inventory item.
ex. "unit_cost": 100.00
list_code decimal The list cost of the inventory item.
ex. "list_code": 149.99
qty integer The quantity of the items in your inventory.
ex. "qty": 200
is_taxable boolean Indicates if the item is taxable or not.
ex. "is_taxable": true
is_tracked boolean Indicates if the item is being tracked or not.
ex. "is_tracked": false
reorder integer The reorder level that you should be notified to order more items.
ex. "reorder": 20
weight decimal The weight of the item.
ex. "weight": "100"
vat string The VAT (value added tax) of the item.
ex. "vat": null
description string Description of the item.
ex. "description": "Fantastic brown all wood dresser.
Curl Example
Response Headers
Response Body
Get an inventory item

Get a single product or service with the specified id. If the product or service does not exist a 404 Not Found status code will be returned.

Curl Example
Response Headers
Response Body
Update an inventory item

Update a product or service with the specified id. If the product or service does not exist a 404 Not Found status code will be returned.

Parameters
Name Type Description
type_id integer The id of the inventory type. For more information see Types
ex. "type_id": 1
name string The name of the inventory item.
ex. "name": "Brown Dresser"
sku string The sku of the inventory item.
ex. "sku": 897526324
barcode string The barcode of the inventory item.
ex. "barcode": 556987065364
unit_cost decimal The unit cost of the inventory item.
ex. "unit_cost": 100.00
list_code decimal The list cost of the inventory item.
ex. "list_code": 149.99
qty integer The quantity of the items in your inventory.
ex. "qty": 200
is_taxable boolean Indicates if the item is taxable or not.
ex. "is_taxable": true
is_tracked boolean Indicates if the item is being tracked or not.
ex. "is_tracked": false
reorder integer The reorder level that you should be notified to order more items.
ex. "reorder": 20
weight decimal The weight of the item.
ex. "weight": "100"
vat string The VAT (value added tax) of the item.
ex. "vat": null
description string Description of the item.
ex. "description": "Fantastic brown all wood dresser.
Curl Example
Response Headers
Response Body
Delete an inventory item

Delete a product or service with the specified id. If the product or service does not exist a 404 Not Found status code will be returned.

Curl Example
Response Headers
Types
List all inventory types

List all available inventory types.

Curl Example
Response Headers
Response Body
Get single inventory type

Get a single type with the specified id. If the type does not exist, a 404 Not Found status code will be returned.

Curl Example
Response Headers
Response Body
Ready to get started

Gro CRM® the Small Business CRM Platform Made Just for Apple Users and Their Devices


Made with in California
© 2019 Gro Software, LLC.
"This is our most-likable website ever"