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 on 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:

  1. Fill out the form on this link about your app: https://gigrove.com/api-form
  2. We will then evaluate your app and send you API keys and Bearer Token which you can use to authenticate to your Gigrove account.

Product Properties

ParameterTypeDescription
idintegerUnique identifier for the resource. READ-ONLY
namestringProduct name Required – Only Create.
slugstringProduct slug.
permalinkstringProduct URL. READ-ONLY
date_createddate-time The date the product was created, in the site’s timezone. READ-ONLY
date_created_gmtdate-time The date the product was created, as GMT. READ-ONLY
date_modifieddate-time The date the product was last modified, in the site’s timezone. READ-ONLY
date_modified_gmtdate-time The date the product was last modified, as GMT. READ-ONLY
typestringProduct type. Options: simple, grouped, external and variable. Default is simple.
statusstringProduct status (post status). Options: draft, pending, publish. It depends on vendor publishing admin settings
featuredbooleanFeatured product. Default is false.
catalog_visibilitystringCatalog visibility. Options: visible, catalog, search and hidden. Default is visible.
descriptionstringProduct description.
short_descriptionstringProduct short description.
skustringUnique identifier.
pricestringCurrent product price. READ-ONLY
regular_pricestringProduct regular price.
sale_pricestringProduct sale price.
date_on_sale_fromdate-time Start date of sale price, in the site’s timezone.
date_on_sale_from_gmtdate-time Start date of sale price, as GMT.
date_on_sale_todate-time End date of sale price, in the site’s timezone.
date_on_sale_to_gmtdate-time End date of sale price, as GMT.
price_htmlstringPrice formatted in HTML. READ-ONLY
on_salebooleanShows if the product is on sale. READ-ONLY
purchasablebooleanShows if the product can be bought. READ-ONLY
total_salesintegerAmount of sales. READ-ONLY
virtualbooleanIf the product is virtual. Default is false.
downloadablebooleanIf the product is downloadable. Default is false.
downloadsarrayList of downloadable files. See Product – Downloads properties
download_limitintegerNumber of times downloadable files can be downloaded after purchase. Default is -1.
download_expiryintegerNumber of days until access to downloadable files expires. Default is -1.
external_urlstringProduct external URL. Only for external products.
button_textstringProduct external button text. Only for external products.
tax_statusstringTax status. Options: taxable, shipping and none. Default is taxable.
tax_classstringTax class.
manage_stockbooleanStock management at product level. Default is false.
stock_quantityintegerStock quantity.
in_stockbooleanControls whether or not the product is listed as “in stock” or “out of stock” on the frontend. Default is true.
backordersstringIf managing stock, this controls if backorders are allowed. Options: no, notify and yes. Default is no.
backorders_allowedbooleanShows if backorders are allowed. READ-ONLY
backorderedbooleanShows if the product is on backordered. READ-ONLY
sold_individuallybooleanAllow one item to be bought in a single order. Default is false.
weightstringProduct weight.
dimensionsobjectProduct dimensions. See Product – Dimensions properties
shipping_requiredbooleanShows if the product need to be shipped. READ-ONLY
shipping_taxablebooleanShows whether or not the product shipping is taxable. READ-ONLY
shipping_classstringShipping class slug.
shipping_class_idstringShipping class ID. READ-ONLY
reviews_allowedbooleanAllow reviews. Default is true.
average_ratingstringReviews average rating. READ-ONLY
rating_countintegerAmount of reviews that the product have. READ-ONLY
related_idsarrayList of related products IDs. READ-ONLY
upsell_idsarrayList of up-sell products IDs.
cross_sell_idsarrayList of cross-sell products IDs.
parent_idintegerProduct parent ID.
purchase_notestringOptional note to send the customer after purchase.
categoriesarrayList of categories. See Product – Categories properties Required – Only create
tagsarrayList of tags. See Product – Tags properties
attributesarrayList of attributes. See Product – Attributes properties
default_attributesarrayDefaults variation attributes. See Product – Default attributes properties
variationsarrayList of variations IDs. READ-ONLY
grouped_productsarrayList of grouped products ID.
menu_orderintegerMenu order, used to custom sort products.
meta_dataarrayMeta data. See Product – Meta data properties

Product – Downloads properties

AttributeTypeDescription
idstringFile MD5 hash. READ-ONLY
namestringFile name.
filestringFile URL.

Product – Dimensions properties

AttributeTypeDescription
lengthstringProduct length.
widthstringProduct width.
heightstringProduct height.

Product – Categories properties

AttributeTypeDescription
idintegerCategory ID.
namestringCategory name. READ-ONLY
slugstringCategory slug. READ-ONLY

Product – Tags properties

AttributeTypeDescription
idintegerTag ID.
namestringTag name. READ-ONLY
slugstringTag slug. READ-ONLY

Product – Images properties

AttributeTypeDescription
idintegerImage ID.
date_createddate-timeThe date the image was created, in the site’s timezone. READ-ONLY
date_created_gmtdate-timeThe date the image was created, as GMT. READ-ONLY
date_modifieddate-timeThe date the image was last modified, in the site’s timezone. READ-ONLY
date_modified_gmtdate-timeThe date the image was last modified, as GMT. READ-ONLY
srcstringImage URL.
namestringImage name.
altstringImage alternative text.
positionintegerImage position. 0 means that the image is featured.

Product – Attributes properties

AttributeTypeDescription
idintegerAttribute ID.
namestringAttribute name.
positionintegerAttribute position.
visiblebooleanDefine if the attribute is visible on the “Additional information” tab in the product’s page. Default is false.
variationbooleanDefine if the attribute can be used as variation. Default is false.
optionsarrayList of available term names of the attribute.

Product – Default attributes properties

AttributeTypeDescription
idintegerAttribute ID.
namestringAttribute name.
optionstringSelected attribute term name.

Product – Meta data properties

AttributeTypeDescription
idintegerMeta ID. READ-ONLY
keystringMeta key.
valuestringMeta value.

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:

AttributeTypeDescription
idintegerUnique identifier for the resource. read-only
parent_idintegerParent order ID.
numberstringOrder number. read-only
order_keystringOrder key. read-only
created_viastringShows where the order was created. read-only
versionintegerVersion of Gigrove last updated the order. read-only
statusstringOrder status. Options: pendingprocessingon-holdcompletedcancelledrefunded and failed. Default is pending.
currencystringCurrency the order was created with, in ISO format. Options: AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBRLBSDBTCBTNBWPBYRBZDCADCDFCHFCLPCNYCOPCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGGPGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSIMPINRIQDIRRIRTISKJEPJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMROMURMVRMWKMXNMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPRBPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSRDSSPSTDSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUYUUZSVEFVNDVUVWSTXAFXCDXOFXPFYERZAR and ZMW. Default is USD.
date_createddate-timeThe date the order was created, in the site’s timezone. read-only
date_created_gmtdate-timeThe date the order was created, as GMT. read-only
date_modifieddate-timeThe date the order was last modified, in the site’s timezone. read-only
date_modified_gmtdate-timeThe date the order was last modified, as GMT. read-only
discount_totalstringTotal discount amount for the order. read-only
discount_taxstringTotal discount tax amount for the order. read-only
shipping_totalstringTotal shipping amount for the order. read-only
shipping_taxstringTotal shipping tax amount for the order. read-only
cart_taxstringSum of line item taxes only. read-only
totalstringGrand total. read-only
total_taxstringSum of all taxes. read-only
prices_include_taxbooleanTrue the prices included tax during checkout. read-only
customer_idintegerUser ID who owns the order. 0 for guests. Default is 0.
customer_ip_addressstringCustomer’s IP address. read-only
customer_user_agentstringUser agent of the customer. read-only
customer_notestringNote left by customer during checkout.
billingobjectBilling address.
shippingobjectShipping address.
payment_methodstringPayment method ID.
payment_method_titlestringPayment method title.
transaction_idstringUnique transaction ID.
date_paiddate-timeThe date the order was paid, in the site’s timezone. read-only
date_paid_gmtdate-timeThe date the order was paid, as GMT. read-only
date_completeddate-timeThe date the order was completed, in the site’s timezone. read-only
date_completed_gmtdate-timeThe date the order was completed, as GMT. read-only
cart_hashstringMD5 hash of cart items to ensure orders are not modified. read-only
meta_dataarrayMeta data.
line_itemsarrayLine items data.
tax_linesarrayTax lines data. read-only
shipping_linesarrayShipping lines data.
fee_linesarrayFee lines data.
coupon_linesarrayCoupons line data.
refundsarrayList of refunds. read-only
set_paidbooleanDefine if the order is paid. It will set the status to processing and reduce stock items. Default is falsewrite-only

Order – Billing properties

AttributeTypeDescription
first_namestringFirst name.
last_namestringLast name.
companystringCompany name.
address_1stringAddress line 1
address_2stringAddress line 2
citystringCity name.
statestringISO code or name of the state, province or district.
postcodestringPostal code.
countrystringCountry code in ISO 3166-1 alpha-2 format.
emailstringEmail address.
phonestringPhone number.

Order – Shipping properties

AttributeTypeDescription
first_namestringFirst name.
last_namestringLast name.
companystringCompany name.
address_1stringAddress line 1
address_2stringAddress line 2
citystringCity name.
statestringISO code or name of the state, province or district.
postcodestringPostal code.
countrystringCountry code in ISO 3166-1 alpha-2 format.

Order – Meta data properties

AttributeTypeDescription
idintegerMeta ID. read-only
keystringMeta key.
valuestringMeta value.

Order – Line items properties

AttributeTypeDescription
idintegerItem ID. read-only
namestringProduct name.
product_idintegerProduct ID.
variation_idintegerVariation ID, if applicable.
quantityintegerQuantity ordered.
tax_classintegerTax class of product.
subtotalstringLine subtotal (before discounts).
subtotal_taxstringLine subtotal tax (before discounts). read-only
totalstringLine total (after discounts).
total_taxstringLine total tax (after discounts). read-only
taxesarrayLine taxes. read-only
meta_dataarrayMeta data.
skustringProduct SKU. read-only
pricestringProduct price. read-only

Order – Tax lines properties

AttributeTypeDescription
idintegerItem ID. read-only
rate_codestringTax rate code. read-only
rate_idstringTax rate ID. read-only
labelstringTax rate label. read-only
compoundbooleanShow if is a compound tax rate. read-only
tax_totalstringTax total (not including shipping taxes). read-only
shipping_tax_totalstringShipping tax total. read-only
meta_dataarrayMeta data.

Order – Shipping lines properties

AttributeTypeDescription
idintegerItem ID. read-only
method_titlestringShipping method name.
method_idstringShipping method ID.
totalstringLine total (after discounts).
total_taxstringLine total tax (after discounts). read-only
taxesarrayLine taxes. read-only
meta_dataarrayMeta data.

Order – Fee lines properties

AttributeTypeDescription
idintegerItem ID. read-only
namestringFee name.
tax_classstringTax class of fee.
tax_statusstringTax status of fee. Options: taxable and none.
totalstringLine total (after discounts).
total_taxstringLine total tax (after discounts). read-only
taxesarrayLine taxes. read-only
meta_dataarrayMeta data.

Order – Coupon lines properties

AttributeTypeDescription
idintegerItem ID. read-only
codestringCoupon code.
discountstringDiscount total.
discount_taxstringDiscount total tax. read-only
meta_dataarrayMeta data.

Order – Refunds properties

AttributeTypeDescription
idintegerRefund ID. read-only
reasonstringRefund reason. read-only
totalstringRefund 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==