Ca key (http_api_key)
Send an authentication token in the
x-ca-key
header
to authenticate with the API.
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.
npm install nomad_pilot_cli
pip install nomad-pilot-cli
groupId, com.gitlab.samarkand-nomad; artifactId, nomad-pilot-cli
This is the documentation for version 1.52.0
of the API. Last update on Feb 2, 2023.
https://nomad.samarkand-global.cn/pilot
Send an authentication token in the
x-ca-key
header
to authenticate with the API.
Create a new waybill for shipping via the specified carrier
Carrier name to ship, e.g. samarkand.sfexpress.test
Package to ship
Dimensions of package
Order reference number in ERP application
Order reference number from retailers, e-commerce platform, e.g. Youzan, Little Red
Order reference number from merchant, e.g. WConceput
Package tracking reference from logistics company
ISO 8601 format, '2019-01-19T18:30:52.442118+00:00' or '2019-01-19T18:30:52+00:00'
Use Kilogram as the basic unit of mass.
Use Kilogram as the basic unit of mass.
The total price of this package, not including any discount and tax.
Price makes sense under an explicit currency, available options: RMB, CNY, USD, GBP
Default value is RMB
.
weight Unit of measurement
Default value is Kilogram
.
length Unit of measurement
Default value is Centimetre
.
the domestic delivery vendor, 2 available options: [SF, YTO]
Default value is SF
.
The time when current order was created. ISO_8601 format
The time when current order was updated. ISO_8601 format
The actual amount paid for the order.
The payment number generated by eCommerce platform such as Youzan
The time when the pay was made. ISO_8601 format
The sum tax of all products in current order, including Non-cash deduction amount.
The shipping cost of current order, excluding the shipping cost on each contained products. If delivery free, just set 0.
Amount that deducted by non-cash, e.g. member points, virtual currency, voucher code, etc.
The special note from the buyer.
The cancel reason of current package.
The code of warehouse for this package
The ID of buyer on current third party platform.
The insurance fee of current shipping.
International logistics express type. BC for 901, 229; CC for 902
The payment number generated by payment tool such as WeChat Pay
The e-commerce platform name, available options: youzan, pdd, nomad
Default value is youzan
.
Express route check point, turn on it by input "enable", default is disabled
Services provided by logistics companies, such as next_day for Next Day Delivery, sign for Signed Delivery, international for International Delivery and so on.
Logistic companies, e.g. SF, FEDEX.
Contents of package
package status, 4 available options: UNPROCESSED, PACKED, PROCESSED, CANCEL. Status SHIPPED is updated by confirm api
nomad express carrier name
express delivery slip url
waybill create date
waybill packed date
waybill processed date
waybill shipped date
waybill cancel date
Customs order declaration results
curl \
-X PUT https://nomad.samarkand-global.cn/pilot/ship/{carrier} \
-H "x-ca-key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"dimension":{"weight":42.0,"height":42.0,"length":42.0,"width":42.0},"shipFrom":{"firstName":"John","lastName":"string","address1":"string","address2":"string","county":"string","city":"string","state":"string","country":"string","zip":"string","tin":"string","phone":"string","countryCode":142,"idCard":"string","email":"string","company":"string","ecommerceWebsiteUserId":"string"},"shipTo":{"firstName":"John","lastName":"string","address1":"string","address2":"string","county":"string","city":"string","state":"string","country":"string","zip":"string","tin":"string","phone":"string","countryCode":142,"idCard":"string","email":"string","company":"string","ecommerceWebsiteUserId":"string"},"bill":{"firstName":"John","lastName":"string","address1":"string","address2":"string","county":"string","city":"string","state":"string","country":"string","zip":"string","tin":"string","phone":"string","countryCode":142,"idCard":"string","email":"string","company":"string","ecommerceWebsiteUserId":"string"},"orderRef":"SO224571","sellerOrderRef":"E202010152223470377011119610GZ","merchantOrderRef":"WU202127533","trackingReference":"SF1032566311525","orderTime":"string","grossWeight":1.53,"netWeight":1.53,"totalPrice":532.8,"currency":"RMB","massUnit":"Kilogram","lengthUnit":"Centimetre","domesticDeliveryCompany":"SF","createdAt":"2019-07-12T13:13:52.004637+01:00","updatedAt":"2019-07-12T13:13:52.004637+01:00","payMethod":"EASIPAY","payMerchantName":"Paypal","payAmount":611.08,"payId":"2014030120394812","paidAt":"2019-07-12T13:13:52.004637+01:00","productsTotalTax":53.28,"shippingCost":25,"nonCashDeductionAmount":0,"customerNote":"This package is very important.","cancelReason":"The customers updated the address.","warehouseCode":"718595286704","customerIdRef":"string","insuranceFee":2.5,"expressType":"BC","paymentPayId":"191028195204000214","platformName":"youzan","checkPoint":"string","service":"string","expressCompany":"string","items":[{"name":"string","nameCn":"测试","barcode":"string","skuNumber":"SMK123","quantity":7,"price":21.3,"tax":2,"discount":1,"brand":"string","quantityUom":"50G","hsCode":"string","countryOfOrigin":"string","goldjet":{"goodsPtcode":"string"},"grossWeight":42.0,"netWeight":42.0,"customsUnitCode":"142, 007, 瓶, ...","customsUnitCodePackage":"142, 011, 140","customsUnitCodeWeight":"035(means 千克, kilogram)","customsFilingId":"string","spec":"25mm","model":"iPhone XR","ingredients":"发酵乳杆菌Lc40(CECT5716),麦芽糊精,蔗糖,抗坏血酸钠","customsUnitCodeCn":"瓶","countryOfOriginIso":"RU","declarationElements":"string"}],"status":"string","carrier":"samarkand.sfexpress.test","deliverySlipUrl":"string","createdDate":"string","packedDate":"string","processedDate":"string","shippedDate":"string","cancelDate":"string","customsNote":"string"}'
{
"dimension": {
"weight": 42.0,
"height": 42.0,
"length": 42.0,
"width": 42.0
},
"shipFrom": {
"firstName": "John",
"lastName": "string",
"address1": "string",
"address2": "string",
"county": "string",
"city": "string",
"state": "string",
"country": "string",
"zip": "string",
"tin": "string",
"phone": "string",
"countryCode": 142,
"idCard": "string",
"email": "string",
"company": "string",
"ecommerceWebsiteUserId": "string"
},
"shipTo": {
"firstName": "John",
"lastName": "string",
"address1": "string",
"address2": "string",
"county": "string",
"city": "string",
"state": "string",
"country": "string",
"zip": "string",
"tin": "string",
"phone": "string",
"countryCode": 142,
"idCard": "string",
"email": "string",
"company": "string",
"ecommerceWebsiteUserId": "string"
},
"bill": {
"firstName": "John",
"lastName": "string",
"address1": "string",
"address2": "string",
"county": "string",
"city": "string",
"state": "string",
"country": "string",
"zip": "string",
"tin": "string",
"phone": "string",
"countryCode": 142,
"idCard": "string",
"email": "string",
"company": "string",
"ecommerceWebsiteUserId": "string"
},
"orderRef": "SO224571",
"sellerOrderRef": "E202010152223470377011119610GZ",
"merchantOrderRef": "WU202127533",
"trackingReference": "SF1032566311525",
"orderTime": "string",
"grossWeight": 1.53,
"netWeight": 1.53,
"totalPrice": 532.8,
"currency": "RMB",
"massUnit": "Kilogram",
"lengthUnit": "Centimetre",
"domesticDeliveryCompany": "SF",
"createdAt": "2019-07-12T13:13:52.004637+01:00",
"updatedAt": "2019-07-12T13:13:52.004637+01:00",
"payMethod": "EASIPAY",
"payMerchantName": "Paypal",
"payAmount": 611.08,
"payId": "2014030120394812",
"paidAt": "2019-07-12T13:13:52.004637+01:00",
"productsTotalTax": 53.28,
"shippingCost": 25,
"nonCashDeductionAmount": 0,
"customerNote": "This package is very important.",
"cancelReason": "The customers updated the address.",
"warehouseCode": "718595286704",
"customerIdRef": "string",
"insuranceFee": 2.5,
"expressType": "BC",
"paymentPayId": "191028195204000214",
"platformName": "youzan",
"checkPoint": "string",
"service": "string",
"expressCompany": "string",
"items": [
{
"name": "string",
"nameCn": "测试",
"barcode": "string",
"skuNumber": "SMK123",
"quantity": 7,
"price": 21.3,
"tax": 2,
"discount": 1,
"brand": "string",
"quantityUom": "50G",
"hsCode": "string",
"countryOfOrigin": "string",
"goldjet": {
"goodsPtcode": "string"
},
"grossWeight": 42.0,
"netWeight": 42.0,
"customsUnitCode": "142, 007, 瓶, ...",
"customsUnitCodePackage": "142, 011, 140",
"customsUnitCodeWeight": "035(means 千克, kilogram)",
"customsFilingId": "string",
"spec": "25mm",
"model": "iPhone XR",
"ingredients": "发酵乳杆菌Lc40(CECT5716),麦芽糊精,蔗糖,抗坏血酸钠",
"customsUnitCodeCn": "瓶",
"countryOfOriginIso": "RU",
"declarationElements": "string"
}
],
"status": "string",
"carrier": "samarkand.sfexpress.test",
"deliverySlipUrl": "string",
"createdDate": "string",
"packedDate": "string",
"processedDate": "string",
"shippedDate": "string",
"cancelDate": "string",
"customsNote": "string"
}
{
"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
}
{
"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
}
Requests waybill creation from specified carrier. Receives waybill details in return, most carriers provide id and PDF packing label
Carrier name to ship, e.g. samarkand.sfexpress.test
Package to ship
Dimensions of package
Order reference number in ERP application
Order reference number from retailers, e-commerce platform, e.g. Youzan, Little Red
Order reference number from merchant, e.g. WConceput
Package tracking reference from logistics company
ISO 8601 format, '2019-01-19T18:30:52.442118+00:00' or '2019-01-19T18:30:52+00:00'
Use Kilogram as the basic unit of mass.
Use Kilogram as the basic unit of mass.
The total price of this package, not including any discount and tax.
Price makes sense under an explicit currency, available options: RMB, CNY, USD, GBP
Default value is RMB
.
weight Unit of measurement
Default value is Kilogram
.
length Unit of measurement
Default value is Centimetre
.
the domestic delivery vendor, 2 available options: [SF, YTO]
Default value is SF
.
The time when current order was created. ISO_8601 format
The time when current order was updated. ISO_8601 format
The actual amount paid for the order.
The payment number generated by eCommerce platform such as Youzan
The time when the pay was made. ISO_8601 format
The sum tax of all products in current order, including Non-cash deduction amount.
The shipping cost of current order, excluding the shipping cost on each contained products. If delivery free, just set 0.
Amount that deducted by non-cash, e.g. member points, virtual currency, voucher code, etc.
The special note from the buyer.
The cancel reason of current package.
The code of warehouse for this package
The ID of buyer on current third party platform.
The insurance fee of current shipping.
International logistics express type. BC for 901, 229; CC for 902
The payment number generated by payment tool such as WeChat Pay
The e-commerce platform name, available options: youzan, pdd, nomad
Default value is youzan
.
Express route check point, turn on it by input "enable", default is disabled
Services provided by logistics companies, such as next_day for Next Day Delivery, sign for Signed Delivery, international for International Delivery and so on.
Logistic companies, e.g. SF, FEDEX.
Contents of package
curl \
-X POST https://nomad.samarkand-global.cn/pilot/ship/{carrier} \
-H "x-ca-key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"dimension":{"weight":42.0,"height":42.0,"length":42.0,"width":42.0},"shipFrom":{"firstName":"John","lastName":"string","address1":"string","address2":"string","county":"string","city":"string","state":"string","country":"string","zip":"string","tin":"string","phone":"string","countryCode":142,"idCard":"string","email":"string","company":"string","ecommerceWebsiteUserId":"string"},"shipTo":{"firstName":"John","lastName":"string","address1":"string","address2":"string","county":"string","city":"string","state":"string","country":"string","zip":"string","tin":"string","phone":"string","countryCode":142,"idCard":"string","email":"string","company":"string","ecommerceWebsiteUserId":"string"},"bill":{"firstName":"John","lastName":"string","address1":"string","address2":"string","county":"string","city":"string","state":"string","country":"string","zip":"string","tin":"string","phone":"string","countryCode":142,"idCard":"string","email":"string","company":"string","ecommerceWebsiteUserId":"string"},"orderRef":"SO224571","sellerOrderRef":"E202010152223470377011119610GZ","merchantOrderRef":"WU202127533","trackingReference":"SF1032566311525","orderTime":"string","grossWeight":1.53,"netWeight":1.53,"totalPrice":532.8,"currency":"RMB","massUnit":"Kilogram","lengthUnit":"Centimetre","domesticDeliveryCompany":"SF","createdAt":"2019-07-12T13:13:52.004637+01:00","updatedAt":"2019-07-12T13:13:52.004637+01:00","payMethod":"EASIPAY","payMerchantName":"Paypal","payAmount":611.08,"payId":"2014030120394812","paidAt":"2019-07-12T13:13:52.004637+01:00","productsTotalTax":53.28,"shippingCost":25,"nonCashDeductionAmount":0,"customerNote":"This package is very important.","cancelReason":"The customers updated the address.","warehouseCode":"718595286704","customerIdRef":"string","insuranceFee":2.5,"expressType":"BC","paymentPayId":"191028195204000214","platformName":"youzan","checkPoint":"string","service":"string","expressCompany":"string","items":[{"name":"string","nameCn":"测试","barcode":"string","skuNumber":"SMK123","quantity":7,"price":21.3,"tax":2,"discount":1,"brand":"string","quantityUom":"50G","hsCode":"string","countryOfOrigin":"string","goldjet":{"goodsPtcode":"string"},"grossWeight":42.0,"netWeight":42.0,"customsUnitCode":"142, 007, 瓶, ...","customsUnitCodePackage":"142, 011, 140","customsUnitCodeWeight":"035(means 千克, kilogram)","customsFilingId":"string","spec":"25mm","model":"iPhone XR","ingredients":"发酵乳杆菌Lc40(CECT5716),麦芽糊精,蔗糖,抗坏血酸钠","customsUnitCodeCn":"瓶","countryOfOriginIso":"RU","declarationElements":"string"}]}'
{
"dimension": {
"weight": 42.0,
"height": 42.0,
"length": 42.0,
"width": 42.0
},
"shipFrom": {
"firstName": "John",
"lastName": "string",
"address1": "string",
"address2": "string",
"county": "string",
"city": "string",
"state": "string",
"country": "string",
"zip": "string",
"tin": "string",
"phone": "string",
"countryCode": 142,
"idCard": "string",
"email": "string",
"company": "string",
"ecommerceWebsiteUserId": "string"
},
"shipTo": {
"firstName": "John",
"lastName": "string",
"address1": "string",
"address2": "string",
"county": "string",
"city": "string",
"state": "string",
"country": "string",
"zip": "string",
"tin": "string",
"phone": "string",
"countryCode": 142,
"idCard": "string",
"email": "string",
"company": "string",
"ecommerceWebsiteUserId": "string"
},
"bill": {
"firstName": "John",
"lastName": "string",
"address1": "string",
"address2": "string",
"county": "string",
"city": "string",
"state": "string",
"country": "string",
"zip": "string",
"tin": "string",
"phone": "string",
"countryCode": 142,
"idCard": "string",
"email": "string",
"company": "string",
"ecommerceWebsiteUserId": "string"
},
"orderRef": "SO224571",
"sellerOrderRef": "E202010152223470377011119610GZ",
"merchantOrderRef": "WU202127533",
"trackingReference": "SF1032566311525",
"orderTime": "string",
"grossWeight": 1.53,
"netWeight": 1.53,
"totalPrice": 532.8,
"currency": "RMB",
"massUnit": "Kilogram",
"lengthUnit": "Centimetre",
"domesticDeliveryCompany": "SF",
"createdAt": "2019-07-12T13:13:52.004637+01:00",
"updatedAt": "2019-07-12T13:13:52.004637+01:00",
"payMethod": "EASIPAY",
"payMerchantName": "Paypal",
"payAmount": 611.08,
"payId": "2014030120394812",
"paidAt": "2019-07-12T13:13:52.004637+01:00",
"productsTotalTax": 53.28,
"shippingCost": 25,
"nonCashDeductionAmount": 0,
"customerNote": "This package is very important.",
"cancelReason": "The customers updated the address.",
"warehouseCode": "718595286704",
"customerIdRef": "string",
"insuranceFee": 2.5,
"expressType": "BC",
"paymentPayId": "191028195204000214",
"platformName": "youzan",
"checkPoint": "string",
"service": "string",
"expressCompany": "string",
"items": [
{
"name": "string",
"nameCn": "测试",
"barcode": "string",
"skuNumber": "SMK123",
"quantity": 7,
"price": 21.3,
"tax": 2,
"discount": 1,
"brand": "string",
"quantityUom": "50G",
"hsCode": "string",
"countryOfOrigin": "string",
"goldjet": {
"goodsPtcode": "string"
},
"grossWeight": 42.0,
"netWeight": 42.0,
"customsUnitCode": "142, 007, 瓶, ...",
"customsUnitCodePackage": "142, 011, 140",
"customsUnitCodeWeight": "035(means 千克, kilogram)",
"customsFilingId": "string",
"spec": "25mm",
"model": "iPhone XR",
"ingredients": "发酵乳杆菌Lc40(CECT5716),麦芽糊精,蔗糖,抗坏血酸钠",
"customsUnitCodeCn": "瓶",
"countryOfOriginIso": "RU",
"declarationElements": "string"
}
]
}
{
"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
}
{
"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
}
String name of carrier
Order reference number from retailers, e-commerce platform, e.g. Youzan, Little Red
curl \
-X GET https://nomad.samarkand-global.cn/pilot/ship/{carrier}/order/{seller_order_ref} \
-H "x-ca-key: $API_KEY"
{
"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
}
{
"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
}
Attempts to cancel a created waybill, success will depend on carrier support.
Carrier name to ship, e.g. samarkand.sfexpress.test
Order reference number from retailers, e-commerce platform, e.g. Youzan, Little Red
curl \
-X DELETE https://nomad.samarkand-global.cn/pilot/ship/{carrier}/order/{seller_order_ref} \
-H "x-ca-key: $API_KEY"
{
"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
}
{
"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
}
Create a new waybill for shipping with minimum product information
Requests waybill creation from specified carrier. Receives waybill details in return, most carriers provide id and PDF packing label
Carrier name to ship, e.g. samarkand.sfexpress.test
Package to quick ship
Dimensions of package
Order reference number in ERP application
Order reference number from retailers, e-commerce platform, e.g. Youzan, Little Red
Order reference number from merchant, e.g. WConceput
Package tracking reference from logistics company
ISO 8601 format, '2019-01-19T18:30:52.442118+00:00' or '2019-01-19T18:30:52+00:00'
Use Kilogram as the basic unit of mass.
Use Kilogram as the basic unit of mass.
The total price of this package, not including any discount and tax.
Price makes sense under an explicit currency, available options: RMB, CNY, USD, GBP
Default value is RMB
.
weight Unit of measurement
Default value is Kilogram
.
length Unit of measurement
Default value is Centimetre
.
the domestic delivery vendor, 2 available options: [SF, YTO]
Default value is SF
.
The time when current order was created. ISO_8601 format
The time when current order was updated. ISO_8601 format
The actual amount paid for the order.
The payment number generated by eCommerce platform such as Youzan
The time when the pay was made. ISO_8601 format
The sum tax of all products in current order, including Non-cash deduction amount.
The shipping cost of current order, excluding the shipping cost on each contained products. If delivery free, just set 0.
Amount that deducted by non-cash, e.g. member points, virtual currency, voucher code, etc.
The special note from the buyer.
The cancel reason of current package.
The code of warehouse for this package
The ID of buyer on current third party platform.
The insurance fee of current shipping.
International logistics express type. BC for 901, 229; CC for 902
The payment number generated by payment tool such as WeChat Pay
The e-commerce platform name, available options: youzan, pdd, nomad
Default value is youzan
.
Express route check point, turn on it by input "enable", default is disabled
Services provided by logistics companies, such as next_day for Next Day Delivery, sign for Signed Delivery, international for International Delivery and so on.
Logistic companies, e.g. SF, FEDEX.
curl \
-X POST https://nomad.samarkand-global.cn/pilot/quick-ship/{carrier} \
-H "x-ca-key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"dimension":{"weight":42.0,"height":42.0,"length":42.0,"width":42.0},"shipFrom":{"firstName":"John","lastName":"string","address1":"string","address2":"string","county":"string","city":"string","state":"string","country":"string","zip":"string","tin":"string","phone":"string","countryCode":142,"idCard":"string","email":"string","company":"string","ecommerceWebsiteUserId":"string"},"shipTo":{"firstName":"John","lastName":"string","address1":"string","address2":"string","county":"string","city":"string","state":"string","country":"string","zip":"string","tin":"string","phone":"string","countryCode":142,"idCard":"string","email":"string","company":"string","ecommerceWebsiteUserId":"string"},"bill":{"firstName":"John","lastName":"string","address1":"string","address2":"string","county":"string","city":"string","state":"string","country":"string","zip":"string","tin":"string","phone":"string","countryCode":142,"idCard":"string","email":"string","company":"string","ecommerceWebsiteUserId":"string"},"orderRef":"SO224571","sellerOrderRef":"E202010152223470377011119610GZ","merchantOrderRef":"WU202127533","trackingReference":"SF1032566311525","orderTime":"string","grossWeight":1.53,"netWeight":1.53,"totalPrice":532.8,"currency":"RMB","massUnit":"Kilogram","lengthUnit":"Centimetre","domesticDeliveryCompany":"SF","createdAt":"2019-07-12T13:13:52.004637+01:00","updatedAt":"2019-07-12T13:13:52.004637+01:00","payMethod":"EASIPAY","payMerchantName":"Paypal","payAmount":611.08,"payId":"2014030120394812","paidAt":"2019-07-12T13:13:52.004637+01:00","productsTotalTax":53.28,"shippingCost":25,"nonCashDeductionAmount":0,"customerNote":"This package is very important.","cancelReason":"The customers updated the address.","warehouseCode":"718595286704","customerIdRef":"string","insuranceFee":2.5,"expressType":"BC","paymentPayId":"191028195204000214","platformName":"youzan","checkPoint":"string","service":"string","expressCompany":"string","items":[{"skuNumber":"SMK123","barcode":5060280371714,"quantity":7,"price":21.3}]}'
{
"dimension": {
"weight": 42.0,
"height": 42.0,
"length": 42.0,
"width": 42.0
},
"shipFrom": {
"firstName": "John",
"lastName": "string",
"address1": "string",
"address2": "string",
"county": "string",
"city": "string",
"state": "string",
"country": "string",
"zip": "string",
"tin": "string",
"phone": "string",
"countryCode": 142,
"idCard": "string",
"email": "string",
"company": "string",
"ecommerceWebsiteUserId": "string"
},
"shipTo": {
"firstName": "John",
"lastName": "string",
"address1": "string",
"address2": "string",
"county": "string",
"city": "string",
"state": "string",
"country": "string",
"zip": "string",
"tin": "string",
"phone": "string",
"countryCode": 142,
"idCard": "string",
"email": "string",
"company": "string",
"ecommerceWebsiteUserId": "string"
},
"bill": {
"firstName": "John",
"lastName": "string",
"address1": "string",
"address2": "string",
"county": "string",
"city": "string",
"state": "string",
"country": "string",
"zip": "string",
"tin": "string",
"phone": "string",
"countryCode": 142,
"idCard": "string",
"email": "string",
"company": "string",
"ecommerceWebsiteUserId": "string"
},
"orderRef": "SO224571",
"sellerOrderRef": "E202010152223470377011119610GZ",
"merchantOrderRef": "WU202127533",
"trackingReference": "SF1032566311525",
"orderTime": "string",
"grossWeight": 1.53,
"netWeight": 1.53,
"totalPrice": 532.8,
"currency": "RMB",
"massUnit": "Kilogram",
"lengthUnit": "Centimetre",
"domesticDeliveryCompany": "SF",
"createdAt": "2019-07-12T13:13:52.004637+01:00",
"updatedAt": "2019-07-12T13:13:52.004637+01:00",
"payMethod": "EASIPAY",
"payMerchantName": "Paypal",
"payAmount": 611.08,
"payId": "2014030120394812",
"paidAt": "2019-07-12T13:13:52.004637+01:00",
"productsTotalTax": 53.28,
"shippingCost": 25,
"nonCashDeductionAmount": 0,
"customerNote": "This package is very important.",
"cancelReason": "The customers updated the address.",
"warehouseCode": "718595286704",
"customerIdRef": "string",
"insuranceFee": 2.5,
"expressType": "BC",
"paymentPayId": "191028195204000214",
"platformName": "youzan",
"checkPoint": "string",
"service": "string",
"expressCompany": "string",
"items": [
{
"skuNumber": "SMK123",
"barcode": 5060280371714,
"quantity": 7,
"price": 21.3
}
]
}
{
"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
}
{
"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
}
Confirm a waybill for shipping via the specified carrier
Carrier name to ship, e.g. samarkand.sfexpress.test
Package tracking reference from logistics company
Dimensions of package
Order reference number in ERP application
Order reference number from retailers, e-commerce platform, e.g. Youzan, Little Red
Order reference number from merchant, e.g. WConceput
Package tracking reference from logistics company
ISO 8601 format, '2019-01-19T18:30:52.442118+00:00' or '2019-01-19T18:30:52+00:00'
Use Kilogram as the basic unit of mass.
Use Kilogram as the basic unit of mass.
The total price of this package, not including any discount and tax.
Price makes sense under an explicit currency, available options: RMB, CNY, USD, GBP
Default value is RMB
.
weight Unit of measurement
Default value is Kilogram
.
length Unit of measurement
Default value is Centimetre
.
the domestic delivery vendor, 2 available options: [SF, YTO]
Default value is SF
.
The time when current order was created. ISO_8601 format
The time when current order was updated. ISO_8601 format
The actual amount paid for the order.
The payment number generated by eCommerce platform such as Youzan
The time when the pay was made. ISO_8601 format
The sum tax of all products in current order, including Non-cash deduction amount.
The shipping cost of current order, excluding the shipping cost on each contained products. If delivery free, just set 0.
Amount that deducted by non-cash, e.g. member points, virtual currency, voucher code, etc.
The special note from the buyer.
The cancel reason of current package.
The code of warehouse for this package
The ID of buyer on current third party platform.
The insurance fee of current shipping.
International logistics express type. BC for 901, 229; CC for 902
The payment number generated by payment tool such as WeChat Pay
The e-commerce platform name, available options: youzan, pdd, nomad
Default value is youzan
.
Express route check point, turn on it by input "enable", default is disabled
Services provided by logistics companies, such as next_day for Next Day Delivery, sign for Signed Delivery, international for International Delivery and so on.
Logistic companies, e.g. SF, FEDEX.
Contents of package
curl \
-X POST https://nomad.samarkand-global.cn/pilot/ship/{carrier}/confirm \
-H "x-ca-key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"dimension":{"weight":42.0,"height":42.0,"length":42.0,"width":42.0},"shipFrom":{"firstName":"John","lastName":"string","address1":"string","address2":"string","county":"string","city":"string","state":"string","country":"string","zip":"string","tin":"string","phone":"string","countryCode":142,"idCard":"string","email":"string","company":"string","ecommerceWebsiteUserId":"string"},"shipTo":{"firstName":"John","lastName":"string","address1":"string","address2":"string","county":"string","city":"string","state":"string","country":"string","zip":"string","tin":"string","phone":"string","countryCode":142,"idCard":"string","email":"string","company":"string","ecommerceWebsiteUserId":"string"},"bill":{"firstName":"John","lastName":"string","address1":"string","address2":"string","county":"string","city":"string","state":"string","country":"string","zip":"string","tin":"string","phone":"string","countryCode":142,"idCard":"string","email":"string","company":"string","ecommerceWebsiteUserId":"string"},"orderRef":"SO224571","sellerOrderRef":"E202010152223470377011119610GZ","merchantOrderRef":"WU202127533","trackingReference":"SF1032566311525","orderTime":"string","grossWeight":1.53,"netWeight":1.53,"totalPrice":532.8,"currency":"RMB","massUnit":"Kilogram","lengthUnit":"Centimetre","domesticDeliveryCompany":"SF","createdAt":"2019-07-12T13:13:52.004637+01:00","updatedAt":"2019-07-12T13:13:52.004637+01:00","payMethod":"EASIPAY","payMerchantName":"Paypal","payAmount":611.08,"payId":"2014030120394812","paidAt":"2019-07-12T13:13:52.004637+01:00","productsTotalTax":53.28,"shippingCost":25,"nonCashDeductionAmount":0,"customerNote":"This package is very important.","cancelReason":"The customers updated the address.","warehouseCode":"718595286704","customerIdRef":"string","insuranceFee":2.5,"expressType":"BC","paymentPayId":"191028195204000214","platformName":"youzan","checkPoint":"string","service":"string","expressCompany":"string","items":[{"name":"string","nameCn":"测试","barcode":"string","skuNumber":"SMK123","quantity":7,"price":21.3,"tax":2,"discount":1,"brand":"string","quantityUom":"50G","hsCode":"string","countryOfOrigin":"string","goldjet":{"goodsPtcode":"string"},"grossWeight":42.0,"netWeight":42.0,"customsUnitCode":"142, 007, 瓶, ...","customsUnitCodePackage":"142, 011, 140","customsUnitCodeWeight":"035(means 千克, kilogram)","customsFilingId":"string","spec":"25mm","model":"iPhone XR","ingredients":"发酵乳杆菌Lc40(CECT5716),麦芽糊精,蔗糖,抗坏血酸钠","customsUnitCodeCn":"瓶","countryOfOriginIso":"RU","declarationElements":"string"}]}'
{
"dimension": {
"weight": 42.0,
"height": 42.0,
"length": 42.0,
"width": 42.0
},
"shipFrom": {
"firstName": "John",
"lastName": "string",
"address1": "string",
"address2": "string",
"county": "string",
"city": "string",
"state": "string",
"country": "string",
"zip": "string",
"tin": "string",
"phone": "string",
"countryCode": 142,
"idCard": "string",
"email": "string",
"company": "string",
"ecommerceWebsiteUserId": "string"
},
"shipTo": {
"firstName": "John",
"lastName": "string",
"address1": "string",
"address2": "string",
"county": "string",
"city": "string",
"state": "string",
"country": "string",
"zip": "string",
"tin": "string",
"phone": "string",
"countryCode": 142,
"idCard": "string",
"email": "string",
"company": "string",
"ecommerceWebsiteUserId": "string"
},
"bill": {
"firstName": "John",
"lastName": "string",
"address1": "string",
"address2": "string",
"county": "string",
"city": "string",
"state": "string",
"country": "string",
"zip": "string",
"tin": "string",
"phone": "string",
"countryCode": 142,
"idCard": "string",
"email": "string",
"company": "string",
"ecommerceWebsiteUserId": "string"
},
"orderRef": "SO224571",
"sellerOrderRef": "E202010152223470377011119610GZ",
"merchantOrderRef": "WU202127533",
"trackingReference": "SF1032566311525",
"orderTime": "string",
"grossWeight": 1.53,
"netWeight": 1.53,
"totalPrice": 532.8,
"currency": "RMB",
"massUnit": "Kilogram",
"lengthUnit": "Centimetre",
"domesticDeliveryCompany": "SF",
"createdAt": "2019-07-12T13:13:52.004637+01:00",
"updatedAt": "2019-07-12T13:13:52.004637+01:00",
"payMethod": "EASIPAY",
"payMerchantName": "Paypal",
"payAmount": 611.08,
"payId": "2014030120394812",
"paidAt": "2019-07-12T13:13:52.004637+01:00",
"productsTotalTax": 53.28,
"shippingCost": 25,
"nonCashDeductionAmount": 0,
"customerNote": "This package is very important.",
"cancelReason": "The customers updated the address.",
"warehouseCode": "718595286704",
"customerIdRef": "string",
"insuranceFee": 2.5,
"expressType": "BC",
"paymentPayId": "191028195204000214",
"platformName": "youzan",
"checkPoint": "string",
"service": "string",
"expressCompany": "string",
"items": [
{
"name": "string",
"nameCn": "测试",
"barcode": "string",
"skuNumber": "SMK123",
"quantity": 7,
"price": 21.3,
"tax": 2,
"discount": 1,
"brand": "string",
"quantityUom": "50G",
"hsCode": "string",
"countryOfOrigin": "string",
"goldjet": {
"goodsPtcode": "string"
},
"grossWeight": 42.0,
"netWeight": 42.0,
"customsUnitCode": "142, 007, 瓶, ...",
"customsUnitCodePackage": "142, 011, 140",
"customsUnitCodeWeight": "035(means 千克, kilogram)",
"customsFilingId": "string",
"spec": "25mm",
"model": "iPhone XR",
"ingredients": "发酵乳杆菌Lc40(CECT5716),麦芽糊精,蔗糖,抗坏血酸钠",
"customsUnitCodeCn": "瓶",
"countryOfOriginIso": "RU",
"declarationElements": "string"
}
]
}
{
"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
}
{
"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
}
waybills in Samarkand Freight Forwarding
Carrier name to ship, e.g. samarkand.sfexpress.test
package status, available options: UNPROCESSED, PACKED, PROCESSED, SHIPPED, CANCEL, ALL
Values are UNPROCESSED
, PACKED
, PROCESSED
, SHIPPED
, CANCEL
, or ALL
. Default value is UNPROCESSED
.
Page number, between 1 and 1000
Minimum value is 1
, maximum value is 1000
. Default value is 1
.
Page size, options: [1, 10, 50, 100, 1000]
Values are 1
, 10
, 50
, 100
, or 1000
. Default value is 10
.
the time range of package update, use ISO_8601 format here, e.g. 2020-07-10T13:00:00Z/2020-07-11T15:30:00Z
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"
{
"code": 42,
"message": "string",
"data": [],
"total": 42
}
{
"code": 42,
"message": "string",
"data": [],
"total": 42
}
Requests waybill data from specified carrier in Freight Forwarding DB. Receives waybill details in return, most carriers provide id and PDF packing label
Carrier name to ship, e.g. samarkand.sfexpress.test
Package to ship for Freight Forwarding DB
Operation for Freight Forwarding DB, available options: QUERY, QUERY_PRODUCT, QUERY_WAYBILL. QUERY is deprecated
Default value is QUERY_WAYBILL
.
Item keys, the key value could be tracking reference(QUERY_WAYBILL) or product sku(QUERY_PRODUCT)
Not more than 100
elements. Default value is []
(empty).
Page number
Minimum value is 1
.
Page size
Minimum value is 1
, maximum value is 100
.
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}'
{
"operation": "QUERY_WAYBILL",
"itemKeys": [
"SF1035215690597",
"SF1025950147480"
],
"pageNo": 1,
"pageSize": 10
}
{
"code": 42,
"message": "string",
"data": [],
"total": 42
}
{
"code": 42,
"message": "string",
"data": [],
"total": 42
}
Update product data with specified carrier in Freight Forwarding DB.
Carrier name to ship, e.g. samarkand.sfexpress.test
Package to ship for Freight Forwarding DB
The barcode of product
The number of stock keeping unit
The brand name of current product
The product name
Chinese name of product
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
The model of current product.
Legal first unit of measurement for customs product
Legal second unit of measurement for customs product
The quantity unit code customs purpose. Declaration Unit
Country of origin of of product
Use Kilogram as the basic unit of mass
Use Kilogram as the basic unit of mass
The spec of current product
The description of product
Chinese description of product
Additional image urls
Available store ids of product
Recommended retail price, unit is China Yuan
Recommended retail price, unit is Great Britain Pound
The returned filing id of current SKU from customs
The ingredients of current product.
Product tax rate for cross-border e-commerce(%)
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}'
{
"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
}
{
"code": 42,
"message": "string",
"data": [],
"total": 42
}
{
"code": 42,
"message": "string",
"data": [],
"total": 42
}
carriers information
The carrier name
curl \
-X GET https://nomad.samarkand-global.cn/pilot/carriers/ \
-H "x-ca-key: $API_KEY"
{
"code": 42,
"message": "string",
"data": [],
"total": 42
}
{
"code": 42,
"message": "string",
"data": [],
"total": 42
}
Manage batches for shipping Royal Mail parcels in the UK only.
The carrier name
curl \
-X POST https://nomad.samarkand-global.cn/pilot/ship/{carrier}/create-batch \
-H "x-ca-key: $API_KEY"
{
"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
}
{
"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
}
Add a parcel to a batch for UK shipments only.
curl \
-X POST https://nomad.samarkand-global.cn/pilot/ship/{carrier}/batch/{batch_id}/add-to-batch \
-H "x-ca-key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"waybillId":"string"}'
{
"waybillId": "string"
}
{
"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
}
{
"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
}
Add a parcel to a batch for UK shipments only.
curl \
-X POST https://nomad.samarkand-global.cn/pilot/ship/{carrier}/batch/{batch_id}/remove-from-batch \
-H "x-ca-key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"waybillId":"string"}'
{
"waybillId": "string"
}
{
"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
}
{
"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
}
Create a scanform (manifest) for a batch
curl \
-X POST https://nomad.samarkand-global.cn/pilot/ship/{carrier}/batch/{batch_id}/create-scan-form \
-H "x-ca-key: $API_KEY"
{
"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
}
{
"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
}
The callback endpoints of logistics, available provider haiku.
ID of the logistics provider.
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"}}'
{
"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"
}
}
{
"success": "success",
"errorcode": "string",
"errormsg": "string"
}
{
"success": "success",
"errorcode": "string",
"errormsg": "string"
}
{
"success": "success",
"errorcode": "string",
"errormsg": "string"
}
Inventory endpoints of logistics, available supplier jingdong.
Query products details from third party logistics company.
The carrier name
Product number used in warehouse.
Stock status, options: 1, Good product; 2, Defective product; 3, Samples.
Values are GOOD
, DEFECTIVE
, or SAMPLE
.
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 number, required for shop stock query.
Page number, between 1 and 1000
Minimum value is 1
, maximum value is 1000
. Default value is 1
.
Page size, options: [1, 10, 50, 100, 1000]
Values are 1
, 10
, 50
, 100
, or 1000
. Default value is 10
.