Nomad Pilot
1.50.0

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 is the documentation for version 1.50.0 of the API. Last update on Sep 1, 2022.

Base URL
https://nomad.samarkand-global.cn/pilot

Authentication

Ca key (http_api_key)

Send an authentication token in the x-ca-key header to authenticate with the API.


Callback

POST /callback/{store}

The callback endpoints of logistics, available provider haiku

Path parameters
  • store Required / string

    ID of the logistics provider.

Body Required

The callback body of logistics

Responses
POST /callback/{store}
curl \
 -X POST https://nomad.samarkand-global.cn/pilot/callback/{store} \
 -H "x-ca-key: $API_KEY" \
 -H "Content-Type: application/xml" \
 -d '{"deliveryOrder":{"deliveryOrderCode":"string","deliveryOrderId":"string","warehouseCode":"string","orderType":"string","status":"string","outBizCode":"string","confirmType":"string","orderConfirmTime":"string","operatorCode":"string","operatorName":"string","operateTime":"string","storageFee":"string","logisticsCode":"string","logisticsName":"string","expressCode":"string"}}'
Request example
{
  "deliveryOrder": {
    "deliveryOrderCode": "string",
    "deliveryOrderId": "string",
    "warehouseCode": "string",
    "orderType": "string",
    "status": "string",
    "outBizCode": "string",
    "confirmType": "string",
    "orderConfirmTime": "string",
    "operatorCode": "string",
    "operatorName": "string",
    "operateTime": "string",
    "storageFee": "string",
    "logisticsCode": "string",
    "logisticsName": "string",
    "expressCode": "string"
  }
}
Response example (200)
{
  "success": "success",
  "errorcode": "string",
  "errormsg": "string"
}
Response example (400)
{
  "success": "success",
  "errorcode": "string",
  "errormsg": "string"
}
Response example (500)
{
  "success": "success",
  "errorcode": "string",
  "errormsg": "string"
}

QueryCarrier

GET /carriers/

Query all carrier name or specific carrier

Query parameters
Responses
  • 200 object

    Success

  • 400

    Invalid input

  • 500 object

    Failed

GET /carriers/
curl \
 -X GET https://nomad.samarkand-global.cn/pilot/carriers/ \
 -H "x-ca-key: $API_KEY"
Response example (200)
{
  "code": 42,
  "message": "string",
  "data": [],
  "total": 42
}
Response example (500)
{
  "code": 42,
  "message": "string",
  "data": [],
  "total": 42
}

QueryFreightForward

GET /freight-forward/{carrier}

Query a specfic waybill in Freight Forwarding DB

Path parameters
  • carrier Required / string

    Carrier name to ship, e.g. samarkand.sfexpress.test

Query parameters
  • status Required / string

    package status, available options: UNPROCESSED, PACKED, PROCESSED, SHIPPED, CANCEL, ALL

    Values are UNPROCESSED, PACKED, PROCESSED, SHIPPED, CANCEL, or ALL. Default value is UNPROCESSED.

  • page_no Required / integer(int32)

    Page number, between 1 and 1000

    Minimum value is 1, maximum value is 1000. Default value is 1.

  • page_size Required / integer(int32)

    Page size, options: [1, 10, 50, 100, 1000]

    Values are 1, 10, 50, 100, or 1000. Default value is 10.

  • created_range string

    the time range of package update, use ISO_8601 format here, e.g. 2020-07-10T13:00:00Z/2020-07-11T15:30:00Z

Responses
  • 200 object

    Success

  • 400

    Invalid input

  • 500 object

    Failed

GET /freight-forward/{carrier}
curl \
 -X GET https://nomad.samarkand-global.cn/pilot/freight-forward/{carrier}?status=UNPROCESSED&page_no=1&page_size=10 \
 -H "x-ca-key: $API_KEY"
Response example (200)
{
  "code": 42,
  "message": "string",
  "data": [],
  "total": 42
}
Response example (500)
{
  "code": 42,
  "message": "string",
  "data": [],
  "total": 42
}

FreightForward

POST /freight-forward/{carrier}

Requests waybill data from specified carrier in Freight Forwarding DB. Receives waybill details in return, most carriers provide id and PDF packing label

Path parameters
  • carrier Required / string

    Carrier name to ship, e.g. samarkand.sfexpress.test

Body

Package to ship for Freight Forwarding DB

  • operation Required / string

    Operation for Freight Forwarding DB, available options: QUERY, QUERY_PRODUCT, QUERY_WAYBILL. QUERY is deprecated

    Default value is QUERY_WAYBILL.

  • itemKeys array[string]

    Item keys, the key value could be tracking reference(QUERY_WAYBILL) or product sku(QUERY_PRODUCT)

    Not more than 100 elements. Default value is [].

  • pageNo integer

    Page number

    Minimum value is 1.

  • pageSize integer

    Page size

    Minimum value is 1, maximum value is 100.

Responses
  • 200 object

    Success

  • 400

    Invalid input

  • 500 object

    Failed

POST /freight-forward/{carrier}
curl \
 -X POST https://nomad.samarkand-global.cn/pilot/freight-forward/{carrier} \
 -H "x-ca-key: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"operation":"QUERY_WAYBILL","itemKeys":["SF1035215690597","SF1025950147480"],"pageNo":1,"pageSize":10}'
Request example
{
  "operation": "QUERY_WAYBILL",
  "itemKeys": [
    "SF1035215690597",
    "SF1025950147480"
  ],
  "pageNo": 1,
  "pageSize": 10
}
Response example (200)
{
  "code": 42,
  "message": "string",
  "data": [],
  "total": 42
}
Response example (500)
{
  "code": 42,
  "message": "string",
  "data": [],
  "total": 42
}

FreightForward

PUT /freight-forward/product/{carrier}

Update product data with specified carrier in Freight Forwarding DB.

Path parameters
  • carrier Required / string

    Carrier name to ship, e.g. samarkand.sfexpress.test

Body

Package to ship for Freight Forwarding DB

  • barcode Required / string

    The barcode of product

  • skuNumber Required / string

    The number of stock keeping unit

  • brand Required / string

    The brand name of current product

  • name Required / string

    The product name

  • nameCn Required / string

    Chinese name of product

  • hsCode Required / string

    The Harmonized Commodity Description and Coding System (HS code) of the tariff nomenclature is an international standardised system of names and numbers for the classification of commodities

  • model string

    The model of current product.

  • customsUnitCodeWeight Required / string

    Legal first unit of measurement for customs product

  • Legal second unit of measurement for customs product

  • customsUnitCodePackage Required / string

    The quantity unit code customs purpose. Declaration Unit

  • countryOfOrigin Required / string

    Country of origin of of product

  • netWeight Required / number

    Use Kilogram as the basic unit of mass

  • grossWeight number

    Use Kilogram as the basic unit of mass

  • spec string

    The spec of current product

  • descriptionEn string

    The description of product

  • descriptionCn string

    Chinese description of product

  • additionalImageUrls array[string]

    Additional image urls

  • storeIds array[string]

    Available store ids of product

  • rrpCny number(float)

    Recommended retail price, unit is China Yuan

  • rrpGbp number(float)

    Recommended retail price, unit is Great Britain Pound

  • The returned filing id of current SKU from customs

  • ingredients string

    The ingredients of current product.

  • taxRate number(float)

    Product tax rate for cross-border e-commerce(%)

Responses
  • 200 object

    Success

  • 400

    Invalid input

  • 500 object

    Failed

PUT /freight-forward/product/{carrier}
curl \
 -X PUT https://nomad.samarkand-global.cn/pilot/freight-forward/product/{carrier} \
 -H "x-ca-key: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"barcode":"12508742","skuNumber":"12508742","brand":"Percy \u0026 Reed","name":"12508742","nameCn":"12508742","hsCode":"3305900000","model":"iPhone XR","customsUnitCodeWeight":"035, means 千克/kilogram","customsUnitCode":"string","customsUnitCodePackage":"142","countryOfOrigin":"502","netWeight":0.25,"grossWeight":0.3,"spec":"250ml/瓶","descriptionEn":"string","descriptionCn":"string","additionalImageUrls":["string"],"storeIds":["string"],"rrpCny":158.4,"rrpGbp":18,"customsFilingId":"string","ingredients":"发酵乳杆菌Lc40(CECT5716),麦芽糊精,蔗糖,抗坏血酸钠","taxRate":9.1}'
Request example
{
  "barcode": "12508742",
  "skuNumber": "12508742",
  "brand": "Percy & Reed",
  "name": "12508742",
  "nameCn": "12508742",
  "hsCode": "3305900000",
  "model": "iPhone XR",
  "customsUnitCodeWeight": "035, means 千克/kilogram",
  "customsUnitCode": "string",
  "customsUnitCodePackage": "142",
  "countryOfOrigin": "502",
  "netWeight": 0.25,
  "grossWeight": 0.3,
  "spec": "250ml/瓶",
  "descriptionEn": "string",
  "descriptionCn": "string",
  "additionalImageUrls": [
    "string"
  ],
  "storeIds": [
    "string"
  ],
  "rrpCny": 158.4,
  "rrpGbp": 18,
  "customsFilingId": "string",
  "ingredients": "发酵乳杆菌Lc40(CECT5716),麦芽糊精,蔗糖,抗坏血酸钠",
  "taxRate": 9.1
}
Response example (200)
{
  "code": 42,
  "message": "string",
  "data": [],
  "total": 42
}
Response example (500)
{
  "code": 42,
  "message": "string",
  "data": [],
  "total": 42
}

Inventory

GET /inventory/product/{carrier}

Query products details from third party logistics company.

Path parameters
  • carrier Required / string

    The carrier name

Query parameters
  • Product number used in warehouse.

  • stock_status string

    Stock status, options: 1, Good product; 2, Defective product; 3, Samples.

    Values are GOOD, DEFECTIVE, or SAMPLE.

  • stock_type string

    Stock type, options: 1, Normal; 2, Product to be returned; 3, Store reservation; 4, Warehouse lock; 5, Inventory lock.

    Values are NORMAL, RETURNED, RESERVATION, WAREHOUSE_LOCK, or INVENTORY_LOCK.

  • shop_no string

    Shop number, required for shop stock query.

  • page_no integer(int32)

    Page number, between 1 and 1000

    Minimum value is 1, maximum value is 1000. Default value is 1.

  • page_size integer(int32)

    Page size, options: [1, 10, 50, 100, 1000]

    Values are 1, 10, 50, 100, or 1000. Default value is 10.

Responses
GET /inventory/product/{carrier}
curl \
 -X GET https://nomad.samarkand-global.cn/pilot/inventory/product/{carrier} \
 -H "x-ca-key: $API_KEY"
Response example (200)
{
  "code": 42,
  "message": "string",
  "connectorResponses": [
    {
      "input": "{\"product_id\": 12121}",
      "mappingName": "GetProductOp",
      "api": [
        "string"
      ],
      "httpRequestRawData": "-",
      "code": 42,
      "response": "string",
      "responseEn": "string",
      "platform": "youzan",
      "requestCount": 1,
      "responseTime": 1000
    }
  ],
  "products": [
    {
      "merchantGoodsNo": "string",
      "platformGoodsNo": "string",
      "warehouseGoodsNo": "string",
      "barcodes": "string",
      "thirdCategoryNo": "string",
      "goodsName": "string",
      "shopNo": "string",
      "stockStatus": "string",
      "stockType": "string",
      "totalNum": "string",
      "usableNum": "string",
      "recordCount": "string",
      "brandName": "string",
      "manufacturer": "string",
      "produceAddress": "string",
      "grossWeight": 42.0,
      "netWeight": 42.0,
      "safeDays": 42,
      "adventDay": 42
    }
  ],
  "purchases": [
    {
      "warehousePurchaseNo": "string",
      "warehouseGoodsNo": "string",
      "supplierNo": "string",
      "poOrderStatus": "string",
      "storageStatus": "string",
      "createTime": "string",
      "completeTime": "string",
      "productName": "string",
      "receiveBoxNumber": "string",
      "grossWeight": "string",
      "volume": "string",
      "poItems": [
        {
          "goodsNo": "string",
          "goodsName": "string",
          "goodsStatus": "string",
          "serialNo": "string",
          "numApplication": "string",
          "unQualifiedQty": "string",
          "qualifiedQty": "string",
          "realInstoreQty": "string",
          "shortQty": "string",
          "damagedQty": "string",
          "emptyQty": "string",
          "expiredQty": "string",
          "otherQty": "string",
          "goodsDamagedQty": "string",
          "deformedQty": "string",
          "errorQty": "string",
          "excessQty": "string",
          "barcodeScanFailQty": "string",
          "expirationDateErrorQty": "string",
          "barcodeErrorQty": "string",
          "pollutionQty": "string",
          "markUnclearQty": "string",
          "remark": "string",
          "orderLine": "string",
          "realGoodsStatus": "string",
          "realGoodsLevel": "string",
          "checkResultStr": "string",
          "errReason": "string",
          "qcTimeStr": "string",
          "batchCode": "string",
          "isvGoodsNo": "string"
        }
      ],
      "qcQualifiedItems": [
        {
          "goodsNo": "string",
          "goodsName": "string",
          "goodsStatus": "string",
          "serialNo": "string",
          "numApplication": "string",
          "unQualifiedQty": "string",
          "qualifiedQty": "string",
          "realInstoreQty": "string",
          "shortQty": "string",
          "damagedQty": "string",
          "emptyQty": "string",
          "expiredQty": "string",
          "otherQty": "string",
          "goodsDamagedQty": "string",
          "deformedQty": "string",
          "errorQty": "string",
          "excessQty": "string",
          "barcodeScanFailQty": "string",
          "expirationDateErrorQty": "string",
          "barcodeErrorQty": "string",
          "pollutionQty": "string",
          "markUnclearQty": "string",
          "remark": "string",
          "orderLine": "string",
          "realGoodsStatus": "string",
          "realGoodsLevel": "string",
          "checkResultStr": "string",
          "errReason": "string",
          "qcTimeStr": "string",
          "batchCode": "string",
          "isvGoodsNo": "string"
        }
      ],
      "qcUnqualifiedItems": [
        {
          "goodsNo": "string",
          "goodsName": "string",
          "goodsStatus": "string",
          "serialNo": "string",
          "numApplication": "string",
          "unQualifiedQty": "string",
          "qualifiedQty": "string",
          "realInstoreQty": "string",
          "shortQty": "string",
          "damagedQty": "string",
          "emptyQty": "string",
          "expiredQty": "string",
          "otherQty": "string",
          "goodsDamagedQty": "string",
          "deformedQty": "string",
          "errorQty": "string",
          "excessQty": "string",
          "barcodeScanFailQty": "string",
          "expirationDateErrorQty": "string",
          "barcodeErrorQty": "string",
          "pollutionQty": "string",
          "markUnclearQty": "string",
          "remark": "string",
          "orderLine": "string",
          "realGoodsStatus": "string",
          "realGoodsLevel": "string",
          "checkResultStr": "string",
          "errReason": "string",
          "qcTimeStr": "string",
          "batchCode": "string",
          "isvGoodsNo": "string"
        }
      ]
    }
  ]
}

Inventory

PUT /inventory/product/{carrier}

Update products with third party logistics company.

Path parameters
  • carrier Required / string

    The carrier name

Body Required

Inventory product request body.

  • merchantGoodsNo Required / string
  • platformGoodsNo Required / string
  • barcodes Required / string

    Barcodes, multiple bar codes are separated by commas.

  • Warehouse goods No, generated by warehouse.

  • Goods category code of third level, required by Jingdong Logistics.

  • goodsName string
  • grossWeight number(float)

    Gross weight, the unit of mass is kilograms.

  • netWeight number(float)

    Net weight, the unit of mass is kilograms.

  • safeDays integer(int32)
  • batch string
  • pattern string

    Cross-border business type, options: BBC, BC, CC.

  • qiRecord string
  • customRecord string

    Goods customs record No.

  • ccProvider string

    Customs clearance service provider.

  • bondedArea string
  • Goods record assigned by the customs system after the commodity is registered.

  • batAttrIds string

    Batch attributes, 1: purchase order number, 2: production date, 3: supplier, 4: receipt date, 5: PLU management batch attribute, 6: logistics company, 7: origin, 8: batch number, 9: manufacturer, 10: packaging batch number, 11: container number attribute, 12: unsaleable attribute. Enter the number, separate the attributes of multiple batches with commas.

  • modelNumber string
  • spec string
  • vatRate integer(int32)

    VAT rate, fill in the integer, for example: 16% VAT, pass 16

  • taxRate integer(int32)
  • hsCode string
  • country string

    Country of origin.

  • qiCountry string
  • legalUnit1 string

    The first legal unit of measurement.

  • legalAmount1 string

    The first legal amount of measurement.

  • legalUnit2 string

    The second legal unit of measurement.

  • legalAmount2 string

    The second legal amount of measurement.

  • measurement string

    Customs unit of measurement.

  • qiMeasurement string
  • Customs declaration elements, separate each item with a comma.

Responses
PUT /inventory/product/{carrier}
curl \
 -X PUT https://nomad.samarkand-global.cn/pilot/inventory/product/{carrier} \
 -H "x-ca-key: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"merchantGoodsNo":"string","platformGoodsNo":"string","barcodes":"string","warehouseGoodsNo":"string","thirdCategoryNo":"string","goodsName":"string","grossWeight":42.0,"netWeight":42.0,"safeDays":42,"batch":"string","overseaPurchase":"string","pattern":"string","qiRecord":"string","customRecord":"string","ccProvider":"string","bondedArea":"string","customsSellerRecord":"string","batAttrIds":"string","modelNumber":"纸尿裤XL 30片/包","spec":"(400ml/瓶+5片/盒)/套","vatRate":42,"taxRate":42,"hsCode":"string","country":"string","qiCountry":"string","legalUnit1":"string","legalAmount1":"string","legalUnit2":"string","legalAmount2":"string","measurement":"string","qiMeasurement":"string","declarationElements":"string"}'
Request example
{
  "merchantGoodsNo": "string",
  "platformGoodsNo": "string",
  "barcodes": "string",
  "warehouseGoodsNo": "string",
  "thirdCategoryNo": "string",
  "goodsName": "string",
  "grossWeight": 42.0,
  "netWeight": 42.0,
  "safeDays": 42,
  "batch": "string",
  "overseaPurchase": "string",
  "pattern": "string",
  "qiRecord": "string",
  "customRecord": "string",
  "ccProvider": "string",
  "bondedArea": "string",
  "customsSellerRecord": "string",
  "batAttrIds": "string",
  "modelNumber": "纸尿裤XL 30片/包",
  "spec": "(400ml/瓶+5片/盒)/套",
  "vatRate": 42,
  "taxRate": 42,
  "hsCode": "string",
  "country": "string",
  "qiCountry": "string",
  "legalUnit1": "string",
  "legalAmount1": "string",
  "legalUnit2": "string",
  "legalAmount2": "string",
  "measurement": "string",
  "qiMeasurement": "string",
  "declarationElements": "string"
}
Response example (200)
{
  "code": 42,
  "message": "string",
  "connectorResponses": [
    {
      "input": "{\"product_id\": 12121}",
      "mappingName": "GetProductOp",
      "api": [
        "string"
      ],
      "httpRequestRawData": "-",
      "code": 42,
      "response": "string",
      "responseEn": "string",
      "platform": "youzan",
      "requestCount": 1,
      "responseTime": 1000
    }
  ],
  "products": [
    {
      "merchantGoodsNo": "string",
      "platformGoodsNo": "string",
      "warehouseGoodsNo": "string",
      "barcodes": "string",
      "thirdCategoryNo": "string",
      "goodsName": "string",
      "shopNo": "string",
      "stockStatus": "string",
      "stockType": "string",
      "totalNum": "string",
      "usableNum": "string",
      "recordCount": "string",
      "brandName": "string",
      "manufacturer": "string",
      "produceAddress": "string",
      "grossWeight": 42.0,
      "netWeight": 42.0,
      "safeDays": 42,
      "adventDay": 42
    }
  ],
  "purchases": [
    {
      "warehousePurchaseNo": "string",
      "warehouseGoodsNo": "string",
      "supplierNo": "string",
      "poOrderStatus": "string",
      "storageStatus": "string",
      "createTime": "string",
      "completeTime": "string",
      "productName": "string",
      "receiveBoxNumber": "string",
      "grossWeight": "string",
      "volume": "string",
      "poItems": [
        {
          "goodsNo": "string",
          "goodsName": "string",
          "goodsStatus": "string",
          "serialNo": "string",
          "numApplication": "string",
          "unQualifiedQty": "string",
          "qualifiedQty": "string",
          "realInstoreQty": "string",
          "shortQty": "string",
          "damagedQty": "string",
          "emptyQty": "string",
          "expiredQty": "string",
          "otherQty": "string",
          "goodsDamagedQty": "string",
          "deformedQty": "string",
          "errorQty": "string",
          "excessQty": "string",
          "barcodeScanFailQty": "string",
          "expirationDateErrorQty": "string",
          "barcodeErrorQty": "string",
          "pollutionQty": "string",
          "markUnclearQty": "string",
          "remark": "string",
          "orderLine": "string",
          "realGoodsStatus": "string",
          "realGoodsLevel": "string",
          "checkResultStr": "string",
          "errReason": "string",
          "qcTimeStr": "string",
          "batchCode": "string",
          "isvGoodsNo": "string"
        }
      ],
      "qcQualifiedItems": [
        {
          "goodsNo": "string",
          "goodsName": "string",
          "goodsStatus": "string",
          "serialNo": "string",
          "numApplication": "string",
          "unQualifiedQty": "string",
          "qualifiedQty": "string",
          "realInstoreQty": "string",
          "shortQty": "string",
          "damagedQty": "string",
          "emptyQty": "string",
          "expiredQty": "string",
          "otherQty": "string",
          "goodsDamagedQty": "string",
          "deformedQty": "string",
          "errorQty": "string",
          "excessQty": "string",
          "barcodeScanFailQty": "string",
          "expirationDateErrorQty": "string",
          "barcodeErrorQty": "string",
          "pollutionQty": "string",
          "markUnclearQty": "string",
          "remark": "string",
          "orderLine": "string",
          "realGoodsStatus": "string",
          "realGoodsLevel": "string",
          "checkResultStr": "string",
          "errReason": "string",
          "qcTimeStr": "string",
          "batchCode": "string",
          "isvGoodsNo": "string"
        }
      ],
      "qcUnqualifiedItems": [
        {
          "goodsNo": "string",
          "goodsName": "string",
          "goodsStatus": "string",
          "serialNo": "string",
          "numApplication": "string",
          "unQualifiedQty": "string",
          "qualifiedQty": "string",
          "realInstoreQty": "string",
          "shortQty": "string",
          "damagedQty": "string",
          "emptyQty": "string",
          "expiredQty": "string",
          "otherQty": "string",
          "goodsDamagedQty": "string",
          "deformedQty": "string",
          "errorQty": "string",
          "excessQty": "string",
          "barcodeScanFailQty": "string",
          "expirationDateErrorQty": "string",
          "barcodeErrorQty": "string",
          "pollutionQty": "string",
          "markUnclearQty": "string",
          "remark": "string",
          "orderLine": "string",
          "realGoodsStatus": "string",
          "realGoodsLevel": "string",
          "checkResultStr": "string",
          "errReason": "string",
          "qcTimeStr": "string",
          "batchCode": "string",
          "isvGoodsNo": "string"
        }
      ]
    }
  ]
}

Inventory

POST /inventory/product/{carrier}

Register products to third party logistics company.

Path parameters
  • carrier Required / string

    The carrier name

Body Required

Inventory product request body.

  • merchantGoodsNo Required / string
  • platformGoodsNo Required / string
  • barcodes Required / string

    Barcodes, multiple bar codes are separated by commas.

  • Warehouse goods No, generated by warehouse.

  • Goods category code of third level, required by Jingdong Logistics.

  • goodsName string
  • grossWeight number(float)

    Gross weight, the unit of mass is kilograms.

  • netWeight number(float)

    Net weight, the unit of mass is kilograms.

  • safeDays integer(int32)
  • batch string
  • pattern string

    Cross-border business type, options: BBC, BC, CC.

  • qiRecord string
  • customRecord string

    Goods customs record No.

  • ccProvider string

    Customs clearance service provider.

  • bondedArea string
  • Goods record assigned by the customs system after the commodity is registered.

  • batAttrIds string

    Batch attributes, 1: purchase order number, 2: production date, 3: supplier, 4: receipt date, 5: PLU management batch attribute, 6: logistics company, 7: origin, 8: batch number, 9: manufacturer, 10: packaging batch number, 11: container number attribute, 12: unsaleable attribute. Enter the number, separate the attributes of multiple batches with commas.

  • modelNumber string
  • spec string
  • vatRate integer(int32)

    VAT rate, fill in the integer, for example: 16% VAT, pass 16

  • taxRate integer(int32)
  • hsCode string
  • country string

    Country of origin.

  • qiCountry string
  • legalUnit1 string

    The first legal unit of measurement.

  • legalAmount1 string

    The first legal amount of measurement.

  • legalUnit2 string

    The second legal unit of measurement.

  • legalAmount2 string

    The second legal amount of measurement.

  • measurement string

    Customs unit of measurement.

  • qiMeasurement string
  • Customs declaration elements, separate each item with a comma.

Responses
POST /inventory/product/{carrier}
curl \
 -X POST https://nomad.samarkand-global.cn/pilot/inventory/product/{carrier} \
 -H "x-ca-key: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"merchantGoodsNo":"string","platformGoodsNo":"string","barcodes":"string","warehouseGoodsNo":"string","thirdCategoryNo":"string","goodsName":"string","grossWeight":42.0,"netWeight":42.0,"safeDays":42,"batch":"string","overseaPurchase":"string","pattern":"string","qiRecord":"string","customRecord":"string","ccProvider":"string","bondedArea":"string","customsSellerRecord":"string","batAttrIds":"string","modelNumber":"纸尿裤XL 30片/包","spec":"(400ml/瓶+5片/盒)/套","vatRate":42,"taxRate":42,"hsCode":"string","country":"string","qiCountry":"string","legalUnit1":"string","legalAmount1":"string","legalUnit2":"string","legalAmount2":"string","measurement":"string","qiMeasurement":"string","declarationElements":"string"}'
Request example
{
  "merchantGoodsNo": "string",
  "platformGoodsNo": "string",
  "barcodes": "string",
  "warehouseGoodsNo": "string",
  "thirdCategoryNo": "string",
  "goodsName": "string",
  "grossWeight": 42.0,
  "netWeight": 42.0,
  "safeDays": 42,
  "batch": "string",
  "overseaPurchase": "string",
  "pattern": "string",
  "qiRecord": "string",
  "customRecord": "string",
  "ccProvider": "string",
  "bondedArea": "string",
  "customsSellerRecord": "string",
  "batAttrIds": "string",
  "modelNumber": "纸尿裤XL 30片/包",
  "spec": "(400ml/瓶+5片/盒)/套",
  "vatRate": 42,
  "taxRate": 42,
  "hsCode": "string",
  "country": "string",
  "qiCountry": "string",
  "legalUnit1": "string",
  "legalAmount1": "string",
  "legalUnit2": "string",
  "legalAmount2": "string",
  "measurement": "string",
  "qiMeasurement": "string",
  "declarationElements": "string"
}
Response example (200)
{
  "code": 42,
  "message": "string",
  "connectorResponses": [
    {
      "input": "{\"product_id\": 12121}",
      "mappingName": "GetProductOp",
      "api": [
        "string"
      ],
      "httpRequestRawData": "-",
      "code": 42,
      "response": "string",
      "responseEn": "string",
      "platform": "youzan",
      "requestCount": 1,
      "responseTime": 1000
    }
  ],
  "products": [
    {
      "merchantGoodsNo": "string",
      "platformGoodsNo": "string",
      "warehouseGoodsNo": "string",
      "barcodes": "string",
      "thirdCategoryNo": "string",
      "goodsName": "string",
      "shopNo": "string",
      "stockStatus": "string",
      "stockType": "string",
      "totalNum": "string",
      "usableNum": "string",
      "recordCount": "string",
      "brandName": "string",
      "manufacturer": "string",
      "produceAddress": "string",
      "grossWeight": 42.0,
      "netWeight": 42.0,
      "safeDays": 42,
      "adventDay": 42
    }
  ],
  "purchases": [
    {
      "warehousePurchaseNo": "string",
      "warehouseGoodsNo": "string",
      "supplierNo": "string",
      "poOrderStatus": "string",
      "storageStatus": "string",
      "createTime": "string",
      "completeTime": "string",
      "productName": "string",
      "receiveBoxNumber": "string",
      "grossWeight": "string",
      "volume": "string",
      "poItems": [
        {
          "goodsNo": "string",
          "goodsName": "string",
          "goodsStatus": "string",
          "serialNo": "string",
          "numApplication": "string",
          "unQualifiedQty": "string",
          "qualifiedQty": "string",
          "realInstoreQty": "string",
          "shortQty": "string",
          "damagedQty": "string",
          "emptyQty": "string",
          "expiredQty": "string",
          "otherQty": "string",
          "goodsDamagedQty": "string",
          "deformedQty": "string",
          "errorQty": "string",
          "excessQty": "string",
          "barcodeScanFailQty": "string",
          "expirationDateErrorQty": "string",
          "barcodeErrorQty": "string",
          "pollutionQty": "string",
          "markUnclearQty": "string",
          "remark": "string",
          "orderLine": "string",
          "realGoodsStatus": "string",
          "realGoodsLevel": "string",
          "checkResultStr": "string",
          "errReason": "string",
          "qcTimeStr": "string",
          "batchCode": "string",
          "isvGoodsNo": "string"
        }
      ],
      "qcQualifiedItems": [
        {
          "goodsNo": "string",
          "goodsName": "string",
          "goodsStatus": "string",
          "serialNo": "string",
          "numApplication": "string",
          "unQualifiedQty": "string",
          "qualifiedQty": "string",
          "realInstoreQty": "string",
          "shortQty": "string",
          "damagedQty": "string",
          "emptyQty": "string",
          "expiredQty": "string",
          "otherQty": "string",
          "goodsDamagedQty": "string",
          "deformedQty": "string",
          "errorQty": "string",
          "excessQty": "string",
          "barcodeScanFailQty": "string",
          "expirationDateErrorQty": "string",
          "barcodeErrorQty": "string",
          "pollutionQty": "string",
          "markUnclearQty": "string",
          "remark": "string",
          "orderLine": "string",
          "realGoodsStatus": "string",
          "realGoodsLevel": "string",
          "checkResultStr": "string",
          "errReason": "string",
          "qcTimeStr": "string",
          "batchCode": "string",
          "isvGoodsNo": "string"
        }
      ],
      "qcUnqualifiedItems": [
        {
          "goodsNo": "string",
          "goodsName": "string",
          "goodsStatus": "string",
          "serialNo": "string",
          "numApplication": "string",
          "unQualifiedQty": "string",
          "qualifiedQty": "string",
          "realInstoreQty": "string",
          "shortQty": "string",
          "damagedQty": "string",
          "emptyQty": "string",
          "expiredQty": "string",
          "otherQty": "string",
          "goodsDamagedQty": "string",
          "deformedQty": "string",
          "errorQty": "string",
          "excessQty": "string",
          "barcodeScanFailQty": "string",
          "expirationDateErrorQty": "string",
          "barcodeErrorQty": "string",
          "pollutionQty": "string",
          "markUnclearQty": "string",
          "remark": "string",
          "orderLine": "string",
          "realGoodsStatus": "string",
          "realGoodsLevel": "string",
          "checkResultStr": "string",
          "errReason": "string",
          "qcTimeStr": "string",
          "batchCode": "string",
          "isvGoodsNo": "string"
        }
      ]
    }
  ]
}

Inventory_purchaseDeprecated

GET /inventory/purchase/{carrier}

Query purchase orders detail from third party logistics company.

Path parameters
  • carrier Required / string

    The carrier name

Query parameters
Responses
GET /inventory/purchase/{carrier}
curl \
 -X GET https://nomad.samarkand-global.cn/pilot/inventory/purchase/{carrier}?purchase_order_no=string \
 -H "x-ca-key: $API_KEY"
Response example (200)
{
  "code": 42,
  "message": "string",
  "connectorResponses": [
    {
      "input": "{\"product_id\": 12121}",
      "mappingName": "GetProductOp",
      "api": [
        "string"
      ],
      "httpRequestRawData": "-",
      "code": 42,
      "response": "string",
      "responseEn": "string",
      "platform": "youzan",
      "requestCount": 1,
      "responseTime": 1000
    }
  ],
  "products": [
    {
      "merchantGoodsNo": "string",
      "platformGoodsNo": "string",
      "warehouseGoodsNo": "string",
      "barcodes": "string",
      "thirdCategoryNo": "string",
      "goodsName": "string",
      "shopNo": "string",
      "stockStatus": "string",
      "stockType": "string",
      "totalNum": "string",
      "usableNum": "string",
      "recordCount": "string",
      "brandName": "string",
      "manufacturer": "string",
      "produceAddress": "string",
      "grossWeight": 42.0,
      "netWeight": 42.0,
      "safeDays": 42,
      "adventDay": 42
    }
  ],
  "purchases": [
    {
      "warehousePurchaseNo": "string",
      "warehouseGoodsNo": "string",
      "supplierNo": "string",
      "poOrderStatus": "string",
      "storageStatus": "string",
      "createTime": "string",
      "completeTime": "string",
      "productName": "string",
      "receiveBoxNumber": "string",
      "grossWeight": "string",
      "volume": "string",
      "poItems": [
        {
          "goodsNo": "string",
          "goodsName": "string",
          "goodsStatus": "string",
          "serialNo": "string",
          "numApplication": "string",
          "unQualifiedQty": "string",
          "qualifiedQty": "string",
          "realInstoreQty": "string",
          "shortQty": "string",
          "damagedQty": "string",
          "emptyQty": "string",
          "expiredQty": "string",
          "otherQty": "string",
          "goodsDamagedQty": "string",
          "deformedQty": "string",
          "errorQty": "string",
          "excessQty": "string",
          "barcodeScanFailQty": "string",
          "expirationDateErrorQty": "string",
          "barcodeErrorQty": "string",
          "pollutionQty": "string",
          "markUnclearQty": "string",
          "remark": "string",
          "orderLine": "string",
          "realGoodsStatus": "string",
          "realGoodsLevel": "string",
          "checkResultStr": "string",
          "errReason": "string",
          "qcTimeStr": "string",
          "batchCode": "string",
          "isvGoodsNo": "string"
        }
      ],
      "qcQualifiedItems": [
        {
          "goodsNo": "string",
          "goodsName": "string",
          "goodsStatus": "string",
          "serialNo": "string",
          "numApplication": "string",
          "unQualifiedQty": "string",
          "qualifiedQty": "string",
          "realInstoreQty": "string",
          "shortQty": "string",
          "damagedQty": "string",
          "emptyQty": "string",
          "expiredQty": "string",
          "otherQty": "string",
          "goodsDamagedQty": "string",
          "deformedQty": "string",
          "errorQty": "string",
          "excessQty": "string",
          "barcodeScanFailQty": "string",
          "expirationDateErrorQty": "string",
          "barcodeErrorQty": "string",
          "pollutionQty": "string",
          "markUnclearQty": "string",
          "remark": "string",
          "orderLine": "string",
          "realGoodsStatus": "string",
          "realGoodsLevel": "string",
          "checkResultStr": "string",
          "errReason": "string",
          "qcTimeStr": "string",
          "batchCode": "string",
          "isvGoodsNo": "string"
        }
      ],
      "qcUnqualifiedItems": [
        {
          "goodsNo": "string",
          "goodsName": "string",
          "goodsStatus": "string",
          "serialNo": "string",
          "numApplication": "string",
          "unQualifiedQty": "string",
          "qualifiedQty": "string",
          "realInstoreQty": "string",
          "shortQty": "string",
          "damagedQty": "string",
          "emptyQty": "string",
          "expiredQty": "string",
          "otherQty": "string",
          "goodsDamagedQty": "string",
          "deformedQty": "string",
          "errorQty": "string",
          "excessQty": "string",
          "barcodeScanFailQty": "string",
          "expirationDateErrorQty": "string",
          "barcodeErrorQty": "string",
          "pollutionQty": "string",
          "markUnclearQty": "string",
          "remark": "string",
          "orderLine": "string",
          "realGoodsStatus": "string",
          "realGoodsLevel": "string",
          "checkResultStr": "string",
          "errReason": "string",
          "qcTimeStr": "string",
          "batchCode": "string",
          "isvGoodsNo": "string"
        }
      ]
    }
  ]
}

Inventory_purchaseDeprecated

POST /inventory/purchase/{carrier}

Create purchase orders with third party logistics company.

Path parameters
  • carrier Required / string

    The carrier name

Body Required

Inventory purchase order request body.

  • warehouseGoodsNo Required / string

    Warehouse goods No, generated by warehouse.

  • purchaseOrderNo Required / string

    Merchant purchase order number.

  • supplierNo string

    Supplier number.

  • goodsNum Required / integer(int32)

    Quantity of goods applied for storage.

  • goodsStatus string

    Product status. GOOD: Good product; DEFECTIVE: Defective product; SAMPLE: Samples.

    Default value is GOOD.

Responses