Git Product home page Git Product logo

shiprocket-api's Introduction

What is this ?

This repo will help to integrated shiprocket with React / React native / Node js

Installation

yarn add shiprocket-api or npm i shiprocket-api --save

Then...

import { GetToken, CourierServiceability , Tracking_OrderId } from 'shiprocket-api'


///  Get Token
const token = await GetToken({
      email : '[email protected]',
      password: 'password',
    })

///  Check Courier Serviceability
    const response = await CourierServiceability({

    auth: {
            email : '[email protected]',
            password: 'password',
        },
    params: {
        pickup_postcode : 600000,
        delivery_postcode : 600005,
        weight: 2,
        cod : 1
    }
})
    
//// Get Tracking Data through Order ID
    const response = await Tracking_OrderId({
        auth: {
            email : '[email protected]',
            password: 'password',
        },
        params: {
            order_id : '55097',
        }
    })

Options

shiprocket supports 2 options , both of which are required

auth option:

  • email (required if you don't provide direct token)
  • password (required if you don't provide direct token)
  • token (Bearer token for authentication)

params option:

  • *necessary parameters * (you can find the parameters list in their offical documentation)

Docs

Offcial APi docs : [Shiprocket API] (https://apidocs.shiprocket.in/)

Support

if you have any questions or suggestions or feature request then email me.

support email : [email protected]

shiprocket-api's People

Contributors

solaimanx avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.