Nomad Pilot API documentation

Inventory

PUT /inventory/product/{carrier}

Update products with third party logistics company.

Path parameters

carrier string Required

The carrier name

application/json

Body Required

Inventory product request body.

merchantGoodsNo string Required
platformGoodsNo string Required
barcodes string Required

Barcodes, multiple bar codes are separated by commas.
warehouseGoodsNo string

Warehouse goods No, generated by warehouse.
thirdCategoryNo string

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
overseaPurchase 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
customsSellerRecord 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
declarationElements string

Customs declaration elements, separate each item with a comma.

Responses

• 200

Update products successfully.
Hide response attributes Show response attributes object
- code integer(int32)
- message string
- connectorResponses array[object]
  
  Hide connectorResponses attributes Show connectorResponses attributes
  
  input string
  
  The input of a NomadOperation, usually it's JSON format.
  
  mappingName string
  
  The name of mapping class.
  
  api array[string]
  
  httpRequestRawData string
  
  Raw data of current HTTP request to the third party server, easy for debug.
  
  code integer(int32)
  
  response string
  
  responseEn string
  
  platform string
  
  requestCount integer(int32)
  
  The number of requests against the third party in one Nomad request.
  
  responseTime integer(int32)
  
  The response time of current NomadOperation request, including sub-NomadOperation. The time unit is millisecond.
- products array[object]
  
  Hide products attributes Show products attributes
  
  merchantGoodsNo string
  
  platformGoodsNo string
  
  warehouseGoodsNo string
  
  Warehouse goods No, generated by warehouse.
  
  barcodes string
  
  Barcodes, multiple bar codes are separated by commas.
  
  thirdCategoryNo string
  
  Goods category code of third level, required by Jingdong Logistics.
  
  goodsName string
  
  shopNo string
  
  stockStatus string
  
  stockType string
  
  totalNum string
  
  usableNum string
  
  recordCount string
  
  brandName string
  
  manufacturer string
  
  produceAddress 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)
  
  adventDay integer(int32)
- purchases array[object]
  
  Hide purchases attributes Show purchases attributes
  
  warehousePurchaseNo string
  
  Warehouse purchase No, generated by warehouse.
  
  warehouseGoodsNo string
  
  Warehouse goods No, generated by warehouse.
  
  supplierNo string
  
  Supplier number.
  
  poOrderStatus string
  
  storageStatus string
  
  createTime string
  
  completeTime string
  
  productName string
  
  receiveBoxNumber string
  
  grossWeight string
  
  volume string
  
  poItems array[object]
  
  Hide poItems attributes Show poItems attributes
  
  goodsNo string Required
  
  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 array[object]
  
  Hide qcQualifiedItems attributes Show qcQualifiedItems attributes
  
  goodsNo string Required
  
  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 array[object]
  
  Hide qcUnqualifiedItems attributes Show qcUnqualifiedItems attributes
  
  goodsNo string Required
  
  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

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 examples (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"
        }
      ]
    }
  ]
}