Skip to main content

Nomad Envoy

Project description


This is the API descriptor for the Nomad Envoy API, responsible for order operation and product lists. Developed by Samarkand Global in partnership with Youzan, LittleRED, PDD, etc. Read the documentation online at Nomad API Suite.

  • Install for node with npm install nomad_envoy_cli
  • Install for python with pip install nomad-envoy-cli

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.51.0
  • Package version: 1.51.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen


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+

(you may need to run pip with root permission: sudo pip install git+

Then import the package:

import nomad_envoy_cli


Install via Setuptools.

python install --user

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

Then import the package:

import nomad_envoy_cli

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import nomad_envoy_cli
from import ApiException
from pprint import pprint

configuration = nomad_envoy_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'
configuration = nomad_envoy_cli.Configuration()
# Configure API key authorization: ca_stage
configuration.api_key['x-ca-stage'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-ca-stage'] = 'Bearer'

# Defining host is optional and default to = ""
# Enter a context with an instance of the API client
with nomad_envoy_cli.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = nomad_envoy_cli.CustomsApi(api_client)
    region = 'region_example' # str | The region of the customs. e.g. shanghai
order = nomad_envoy_cli.Order() # Order | Order detail

        # postCustomsOrder
        api_response = api_instance.post_customs_order(region, order)
    except ApiException as e:
        print("Exception when calling CustomsApi->post_customs_order: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to

Class Method HTTP request Description
CustomsApi post_customs_order POST /customs/{region}/order postCustomsOrder
CustomsApi post_customs_payment POST /customs/{region}/payment postCustomsPayment
CustomsApi post_customs_product POST /customs/{region}/product postCustomsProduct
CustomsApi put_customs_order PUT /customs/{region}/order putCustomsOrder
CustomsCallbackApi post_customs_callback POST /customs/{store} postCustomsCallback
OrderApi add_order POST /order/{store} addOrder
OrderApi cancel_order DELETE /order/{store} cancelOrder
OrderApi get_order_by_field GET /order/{store} getOrderByField
OrderApi update_order PUT /order/{store} updateOrder
ProductApi add_product POST /product/{store} addProduct
ProductApi delete_product DELETE /product/{store} deleteProduct
ProductApi get_products_by_field GET /product/{store} getProductsByField
ProductApi update_product PUT /product/{store} updateProduct
StoreApi query_store GET /stores/ queryStore

Documentation For Models

Documentation For Authorization


  • Type: API key
  • API key parameter name: x-ca-key
  • Location: HTTP header


  • Type: API key
  • API key parameter name: x-ca-stage
  • Location: HTTP header


Project details

Download files

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

Source Distribution

nomad-envoy-cli-1.51.0.tar.gz (65.0 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page