Skip to content
SDK for Multichannel API
Branch: master
Clone or download
deepaksharma208
deepaksharma208 sdk created
Latest commit 2017f5c May 10, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs sdk created May 10, 2018
lib
test sdk created May 10, 2018
vendor sdk created May 10, 2018
.php_cs sdk created May 10, 2018
.travis.yml sdk created May 10, 2018
README.md sdk created May 10, 2018
composer.json sdk created May 10, 2018
composer.lock sdk created May 10, 2018
git_push.sh sdk created May 10, 2018
phpunit.xml.dist sdk created May 10, 2018
test.php sdk created May 10, 2018

README.md

SwaggerClient-php

Welcome to ShipRocket’s API Documentation. Get a clear understanding of all the sections and codes that are used in ShipRocket’s API. ShipRocket API uses the JSON syntax. First you need to register with ShipRocket and create an account. Simply click on this link to complete the simple sign up process. Please note that to utilise the ShipRocket API's, you need to upgrade your plan to Advance or Pro. To get access to use the API's, you need to call to +91-9266623006 our customer care or send a mail to srs@kartrocket.com, stating that you would like to use ShipRocket Open API's. After that you will have to provide an alternate email id which will be used for the ShipRocket API.

This PHP package is automatically generated by the Swagger Codegen project:

  • API version: 1.0
  • Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com//.git"
    }
  ],
  "require": {
    "/": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\AuthenticationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Swagger\Client\Model\GetTokenRequest(); // \Swagger\Client\Model\GetTokenRequest | 

try {
    $result = $apiInstance->getToken($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->getToken: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://apiv2.shiprocket.in

Class Method HTTP request Description
AuthenticationApi getToken POST /v1/external/auth/login Access Token
ChannelsApi getAll2 GET /v1/external/channels Get all channels
CountriesApi getCountries GET /v1/external/countries Countries
CountriesApi getZones GET /v1/external/countries/show/{id} Get all zones
CouriersApi awbCreation POST /v1/external/courier/assign/awb AWB Creation
CouriersApi checkServiceability GET /v1/external/courier/serviceability/ Check Serviceability
CouriersApi pickupCreation POST /v1/external/courier/generate/pickup Get Pickup Details
DiscrepancyApi discrepancy GET /v1/external/billing/discrepancy Get discrepancy Details
FileImportsApi v1ExternalErrorsIdCheckGet GET /v1/external/errors/{id}/check Get file import results from Bulk order, products, listing imports.
InventoryApi getInventories GET /v1/external/inventory Get Details of orders with inventories
InventoryApi updateInventory PUT /v1/external/inventory/{id}/update Update Inventory
LabelApi generateLabel POST /v1/external/courier/generate/label Generate Label
ListingsApi bulkImport1 POST /v1/external/listings/import Import Catalog mappings
ListingsApi exportMapped GET /v1/external/listings/export/mapped Export Mapped
ListingsApi exportSample GET /v1/external/listings/sample Export sample
ListingsApi exportUnMapped GET /v1/external/listings/export/unmapped Export Unmapped
ListingsApi getAll GET /v1/external/listings Get all Listings
ListingsApi map POST /v1/external/listings/link Map
ManifestsApi generateManifest POST /v1/external/manifests/generate Generate Manifests
ManifestsApi getManifests POST /v1/external/orders/print/manifest Get manifest
OrdersApi bulkImport2 POST /v1/external/orders/import Bulk Import
OrdersApi bulkSample1 GET /v1/external/orders/sample Get sample format for Orders Import
OrdersApi cancelOrders POST /v1/external/orders/cancel Cancel an order
OrdersApi changeAddress POST /v1/external/orders/address/update
OrdersApi createCustomOrder POST /v1/external/orders/create/adhoc Create Custom order
OrdersApi createLinkedOrder_ POST /v1/external/orders/create Create Channel Order
OrdersApi exportOrders POST /v1/external/orders/export
OrdersApi fetchOrders GET /v1/external/orders/fetch Fetch
OrdersApi fulfillment PATCH /v1/external/orders/fulfill Add inventory for order product
OrdersApi generateInvoice POST /v1/external/orders/print/invoice Generate Invoice
OrdersApi getAllOrders GET /v1/external/orders Get all orders
OrdersApi getOrder GET /v1/external/orders/show/{id} Get order Details
OrdersApi mapping PATCH /v1/external/orders/mapping Map orders products
OrdersApi syncStatus GET /v1/external/orders/status Sync status
OrdersApi track GET /v1/external/orders/track Get tracking Details
ProductsApi add POST /v1/external/products Add new Products
ProductsApi bulkExport GET /v1/external/products/export Bulk Sample
ProductsApi bulkImport POST /v1/external/products/import Bulk import
ProductsApi bulkSample GET /v1/external/products/sample Get a sample format to Import Products
ProductsApi getProducts GET /v1/external/products Get Products
ProductsApi show GET /v1/external/products/show/{id} Show
ShipmentsApi details GET /v1/external/shipments/{id} Get shipment Details of specific orders
ShipmentsApi getAllShipments GET /v1/external/shipments Get shipment Details
StatementApi satement GET /v1/external/account/details/statement Get statement Details
TrackingApi aWBTracking GET /v1/external/courier/track/awb/{awb_code} Get AWB tracking Details
TrackingApi shipmentTracking GET /v1/external/courier/track/shipment/{shipment_id} Get shipment Tracking Details

Documentation For Models

Documentation For Authorization

Bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author

You can’t perform that action at this time.