Skip to main content

Nomad Pilot

Project description

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.42.0
  • Package version: 1.42.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
CarriersApi query_carrier GET /carriers/ queryCarrier
FreightForwardApi freight_forward POST /freight-forward/{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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for nomad-pilot-cli, version 1.42.0
Filename, size File type Python version Upload date Hashes
Filename, size nomad-pilot-cli-1.42.0.tar.gz (79.2 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page