nomad-pilot-cli

This is the API descriptor for the Nomad Pilot API, responsible for shipping and logistics processing. Developed by Samarkand Global in partnership with SF Express, eSinotrans, sto. Read the documentation online at Nomad API Suite.

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 project:

API version: 1.48.0
Package version: 1.48.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:

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:

import nomad_pilot_cli

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import nomad_pilot_cli

Getting Started

Please follow the installation procedure and then run the following:

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	POST /ship/{carrier}/batch/{batch_id}/add-to-batch	batch
BatchApi	create_batch	POST /ship/{carrier}/create-batch	batch
BatchApi	remove_parcel	POST /ship/{carrier}/batch/{batch_id}/remove-from-batch	batch
BatchApi	scan_batch	POST /ship/{carrier}/batch/{batch_id}/create-scan-form	batch
CallbackApi	callback	POST /callback/{store}	callback
CarriersApi	query_carrier	GET /carriers/	queryCarrier
FreightForwardApi	freight_forward	POST /freight-forward/{carrier}	freightForward
FreightForwardApi	put_freight_forward_product	PUT /freight-forward/product/{carrier}	freightForward
FreightForwardApi	query_freight_forward	GET /freight-forward/{carrier}	queryFreightForward
QuickShipApi	quick_ship	POST /quick-ship/{carrier}	quickShip
ShipApi	cancel_ship	DELETE /ship/{carrier}/order/{seller_order_ref}	cancelShip
ShipApi	put_ship	PUT /ship/{carrier}	ship
ShipApi	query_ship	GET /ship/{carrier}/order/{seller_order_ref}	queryShip
ShipApi	ship	POST /ship/{carrier}	ship
ShipConfirmApi	ship_confirm	POST /ship/{carrier}/confirm	shipConfirm

Documentation For Models

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

Metadata

Release files for nomad-pilot-cli 1.48.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nomad-pilot-cli 1.48.0
File	Size	Uploaded
nomad-pilot-cli-1.48.0.tar.gz	87.3 kB	Mar 9, 2022	Details

Release files / nomad-pilot-cli-1.48.0.tar.gz

Download URL	nomad-pilot-cli-1.48.0.tar.gz
Size	87.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`4649ad9a8cf7e25f72b693a91a711955e822879e51e88590348904c334c9d7db`
BLAKE2b-256 checksum How to use checksums	`35630d08abfe3bce80628112e484409865da3174800a146367f1981760d668e7`
Upload date	Mar 9, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.8.0 tqdm/4.62.3 CPython/3.6.13`