×





















GITOAI

Gito provides a smart integrated platform that can host all aggregated business models (Retailer, Marketplace, Market Exchange).
Gito brings to life a concept that essentially powers all e-commerce models employed globally into a single hosted platform. Our e-commerce platform provides group commerce capabilities in each of 3 business models utilized within the industry (retail, marketplace, market exchange) that can be used at the discretion of any online seller anywhere!

INTRODUCTION

Authentication - Summary

Gito's Partners (API Developers) will be provided with a client_id and a client_secret as part of their registration with Gito.
Each API call will be associated to a particular store.As such, each API call will begin with ../V1/ .The partner will have to send the client_id and a client_secret for using in each API call.

IMPORTANT NOTE:

  • client_id and client_secret are associated with Gito's Partners (API Developers) only
  • The client_id and client_secret provided to partners can be used to access data of ALL stores that have granted the partner access.
  • There are no separate client_id or client_secret associated with the stores.
  • The REST response are in JSON format.

Description Of Usual Server Responses

  • 200 OK - the request was successful (some API calls may return 201 instead).
  • 201 Created - the request was successful and a resource was created.
  • 204 No Content - the request was successful but there is no representation to return (i.e. the response is empty).
  • 400 Bad Request - the request could not be understood or was missing required parameters.
  • 401 Unauthorized - authentication failed or user doesn't have permissions for requested operation.
  • 403 Forbidden - access denied.
  • 404 Not Found - resource was not found.
  • 405 Method Not Allowed - requested method is not supported for resource.

Include by query string

An API client can pass list of includes using array or csv string format.

  • e.g. /authors?include[]=books:limit(2|0)&include[]=comments:sort(id|asc)
  • /authors?include=books:limit(2|0),comments:sort(id|asc)
  • For sub-resource inclusion, client can use dot(.) notation.

  • e.g. /books?include=author,publisher.somethingelse

Allowed HTTPs requests

Method

GET Get resource
POST To create resource
PUt Update resource

HOME PAGE

Get All the home pages details using this API. Login, Register, Menu options and many more options will be provided and using the following requests we can fetch all the necessary information

POST register

User add all the mandatory information and get registered successfully

HTTP Request

POST {{url}}/register parameterImage
example

curl -X POST -G " {{url}}/register "

Response
 
      {
            "status": "ok",
            "success": 
            {
            "code": 201,
            "message": "User registered"
            }
      }

POST social-login

User can enter their username and password they have set for their social media profiles like Facebook, Google, Twitter and more. And log in into the site without entering all details in the form

HTTP Request

POST {{url}}/social-login parameterImage
example

curl -X POST -G "{{url}}/social-login"

Response
 
      {
            "status": "ok",
            "success": 
            {
            "code": 201,
            "message": "User registered"
            }
      }

POST password/email

User entered password can be verified in the email they have used in the time of registration.

HTTP Request

POST {{url}}/password/email parameterImage
example

curl -X POST -G "{{url}}/password/email"

Response
 
      {
            
            "success": "true"
            
      }

POST password/email-otp

User entered password can be verified in the email by sending OTP. By entering the OTP received in the email they can complete the verification process.

HTTP Request

POST {{url}}/password/email-otp parameterImage
example

curl -X POST -G "{{url}}/password/email-otp"

Response
 
      {
            "Confirmation Email Sent."  
      }

USER

Retrieves the details of an existing user. You need only supply the unique user identifier that was returned upon user creation. ARGUMENTS ?include=address:limit(5|1):order(created_at|desc)

GET user

Get the all the resource details using client id and address details
This can be an optional longer description of your API call, used within the documentation.
Retrieve logged in user User details
Returns a user object if a valid identifier was provided.
This request always needs to be authenticated.

HTTP Request

GET {{url}}/user?include=address&client_id={{client_id}} parameterImage
example

curl -X GET -G " {{url}}/user?include=address&client_id={{client_id}}"

Response
 
      {

      "data": {
      "name": "Niranjan",
      "email": "niranjan@gito.me",
      "phone": "9765432123",
      "user_verified": 0,
      "gravatar": "http://www.gravatar.com/avatar/e0b02dfd0b6d3552baf5fdc95a915e8b?d=identicon&s=40",
      "created": "15/09/19 03:06 PM",
      "updated": "15/09/19 03:06 PM",
      "address": {
            "data": [
            {
                  "id": 1922,
                  "first_name": "Niranjan",
                  "last_name": "Niranjan",
                  "nicename": "Niranjan",
                  "email": "niranjan@gito.me",
                  "phone": "9765432123",
                  "alpha_street": "6/5 Second floor",
                  "beta_street": "Convent Road",
                  "city": "Bangalore",
                  "state": "Karnataka",
                  "country": "India",
                  "zipcode": "560027",
                  "created": "23/12/19 12:27 PM",
                  "updated": "23/12/19 12:27 PM"
            },…  
      }

GET verify the email address

Get the all the resource information for verification using id and secret key This can be an optional longer description of your API call, used within the documentation.

HTTP Request

GET {{url}}/verify-email?email_token=bmlyYW5qYW5AZ2l0by5tZQ%3D%3D
&client_id={{client_id}}&client_secret={{client_secret}}
parameterImage
example

curl -X GET -G " {{url}}/ verify-email?email_token=bmlyYW5qYW5AZ2l0by5tZQ%3D%3D
&client_id={{client_id}}&client_secret={{client_secret}}”

Response
 

      {
            "status": "ok",
            "success": {
                "code": 200,
                "message": "Your email address has been successfully verified."
            }
      } 

GET redirect to tribyte

Get the all the resource information for verification using id This can be an optional longer description of your API call, used within the documentation.

HTTP Request

GET {{url}}/redirect-to-tribyte&client_id={{client_id}}
example

curl -X GET -G " {{url}}/redirect-to-tribyte&client_id={{client_id}}”

PUT user update

Update a User.
Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
This request always needs to be authenticated.

HTTP Request

PUT {{url}}/user
example

curl -X GET -G "{{url}}/user"

Response
 

      "update successful" 

GET Phone Number Exists

Get the all the resources phone number exits or not .This can be an optional longer description of your API call, used within the documentation.

HTTP Request

GET phone-number/9000000009?client_id={{client_id}}&client_secret={{client_secret}} parameterImage
example

curl -X GET -G "{{url}}/phone-number/9000000009?client_id={{client_id}}&client_secret={{client_secret}}"

Response
 

      "Phone number exists"

GET Address of a User

Get the all the address information of the user This can be an optional longer description of your API call, used within the documentation.

HTTP Request

GET address
example

curl -X GET -G "{{url}}/address"

Response
 

      {
            "data": [
            {
                  "id": 1808,
                  "first_name": "Niranjan",
                  "last_name": "Niranjan",
                  "nicename": "Niranjan",
                  "email": "niranjan@gito.me",
                  "phone": "9000000009",
                  "alpha_street": "2nd H main",
                  "beta_street": "Vijaya Bank Colony,Banswadi",
                  "city": "Bangalore",
                  "state": "Karnataka",
                  "country": "India",
                  "zipcode": "560095",
                  "created": "15/09/19 03:13 PM",
                  "updated": "15/09/19 03:13 PM"
            
      } 
      

GET Single address of User by ID

Get address information of a user by ID
can be an optional longer description of your API call, used within the documentation.

HTTP Request

GET {{url}}/address/1922
example

curl -X GET -G {{url}}/address/1922”

Response
 

      {
                                 
            "id": 1922,
            "first_name": "Niranjan",
            "last_name": "Niranjan",
            "nicename": "Niranjan",
            "email": "niranjan@gito.me",
            "phone": "9765432123",
            "alpha_street": "6/5 Second floor",
            "beta_street": "Convent Road",
            "city": "Bangalore",
            "state": "Karnataka",
            "country": "India",
            "zipcode": "560027",
            "created": "23/12/19 12:27 PM",
            "updated": "23/12/19 12:27 PM"
   
      } 
                              

POST Login

Enter used name and password to login by adding authenticated token provided

HTTP Request

POST login parameterImage
example

curl -X GET -G {{url}}/password/reset-otp ”

Response
 

                       
                           "Logged in!"   
                        
                        

POST password/reset-otp

Enter password by sending the OTP for changing the password created.

HTTP Request

POST password/reset-otp parameterImage
example

curl -X GET -G {{url}}/password/reset-otp ”

Response
 

      
      "reset successful!"    
      

POST password/reset

Enter password by sending the OTP for changing the password created.

HTTP Request

POST password/reset parameterImage
example

curl -X GET -G {{url}}/password/reset”

Response
 

      "successful!" 

POST address

Enter all the details asked in the form to create new address

HTTP Request

POST address parameterImage
example

curl -X GET -G {{url}}/address”

Response
 

{
      "status": "ok",
      "success": {
            "code": 201,
            "message": "Successfully created address."
      }
      
} 

POST Update Address by ID

Update the address by changing fields using individual client ID.

HTTP Request

POST {{url}}/address/1008 parameterImage
example

curl -X GET -G “{{url}}/address/1008"

Response
 

      Response"successful!"

POST Password change after Login

Enter old password and then add new password to change existing password after loggin in.

HTTP Request

POST user/password/change parameterImage
example

curl -X GET -{{url}}/user/password/change

Response
 

{
      "status": "ok",
      "success": {
           "message": "Password changed Successfully"
}

      
} 

GET home

Get the all the resource details
can be an optional longer description of your API call, used within the documentation.

HTTP Request

GET {{url}}/home?include=&client_id={{client_id}}&client_secret={{client_secret}} parameterImage
example

curl -X GET -G GET {{url}}/home?include=&client_id={{client_id}}&client_secret={{client_secret}}

Response
 

{
      data": [
      {
          "name": "banner",
          "links": {
              "image": "http://s3-ap-southeast-1.amazonaws.com/s.demo.buckets/marcadisati/promotions/banner_image_54227-1570076280.jpeg",
              "type": "category",
              "href": "558",
              "details": {
                  "name": "Men",
                  "slug": "men"
              }
          },
          "hash": {
              "data": [
                  {
                      "field": "content",
                      "value": "\r\n\r\n\r\n\r\n\r\n\r\n\r\n"
                  },
                  {
                      "field": "custom_url",
                      "value": ""
                  }
              ]
          }
  
} 

GET home-product/{option}

Get all the products using respective option field for offered products provided.

HTTP Request

GET {{url}}/home-product/offered-product?include=&client_id={{client_id}}&client_secret={{client_secret}} parameterImage
example

curl -X GET -G /home-product/offered-product?include=&client_id={{client_id}}&client_secret={{client_secret}}

Response
 

{
      "data": [],
      "meta": {
          "tax_flow": "FORWARD",
          "label": ""
      }
     
} 

GET pages

Get the page details from the resource details This can be an optional longer description of your API call, used within the documentation.

HTTP Request

GET {{url}}/pages?client_id={{client_id}}&client_secret={{client_secret}} parameterImage
example

curl -X GET -G {{url}}/pages?client_id={{client_id}}&client_secret={{client_secret}}

Response
 

{
      "data": [
        {
            "identifier": "privacy-policy",
            "title": "Privacy Policy",
            "content": "\r\n\r\n\r\n\r\n\r\n

jblkmnbv,mnb 

\r\n\r\n", "position": "FOOTER", "meta_title": "", "meta_keyword": "", "meta_description": "", "created": "09/08/19 05:32 PM", "updated": "09/08/19 05:32 PM" }

GET site-details

Get the site details from the resource details This can be an optional longer description of your API call, used within the documentation.

HTTP Request

GET {{url}}/site-details?include=&client_id={{client_id}}&client_secret={{client_secret}} parameterImage
example

curl -X GET -G {{url}}/site-details?include=&client_id={{client_id}}&client_secret={{client_secret}}

Response
 

{
      "id": 53690,
      "option_name": "favicon",
      "option_value": "http://s3-ap-southeast-1.amazonaws.com/s.demo.buckets/marcadisati/promotions/favicon_1570096729.png",
      "option_hash": []
  },
  {
      "id": 53698,
      "option_name": "ga_id",
      "option_value": "",
      "option_hash": []
  },
  {
      "id": 53699,
      "option_name": "ga_view_id",
      "option_value": "",
      "option_hash": []

      
} 

POST option-details

Get the option details from the resource details
This can be an optional longer description of your API call, used within the documentation.

HTTP Request

POST {{url}}/option-details?client_id={{client_id}}&client_secret={{client_secret}}
example

curl -X POST {{url}}/option-details?client_id={{client_id}}&client_secret={{client_secret}}

POST contact-us

Get all the contact us page information from the resource details

HTTP Request

POST {{url}}/contact-us?include=&client_id={{client_id}}&client_secret={{client_secret}} parameterImage
example

curl -X POST {{url}}/contact-us?include=&client_id={{client_id}}&client_secret={{client_secret}}

Response
 

      "successfully sent request"

POST Subscribe

Enter all the details asked in the form and submit to get subscription from the website to get notified everytime

HTTP Request

POST {{url}}/subscribe
example

curl -X POST {{url}}/subscribe

Response
 

{
 
      "status": "ok",
      "success": {
                 "message": "Subscription successful"
      }
       
} 

GET social media

Get all information about our social media platforms

HTTP Request

GET {{url}}/social-media?client_id={{client_id}}&client_secret={{client_secret}} parameterImage
example

curl -X GET -G {{url}}/social-media?client_id={{client_id}}&client_secret={{client_secret}}

Response
 

{
      "id": 53687,
      "option_name": "facebook",
      "option_value": "https://www.facebook.com/www.gito.me/",
      "option_hash": []
  },
  {
      "id": 53714,
      "option_name": "googleplus",
      "option_value": "",
      "option_hash": []
  },
  {
      "id": 53744,
      "option_name": "instagram",
      "option_value": "Instagram",
      "option_hash": []
  },
  {
      "id": 53750,
      "option_name": "linkedIn",
      "option_value": "",
      "option_hash": []
  },
  {
      "id": 53831,
      "option_name": "pinterest",
      "option_value": "Pinterest",
      "option_hash": []
  },
  {
      "id": 54191,
      "option_name": "twitter",
      "option_value": "Marca Disati",
      "option_hash": []
  
} 

USER-PROFILE(Digital Twin)

API store user profile details

# Parameter Description
1 order_item_id array
2 product_id array
3 sub_user_name string
4 order_item_id string

HTTP Request

POST {{url}} /user-profile
example

curl -X POST -G "{{url}} /user-profile"

POST v1/save-user-session

Saving User credentials for that session for using the application

HTTP Request

POST {{url}}/save-user-session
example

curl -X POST -G {{url}}/save-user-session

Response
 

      Null

POST save-user-activity

Saving User activity or that session for using the application

HTTP Request

POST {{url}}/save-user-activity
example

curl -X POST -G {{url}}/save-user-activity

GET /flex/{section_name}

flex attributes can be generated using section names

HTTP Request

GET {{URL}}/flex/{section_name}
example

curl -X GET -G {{URL}}/flex/{section_name}

Response
 

      Null

GET/promocode

promo code can be generated

HTTP Request

GET {{url}}/promocode
example

curl -X GET -G GET {{url}}/promocode

Response
 
      Null 

GET /savecart-listing

all saved items in the cart will be listed in this page

HTTP Request

GET v1/savecart-listing
example

curl -X GET -G http://localhost/v1/savecart-listing

Response
 

Null

DELETE v1/savecart-delete/{savecart_id}

All saved items in the cart will be listed in the page can all be deleted.

HTTP Request

DELETE {{url}}/savecart-delete/{savecart_id}
example

curl-X DELETE {{url}}/savecart-delete/{savecart_id}

POST v1/savecart-save

All saved items in the cart will saved.

HTTP Request

POST {{url}}/savecart-save
example

curl -X POST POST {{url}}/savecart-save

Response
 
      Null

WISHLIST SAVECART

GET Wishlist Savecart list API

This API used to get the details of wish list and savecart of the logged in user.

HTTP Request

GET {{url}}/wishlist-savecart-listing?client_id={{client_id}}&client_secret={{client_secret}}&source=web parameterImage
example

curl -X GET -G {{url}}/wishlist-savecart-listing?client_id={{client_id}}&client_secret={{client_secret}}&source=web

Response
 

{
      "data": [
      {
          "product_id": 35011,
          "product_name": "Block Print Tshirt",
          "product_slug": "block-print-tshirt-35011",
          "status": 1
      }
  ],
  "meta": {
      "tax_flow": "FORWARD",
      "pagination": {
          "total": 1,
          "count": 1,
          "per_page": 15,
          "current_page": 1,
          "total_pages": 1,
          "links": []
      }
  }
   
} 

POST wishlist-savecart list API

Adding a shipping wishlist-savecart for logged in user.

HTTP Request

POST {{url}}/wishlist?include=&client_id={{client_id}}&client_secret={{client_secret}}
example

curl -X POST {{url}}/wishlist?include=&client_id={{client_id}}&client_secret={{client_secret}}

Response
 

{
      "status": "ok",
    "success": {
        "code": 201,
        "message": "Successfully created wishlist."
    }
    
} 

GET wishlist delete API

Used by visitors to update their wishlist used in the shop.

HTTP Request

GET {{url}}/wishlist/87121/327044? parameterImage
example

curl -X GET -G {{url}}/wishlist/87121/327044?

Response
 

{
      "status": "ok",
      "success": {
          "code": 201,
          "message": "Successfully updated wishlist."
      }
      
} 

BRAND

List brand and Subcategories Get brand Details

GET all brand list

API lists all brands and categories belonging to the store.

HTTP Request

GET {{url}}/brands?include=vendors&client_id={{client_id}}&client_secret={{client_secret}} image
example

curl -X GET -G {{url}}/brands?include=vendors&client_id={{client_id}}&client_secret={{client_secret}}

GET list brand based on product

API is called to list only brands having respective product id

HTTP Request

GET {{url}}/product-brand/10003?client_id={{client_id}}&client_secret={{client_secret}}
example

curl -X GET -G {{url}}/product-brand/10003?client_id={{client_id}}&client_secret={{client_secret}}

GET v1/brands

API lists all categories and brand belonging to the store based on brand name.

# Parameter Description
1 include 'category'

HTTP Request

GET v1/brand-grouped
example

curl -X GET -G v1/brand-grouped

Response
 
  Null

GET v1/brand/{slug}

API provides the details of particular brand.

# Parameter Description
1 include 'category'
2 slug It must be a valid brand Slug

HTTP Request

GET v1/brands/{slug}
example

curl -X GET -G v1/brands/{slug}

Response
 
      Null

CATEGORY

List categories and Subcategories Get Category Details

GET v1/categories

API lists all categories and sub-categories belonging to the store.

# Parameter Description
1 include 'subCategory','products','vendors'

HTTP Request

GET v1/categories
example

curl -X GET -G "http://localhost/v1/categories"

Response
 
      Null 

GET v1/categories/{slug}

API provides the details of particular category.

# Parameter Description
1 include 'subCategory','products'
2 slug It must be a valid category Slug

HTTP Request

GET v1/categories/{slug}
example

curl -X GET -G v1/categories/{slug}

Response
Null

SUBCATEGORY

Get the All the static pages details

GET v1/sub-categories

API lists all sub-categories belonging to the store.

# Parameter Description
1 include 'vendors'

HTTP Request

GET v1/sub-categories
example

curl -X GET -G "http://localhost/v1/sub-categories"

Response
 
      Null 

GET v1/sub-categories/{slug}

# Parameter Description
1 include
2 slug It must be a valid subcategory Slug

HTTP Request

GET v1/sub-categories/{slug}
example

curl -X GET -G "http://localhost/v1/sub-categories/{slug}"

Response
 

      Null

PRODUCT

Get data of the product

GET list all products from site

Product Collection Get the details of all the products on the site. Include parameters to get additional details of the product.

# Parameter Type Status Description
1 include string optional 'variants', 'details', 'specifications', 'upsells', 'images', 'locality', 'attributes',
2 sideFilters string optional 'tagAttribute, promotions, subCategories, categories, brands,price'
3 id integer optional product id
4 promotion_type string optional filter by type of promotion
5 category:category_slug string optional filter by category slug
6 subcategory:subcategory_slug string optional filter by sub category slug
7 category_id string optional filter by category ids
8 subcategory_id string optional filter by subcategory ids
9 vendorIds string optional filter by vendor id
10 variants:id string optional filter by variants id

HTTP Request

GET {{url}}/product?include=details,variants,variants.vendor,variants&client_id={{client_id}}&client_secret={{client_secret}}
example

curl -X GET -G "{{url}}/product"
-d "include"="wvog7CGAxwdbCFfx" \
-d "sideFilters"="AAGI6RHqVnT85vBn" \
-d "id"="2" \
-d "promotion_type"="va1SSXaj6LHnir7m" \
-d "category:category_slug"="E6CTphGhcqYRwBI0" \
-d "subcategory: subcategory_slug"="0K8UhCR4idQmQbAa" \
-d "category_id"="uEzVAc1kcV10hY2S" \
-d "subcategory_id"="u1NekqIRHJ3KF4VH" \
-d "vendorIds"="KswosASPBKp39ArG" \ -d "variants:id"="szguV2WKDtmORGMB"

Response
 

{
      "data": [
        {
            "product_id": 35000,
            "product_name": "testp",
            "product_slug": "testp-35000",
            "status": 1,
            "variants": {
                "data": [
                    {
                        "product_variant_id": 88467,
                        "product_vendor_id": 87018,
                        "variant_name": [],
                        "price": 15,
                        "actual_price": 15,
                        "discount": 0,
                        "transfer_price": 0,
                        "sku": "tp-3",
                        "default_variant": 0,
                        "quantity": 4,
                        "expired": false,
                        "promotion_name": "",
                        "vendor": {
                            "data": {
                                "id": 485,
                                "name": "Actsfolio International Pvt Ltd",
                                "slug": "actsfolio-international-pvt-ltd",
                                "description": "",
                                "address": "No 887, 6th Cross,HBR Layout,1st Stage,,King's Tower,,Bengaluru,Karnataka,India,560043",
                                "email": "prachee.behera@costprize.com",
                                "phone": 1100000000,
                                "fax": 0,
                                "rating": 0,
                                "votes": 0,
                                "created": "06/08/19 01:18 PM",
                                "updated": "06/08/19 01:18 PM"
                            }
                        }
    
} 

GET product by ID

Get the single product details

# Parameter Description
1 id valid product id
2 include 'variants','details','specifications','upsells', 'all_sellers','all_sellers.variants'

HTTP Request

GET {{url}}/product/81648?include=&client_id={{client_id}}&client_secret={{client_secret}}
example

curl -X GET -G {{url}}/product/81648?include=&client_id={{client_id}}&client_secret={{client_secret}}"

Response
 

{
      "data": []     
} 

GET top products

Get top products listed in the site, likewise we have best seller and other options to choose products for the respective section.

HTTP Request

GET {{url}}/product/featured-product?include=details,variants,variants.images&client_id={{client_id}}&client_secret={{client_secret}}
example

curl -X GET -G {{url}}/product/featured-product? include=details,variants,variants.images&client_id= {{client_id}}&client_secret={{client_secret}}

Response
 

{
      "data": [
      {
          "product_id": 35000,
          "product_name": "testp",
          "product_slug": "testp-35000",
          "status": 1,
          "variants": {
              "data": [
                  {
                      "product_variant_id": 88467,
                      "product_vendor_id": 87018,
                      "variant_name": [],
                      "price": 15,
                      "actual_price": 15,
                      "discount": 0,
                      "transfer_price": 0,
                      "sku": "tp-3",
                      "default_variant": 0,
                      "quantity": 4,
                      "expired": false,
                      "promotion_name": ""
   
} 

GET list all product by vendor

Product Collection Get the details of all the products on the site. Include parameters to get additional details of the product

# Parameter Description
1 include 'variants','details','specifications','upsells'

HTTP Request

GET {{url}}/product/vendor/137?client_id={{client_id}}&client_secret={{client_secret}}&include=variants
example

curl -X GET -G GET {{url}}/product/vendor/137?client_id={{client_id}}&client_secret={{client_secret}}&include=variants

Response
 

{
      "data": [],
      "meta": {
          "tax_flow": "FORWARD",
          "pagination": {
              "total": 0,
              "count": 0,
              "per_page": 15,
              "current_page": 1,
              "total_pages": 1,
              "links": []
          }
      }
       
} 

GET filter the products

Get filtered products by attributes,varients,location,client,details and more

HTTP Request

GET {{url}}/product?include=upsells. images,specifications,details,variants:sort (actual_price|desc),locality,location,variants. vendor,occasions,attributes,pax&client_id={{client_id}}&client_ secret={{client_secret}}
example

curl -X GET -G GET {{url}}/product?include=upsells. images,specifications,details, variants:sort(actual_price|desc) ,locality,location, variants.vendor,occasions,attributes, pax&client_id={{client_id}}&client_ secret={{client_secret}}

Response
 

{
      "data": [
      {
          "product_id": 35000,
          "product_name": "testp",
          "product_slug": "testp-35000",
          "status": 1,
          "variants": {
              "data": [
                  {
                      "product_variant_id": 88467,
                      "product_vendor_id": 87018,
                      "variant_name": [],
                      "price": 15,
                      "actual_price": 15,
                      "discount": 0,
                      "transfer_price": 0,
                      "sku": "tp-3",
                      "default_variant": 0,
                      "quantity": 4,
                      "expired": false,
                      "promotion_name": "",
                      "vendor": {
                          "data": {
                              "id": 485,
                              "name": "Actsfolio International Pvt Ltd",
                              "slug": "actsfolio-international-pvt-ltd",
                              "description": "",
                              "address": "No 887, 6th Cross,HBR Layout,1st Stage,,King's Tower,,Bengaluru,Karnataka,India,560043",
                              "email": "prachee.behera@costprize.com",
                              "phone": 1100000000,
                              "fax": 0,
                              "rating": 0,
                              "votes": 0,
                              "created": "06/08/19 01:18 PM",
                              "updated": "06/08/19 01:18 PM"
                          }
                      }
  
} 

GET product/vendor/{id}/offers

Offer Product Collection Get the details of all offer products on the site. Include parameters to get additional details of the product

# Parameter Description
1 include 'variants','details','specifications','upsells'

HTTP Request

GET {{url}}/product/vendor/137/offers?include=details,variants, variants.images&client_id={{client_id}}&client_secret={{client_secret}}
example

curl -X GET -G {{url}}/product/vendor/137/offers?include=details,variants, variants.images&client_id={{client_id}}&client_secret={{client_secret}}

Response
 

{
  
      "data": [],
      "meta": {
          "tax_flow": "FORWARD",
          "pagination": {
              "total": 0,
              "count": 0,
              "per_page": 15,
              "current_page": 1,
              "total_pages": 1,
              "links": []
          }
      }
      
} 

GET deals get list

Bundles and deals created will all be listed Authentication required

HTTP Request

GET {{url}}/deals?include=variants.deal
example

curl -X GET -G {{url}}/deals?include=variants.deal

POST create deal

Deals can be created by filling up all the required fields and can be stored after submission Authentication required

HTTP Request

POST {{url}}/create-deal
example

curl -X GET -G {{url}}/create-deal

Response
 

{
  
      "status": "ok",
      "success": {
          "code": 201,
          "message": "Successfully requested."
      }
      
} 

POST deal submit

Deals can be created by filling up all the required fields and can be stored after submission Authentication required

HTTP Request

POST {{url}}/deals?include=
example

curl -X GET -G {{url}}/deals?include=

Response
 

{
      "status": "ok",
      "success": {
          "code": 201,
          "message": "Successfully requested."
      }
       
} 

POST deal all submit

All Deals can be created by filling up all the required fields and can be stored after submission Authentication required

HTTP Request

POST {{url}}/deals-all?include=
example

curl -X GET -G {{url}}/deals-all?include=

Response
 

{
      "status": "ok",
      "success": {
          "code": 201,
          "message": "Successfully requested."
      }
        
} 

GET offers/product

HTTP Request

GET {{url}}/offers/product
example

curl -X GET -G {{url}}/offers/product

GET home-product/{option}

Get the specified option from the resource details for a option

# Parameter Description
1 option 'featured-product','top-products'

HTTP Request

GET {{url}}/home-product/{option}
example

curl -X GET -G {{url}}/home-product/{option}

GET home-product

Get the all the resource details for all the options('featured-product','top-products' )

HTTP Request

GET "{{url}}/home-product
example

curl -X GET -G {{url}}/home-product

GET product-model

HTTP Request

GET {{url}}/product-model
example

curl -X GET -G {{url}}/product-model

Response
 

{
      Null  
} 

v1/product-brand/{product_model

HTTP Request

GET v1/product-brand/{product_model}
example

curl -X GET -G v1/product-brand/{product_model}

Response
 

{
      Null     
} 

v1/comment

HTTP Request

POST v1/comment
example

curl -X POST v1/comment

Response
 

{
      Null   
} 

ATTRIBUTE

Get the All the Product Tag Attribute details

GET attribute/{attribute_code}

Get the specified attribute_code from the resource details This can be an optional longer description of your API call, used within the documentation.

HTTP Request

GET {{url}}/attribute/occassions?include=&client_ id={{client_id}}&client_secret={{client_secret}}
example

curl -X GET -G {{url}}/attribute/occassions?include=&client _id={{client_id}}&client_secret={{client_secret}}

Response
 

{
      Null 
} 

GET /menu-attribute

Get the is menu attribute_code from the resource details This can be an optional longer description of your API call, used within the documentation.

HTTP Request

GET {{url}}/menu-attribute
example

curl -X GET -G {{url}}/menu-attribute

Response
 

{
      Null    
} 

SEARCH

post /search

Get all product with search

# Parameter Description
1 term search tearm
2 include 'variants','details','specifications'
3 category_id comma separated ids(no limit)
4 subcategory_id comma separated ids(no limit)
4 brand_id comma separated ids(no limit)
4 price separated range(limit restrict to 2)
4 filter-vendorIds string (,)comma separated

HTTP Request

POST {{url}}/search?client_id={{client_id}}&client_secret={{client_secret}} &vendorIds=105&subcategory_id=1955&brand_ id=910&inStock=1&sortByPopularity=desc


example

curl -X POST {{url}}/search?client_id={{client_id}} &client_secret={{client_secret}}& vendorIds=105&subcategory _id=1955&brand_ id=910&inStock= 1&sortByPopularity=desc

VENDOR

This is an object representing your Vendor account. You can retrieve it to see properties on the account like its current provides information of store such as store name, store url, domain, date, contact information, images links and urls..

GET vendors

Vendor Collection Get a list of all the vendor details on the site

HTTP Request

GET {{url}}/vendors?include=&client_id={{client_id}} &client_secret={{client_secret}} parameterImage
example

curl -X GET -G {{url}}/vendors?include=&client_ id={{client_id}}&client_secret={{client_secret}}

GET vendors/{slug}

Vendor Get the details of a single vendor on the site

HTTP Request

GET {{url}}/vendors/super-grocery?include=comments,rating,pages, details&client_id={{client_id}}&client_secret={{client_secret}} parameterImage
example

curl -X GET -G {{url}}/vendors/super-grocery?include=comments, rating,pages,details&client_ id={{client_id}}&client_secret={{client_secret}}

GET vendor cities

Find the Vendor cities

HTTP Request

GET {{url}}/vendor-cities?include=&client_id ={{client_id}}&client_secret={{client_secret}}
example

curl -X GET -G {{url}}/vendor-cities?include=&client_id= {{client_id}}&client_secret={{client_secret}}

GET v1/findVendor/

Find the Vendor based on Referal URL Get the details of a single vendor on the site if they have static site used for lvb platinum theme

HTTP Request

GET v1/findVendor
example

curl -X GET -G "http://localhost/v1/findVendor"

Response
 

{
      Null    
} 

GET v1/getVendor/

Find the Vendor based on serving radius

HTTP Request

GET v1/getVendor
example

curl -X GET -G "http://localhost/v1/getVendor"

Response
 

 
      Null    
 

VARIENTS

Get the product variants details

GET v1/variants/{product_vendor_id}

Get the single variant by passing the page product_vendor_id and name and values as array This can be used when fetch details of variant choosen.

HTTP Request

POST v1/variants/{product_vendor_id}
example

curl -X POST v1/variants/{product_vendor_id}

Response
 

{
      Null    
} 

GET v1/variants/{variant_id}

Get the variant by passing the variant_id This can be used when fetch the variant details by id.

HTTP Request

GET v1/variants/{variant_id}
example

curl -X GET -G "http://localhost/v1/variants/{variant_id}"

Response
 

{
      Null    
} 

POST v1/variants

Get the all variant by passing the product model, brand Id and variants name and values as array This can be used when fetch list of variants for the filter section.

HTTP Request

POST v1/variants
example

curl -X POST "http://localhost/v1/variants"

Response
 

{
      Null 
} 

CART

Get the cart details with shipping charges and promotions

POST /cart

add all product to cart and get the cart contents back

# Parameter Type Description
1 cart_contents[]['product_variant_id'] array required pass the product variant id
2 cart_contents[]['quantity'] array required pass the product variant id
3 more_info['shipping_address_id'] string optional user selected address
4 more_info['promo_code'] string optional pass the valid cart promo code
5 source string required valid any one android, web or ios

HTTP Request

POST {{url}}/cart?client_id={{client_id}}&client_secret={{client_secret}}
example

curl -X POST {{url}}/cart?client_id={{client_id}}&client_secret={{client_secret}}

Response
 

{
      Null  
} 

GET shopping cart

Cart Values Get a list of all the cart details on the site

HTTP Request

GET {{url}}/shopping-cart?client_id={{client_id}} &client_secret={{client_secret}}
example

curl -X GET -G {{url}}/shopping-cart?client_id={{client_id}} &client_secret={{client_secret}}

Response
 

{
      Null    
} 

POST shopping cart

Cart values will all be saved

HTTP Request

POST {{url}}/shopping-cart?client_id={{client_id}}&client_secret={{client_secret}}
example

curl -X POST {{url}}/shopping-cart?client_id={{client_id}}&client_secret={{client_secret}}

Response
 

{
      Null   
} 

ORDER

Get data of the orders.

POST create new order

Enter all the fields to create new order Authentication required

HTTP Request

POST {{url}}/order-create
example

curl -X POST {{url}}/order-create

Response
 

{
      Successful!    
} 

GET user orders list

Order Collection Get a list of all the order details on the site

HTTP Request

GET {{url}}/user-orders?include1=address,orderItems,orderItems.product,orderItems. variant,orderItems.variant.taxes,orderItems. itemHash&include=orderItems.tracking parameterImage
example

curl -X GET -G {{url}}/user-orders?include1=address, orderItems,orderItems.product,orderItems. variant,orderItems.variant.taxes,orderItems. itemHash&include=orderItems.tracking

Response
 

{
      Null    
} 

GET orders/{transaction_id}

Order Collection by transaction_id Get a list of all the order details respective to the transaction_id

HTTP Request

GET {{url}}/order/15350191854918?include=orderItems,orderItems.product,orderItems. itemHash,orderItems.variant&client_id ={{client_id}}&client_secret={{client_secret}} parameterImage
example

curl -X GET -G {{url}}/order/15350191854918?include=orderItems ,orderItems.product,orderItems.itemHash, orderItems.variant&client_id={{client_id}} &client_secret={{client_secret}}

Response
 

      {
            "data":[],
            "meta": {
                "pagination": {
                    "total": 0,
                    "count": 0,
                    "per_page": 15,
                    "current_page": 1,
                    "total_pages": 1,
                    "links": []
                }
            }
        }

CREATE ORDER

Create the order and process payment transaction

POST order-create

Requires Authentication

# Parameter Type Description
1 cart_contents[]['product_variant_id'] array required pass the product variant id
2 cart_contents[]['quantity'] array required pass the product variant id
3 more_info['shipping_address_id'] string optional user selected address
4 more_info['delivery_slot'] string optional you can pass delivery slot
5 more_info['payment_method'] string required Payment methods any one (cod,payu,card_on_delivery, ccavenue_mars,paymark)
6 more_info['promo_code'] string optional pass the valid cart promo code
7 source string required valid any one android, web or ios

HTTP Request

POST {{url}}/shopping-cart?client_id={{client_id}}&client_ secret={{client_secret}}
example

curl -X POST {{url}}/shopping-cart?client_id={{client_id}} &client_secret={{client_secret}}

ADDRESS

Get the Address details

POST v1/address

Adding a shipping address for logged in user. Requires Authentication

HTTP Request

POST v1/address
example

curl -X POST v1/address

Response
 

      Null 

GET v1/address/{id}

Used by visitors to view their addresses used in the shop.

# Parameter Type Description
1 id integer required the id of the It must be a valid Address ID
2 include string optional

HTTP Request

GET v1/address/{id}
example

curl -X GET -G "http://localhost/v1/address/{id}" -d "id"="4" \-d "include"="PNJQZQ29kZIstF43"

Response
 

      Null

GET v1/address

This API used to get the details of address of the logged in user.

HTTP Request

GET v1/address
example

curl -X GET -G "http://localhost/v1/address"

Response
 

      Null 

POST v1/address/{id}

Used by visitors to update their addresses used in the shop.

HTTP Request

POST v1/address/{id}
example

curl -X GET -G "http://localhost/v1/address/{id}"

Response
 

      Null

GET v1/address/delete/{id}

Used by visitors to delete their addresses used in the shop.

HTTP Request

POST v1/address/delete/{id}
example

curl -X POST v1/address/delete/{id}

Response
 

      Null

LOGISTICS

Get data and type of the shipping changes

GET shipping-charges

Get the all the resource details for all the shipping charges in cart level

HTTP Request

GET {{url}}/shipping-charges?include=&client_ id={{client_id}}&client_secret={{client_secret}}
example

curl -X GET -G {{url}}/shipping-charges?include=&client_i d={{client_id}}&client_secret={{client_secret}}

Response
 

      Null

POST dynamic-shipping-charges

get dynamic shipping rates from shipping provides Only Shipmile is integrated

HTTP Request

POST {{url}}/dynamic-shipping-charges?client_id ={{client_id}}&client_secret={{client_secret}}
example

curl -X POST {{url}}/dynamic-shipping-charges?client_id= {{client_id}}&client_secret={{client_secret}}

Response
 
      Null

DELIVERY SLOTS

Vendor delivery Timings slots Collection Get a list of all the vendor delivery timing details on the site

GET delivery-slots

Vendor delivery Timings slots Collection Get a list of all the vendor delivery timing details on the site

# Parameter Type Status Description
1 vendorId integer required

HTTP Request

GET {{url}}/delivery-slots?vendorId=118&client_id= {{client_id}}&client_secret={{client_secret}}
example

curl -X GET -G GET {{url}}/delivery-slots?vendorId=118&client_id= {{client_id}}&client_secret={{client_secret}}

Response
 

      Null 

GET express-delivery-slots

Vendor Express delivery slot Get a slot of the vendor express delivery timing details on the site

# Parameter Type Status Description
1 vendorId integer required
2 addressId integer required

HTTP Request

GET {{url}}/express-delivery-slots?vendorId=105&client_id= {{client_id}}&client_secret={{client_secret}} &addressId=5722
example

curl -X GET -G GET {{url}}/express-delivery-slots?vendorId=105&client_id= {{client_id}}&client_secret= {{client_secret}}&addressId=5722

Response
 
null 

STATIC PAGES

Get the All the static pages details

GET v1/pages

Get the all the pages details This can be an optional longer description of your API call, used within the documentation

HTTP Request

GET v1/pages
example

curl -X GET -G v1/pages

Response
 

      Null 

GET v1/pages/{slug}

Get the single page by passing the page slug This can be an optional longer description of your API call, used within the documentation.

HTTP Request

GET v1/pages/{slug}
example

curl -X GET -G v1/pages/{slug}

Response
 
      Null 

DEAL CONTROLLER

Get the Deal contents

GET v1/ask-an-expert

This API used to get the details of products of based on filters.

HTTP Request

GET {{url}}/ask-an-expert?include=images ,variants.vendor.address&client_id= {{client_id}}&client_secret={{client_secret}}&name= niranjan&email=niranjan@gito.me&phone=12345677898&from= 12-12-2018 12:12 PM&to=19-12-2018 12:12 PM&subcategory :subcategory_slug=venues-banquet-halls&pax=12&price=1230
example

curl -X GET -G {{url}}/ask-an-expert?include=images ,variants.vendor.address&client_id= {{client_id}}&client_secret={{client_secret}}&name= niranjan&email=niranjan@gito.me& phone=12345677898&from= 12-12-2018 12:12 PM&to=19-12-2018 12:12 PM&subcategory :subcategory_slug=venues-banquet-halls&pax=12&price=1230

Response
 
      Null

GET payment gateway test

This API used to test payment gateway using test credentials provided.

HTTP Request

GET http://gito-api.dev/v1/payment?client_id= {{client_id}}&client_secret={{client_secret}}
example

curl -X GET -G GET http://gito-api.dev/v1/payment?client_id= {{client_id}}&client_secret= {{client_secret}}

POST PAYU payment gateway response

This API used to test payu payment gateway using test credentials provided.

HTTP Request

GET http://gito-api.dev/v1/payment?client_id= {{client_id}}&client_secret={{client_secret}}
example

curl -X GET -G http://gito-api.dev/v1/payment?client_id= {{client_id}}&client_secret={{client_secret}}

TESTIMONIALS

Get the All the User testimonial pages details

GET v1/testimonials

Get the all the testimonials details

# Parameter Type Status Description
1 include string optional user

HTTP Request

GET v1/testimonials
example

curl -X GET -G v1/testimonials

Response
 

      {
            "data": [
                {
                    "title": "Thanks",
                    "content": "Testestest",
                    "a_rating": 5,
                    "created": "23/09/19 10:34 AM",
                    "updated": "25/09/19 10:58 PM",
                    "user": {
                        "data": {
                            "name": "PBPB",
                            "email": "prachee.behera@costprize.com",
                            "phone": "7406212105",
                            "user_verified": 1,
                            "gravatar": "http://www.gravatar.com/avatar/ea78ba0bd215063b362d55de1b374728?d=identicon&s=40",
                            "created": "05/08/19 12:54 PM",
                            "updated": "05/08/19 12:54 PM"
                        }
                    }
                },...
            ]
      }  

POST v1/testimonial

Get the all the testimonials details

# Parameter Type Status Description 1 title string required short description 1 content string optional long description

HTTP Request

POST v1/testimonial
example

curl -X POST v1/testimonial

Response
 

      Null