Skip to content
Permalink
Browse files

sdk created

  • Loading branch information...
deepaksharma208
deepaksharma208 committed May 10, 2018
1 parent d43d718 commit 2017f5c987d3cd3f3046670ab547ef288e16bec1
Showing 2,673 changed files with 329,016 additions and 5 deletions.

This file was deleted.

18 .php_cs
@@ -0,0 +1,18 @@
<?php
return Symfony\CS\Config::create()
->level(Symfony\CS\FixerInterface::PSR2_LEVEL)
->setUsingCache(true)
->fixers(
[
'ordered_use',
'phpdoc_order',
'short_array_syntax',
'strict',
'strict_param'
]
)
->finder(
Symfony\CS\Finder\DefaultFinder::create()
->in(__DIR__)
);
@@ -0,0 +1,10 @@
language: php
sudo: false
php:
- 5.4
- 5.5
- 5.6
- 7.0
- hhvm
before_install: "composer install"
script: "vendor/bin/phpunit"
236 README.md
@@ -0,0 +1,236 @@
# 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](https://app.shiprocket.in/register) to complete the simple sign up process. Please note that to utilise the ShipRocket API's, you need to [upgrade](https://app.shiprocket.in/billing-plan-details) 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](https://github.com/swagger-api/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](http://getcomposer.org/), 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`:

```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](#installation--usage) and then run the following:

```php
<?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**](docs/Api/AuthenticationApi.md#gettoken) | **POST** /v1/external/auth/login | Access Token
*ChannelsApi* | [**getAll2**](docs/Api/ChannelsApi.md#getall2) | **GET** /v1/external/channels | Get all channels
*CountriesApi* | [**getCountries**](docs/Api/CountriesApi.md#getcountries) | **GET** /v1/external/countries | Countries
*CountriesApi* | [**getZones**](docs/Api/CountriesApi.md#getzones) | **GET** /v1/external/countries/show/{id} | Get all zones
*CouriersApi* | [**awbCreation**](docs/Api/CouriersApi.md#awbcreation) | **POST** /v1/external/courier/assign/awb | AWB Creation
*CouriersApi* | [**checkServiceability**](docs/Api/CouriersApi.md#checkserviceability) | **GET** /v1/external/courier/serviceability/ | Check Serviceability
*CouriersApi* | [**pickupCreation**](docs/Api/CouriersApi.md#pickupcreation) | **POST** /v1/external/courier/generate/pickup | Get Pickup Details
*DiscrepancyApi* | [**discrepancy**](docs/Api/DiscrepancyApi.md#discrepancy) | **GET** /v1/external/billing/discrepancy | Get discrepancy Details
*FileImportsApi* | [**v1ExternalErrorsIdCheckGet**](docs/Api/FileImportsApi.md#v1externalerrorsidcheckget) | **GET** /v1/external/errors/{id}/check | Get file import results from Bulk order, products, listing imports.
*InventoryApi* | [**getInventories**](docs/Api/InventoryApi.md#getinventories) | **GET** /v1/external/inventory | Get Details of orders with inventories
*InventoryApi* | [**updateInventory**](docs/Api/InventoryApi.md#updateinventory) | **PUT** /v1/external/inventory/{id}/update | Update Inventory
*LabelApi* | [**generateLabel**](docs/Api/LabelApi.md#generatelabel) | **POST** /v1/external/courier/generate/label | Generate Label
*ListingsApi* | [**bulkImport1**](docs/Api/ListingsApi.md#bulkimport1) | **POST** /v1/external/listings/import | Import Catalog mappings
*ListingsApi* | [**exportMapped**](docs/Api/ListingsApi.md#exportmapped) | **GET** /v1/external/listings/export/mapped | Export Mapped
*ListingsApi* | [**exportSample**](docs/Api/ListingsApi.md#exportsample) | **GET** /v1/external/listings/sample | Export sample
*ListingsApi* | [**exportUnMapped**](docs/Api/ListingsApi.md#exportunmapped) | **GET** /v1/external/listings/export/unmapped | Export Unmapped
*ListingsApi* | [**getAll**](docs/Api/ListingsApi.md#getall) | **GET** /v1/external/listings | Get all Listings
*ListingsApi* | [**map**](docs/Api/ListingsApi.md#map) | **POST** /v1/external/listings/link | Map
*ManifestsApi* | [**generateManifest**](docs/Api/ManifestsApi.md#generatemanifest) | **POST** /v1/external/manifests/generate | Generate Manifests
*ManifestsApi* | [**getManifests**](docs/Api/ManifestsApi.md#getmanifests) | **POST** /v1/external/orders/print/manifest | Get manifest
*OrdersApi* | [**bulkImport2**](docs/Api/OrdersApi.md#bulkimport2) | **POST** /v1/external/orders/import | Bulk Import
*OrdersApi* | [**bulkSample1**](docs/Api/OrdersApi.md#bulksample1) | **GET** /v1/external/orders/sample | Get sample format for Orders Import
*OrdersApi* | [**cancelOrders**](docs/Api/OrdersApi.md#cancelorders) | **POST** /v1/external/orders/cancel | Cancel an order
*OrdersApi* | [**changeAddress**](docs/Api/OrdersApi.md#changeaddress) | **POST** /v1/external/orders/address/update |
*OrdersApi* | [**createCustomOrder**](docs/Api/OrdersApi.md#createcustomorder) | **POST** /v1/external/orders/create/adhoc | Create Custom order
*OrdersApi* | [**createLinkedOrder_**](docs/Api/OrdersApi.md#createlinkedorder_) | **POST** /v1/external/orders/create | Create Channel Order
*OrdersApi* | [**exportOrders**](docs/Api/OrdersApi.md#exportorders) | **POST** /v1/external/orders/export |
*OrdersApi* | [**fetchOrders**](docs/Api/OrdersApi.md#fetchorders) | **GET** /v1/external/orders/fetch | Fetch
*OrdersApi* | [**fulfillment**](docs/Api/OrdersApi.md#fulfillment) | **PATCH** /v1/external/orders/fulfill | Add inventory for order product
*OrdersApi* | [**generateInvoice**](docs/Api/OrdersApi.md#generateinvoice) | **POST** /v1/external/orders/print/invoice | Generate Invoice
*OrdersApi* | [**getAllOrders**](docs/Api/OrdersApi.md#getallorders) | **GET** /v1/external/orders | Get all orders
*OrdersApi* | [**getOrder**](docs/Api/OrdersApi.md#getorder) | **GET** /v1/external/orders/show/{id} | Get order Details
*OrdersApi* | [**mapping**](docs/Api/OrdersApi.md#mapping) | **PATCH** /v1/external/orders/mapping | Map orders products
*OrdersApi* | [**syncStatus**](docs/Api/OrdersApi.md#syncstatus) | **GET** /v1/external/orders/status | Sync status
*OrdersApi* | [**track**](docs/Api/OrdersApi.md#track) | **GET** /v1/external/orders/track | Get tracking Details
*ProductsApi* | [**add**](docs/Api/ProductsApi.md#add) | **POST** /v1/external/products | Add new Products
*ProductsApi* | [**bulkExport**](docs/Api/ProductsApi.md#bulkexport) | **GET** /v1/external/products/export | Bulk Sample
*ProductsApi* | [**bulkImport**](docs/Api/ProductsApi.md#bulkimport) | **POST** /v1/external/products/import | Bulk import
*ProductsApi* | [**bulkSample**](docs/Api/ProductsApi.md#bulksample) | **GET** /v1/external/products/sample | Get a sample format to Import Products
*ProductsApi* | [**getProducts**](docs/Api/ProductsApi.md#getproducts) | **GET** /v1/external/products | Get Products
*ProductsApi* | [**show**](docs/Api/ProductsApi.md#show) | **GET** /v1/external/products/show/{id} | Show
*ShipmentsApi* | [**details**](docs/Api/ShipmentsApi.md#details) | **GET** /v1/external/shipments/{id} | Get shipment Details of specific orders
*ShipmentsApi* | [**getAllShipments**](docs/Api/ShipmentsApi.md#getallshipments) | **GET** /v1/external/shipments | Get shipment Details
*StatementApi* | [**satement**](docs/Api/StatementApi.md#satement) | **GET** /v1/external/account/details/statement | Get statement Details
*TrackingApi* | [**aWBTracking**](docs/Api/TrackingApi.md#awbtracking) | **GET** /v1/external/courier/track/awb/{awb_code} | Get AWB tracking Details
*TrackingApi* | [**shipmentTracking**](docs/Api/TrackingApi.md#shipmenttracking) | **GET** /v1/external/courier/track/shipment/{shipment_id} | Get shipment Tracking Details


## Documentation For Models

- [AddProduct422](docs/Model/AddProduct422.md)
- [AddProduct422Errors](docs/Model/AddProduct422Errors.md)
- [AddRequest](docs/Model/AddRequest.md)
- [AwbCreationRequest](docs/Model/AwbCreationRequest.md)
- [AwbCreationResponse](docs/Model/AwbCreationResponse.md)
- [AwbCreationResponseResponse](docs/Model/AwbCreationResponseResponse.md)
- [AwbCreationResponseResponseData](docs/Model/AwbCreationResponseResponseData.md)
- [AwbCreationResponseResponseDataAssignedDateTime](docs/Model/AwbCreationResponseResponseDataAssignedDateTime.md)
- [AwbError500](docs/Model/AwbError500.md)
- [AwbTrackingRequest](docs/Model/AwbTrackingRequest.md)
- [AwbTrackingResponse](docs/Model/AwbTrackingResponse.md)
- [BulkExportResponse](docs/Model/BulkExportResponse.md)
- [CancelOrdersRequest](docs/Model/CancelOrdersRequest.md)
- [CancelOrdersResponse](docs/Model/CancelOrdersResponse.md)
- [ChangeAddressRequest](docs/Model/ChangeAddressRequest.md)
- [ChannelsRequest](docs/Model/ChannelsRequest.md)
- [ChannelsRequestBaseChannel](docs/Model/ChannelsRequestBaseChannel.md)
- [ChannelsRequestBaseChannelSettingsSample](docs/Model/ChannelsRequestBaseChannelSettingsSample.md)
- [ChannelsRequestData](docs/Model/ChannelsRequestData.md)
- [ChannelsRequestSettings](docs/Model/ChannelsRequestSettings.md)
- [CheckServiceabilityError](docs/Model/CheckServiceabilityError.md)
- [CheckServiceabilityResponse](docs/Model/CheckServiceabilityResponse.md)
- [CreateLinkedOrderRequest](docs/Model/CreateLinkedOrderRequest.md)
- [CreateLinkedOrderRequestOrderItems](docs/Model/CreateLinkedOrderRequestOrderItems.md)
- [CreateLinkedOrderResponse](docs/Model/CreateLinkedOrderResponse.md)
- [CreateQuickOrderRequest](docs/Model/CreateQuickOrderRequest.md)
- [CreateQuickOrderRequestOrderItems](docs/Model/CreateQuickOrderRequestOrderItems.md)
- [CreateQuickOrderResponse](docs/Model/CreateQuickOrderResponse.md)
- [DetailsResponse](docs/Model/DetailsResponse.md)
- [DiscrepancyResponse](docs/Model/DiscrepancyResponse.md)
- [Export401](docs/Model/Export401.md)
- [FileImportResponse](docs/Model/FileImportResponse.md)
- [FulfillmentRequest](docs/Model/FulfillmentRequest.md)
- [FulfillmentRequestData](docs/Model/FulfillmentRequestData.md)
- [FulfillmentResponse](docs/Model/FulfillmentResponse.md)
- [GenerateInvoiceRequest](docs/Model/GenerateInvoiceRequest.md)
- [GenerateInvoiceResponse](docs/Model/GenerateInvoiceResponse.md)
- [GenerateLabelRequest](docs/Model/GenerateLabelRequest.md)
- [GenerateLabelResponse](docs/Model/GenerateLabelResponse.md)
- [GenerateManifestRequest](docs/Model/GenerateManifestRequest.md)
- [GenerateManifestResponse](docs/Model/GenerateManifestResponse.md)
- [GetAllResponse](docs/Model/GetAllResponse.md)
- [GetAllResponseData](docs/Model/GetAllResponseData.md)
- [GetCountriesResponse](docs/Model/GetCountriesResponse.md)
- [GetInventoriesResponse](docs/Model/GetInventoriesResponse.md)
- [GetInventoriesResponseData](docs/Model/GetInventoriesResponseData.md)
- [GetInventoriesResponseMeta](docs/Model/GetInventoriesResponseMeta.md)
- [GetInventoriesResponseMetaPagination](docs/Model/GetInventoriesResponseMetaPagination.md)
- [GetManifestsRequest](docs/Model/GetManifestsRequest.md)
- [GetManifestsResponse](docs/Model/GetManifestsResponse.md)
- [GetOrderResponse](docs/Model/GetOrderResponse.md)
- [GetOrderResponseData](docs/Model/GetOrderResponseData.md)
- [GetOrderResponseDataProducts](docs/Model/GetOrderResponseDataProducts.md)
- [GetOrderResponseDataShipments](docs/Model/GetOrderResponseDataShipments.md)
- [GetOrderResponseMeta](docs/Model/GetOrderResponseMeta.md)
- [GetOrderResponseMetaPagination](docs/Model/GetOrderResponseMetaPagination.md)
- [GetOrderResponseMetaPaginationLinks](docs/Model/GetOrderResponseMetaPaginationLinks.md)
- [GetProductsResponse](docs/Model/GetProductsResponse.md)
- [GetProductsResponseData](docs/Model/GetProductsResponseData.md)
- [GetProductsResponseMeta](docs/Model/GetProductsResponseMeta.md)
- [GetProductsResponseMetaPagination](docs/Model/GetProductsResponseMetaPagination.md)
- [GetTokenRequest](docs/Model/GetTokenRequest.md)
- [GetTokenResponse](docs/Model/GetTokenResponse.md)
- [GetZonesResponse](docs/Model/GetZonesResponse.md)
- [Import403](docs/Model/Import403.md)
- [Listing400](docs/Model/Listing400.md)
- [Login422Error](docs/Model/Login422Error.md)
- [Login422ErrorErrors](docs/Model/Login422ErrorErrors.md)
- [MapRequest](docs/Model/MapRequest.md)
- [MappingRequest](docs/Model/MappingRequest.md)
- [MappingRequestData](docs/Model/MappingRequestData.md)
- [MappingResponse](docs/Model/MappingResponse.md)
- [MappingResponseInner](docs/Model/MappingResponseInner.md)
- [Model400Error](docs/Model/Model400Error.md)
- [Model401Error](docs/Model/Model401Error.md)
- [Model404Error](docs/Model/Model404Error.md)
- [Model405Error](docs/Model/Model405Error.md)
- [PickupCreationRequest](docs/Model/PickupCreationRequest.md)
- [PickupCreationResponse](docs/Model/PickupCreationResponse.md)
- [PickupCreationResponseResponse](docs/Model/PickupCreationResponseResponse.md)
- [ProductImportResponse](docs/Model/ProductImportResponse.md)
- [SatementResponse](docs/Model/SatementResponse.md)
- [ShipmentTrackingRequest](docs/Model/ShipmentTrackingRequest.md)
- [ShipmentTrackingResponse](docs/Model/ShipmentTrackingResponse.md)
- [Show400](docs/Model/Show400.md)
- [ShowResponse](docs/Model/ShowResponse.md)
- [UpdateInventoryResponse](docs/Model/UpdateInventoryResponse.md)
- [UpdateInventoryResponseData](docs/Model/UpdateInventoryResponseData.md)


## Documentation For Authorization


## Bearer

- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header


## Author




@@ -0,0 +1,36 @@
{
"name": "/",
"description": "",
"keywords": [
"swagger",
"php",
"sdk",
"api"
],
"homepage": "http://swagger.io",
"license": "proprietary",
"authors": [
{
"name": "Swagger and contributors",
"homepage": "https://github.com/swagger-api/swagger-codegen"
}
],
"require": {
"php": ">=5.5",
"ext-curl": "*",
"ext-json": "*",
"ext-mbstring": "*",
"guzzlehttp/guzzle": "^6.2"
},
"require-dev": {
"phpunit/phpunit": "^4.8",
"squizlabs/php_codesniffer": "~2.6",
"friendsofphp/php-cs-fixer": "~1.12"
},
"autoload": {
"psr-4": { "Swagger\\Client\\" : "lib/" }
},
"autoload-dev": {
"psr-4": { "Swagger\\Client\\" : "test/" }
}
}

0 comments on commit 2017f5c

Please sign in to comment.
You can’t perform that action at this time.