Overview - API

Name: Storeino Online Store
Price: 16.90 USD
Availability: InStock
Rating: 4.5 (5 reviews)
Author: Storeino

Connect Now

Introduction

Storeino API provides new enhancement, performance improvements and new features for clients. This document provides detailed API information. It is recommended to to read it completely before implementing the integrations to any system

API Structure

Api End Points

Storeino provides API end points for both Development and Production systems. For initial development and testing please use the development API end point.

Development API End Point URL

https://api-shippings.storeino.world/api/

Production API End Point URL

https://api-shippings.storeino.com/api/

Request Header

Storeino API requires the following two headers.

Table
Header	Possible Value	Description
Accept	application/json	To get response in JSON format, this header should be passed with request with value application/json
X-auth-token	String	Token your company get it after register

APIs

Create Order

we send to your end point creation order this data format JSON

999
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 {
      RECEIVER : 'BADR AGRIR', //full name 
      SELLERID : 2343, //seller ID in your company
      PHONE : '06xx-xx-xx-xx', //phone number string
      CITY : 'city of custemer', //string
      COUNTRY:'USA', //contry of custemer String
      //You can find product field only if you have warehousing service
      PRODUCTS:[
      {
        product:{
          _id:'23412' //id of product in your plateform
        },
        quantity:4,
        unitPrice:34
      },
      {...},
      ],
      ADDRESS : 'new yourk 1109 road 02', //address of custemer string
      TOTAL_PRICE : 15, //total price integer
      SERVICE:'CASH IN DELIVERY', // string
      SOURCE : 'STOREINO'
  }; {
      RECEIVER : 'BADR AGRIR', //full name 
      SELLERID : 2343, //seller ID in your company
      PHONE : '06xx-xx-xx-xx', //phone number string
      CITY : 'city of custemer', //string
      COUNTRY:'USA', //contry of custemer String
      //You can find product field only if you have warehousing service
      PRODUCTS:[
      {
        product:{
          _id:'23412' //id of product in your plateform
        },
        quantity:4,
        unitPrice:34
      },
      {...},
      ],
      ADDRESS : 'new yourk 1109 road 02', //address of custemer string
      TOTAL_PRICE : 15, //total price integer
      SERVICE:'CASH IN DELIVERY', // string
      SOURCE : 'STOREINO'
  };

success format accepted

999
1
2
3
4
5
6
 {
      status:200
      data:{
        orderRef:23234, //ID order in yourn plateform
      }
  }; {
      status:200
      data:{
        orderRef:23234, //ID order in yourn plateform
      }
  };

Error format accepted

999
1
2
3
4
5
6
 {
      status:400
      data:{
        error:'phone number not valid'
      }
  }; {
      status:400
      data:{
        error:'phone number not valid'
      }
  };

Import Product(this api is required if you have warehousing service)

We send to your end point creation Product this data format JSON

999
1
2
3
4
5
6
7
8
9
 {
      name : 'phone', //title the product
      picture:'https/image.xx/', //url of the product
      description : 'new product', //description of the product
      source: 'STOREINO',
      sellerId:'', //id the seller in your company
      price: 15,
      quantity: 122, //quantity in stock
  }; {
      name : 'phone', //title the product
      picture:'https/image.xx/', //url of the product
      description : 'new product', //description of the product
      source: 'STOREINO',
      sellerId:'', //id the seller in your company
      price: 15,
      quantity: 122, //quantity in stock
  };

success format accepted

999
1
2
3
4
5
6
7
 {
      status:200
      data:{
        productRef:23234, //ID product in your plateform
        sellerId:233 //ID seller in your plateform
      }
  }; {
      status:200
      data:{
        productRef:23234, //ID product in your plateform
        sellerId:233 //ID seller in your plateform
      }
  };

Error format accepted

999
1
2
3
4
5
6
 {
      status:400
      data:{
        error:'title not valid'
      }
  }; {
      status:400
      data:{
        error:'title not valid'
      }
  };

update status order

body format accepted

https://api-shippings.storeino.com/api/

BASE-URL/companies/changeStatus?source=NAME-COMPANY

999
1
2
3
4
5
6
7
        <!-- headers above is necessary -->
 {
      orderId : 423, //ID order in your database
      status:'', //new status
      note:'delivered 12:12 AM'
  };        <!-- headers above is necessary -->
 {
      orderId : 423, //ID order in your database
      status:'', //new status
      note:'delivered 12:12 AM'
  };

success result

999
1
2
3
4
 {
      status:200,
      { data: 'status changed' }
  }; {
      status:200,
      { data: 'status changed' }
  };

Accepted Status

CONFIRMED

PREPARED

SHIPPED

DELIVERED

PAID

OUTOFSTOCK

UNREACHED

CANCELED

REFUSED

AWAITING_RETURN

RETURNED

PENDING

Login customer

body format accepted

BASE-URL/companies/login?source=NAME-COMPANY

999
1
2
3
4
5
6
 
  {
      email : 'email@xxx.com', 
      password:'......',
      source:'STOREINO'
  }; 
  {
      email : 'email@xxx.com', 
      password:'......',
      source:'STOREINO'
  };

success result

999
1
2
3
4
5
6
 {
      status:200,
      data:{ 
        sellerId: '423' //ID seller in your database
       }
  }; {
      status:200,
      data:{ 
        sellerId: '423' //ID seller in your database
       }
  };

Error format accepted

999
1
2
3
4
5
6
 {
      status:400
      data:{
        error:'EX email or password is invalid'
      }
  }; {
      status:400
      data:{
        error:'EX email or password is invalid'
      }
  };

Register customer (this api is optional)

body format accepted

BASE-URL/companies/register?source=NAME-COMPANY

999
1
2
3
4
5
6
7
8
 
  {
      fullName:''
      email : 'email@xxx.com', 
      password:'......',
      numberPhone:'',
      source:'STOREINO'
  }; 
  {
      fullName:''
      email : 'email@xxx.com', 
      password:'......',
      numberPhone:'',
      source:'STOREINO'
  };

success result

999
1
2
3
4
5
6
 {
      status:200,
      data:{ 
        sellerId: '423' //ID seller in your database
       }
  }; {
      status:200,
      data:{ 
        sellerId: '423' //ID seller in your database
       }
  };

Error format accepted

999
1
2
3
4
5
6
 {
      status:400
      data:{
        error:'EX'
      }
  }; {
      status:400
      data:{
        error:'EX'
      }
  };

validate customer(this api is required only is you use register api)

body format accepted

BASE-URL/companies/validation?source=NAME-COMPANY

999
1
2
3
4
5
6
 
        <!-- headers above is necessary -->
  {
      sellerId : 423, //ID Seller in your database
      confirmed:true,
  }; 
        <!-- headers above is necessary -->
  {
      sellerId : 423, //ID Seller in your database
      confirmed:true,
  };

success result

999
1
2
3
4
 {
      status:200,
      data:{ connected: true }
  }; {
      status:200,
      data:{ connected: true }
  };