Nomad Pilot API documentation

Batch

POST /ship/{carrier}/create-batch

Create a batch to add parcels to for UK shipments only.

Path parameters

carrier string Required

The carrier name

Responses

• 200

Batch creation successed
Hide response attributes Show response attributes object
- code integer(int32)
- message string
- data object
  
  Hide data attributes Show data attributes
  
  shipmentId string
  
  scanFormId string
  
  scanFormUrl string
  
  trackingReference string
  
  waybillId string
  
  Logistics company waybill no.
  
  orderSn string Deprecated
  
  Deprecated. Replaced by 'orderRef'.
  
  orderRef string
  
  Order reference number. Default is from Odoo.
  
  sellerOrderRef string
  
  Order reference number. Also could be from retailers, e.g. Youzan.
  
  domesticDeliveryCompany string
  
  the domestic delivery vender for sinotrans
  
  deliveryStatus string
  
  The delivery status of one package
  
  Values are PREPARE_ORDER, SORT_ORDER, PACK_ORDER, ORDER_OUTBOUND, DELIVERY, FLIGHT_DEPARTURE, FLIGHT_ARRIVE, CUSTOM_CLEAR, CUSTOM_CLEAR_COMPLETE, CUSTOM_CLEAR_FAILURE, DOMESTIC_DELIVERY, DOMESTIC_IN_TRANSIT, DOMESTIC_SIGNING, DOMESTIC_SUCCESS, DOMESTIC_RETURNED, or DOMESTIC_FAILURE.
  
  deliveryNote string
  
  A note marked by the carrier, could be changed at any time.
  
  deliverySlipUrl string
  
  The URL of delivery slip.
  
  trackingUrl string
  
  The URL of waybill tracking.
  
  checkPoints array[string]
  
  The details of express checkpoints.
  
  weightFailed boolean
  
  Comparison of gross weight with expected weight(the sum of net weight of items * 1.2 + 1)
  
  Default value is false.
  
  errorCode string
  
  Error code, returning if waybill creation failed. Available codes which will be progressively clarified: PRODUCT_NOT_EXIST, ORDER_NOT_EXIST, AREA_RESTRICTED, PRODUCT_ERROR, CUSTOMER_ERROR, ADDRESS_ERROR, LOGISTIC_ERROR, OTHERS
  
  errorMessage string
  
  Error message, which will be progressively clarified
- 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.
- responseTime integer(int32)
  
  The response time of current NomadOperation request, including sub-NomadOperation. The time unit is millisecond.
• 400

Invalid input
• 500

Waybill creation failed
Hide response attributes Show response attributes object
- code integer(int32)
- message string
- data object
  
  Hide data attributes Show data attributes
  
  shipmentId string
  
  scanFormId string
  
  scanFormUrl string
  
  trackingReference string
  
  waybillId string
  
  Logistics company waybill no.
  
  orderSn string Deprecated
  
  Deprecated. Replaced by 'orderRef'.
  
  orderRef string
  
  Order reference number. Default is from Odoo.
  
  sellerOrderRef string
  
  Order reference number. Also could be from retailers, e.g. Youzan.
  
  domesticDeliveryCompany string
  
  the domestic delivery vender for sinotrans
  
  deliveryStatus string
  
  The delivery status of one package
  
  Values are PREPARE_ORDER, SORT_ORDER, PACK_ORDER, ORDER_OUTBOUND, DELIVERY, FLIGHT_DEPARTURE, FLIGHT_ARRIVE, CUSTOM_CLEAR, CUSTOM_CLEAR_COMPLETE, CUSTOM_CLEAR_FAILURE, DOMESTIC_DELIVERY, DOMESTIC_IN_TRANSIT, DOMESTIC_SIGNING, DOMESTIC_SUCCESS, DOMESTIC_RETURNED, or DOMESTIC_FAILURE.
  
  deliveryNote string
  
  A note marked by the carrier, could be changed at any time.
  
  deliverySlipUrl string
  
  The URL of delivery slip.
  
  trackingUrl string
  
  The URL of waybill tracking.
  
  checkPoints array[string]
  
  The details of express checkpoints.
  
  weightFailed boolean
  
  Comparison of gross weight with expected weight(the sum of net weight of items * 1.2 + 1)
  
  Default value is false.
  
  errorCode string
  
  Error code, returning if waybill creation failed. Available codes which will be progressively clarified: PRODUCT_NOT_EXIST, ORDER_NOT_EXIST, AREA_RESTRICTED, PRODUCT_ERROR, CUSTOMER_ERROR, ADDRESS_ERROR, LOGISTIC_ERROR, OTHERS
  
  errorMessage string
  
  Error message, which will be progressively clarified
- 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.
- responseTime integer(int32)
  
  The response time of current NomadOperation request, including sub-NomadOperation. The time unit is millisecond.

POST /ship/{carrier}/create-batch

curl \
 -X POST https://nomad.samarkand-global.cn/pilot/ship/{carrier}/create-batch \
 -H "x-ca-key: $API_KEY"

Response examples (200)

{
  "code": 42,
  "message": "string",
  "data": {
    "shipmentId": "string",
    "scanFormId": "string",
    "scanFormUrl": "string",
    "trackingReference": "string",
    "waybillId": "string",
    "orderSn": "string",
    "orderRef": "string",
    "sellerOrderRef": "string",
    "domesticDeliveryCompany": "YTO",
    "deliveryStatus": "DELIVERY",
    "deliveryNote": "string",
    "deliverySlipUrl": "string",
    "trackingUrl": "string",
    "checkPoints": [
      "@accept_time 2020-05-01 04:59:38; @accept_address 伦敦; @remark 寄方准备快件中,当前地点: 【GB London Delivery Centre (英國倫敦收派中心)】; @opcode 647; @zoneGmt 1",
      "...",
      "@accept_time 2020-05-13 09:10:49; @accept_address 江门市;  @remark 在官网'运单资料&签收图',可查看签收人信息; @opcode 8000; @stayWhyCode  1; @zoneGmt 8"
    ],
    "weightFailed": false,
    "errorCode": "string",
    "errorMessage": "string"
  },
  "connectorResponses": [
    {
      "input": "{\"product_id\": 12121}",
      "mappingName": "GetProductOp",
      "api": [
        "string"
      ],
      "httpRequestRawData": "-",
      "code": 42,
      "response": "string",
      "responseEn": "string",
      "platform": "youzan",
      "requestCount": 1,
      "responseTime": 1000
    }
  ],
  "responseTime": 1000
}

Response examples (500)

{
  "code": 42,
  "message": "string",
  "data": {
    "shipmentId": "string",
    "scanFormId": "string",
    "scanFormUrl": "string",
    "trackingReference": "string",
    "waybillId": "string",
    "orderSn": "string",
    "orderRef": "string",
    "sellerOrderRef": "string",
    "domesticDeliveryCompany": "YTO",
    "deliveryStatus": "DELIVERY",
    "deliveryNote": "string",
    "deliverySlipUrl": "string",
    "trackingUrl": "string",
    "checkPoints": [
      "@accept_time 2020-05-01 04:59:38; @accept_address 伦敦; @remark 寄方准备快件中,当前地点: 【GB London Delivery Centre (英國倫敦收派中心)】; @opcode 647; @zoneGmt 1",
      "...",
      "@accept_time 2020-05-13 09:10:49; @accept_address 江门市;  @remark 在官网'运单资料&签收图',可查看签收人信息; @opcode 8000; @stayWhyCode  1; @zoneGmt 8"
    ],
    "weightFailed": false,
    "errorCode": "string",
    "errorMessage": "string"
  },
  "connectorResponses": [
    {
      "input": "{\"product_id\": 12121}",
      "mappingName": "GetProductOp",
      "api": [
        "string"
      ],
      "httpRequestRawData": "-",
      "code": 42,
      "response": "string",
      "responseEn": "string",
      "platform": "youzan",
      "requestCount": 1,
      "responseTime": 1000
    }
  ],
  "responseTime": 1000
}