Through the shipping account provided by the carrier, you can create a shipping label, and use the local printer to print out the shipping label.
POST:https://app.kd100.com/sendAssistant/order/apiCall
POST
https://app.kd100.com/sendAssistant/order/apiCall
Content-Type: application/json
API-Key: Enter your API Key here
signature: MD5(json+API-Key+SecretAccessKey)
Name | Data Type | Required | Note | |
---|---|---|---|---|
account_id | string | true | Monthly statement or payment account | |
account_name | string | false | The username of your monthly statement | |
account_secret | string | false | User password | |
account_key | string | false | Account parameter | |
code | string | false | Account parameter | |
carrier_id | string | false | Carrier code, must user lowercase letters | |
ship_to | ||||
name | string | true | ||
mobile_phone | string | true | ||
address1 | string | true | Receiving address | |
address2 | string | false | Prefecture | Country: as a supplement to receiving address | |
state_province | string | false | State | Province: as a supplement to receiving address | |
company | string | false | Company name | |
country_code | string | true | Country ISO code. For example, CN stands for China and US stands for United States of America. | |
city | string | true | ||
postal_code | string | true | ||
landline_phone | string | false | Phone number | |
string | false | Email address | ||
tax_id | string | false | ||
tax_type | string | false | Taxpayer type | |
vat_number | string | false | VAT number; used in European countries, UK included. | |
eori_number | string | false | EORI number: used for customs clearance in the European Union | |
ioss_number | string | false | IOSS number | |
ship_from | ||||
name | string | true | ||
mobile_phone | string | true | ||
address1 | string | true | sending address | |
address2 | string | false | Prefecture | Country: as a supplement to sending address | |
state_province | string | false | State | Province: as a supplement to sending address | |
company | string | false | Company name | |
country_code | string | true | Country ISO code. For example, CN stands for China and US stands for United States of America. | |
city | string | true | ||
postal_code | string | true | ||
landline_phone | string | false | Phone number | |
string | false | Email address | ||
tax_id | string | false | ||
tax_type | string | false | Taxpayer type | |
vat_number | string | false | VAT number; used in European countries, UK included. | |
eori_number | string | false | EORI number: used for customs clearance in the European Union | |
ioss_number | string | false | IOSS number | |
contents_explanation | string | false | Description of the goods | |
shipping_service | string | false | Product type | |
notes | string | false | ||
total_customs_value | Double | false | Declared value | |
unit_of_measurement | string | false | SI is the International System of Units | |
incoterm | string | true | Trade Terms: CFR, DAP, etc. | |
currency | string | true | Currency. CNY is the default. | |
packages | Array[Object] | true | Package info | |
customs_items | Array[Object] | false | Export info | |
customs_duties_payment | Object | false | Customs duty payment. The recipient is going to pay customs duty by default. | |
shipping_cost_payment | Object | false | Shipping cost payment method | |
customs_clearance | Object | false | Customs Clearance information | |
invoice | Object | false | ||
route_id | string | false | Route ID (Reauired for J&T International) | |
total_actual_weight | Double | true | Weight | |
packageInfos | height | Double | false | Height. Unit: centimeter |
width | Double | false | Width. Unit: centimeter | |
length | Double | false | Length. Unit: centimeter | |
weight | Double | false | Weight. Unit: kilogram | |
reference | string | false | Some notes about the package | |
exportInfos | ||||
net_weight | Double | false | Net weight. Unit: kilogram | |
gross_weight | Double | false | Gross weight. Unit: kilogram | |
country_code | string | true | Manufacturing country | |
unit_price | Double | true | ||
quantity | Integer | true | Quantity. 1 is the default. | |
units | string | false | Counting unit (required). PCS if the default. | |
contents_explanation | string | false | Description of the goods | |
export_commodity_code | string | false | Export commodity code. It is recommended to fill in this for faster customs clearance. | |
import_commodity_code | string | false | Import commodity code. It is recommended to fill in this for faster customs clearance. | |
dutiesPaymentType | ||||
paid_by | string | false | Payment method.DDU: the receiver is responsible for paying the duties. DDP: the sender is responsible for paying the duties | |
account_id | string | false | Account | |
freightPaymentType | ||||
paid_by | string | false | Paid by: Shipper or Consignee. Shipper is going to make payment by default. | |
account_id | string | false | Account | |
customsClearance | ||||
purpose | string | false | Export purpose | |
isDocument | boolean | false | Is document? The default answer is ‘True’. | |
invoiceInfo | ||||
date | string | true | Date of invoice (yyyy-mm-dd) | |
number | string | true | Invoice number | |
type | string | false | Invoice number. The default is commercial invoice. | |
title | string | true | Invoice title | |
signature | string | true | Invoice signature (base64 string) | |
pltEnable | boolean | false | Start paperless trading? Choose ‘True’ or ‘False’. |
{
"account_id": "123456",
"account_name": "1231",
"account_secret": "abc123",
"account_key": "",
"code": "",
"carrier_id": "dhl",
"ship_to": {
"name": "Cindy Martinez",
"mobile_phone": "(86)13512345678",
"address1": "Apoquindo 4001, of. 501. Las Condes",
"address2": "Santiago, Chile",
"state_province": "",
"company": "Lamaignere Chile S.A.",
"country_code": "CL",
"city": "Santiago",
"postal_code": "7550000",
"landline_phone": "+56 (9) 76164365",
"email": "12344699@qq.com",
"tax_id": "",
"tax_type": "",
"vat_number": "IOSS23249923",
"eori_number": "IOSS23249923",
"ioss_number": "IOSS23249923"
},
"ship_from": {
"name": "Kaka",
"mobile_phone": "13500000000",
"address1": "Kingdee Software Park",
"address2": "Hi-tech Park,Nanshang District",
"state_province": "",
"company": "QIAN HAI BAI DI",
"country_code": "CN",
"city": "SHEN ZHEN",
"postal_code": "518057",
"landline_phone": "0755-5890123",
"email": "12344655@qq.com",
"tax_id": "",
"tax_type": "",
"vat_number": "IOSS23249923",
"eori_number": "IOSS23249923",
"ioss_number": "IOSS23249923"
},
"contents_explanation": "test don't ship",
"total_actual_weight": 0.1,
"shipping_service": "parcel-normal",
"notes": "just a test demo",
"total_customs_value": 10.00,
"unit_of_measurement": "SI",
"incoterm": "DAP",
"currency": "USD",
"packages": [
{
"height": 11.00,
"width": 20.00,
"length": 10.00,
"weight": 0.10,
"reference": "just a user remark"
}
],
"customs_items": [
{
"net_weight": 0.10,
"gross_weight": 0.10,
"country_code": "CN",
"unit_price": 10.00,
"quantity": 1,
"units": "PCS",
"contents_explanation": "test",
"import_commodity_code": "6109100021",
"export_commodity_code": "6109100021"
}
],
"customs_duties_payment": {
"paid_by": "DDU",
"account_id": ""
},
"shipping_cost_payment": {
"paid_by": "SHIPPER",
"account_id": "601470543"
},
"customs_clearance": {
"purpose": "",
"is_document": false
},
"invoice": {
"invoice_date": "2021-08-12",
"invoice_number": "15462412",
"invoice_type": "",
"title": "test",
"signature": "base64 string or plain",
"paperless_invoice": true
},
"route_id": ""
}
Name | Data Type | Required | Note | ||
---|---|---|---|---|---|
status | string | true | Return status code | ||
message | string | true | Return reports | ||
data | |||||
tracking_number | string | true | |||
package_number | string | false | Package number | ||
invoice | |||||
base64_string | string | true | The base64 string of an invoice | ||
type | string | true | File type | ||
invoice_url | string | true | Short URL (valid in one month) | ||
label | |||||
base64_string | string | true | The base64 string of a label | ||
type | string | true | File type | ||
label_url | string | true | Short URL (valid in one month) | ||
sub_numbers | string | false | Sub tracking number |
{
"code": 200,
"data": {
"tracking_number": "1254089060",
"label": {
"type": "pdf",
"base64_string": "base64_string==",
"label_url": "https://app.kd100.com/interShip/getFile?fileName=123.pdf"
},
"invoice": {
"type": "PDF",
"base64_string": "base64_string==",
"invoice_url": "https://app.kd100.com/interShip/getFile?fileName=456.pdf"
},
"package_number": "JD011100003656147766",
"sub_numbers": null
},
"message": "success",
}
carrier Code | carrier | account_id | account_key | account_secret | account_name | code |
---|---|---|---|---|---|---|
dhl | DHL | partnerId | partnerSecret | partnerName | ||
fedex | FEDEX | partnerId | partnerKey | partnerSecret | code | |
jet | J&T International | Customer identification | Customer key | Customer company number | ||
chinapost | Chinapost | partnerCode | signKey | |||
baishiguoji | Best Express | partnerCode | partnerKey | |||
disifang | 4PX | partnerId | ||||
jdme | JD International Logistics | GatewayUser | operator | customerCode | ||
ups | UPS | partnerId | ||||
naqel | NAQEL | LoadTypeID | ClientID | Password | ||
imile | iMile | customerId | api key | |||
auspost | Australia Post | Account number | Key | Password |
county | countycode |
---|---|
China | CN |
Indonesian | ID |
Portugal | PT |
Danmark | DK |
Luxembourg | LU |
Croatia | HR |
Ukraine | UA |
Hungary | HU |
The United States | US |
Uruguay | UY |
India | IN |
Mexico | MX |
Italy | IT |
Malaysia | MY |
Spain | ES |
Argentina | AR |
Brazil | BR |
Chile | CL |
Colombia | CO |
Peru | PE |
United Arab Emirates | AE |
carrier(code) | Shipping_service |
---|---|
DHL(dhl) | |
document-normal | |
parcel-normal | |
FEDEX(fedex) | |
International First | |
International Priority | |
International Economy |