| Table of Contents |
|---|
Inventory API Query
Sample Query for Inventory Items
Samples are using Postman to send requests<Rockstar description here>
How to get the Bearer Token
Request URL: https://go.solarplus.co/graphqlAuthorization: Integration → Solarplus API Credentials Token
Get the bearer token from the Integrations page (https://dev.solarplus.co/user/api)
...
Paste it as Graphql’s authorization access
...
Testing Graphql via
...
On the right, see documentation of app structure:
eg.
{ Inventory(id: 87381 )
{
...
postman
Set the bearer token from the collection settings
Create a POST request from the request URL above
Set the body as GraphQL and formulate a query
Perform a request
...
Visit postman documentation to learn how to write test cases
Testing Graphql via browser
On the right, see documentation of app structure:
eg.
{ Inventory(id: 87381 )
{
id
name
InventoryPricings {
item_variation_suffix
unitPrice
}
}
}
...
CREATE (POST) requests
Create Inventory :
VARIABLES:
...
category_id - required field ( check possible values at the end of this post)
brand_id - required field for specific categories ( check end of post for categories which require brand_id)
model_id - required field for specific categories ( check end of post for categories which require model_id)
name - required field
item is purchased - boolean value 0( false) or 1( true)
include in quote by default - boolean value 0( false) or 1( true)
assign kit value - boolean value 0( false) or 1( true)
description - text description
apply sales tax - applicable only to SUBSIDY ( CAT. 18)
subtract from payable - applicable only to SUBSIDY ( CAT. 18)
Create Inventory Kit ( with Pricing )
mutation: gql` mutation createInventoryKitItem( $input: CreateInventoryKitInput! ) { createInventoryKitItem(input: $input) } `, variables,
Create Pricing Level:
VARIABLES:
...
METHOD:
savePricing
...
UPDATE ( POST ) Requests
Update Inventory
inventory_id - required field
category_id - ( check possible values at the end of this post)
brand_id - required field for specific categories ( check end of post for categories which require brand_id)
model_id - required field for specific categories ( check end of post for categories which require model_id)
name - required field
item is purchased - boolean value 0( false) or 1( true)
include in quote by default - boolean value 0( false) or 1( true)
assign kit value - boolean value 0( false) or 1( true)
description - text description
apply sales tax - applicable only to SUBSIDY ( CAT. 18)
subtract from payable - applicable only to SUBSIDY ( CAT. 18)
...
METHOD:
createInventory
NOTE:
method returns the Inventory that has been created, kindly check the end of the page for the available fields on Inventory model
some categories will require model ( foriegn_id) field
some categories also have a default value for 'Cost of Sales Inc’
more information to this is added at the end of the page
...
Create Pricing Level:
VARIABLES:
note: same method is used for update pricing, to create a new one , supply id with value 0, or do not pass field id
...
METHOD:
savePricing
...
Create Pricing without SKU and Supplier
...
NOTES:
if is_default is not specified for the pricing, it is automatically set to true
if no supplier and SKU is provided for the pricing, an SKU is automatically generated for the pricing. This is usually the case for Inventories under service categories.
UPDATE ( POST ) Requests
Update Inventory
VARIABLES:
...
METHOD:
updateInventory
UPDATE PRICING
VARIABLES:
...
METHOD:
savePricing
...
DELETE REQUEST
DELETE INVENTORY
VARIABLES :
id : required, inventory id to be deleted
METHOD:
deleteInventoryByPk
...
METHOD:
deleteInventoryByPk
...
SEARCH (POST) REQUEST
Search Inventory
METHOD:
Inventories
...
| Code Block |
|---|
{
"data": {
"InventoryPricings": [
{
"id": "24399",
"inventory_id": "29505",
"supplier_id": "293",
"code": "ET Solar ET-M572190",
"unit_price": 2,
"markup_value": 12,
"markup_is_percentage": "1",
"unit_of_measure_string": "/ kW Solar PV",
"unit_of_measure": "2",
"item_variation_suffix": "",
"spare_qty": 0,
"quantity": 0
},
{
"id": "15459",
"inventory_id": "29505",
"supplier_id": null,
"code": "ET-M572190",
"unit_price": 200,
"markup_value": 12,
"markup_is_percentage": "1",
"unit_of_measure_string": "/ item",
"unit_of_measure": "0",
"item_variation_suffix": "",
"spare_qty": 0,
"quantity": 0
}
]
}
} |
IMPORTANT DATA :
INVENTORY MODEL:
CATEGORY VALUES
1 Mounting
2 Isolators - DC
...
23 Battery Isolator
24 Energy Management
25 Discount
26 Contractor install kits
27 Safety & access equipment
CATEGORIES THAT REQUIRE BRAND AND MODEL:
...
13 Miscellaneous
6 Monitoring
1 Mounting
CATEGORIES THAT THE DEFAULT VALUE FOR COST OF SALES IS FALSE:
9 Labour
10 Difficulty surcharges
11 Travel/Freight
12 Administrative
13 Miscellaneous
15 Warranty
18 Subsidy
25 Discount