nomad_envoy_cli

NomadEnvoyCli - JavaScript client for nomad_envoy_cli 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 SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.58.0
• Package version: 1.58.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install nomad_envoy_cli --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

Getting Started

Please follow the installation instruction and execute the following JS code:

const nomadEnvoyCli = require('nomad_envoy_cli');

var defaultClient = nomadEnvoyCli.ApiClient.instance;
// defaultClient.basePath = 'http://127.0.0.1:8080/envoy';
defaultClient.defaultHeaders['source'] = 'storefront';
defaultClient.platformParameters = {
  "ALICLOUD_APIGATEWAY_APP_SECRET": process.env["ALICLOUD_APIGATEWAY_APP_SECRET"]
};

// Configure API key authorization: AlibabaXCaKey
var AlibabaXCaKey = defaultClient.authentications[nomadEnvoyCli.ApiClient.KEY_x_ca_key];
AlibabaXCaKey.apiKey = process.env['ALICLOUD_APIGATEWAY_APP_KEY'];

// Configure API key authorization: AlibabaXCaStage
var AlibabaXCaStage = defaultClient.authentications[nomadEnvoyCli.ApiClient.KEY_x_ca_stage];
AlibabaXCaStage.apiKey = process.env["ALICLOUD_STAGE"];


var api = new nomadEnvoyCli.ProductApi();

var store = 'samarkand.youzan.foreveryoung';
// var store = 'samarkand.shopify.david';  // note: Shopify's API is easiest.
// var store = 'samarkand.nomad.test';

(async () => {
  var product = new nomadEnvoyCli.Product();
  product.name = "SMK nodejs client test";
  product.price = 1;
  product.description = "another description";
  product.images = nomadEnvoyCli.Images({"uploads":["https://img.yzcdn.cn/upload_files/2018/10/30/FmwaLNs422AF1JHLy3f_Z0kYcySd.jpg"]});

  var apiReponse0 = await api.getProductsByField(store).catch((err) => console.log(err));
  console.log("apiReponse0:", apiReponse0);

  /* POST */
  var apiReponse1 = await api.addProduct(store, {"product": product});
  console.log("apiReponse1:", apiReponse1);

  /* PUT */
  product2 = Object.assign({}, apiReponse1.data.product);
  product2.name = "product2.name updated";
  var apiReponse2 = await api.updateProduct(store, {"product": product2});
  console.log("apiReponse2:", apiReponse2);

  /* GET */
  product3 = Object.assign({}, apiReponse2.data.product);
  var apiReponse3 = await api.getProductsByField(store, {"productId": "1278349221"});
  console.log("apiReponse3:", apiReponse3);

  /* DELETE */
//   product4 = Object.assign({}, apiReponse3.data.product);
//   var apiReponse4 = await api.deleteProduct(store, product4.productId);
//   console.log("apiReponse4:", apiReponse4);
})();

Documentation for API Endpoints

All URIs are relative to https://nomad.samarkand-global.cn/envoy

Class	Method	HTTP request	Description
NomadEnvoyCli.CustomsApi	postCustomsOrder	POST /customs/{region}/order	postCustomsOrder
NomadEnvoyCli.CustomsApi	postCustomsPayment	POST /customs/{region}/payment	postCustomsPayment
NomadEnvoyCli.CustomsApi	postCustomsProduct	POST /customs/{region}/product	postCustomsProduct
NomadEnvoyCli.CustomsApi	putCustomsOrder	PUT /customs/{region}/order	putCustomsOrder
NomadEnvoyCli.CustomsCallbackApi	postCustomsCallback	POST /customs/{store}	postCustomsCallback
NomadEnvoyCli.OrderApi	addOrder	POST /order/{store}	addOrder
NomadEnvoyCli.OrderApi	cancelOrder	DELETE /order/{store}	cancelOrder
NomadEnvoyCli.OrderApi	getOrderByField	GET /order/{store}	getOrderByField
NomadEnvoyCli.OrderApi	updateOrder	PUT /order/{store}	updateOrder
NomadEnvoyCli.ProductApi	addProduct	POST /product/{store}	addProduct
NomadEnvoyCli.ProductApi	deleteProduct	DELETE /product/{store}	deleteProduct
NomadEnvoyCli.ProductApi	getProductsByField	GET /product/{store}	getProductsByField
NomadEnvoyCli.ProductApi	updateProduct	PUT /product/{store}	updateProduct
NomadEnvoyCli.StoreApi	createStoreInventory	POST /stores/{store_id}/inventory	createStoreInventory
NomadEnvoyCli.StoreApi	postStore	POST /stores/	postStore
NomadEnvoyCli.StoreApi	queryStore	GET /stores/	queryStore
NomadEnvoyCli.StoreApi	queryStoreInventory	GET /stores/{store_id}/inventory	queryStoreInventory
NomadEnvoyCli.StoreApi	updateStoreInventory	PUT /stores/{store_id}/inventory	updateStoreInventory

Documentation for Models

• NomadEnvoyCli.Address
• NomadEnvoyCli.ApiResponse
• NomadEnvoyCli.ApiResponseConnectorResponse
• NomadEnvoyCli.ApiResponseData
• NomadEnvoyCli.ApiResponseDataRequired
• NomadEnvoyCli.ApiResponseGeneral
• NomadEnvoyCli.ApiResponseInventory
• NomadEnvoyCli.ApiResponseRequired
• NomadEnvoyCli.BaseApiResponse
• NomadEnvoyCli.BaseApiResponseData
• NomadEnvoyCli.CustomsDeclarationResult
• NomadEnvoyCli.Gender
• NomadEnvoyCli.Images
• NomadEnvoyCli.Inventory
• NomadEnvoyCli.Order
• NomadEnvoyCli.OrderApiResponse
• NomadEnvoyCli.OrderApiResponseData
• NomadEnvoyCli.OrderApiResponseDataRequired
• NomadEnvoyCli.OrderApiResponseRequired
• NomadEnvoyCli.OrderProduct
• NomadEnvoyCli.Product
• NomadEnvoyCli.ProductApiResponse
• NomadEnvoyCli.ProductApiResponseData
• NomadEnvoyCli.ProductApiResponseRequired
• NomadEnvoyCli.ProductComponent
• NomadEnvoyCli.ProductResponseDataRequired
• NomadEnvoyCli.ProductSku
• NomadEnvoyCli.Store

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