# nomad-pilot-cli
This is the API descriptor for the Nomad Pilot API, responsible for shipping and logistics processing. Developed by [Samarkand Global](https://www.samarkand.global/) in partnership with [SF Express](https://www.sf-express.com/), [eSinotrans](http://air.esinotrans.com/), [sto](http://sto-express.co.uk/). Read the documentation online at [Nomad API Suite](https://api.samarkand.io/).
- Install for node with `npm install nomad_pilot_cli`
- Install for python with `pip install nomad-pilot-cli`
- Install for Maven users `groupId, com.gitlab.samarkand-nomad; artifactId, nomad-pilot-cli`
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.53.0
- Package version: 1.53.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 2.7 and 3.4+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import nomad_pilot_cli
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import nomad_pilot_cli
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import nomad_pilot_cli
from nomad_pilot_cli.rest import ApiException
from pprint import pprint
configuration = nomad_pilot_cli.Configuration()
# Configure API key authorization: ca_key
configuration.api_key['x-ca-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-ca-key'] = 'Bearer'
# Defining host is optional and default to https://nomad.samarkand-global.cn/pilot
configuration.host = "https://nomad.samarkand-global.cn/pilot"
# Enter a context with an instance of the API client
with nomad_pilot_cli.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = nomad_pilot_cli.BatchApi(api_client)
carrier = 'carrier_example' # str | The carrier name
batch_id = 'batch_id_example' # str | The batch name returned from the create batch method
inline_object = nomad_pilot_cli.InlineObject() # InlineObject |
try:
# batch
api_response = api_instance.add_parcel(carrier, batch_id, inline_object)
pprint(api_response)
except ApiException as e:
print("Exception when calling BatchApi->add_parcel: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://nomad.samarkand-global.cn/pilot*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*BatchApi* | [**add_parcel**](docs/BatchApi.md#add_parcel) | **POST** /ship/{carrier}/batch/{batch_id}/add-to-batch | batch
*BatchApi* | [**create_batch**](docs/BatchApi.md#create_batch) | **POST** /ship/{carrier}/create-batch | batch
*BatchApi* | [**remove_parcel**](docs/BatchApi.md#remove_parcel) | **POST** /ship/{carrier}/batch/{batch_id}/remove-from-batch | batch
*BatchApi* | [**scan_batch**](docs/BatchApi.md#scan_batch) | **POST** /ship/{carrier}/batch/{batch_id}/create-scan-form | batch
*CallbackApi* | [**callback**](docs/CallbackApi.md#callback) | **POST** /callback/{store} | callback
*CarriersApi* | [**query_carrier**](docs/CarriersApi.md#query_carrier) | **GET** /carriers/ | queryCarrier
*FreightForwardApi* | [**freight_forward**](docs/FreightForwardApi.md#freight_forward) | **POST** /freight-forward/{carrier} | freightForward
*FreightForwardApi* | [**put_freight_forward_product**](docs/FreightForwardApi.md#put_freight_forward_product) | **PUT** /freight-forward/product/{carrier} | freightForward
*FreightForwardApi* | [**query_freight_forward**](docs/FreightForwardApi.md#query_freight_forward) | **GET** /freight-forward/{carrier} | queryFreightForward
*InventoryApi* | [**get_inventory_product**](docs/InventoryApi.md#get_inventory_product) | **GET** /inventory/product/{carrier} | inventory
*InventoryApi* | [**post_inventory_product**](docs/InventoryApi.md#post_inventory_product) | **POST** /inventory/product/{carrier} | inventory
*InventoryApi* | [**put_inventory_product**](docs/InventoryApi.md#put_inventory_product) | **PUT** /inventory/product/{carrier} | inventory
*InventoryPurchaseApi* | [**delete_inventory_purchase**](docs/InventoryPurchaseApi.md#delete_inventory_purchase) | **DELETE** /inventory/purchase/{carrier} | inventory_purchase
*InventoryPurchaseApi* | [**get_inventory_purchase**](docs/InventoryPurchaseApi.md#get_inventory_purchase) | **GET** /inventory/purchase/{carrier} | inventory_purchase
*InventoryPurchaseApi* | [**post_inventory_purchase**](docs/InventoryPurchaseApi.md#post_inventory_purchase) | **POST** /inventory/purchase/{carrier} | inventory_purchase
*QuickShipApi* | [**quick_ship**](docs/QuickShipApi.md#quick_ship) | **POST** /quick-ship/{carrier} | quickShip
*ShipApi* | [**cancel_ship**](docs/ShipApi.md#cancel_ship) | **DELETE** /ship/{carrier}/order/{seller_order_ref} | cancelShip
*ShipApi* | [**put_ship**](docs/ShipApi.md#put_ship) | **PUT** /ship/{carrier} | ship
*ShipApi* | [**query_ship**](docs/ShipApi.md#query_ship) | **GET** /ship/{carrier}/order/{seller_order_ref} | queryShip
*ShipApi* | [**ship**](docs/ShipApi.md#ship) | **POST** /ship/{carrier} | ship
*ShipConfirmApi* | [**ship_confirm**](docs/ShipConfirmApi.md#ship_confirm) | **POST** /ship/{carrier}/confirm | shipConfirm
## Documentation For Models
- [Address](docs/Address.md)
- [AddressRequired](docs/AddressRequired.md)
- [AddressShip](docs/AddressShip.md)
- [ApiResponse](docs/ApiResponse.md)
- [ApiResponseCallback](docs/ApiResponseCallback.md)
- [ApiResponseConnectorResponse](docs/ApiResponseConnectorResponse.md)
- [ApiResponseData](docs/ApiResponseData.md)
- [ApiResponseGeneral](docs/ApiResponseGeneral.md)
- [ApiResponseInventory](docs/ApiResponseInventory.md)
- [CallbackBody](docs/CallbackBody.md)
- [DeliveryStatus](docs/DeliveryStatus.md)
- [Dimension](docs/Dimension.md)
- [Goldjet](docs/Goldjet.md)
- [HaikuDeliveryOrder](docs/HaikuDeliveryOrder.md)
- [InlineObject](docs/InlineObject.md)
- [InlineObject1](docs/InlineObject1.md)
- [InventoryBase](docs/InventoryBase.md)
- [InventoryProduct](docs/InventoryProduct.md)
- [InventoryPurchase](docs/InventoryPurchase.md)
- [InventoryPurchaseItem](docs/InventoryPurchaseItem.md)
- [InventoryResponseProduct](docs/InventoryResponseProduct.md)
- [InventoryResponsePurchase](docs/InventoryResponsePurchase.md)
- [Pack](docs/Pack.md)
- [PackBased](docs/PackBased.md)
- [Package](docs/Package.md)
- [PackageFreight](docs/PackageFreight.md)
- [PackageItem](docs/PackageItem.md)
- [PackageItemQuick](docs/PackageItemQuick.md)
- [PackageItems](docs/PackageItems.md)
- [PackageItemsQuick](docs/PackageItemsQuick.md)
- [PackagePut](docs/PackagePut.md)
- [PackagePutRequired](docs/PackagePutRequired.md)
- [PackageQuick](docs/PackageQuick.md)
- [PackageRequired](docs/PackageRequired.md)
- [PackageUpdate](docs/PackageUpdate.md)
- [PackageUpdateRequired](docs/PackageUpdateRequired.md)
- [ProductFreight](docs/ProductFreight.md)
## Documentation For Authorization
## ca_key
- **Type**: API key
- **API key parameter name**: x-ca-key
- **Location**: HTTP header
## ca_stage
- **Type**: API key
- **API key parameter name**: x-ca-stage
- **Location**: HTTP header
## Author
paul@samarkand.global
Raw data
{
"_id": null,
"home_page": "",
"name": "nomad-pilot-cli",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "OpenAPI,OpenAPI-Generator,Nomad Pilot",
"author": "OpenAPI Generator community",
"author_email": "paul@samarkand.global",
"download_url": "https://files.pythonhosted.org/packages/ae/d2/7e69a29500bb3fbfb3c87e9133936c78229844a259a789cdb7e8a9ae9403/nomad-pilot-cli-1.53.0.tar.gz",
"platform": null,
"description": "# nomad-pilot-cli\nThis is the API descriptor for the Nomad Pilot API, responsible for shipping and logistics processing. Developed by [Samarkand Global](https://www.samarkand.global/) in partnership with [SF Express](https://www.sf-express.com/), [eSinotrans](http://air.esinotrans.com/), [sto](http://sto-express.co.uk/). Read the documentation online at [Nomad API Suite](https://api.samarkand.io/).\n- Install for node with `npm install nomad_pilot_cli`\n- Install for python with `pip install nomad-pilot-cli`\n- Install for Maven users `groupId, com.gitlab.samarkand-nomad; artifactId, nomad-pilot-cli`\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.53.0\n- Package version: 1.53.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 2.7 and 3.4+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport nomad_pilot_cli\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport nomad_pilot_cli\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom __future__ import print_function\nimport time\nimport nomad_pilot_cli\nfrom nomad_pilot_cli.rest import ApiException\nfrom pprint import pprint\n\nconfiguration = nomad_pilot_cli.Configuration()\n# Configure API key authorization: ca_key\nconfiguration.api_key['x-ca-key'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['x-ca-key'] = 'Bearer'\n\n# Defining host is optional and default to https://nomad.samarkand-global.cn/pilot\nconfiguration.host = \"https://nomad.samarkand-global.cn/pilot\"\n# Enter a context with an instance of the API client\nwith nomad_pilot_cli.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = nomad_pilot_cli.BatchApi(api_client)\n carrier = 'carrier_example' # str | The carrier name\nbatch_id = 'batch_id_example' # str | The batch name returned from the create batch method\ninline_object = nomad_pilot_cli.InlineObject() # InlineObject | \n\n try:\n # batch\n api_response = api_instance.add_parcel(carrier, batch_id, inline_object)\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling BatchApi->add_parcel: %s\\n\" % e)\n \n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://nomad.samarkand-global.cn/pilot*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*BatchApi* | [**add_parcel**](docs/BatchApi.md#add_parcel) | **POST** /ship/{carrier}/batch/{batch_id}/add-to-batch | batch\n*BatchApi* | [**create_batch**](docs/BatchApi.md#create_batch) | **POST** /ship/{carrier}/create-batch | batch\n*BatchApi* | [**remove_parcel**](docs/BatchApi.md#remove_parcel) | **POST** /ship/{carrier}/batch/{batch_id}/remove-from-batch | batch\n*BatchApi* | [**scan_batch**](docs/BatchApi.md#scan_batch) | **POST** /ship/{carrier}/batch/{batch_id}/create-scan-form | batch\n*CallbackApi* | [**callback**](docs/CallbackApi.md#callback) | **POST** /callback/{store} | callback\n*CarriersApi* | [**query_carrier**](docs/CarriersApi.md#query_carrier) | **GET** /carriers/ | queryCarrier\n*FreightForwardApi* | [**freight_forward**](docs/FreightForwardApi.md#freight_forward) | **POST** /freight-forward/{carrier} | freightForward\n*FreightForwardApi* | [**put_freight_forward_product**](docs/FreightForwardApi.md#put_freight_forward_product) | **PUT** /freight-forward/product/{carrier} | freightForward\n*FreightForwardApi* | [**query_freight_forward**](docs/FreightForwardApi.md#query_freight_forward) | **GET** /freight-forward/{carrier} | queryFreightForward\n*InventoryApi* | [**get_inventory_product**](docs/InventoryApi.md#get_inventory_product) | **GET** /inventory/product/{carrier} | inventory\n*InventoryApi* | [**post_inventory_product**](docs/InventoryApi.md#post_inventory_product) | **POST** /inventory/product/{carrier} | inventory\n*InventoryApi* | [**put_inventory_product**](docs/InventoryApi.md#put_inventory_product) | **PUT** /inventory/product/{carrier} | inventory\n*InventoryPurchaseApi* | [**delete_inventory_purchase**](docs/InventoryPurchaseApi.md#delete_inventory_purchase) | **DELETE** /inventory/purchase/{carrier} | inventory_purchase\n*InventoryPurchaseApi* | [**get_inventory_purchase**](docs/InventoryPurchaseApi.md#get_inventory_purchase) | **GET** /inventory/purchase/{carrier} | inventory_purchase\n*InventoryPurchaseApi* | [**post_inventory_purchase**](docs/InventoryPurchaseApi.md#post_inventory_purchase) | **POST** /inventory/purchase/{carrier} | inventory_purchase\n*QuickShipApi* | [**quick_ship**](docs/QuickShipApi.md#quick_ship) | **POST** /quick-ship/{carrier} | quickShip\n*ShipApi* | [**cancel_ship**](docs/ShipApi.md#cancel_ship) | **DELETE** /ship/{carrier}/order/{seller_order_ref} | cancelShip\n*ShipApi* | [**put_ship**](docs/ShipApi.md#put_ship) | **PUT** /ship/{carrier} | ship\n*ShipApi* | [**query_ship**](docs/ShipApi.md#query_ship) | **GET** /ship/{carrier}/order/{seller_order_ref} | queryShip\n*ShipApi* | [**ship**](docs/ShipApi.md#ship) | **POST** /ship/{carrier} | ship\n*ShipConfirmApi* | [**ship_confirm**](docs/ShipConfirmApi.md#ship_confirm) | **POST** /ship/{carrier}/confirm | shipConfirm\n\n\n## Documentation For Models\n\n - [Address](docs/Address.md)\n - [AddressRequired](docs/AddressRequired.md)\n - [AddressShip](docs/AddressShip.md)\n - [ApiResponse](docs/ApiResponse.md)\n - [ApiResponseCallback](docs/ApiResponseCallback.md)\n - [ApiResponseConnectorResponse](docs/ApiResponseConnectorResponse.md)\n - [ApiResponseData](docs/ApiResponseData.md)\n - [ApiResponseGeneral](docs/ApiResponseGeneral.md)\n - [ApiResponseInventory](docs/ApiResponseInventory.md)\n - [CallbackBody](docs/CallbackBody.md)\n - [DeliveryStatus](docs/DeliveryStatus.md)\n - [Dimension](docs/Dimension.md)\n - [Goldjet](docs/Goldjet.md)\n - [HaikuDeliveryOrder](docs/HaikuDeliveryOrder.md)\n - [InlineObject](docs/InlineObject.md)\n - [InlineObject1](docs/InlineObject1.md)\n - [InventoryBase](docs/InventoryBase.md)\n - [InventoryProduct](docs/InventoryProduct.md)\n - [InventoryPurchase](docs/InventoryPurchase.md)\n - [InventoryPurchaseItem](docs/InventoryPurchaseItem.md)\n - [InventoryResponseProduct](docs/InventoryResponseProduct.md)\n - [InventoryResponsePurchase](docs/InventoryResponsePurchase.md)\n - [Pack](docs/Pack.md)\n - [PackBased](docs/PackBased.md)\n - [Package](docs/Package.md)\n - [PackageFreight](docs/PackageFreight.md)\n - [PackageItem](docs/PackageItem.md)\n - [PackageItemQuick](docs/PackageItemQuick.md)\n - [PackageItems](docs/PackageItems.md)\n - [PackageItemsQuick](docs/PackageItemsQuick.md)\n - [PackagePut](docs/PackagePut.md)\n - [PackagePutRequired](docs/PackagePutRequired.md)\n - [PackageQuick](docs/PackageQuick.md)\n - [PackageRequired](docs/PackageRequired.md)\n - [PackageUpdate](docs/PackageUpdate.md)\n - [PackageUpdateRequired](docs/PackageUpdateRequired.md)\n - [ProductFreight](docs/ProductFreight.md)\n\n\n## Documentation For Authorization\n\n\n## ca_key\n\n- **Type**: API key\n- **API key parameter name**: x-ca-key\n- **Location**: HTTP header\n\n\n## ca_stage\n\n- **Type**: API key\n- **API key parameter name**: x-ca-stage\n- **Location**: HTTP header\n\n\n## Author\n\npaul@samarkand.global",
"bugtrack_url": null,
"license": "",
"summary": "Nomad Pilot",
"version": "1.53.0",
"project_urls": null,
"split_keywords": [
"openapi",
"openapi-generator",
"nomad pilot"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aed27e69a29500bb3fbfb3c87e9133936c78229844a259a789cdb7e8a9ae9403",
"md5": "8b258b6742f59b391664b8e21193670a",
"sha256": "363c26f5c331bd8a9df23658be9663e45f4abb40cc40f90602700cdc37a13bb0"
},
"downloads": -1,
"filename": "nomad-pilot-cli-1.53.0.tar.gz",
"has_sig": false,
"md5_digest": "8b258b6742f59b391664b8e21193670a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 104723,
"upload_time": "2023-07-11T02:29:34",
"upload_time_iso_8601": "2023-07-11T02:29:34.080235Z",
"url": "https://files.pythonhosted.org/packages/ae/d2/7e69a29500bb3fbfb3c87e9133936c78229844a259a789cdb7e8a9ae9403/nomad-pilot-cli-1.53.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-11 02:29:34",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "nomad-pilot-cli"
}
JSON