Gigrove API
Extend or build your own e-commerce apps
Introduction
Gigrove API is a service you can use to connect with your online store on Gigrove over REST API and make API calls that will generate responses in your e-commerce projects.
To start using the Gigrove API you will need to generate Bearer Token. More about it at the Authentication tab.
Authentication
In order to get access to API requests, you will need to authenticate your seller account over Bearer Token.
Steps to get a Bearer Token:
- Fill out the form on this link about your app: https://gigrove.com/api-form
- We will then evaluate your app and send you API keys and Bearer Token which you can use to authenticate to your Gigrove account.
Create a product
This API endpoint will help you to create a new product in your online store on Gigrove.
HTTP Request
POST https://gigrove.com/api/request/v1/products/
Query Parameters
All parameters from Product Properties are accepted as query parameters.
Update a product
This API endpoint will help you to update an existing product in your online store on Gigrove.
HTTP Request
PUT https://gigrove.com/api/request/v1/products/#ID
Query Parameters
All parameters from Product Properties are accepted as query parameters.
Get a single product
This API lets you retrieve and view a specific product by ID.
HTTP Request
GET https://gigrove.com/api/request/v1/products/5694268/
Get all products
This endpoint will retrieve all products from your online store on Gigrove.
HTTP Request
GET https://gigrove.com/api/request/v1/products/
Order properties
The orders API enables you to view single or all orders for authenticated seller:
Attribute | Type | Description |
---|---|---|
id |
integer | Unique identifier for the resource. read-only |
parent_id |
integer | Parent order ID. |
number |
string | Order number. read-only |
order_key |
string | Order key. read-only |
created_via |
string | Shows where the order was created. read-only |
version |
integer | Version of Gigrove last updated the order. read-only |
status |
string | Order status. Options: pending , processing , on-hold , completed , cancelled , refunded and failed . Default is pending . |
currency |
string | Currency the order was created with, in ISO format. Options: AED , AFN , ALL , AMD , ANG , AOA , ARS , AUD , AWG , AZN , BAM , BBD , BDT , BGN , BHD , BIF , BMD , BND , BOB , BRL , BSD , BTC , BTN , BWP , BYR , BZD , CAD , CDF , CHF , CLP , CNY , COP , CRC , CUC , CUP , CVE , CZK , DJF , DKK , DOP , DZD , EGP , ERN , ETB , EUR , FJD , FKP , GBP , GEL , GGP , GHS , GIP , GMD , GNF , GTQ , GYD , HKD , HNL , HRK , HTG , HUF , IDR , ILS , IMP , INR , IQD , IRR , IRT , ISK , JEP , JMD , JOD , JPY , KES , KGS , KHR , KMF , KPW , KRW , KWD , KYD , KZT , LAK , LBP , LKR , LRD , LSL , LYD , MAD , MDL , MGA , MKD , MMK , MNT , MOP , MRO , MUR , MVR , MWK , MXN , MYR , MZN , NAD , NGN , NIO , NOK , NPR , NZD , OMR , PAB , PEN , PGK , PHP , PKR , PLN , PRB , PYG , QAR , RON , RSD , RUB , RWF , SAR , SBD , SCR , SDG , SEK , SGD , SHP , SLL , SOS , SRD , SSP , STD , SYP , SZL , THB , TJS , TMT , TND , TOP , TRY , TTD , TWD , TZS , UAH , UGX , USD , UYU , UZS , VEF , VND , VUV , WST , XAF , XCD , XOF , XPF , YER , ZAR and ZMW . Default is USD . |
date_created |
date-time | The date the order was created, in the site’s timezone. read-only |
date_created_gmt |
date-time | The date the order was created, as GMT. read-only |
date_modified |
date-time | The date the order was last modified, in the site’s timezone. read-only |
date_modified_gmt |
date-time | The date the order was last modified, as GMT. read-only |
discount_total |
string | Total discount amount for the order. read-only |
discount_tax |
string | Total discount tax amount for the order. read-only |
shipping_total |
string | Total shipping amount for the order. read-only |
shipping_tax |
string | Total shipping tax amount for the order. read-only |
cart_tax |
string | Sum of line item taxes only. read-only |
total |
string | Grand total. read-only |
total_tax |
string | Sum of all taxes. read-only |
prices_include_tax |
boolean | True the prices included tax during checkout. read-only |
customer_id |
integer | User ID who owns the order. 0 for guests. Default is 0 . |
customer_ip_address |
string | Customer’s IP address. read-only |
customer_user_agent |
string | User agent of the customer. read-only |
customer_note |
string | Note left by customer during checkout. |
billing |
object | Billing address. |
shipping |
object | Shipping address. |
payment_method |
string | Payment method ID. |
payment_method_title |
string | Payment method title. |
transaction_id |
string | Unique transaction ID. |
date_paid |
date-time | The date the order was paid, in the site’s timezone. read-only |
date_paid_gmt |
date-time | The date the order was paid, as GMT. read-only |
date_completed |
date-time | The date the order was completed, in the site’s timezone. read-only |
date_completed_gmt |
date-time | The date the order was completed, as GMT. read-only |
cart_hash |
string | MD5 hash of cart items to ensure orders are not modified. read-only |
meta_data |
array | Meta data. |
line_items |
array | Line items data. |
tax_lines |
array | Tax lines data. read-only |
shipping_lines |
array | Shipping lines data. |
fee_lines |
array | Fee lines data. |
coupon_lines |
array | Coupons line data. |
refunds |
array | List of refunds. read-only |
set_paid |
boolean | Define if the order is paid. It will set the status to processing and reduce stock items. Default is false . write-only |
Order – Billing properties
Attribute | Type | Description |
---|---|---|
first_name |
string | First name. |
last_name |
string | Last name. |
company |
string | Company name. |
address_1 |
string | Address line 1 |
address_2 |
string | Address line 2 |
city |
string | City name. |
state |
string | ISO code or name of the state, province or district. |
postcode |
string | Postal code. |
country |
string | Country code in ISO 3166-1 alpha-2 format. |
email |
string | Email address. |
phone |
string | Phone number. |
Order – Shipping properties
Attribute | Type | Description |
---|---|---|
first_name |
string | First name. |
last_name |
string | Last name. |
company |
string | Company name. |
address_1 |
string | Address line 1 |
address_2 |
string | Address line 2 |
city |
string | City name. |
state |
string | ISO code or name of the state, province or district. |
postcode |
string | Postal code. |
country |
string | Country code in ISO 3166-1 alpha-2 format. |
Order – Meta data properties
Attribute | Type | Description |
---|---|---|
id |
integer | Meta ID. read-only |
key |
string | Meta key. |
value |
string | Meta value. |
Order – Line items properties
Attribute | Type | Description |
---|---|---|
id |
integer | Item ID. read-only |
name |
string | Product name. |
product_id |
integer | Product ID. |
variation_id |
integer | Variation ID, if applicable. |
quantity |
integer | Quantity ordered. |
tax_class |
integer | Tax class of product. |
subtotal |
string | Line subtotal (before discounts). |
subtotal_tax |
string | Line subtotal tax (before discounts). read-only |
total |
string | Line total (after discounts). |
total_tax |
string | Line total tax (after discounts). read-only |
taxes |
array | Line taxes. read-only |
meta_data |
array | Meta data. |
sku |
string | Product SKU. read-only |
price |
string | Product price. read-only |
Order – Tax lines properties
Attribute | Type | Description |
---|---|---|
id |
integer | Item ID. read-only |
rate_code |
string | Tax rate code. read-only |
rate_id |
string | Tax rate ID. read-only |
label |
string | Tax rate label. read-only |
compound |
boolean | Show if is a compound tax rate. read-only |
tax_total |
string | Tax total (not including shipping taxes). read-only |
shipping_tax_total |
string | Shipping tax total. read-only |
meta_data |
array | Meta data. |
Order – Shipping lines properties
Attribute | Type | Description |
---|---|---|
id |
integer | Item ID. read-only |
method_title |
string | Shipping method name. |
method_id |
string | Shipping method ID. |
total |
string | Line total (after discounts). |
total_tax |
string | Line total tax (after discounts). read-only |
taxes |
array | Line taxes. read-only |
meta_data |
array | Meta data. |
Order – Fee lines properties
Attribute | Type | Description |
---|---|---|
id |
integer | Item ID. read-only |
name |
string | Fee name. |
tax_class |
string | Tax class of fee. |
tax_status |
string | Tax status of fee. Options: taxable and none . |
total |
string | Line total (after discounts). |
total_tax |
string | Line total tax (after discounts). read-only |
taxes |
array | Line taxes. read-only |
meta_data |
array | Meta data. |
Order – Coupon lines properties
Attribute | Type | Description |
---|---|---|
id |
integer | Item ID. read-only |
code |
string | Coupon code. |
discount |
string | Discount total. |
discount_tax |
string | Discount total tax. read-only |
meta_data |
array | Meta data. |
Order – Refunds properties
Attribute | Type | Description |
---|---|---|
id |
integer | Refund ID. read-only |
reason |
string | Refund reason. read-only |
total |
string | Refund total. read-only |
Get a single order
This endpoint will retrieve a single order for authenticated user.
HTTP Request
GET https://gigrove.com/api/request/v1/orders/5694447
Get all orders
This endpoint will retrieve all orders for authenticated user.
HTTP Request
GET https://gigrove.com/api/request/v1/orders/5694447
Get online store notifications
This API retrieves all the notifications of the authenticated seller.
HTTP Request
GET https://gigrove.com/api/request/v1/notifications/
HTTP Request with Pagination
GET https://gigrove.com/api/request/v1/notifications/?per_page=2&page=2
Example JSON response
[
{
"ID": "2170",
"message": "You have received an Order #5694447 for Design Print",
"message_type": "order",
"created": "2020-07-09 17:32:30"
},
{
"ID": "2168",
"message": "You have received an Order #5694446 for Design Print",
"message_type": "order",
"created": "2020-07-09 17:30:41"
},
{
"ID": "2166",
"message": "You have received an Order #5694445 for Design Print",
"message_type": "order",
"created": "2020-07-09 17:24:13"
}
]
You can use Bookings API to pull shop owner’s booking request with GET method:
https://gigrove.com/api/request/v1/bookings/
- GET – Single Booking (ID)
- GET – All Bookings
Gigrove Delivery API enables you to build apps for Delivery on top of your gig store on Gigrove. You need to be authenticated as a delivery person when making API requests. To request a Bearer Token for delivery person’s account, fill out the form here: https://gigrove.com/api-form
To get a Delivery list for shop owner (all deliveries): GET https://gigrove.com/api/request/v1/deliveries
To get a single Delivery: GET https://gigrove.com/api/request/v1/deliveries/==delivery_id==
To update Delivery Status: POST https://gigrove.com/api/request/v1/deliveries/==delivery_id==