CIRRO API V1.0.1
1 Introduction
1.1 Integration Process
Elogistic will provide app_key and app_secret.
Retrieve access_token by app_key and app_secret, every access_token has an expiration date.
Get data by access_token.
The system only supports UTF-8 encoding
1.2 Rate Limiting
Each request_id(Randomly generated) can only be requested once
The maximum amount of requests in 1 minute is 600 for each API.
1.3 Request and Response Format:
Content -Type :application/json ,
Accept -Language : en-US
Authorization :Bearer $token {
"request_id ": "request unique ID" request_time ": "request timestamp" request_data ": "request parameters" {
"code ": "0 success" message ": "response message" data ": "response data, JSON format" 2 Auth
2.1 Get Access Token
API description： Get Access token, use it before the expiration date.
Test
2.1.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {
"app_token": "",
"app_key": ""
}
}2.1.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
-- app_token
string
Yes
App Key
-- app_key
string
Yes
App Token
2.1.3 Response
Field
Type
Description
code
int
message
string
data
object
-- access_token
string
Access Token
-- expired_at
int
Expiration timestamp
2.1.4 Response Example
{
"code": 0,
"message": "",
"data": {
"access_token": "",
"expired_at": 0
}
}3 Country
3.1 Country List
3.1.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {}
}3.1.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
3.1.3 Response
Field
Type
Description
code
int
message
string
data
object
-- list
object[]
Country list
-- country_code
string
Two-letter country codes
-- country_name_en
string
Country name
3.1.4 Response Example
{
"code": 0,
"message": "",
"data": {
"list": [
{
"country_code": "",
"country_name_en": ""
}
]
}
}4 ShippingMethod
4.1 ShippingMethod List
4.1.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {}
}4.1.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
4.1.3 Response
Field
Type
Description
code
int
message
string
data
object
-- list
object[]
Shipping method list
-- warehouse_code
string
Warehouse code
-- warehouse_name
string
Warehouse name
-- sm_list
object[]
Shipping method list
-- sm_code
string
Shipping method code
-- sm_name
string
Shipping method name
-- type
string
Shipping method type, 0= last mile courier, 6= Self pick-u
-- is_signature
int
Whether support signature service, 0=No, 1=Yes
-- sp_code
string
Service provider code
-- order_business_type
int
0:Full fulfilment service 1: Warehouse service only;when create order,this field is consistent with the `order_business_type` of the order
4.1.4 Response Example
{
"code": 0,
"message": "",
"data": {
"list": [
{
"warehouse_code": "",
"warehouse_name": "",
"sm_list": [
{
"sm_code": "",
"sm_name": "",
"type": "",
"is_signature": 0,
"sp_code": "",
"order_business_type": 0
}
]
}
]
}
}5 Warehouse
5.1 Warehouse List
5.1.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {}
}5.1.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
5.1.3 Response
Field
Type
Description
code
int
message
string
data
object
-- list
object[]
Warehouse List
-- warehouse_code
string
Warehouse code
-- warehouse_name
string
Warehouse name
-- country_code
string
Two-letter country code for warehouse
5.1.4 Response Example
{
"code": 0,
"message": "",
"data": {
"list": [
{
"warehouse_code": "",
"warehouse_name": "",
"country_code": ""
}
]
}
}6 Importer
6.1 Importer List
6.1.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {}
}6.1.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
6.1.3 Response
Field
Type
Description
code
int
message
string
data
object
-- list
object[]
Importer list
-- cv_id
string
Importer ID/Exporter ID
-- vat_type
string
Type 1=Importer 2=Exporter
-- company_name
string
Company Name
-- vat_number
string
VAT number
-- exemption_number
string
Exemption number
-- eori
string
EORI
-- warehouse_code
string
Warehouse code
-- cv_contacter
string
Contact name
-- cv_contact_phone
string
Phone number
-- vat_email
string
Email address
-- cv_status
string
Importer/Exporter status: 0=Discard, 1=Verifying, 2=Available, 3=Rejected
-- cv_create_time
string
Creation Time
-- auditing_time
string
Submission Time
-- cv_update_time
string
Update Time
-- cv_post_address
string
Company address
6.1.4 Response Example
{
"code": 0,
"message": "",
"data": {
"list": [
{
"cv_id": "",
"vat_type": "",
"company_name": "",
"vat_number": "",
"exemption_number": "",
"eori": "",
"warehouse_code": "",
"cv_contacter": "",
"cv_contact_phone": "",
"vat_email": "",
"cv_status": "",
"cv_create_time": "",
"auditing_time": "",
"cv_update_time": "",
"cv_post_address": ""
}
]
}
}7 Product
7.1 Category List
7.1.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {}
}7.1.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
7.1.3 Response
Field
Type
Description
code
int
message
string
data
object
-- list
object[]
Category List
-- category_id
int
Category id
-- declare_name
string
Category name
-- declare_name_en
string
Product Name
7.1.4 Response Example
{
"code": 0,
"message": "",
"data": {
"list": [
{
"category_id": 0,
"declare_name": "",
"declare_name_en": ""
}
]
}
}7.2 Unit List
7.2.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {}
}7.2.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
7.2.3 Response
Field
Type
Description
code
int
message
string
data
object
-- data
object[]
Product unit
-- id
int
id
-- value
string
Unit
7.2.4 Response Example
{
"code": 0,
"message": "",
"data": {
"data": [
{
"id": 0,
"value": ""
}
]
}
}7.3 Product Create
7.3.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {
"product_sku": "",
"product_name_en": "",
"product_weight": "",
"product_length": "",
"product_width": "",
"product_height": "",
"goods_attribute": 0,
"product_package_type": 0,
"reference_no": "",
"is_brand": 0,
"product_brand": "",
"is_verify": 0,
"product_model": "",
"product_url": "",
"unit": "",
"product_picture_url_list": [
""
],
"category_id": 0,
"certificate_list": [
""
],
"import_countries": [
{
"country_code": "",
"declared_value": 0.01
}
],
"copyright_patent": 0,
"return_auth": 0,
"rebrand_barcode": "",
"is_inbound_collect_serial_number": 0,
"is_collect_serial_number": 0,
"is_return_collect_serial_number": 0,
"is_whether_batch_management": 0,
"batch_info": {
"validity_period_info": {
"is_whether_validity_management": 0,
"shelf_life_days": 0,
"warning_days": 0,
"outbound_threshold": 0,
"inbound_threshold": 0
}
},
"sku_wrapper_type": 0,
"map_barcode_list": [
""
]
}
}7.3.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
-- product_sku
string
Yes
Product SKU (unique identifier of the product), maximum 24 characters
-- product_name_en
string
Yes
Product name, maximum 255 characters
-- product_weight
string
Yes
weight (lb) [In the range of 0.001-9999.999, and retains up to 3 decimal places]
-- product_length
string
Yes
length (inch) [In the range of 0.01-9999.99, and retains up to 2 decimal places]
-- product_width
string
Yes
width (inch) [In the range of 0.01-9999.99, and retains up to 2 decimal places]
-- product_height
string
Yes
height (inch) [In the range of 0.01-9999.99, and retains up to 2 decimal places]
-- goods_attribute
int
Yes
Product attribute 0=General product，1=Battery contained，2=Battery, 3=Textile，4=Fragile goods
-- product_package_type
int
Yes
Parcel type, 0=Package, 1=Envelope
-- reference_no
string
No
Unique reference identifier of the product
-- is_brand
int
Yes
Weather brand, 0=No 1=Yes
-- product_brand
string
No
Product brand, maximum 100 characters. This field required when is_brand=1
-- is_verify
int
Yes
Whether verify: value 0=Only create to draft status, value 1=Create and submit to verify. Default value is 0. If choose create and submit to verify, product will be available and can not be edited.
-- product_model
string
No
Product model, maximum 100 characters. This field required when is_brand=1
-- product_url
string
Yes
Product link (URL)
-- unit
string
Yes
Unit. Enum: pcs, meter, box.. more refers to unit list. The default value is pcs.
-- product_picture_url_list
string[]
No
Product image url
-- category_id
int
Yes
Category id, refers to GetProductCategory
-- certificate_list
string[]
No
Product Certification and other Intellectual Property Related Documents, up to 30 attachments
-- import_countries
object[]
Yes
Destination country, refers to Country List
-- country_code
string
Yes
Two-letter country code, refers to Country List
-- declared_value
float
Yes
Product Price,up to 2 decimal places
-- copyright_patent
int
Yes
Copyright/Patent 0=none 1=Owner for Copyright/Patent 2=Use Other’s with Licensing 4=Use Other’s without Licensing
-- return_auth
int
Yes
Return authorization 0=No 1=Yes
-- rebrand_barcode
string
No
Replacement code
-- is_inbound_collect_serial_number
int
No
Inbound Serial Number Scan, The default value is 0, 0=No 1=Yes
-- is_collect_serial_number
int
No
Outbound Serial Number Scan, The default value is 0, 0=No 1=Yes
-- is_return_collect_serial_number
int
No
Return Serial Number Scan, The default value is 0, 0=No 1=Yes
-- is_whether_batch_management
int
Yes
Batch management: 0 No, 1 Yes
-- batch_info
object
No
Batch information
-- validity_period_info
object
No
-- is_whether_validity_management
int
No
Is shelf life: 0 No, 1 Yes
-- shelf_life_days
int
No
Shelf life (days)
-- warning_days
int
No
Warning days
-- outbound_threshold
int
No
Outbound threshold
-- inbound_threshold
int
No
Inbound threshold
-- sku_wrapper_type
int
No
Sku packing Type, The default value is 1, 1=PRE-package 2=Sales package 3=Original package
-- map_barcode_list
string[]
No
If you choose not to use the CIRRO SKU barcode, you must ensure that the Barcode you provided is visible and scannable on the outer surface of your SKUs. Our warehouse staff are not authorized to open packages of SKUs for the purpose of scanning barcodes. Failure to attach a barcode on the outer surface of SKUs may result in a labelling fee and increased picking errors.
7.3.3 Response
Field
Type
Description
code
int
message
string
data
object
-- product_sku
string
SKU
-- product_barcode
string
Barcode
7.3.4 Response Example
{
"code": 0,
"message": "",
"data": {
"product_sku": "",
"product_barcode": ""
}
}7.4 Product Update
7.4.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {
"product_sku": "",
"product_name_en": "",
"product_weight": "",
"product_length": "",
"product_width": "",
"product_height": "",
"goods_attribute": 0,
"product_package_type": 0,
"reference_no": "",
"is_brand": 0,
"product_brand": "",
"is_verify": 0,
"product_model": "",
"product_url": "",
"unit": "",
"product_picture_url_list": [
""
],
"category_id": 0,
"import_countries": [
{
"country_code": "",
"declared_value": 0.01
}
],
"copyright_patent": 0,
"certificate_list": [
""
],
"return_auth": 0,
"rebrand_barcode": "",
"is_inbound_collect_serial_number": 0,
"is_collect_serial_number": 0,
"is_return_collect_serial_number": 0,
"is_whether_batch_management": 0,
"batch_info": {
"validity_period_info": {
"is_whether_validity_management": 0,
"shelf_life_days": 0,
"warning_days": 0,
"outbound_threshold": 0,
"inbound_threshold": 0
}
},
"sku_wrapper_type": 0,
"map_barcode_list": [
""
]
}
}7.4.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
-- product_sku
string
Yes
Product SKU (unique identifier of the product), maximum 24 characters
-- product_name_en
string
Yes
Product name, maximum 255 characters
-- product_weight
string
Yes
weight (lb) [In the range of 0.001-9999.999, and retains up to 3 decimal places]
-- product_length
string
Yes
length (inch) [In the range of 0.01-9999.99, and retains up to 2 decimal places]
-- product_width
string
Yes
width (inch) [In the range of 0.01-9999.99, and retains up to 2 decimal places]
-- product_height
string
Yes
height (inch) [In the range of 0.01-9999.99, and retains up to 2 decimal places]
-- goods_attribute
int
Yes
Product attribute 0=General product，1=Battery contained，2=Battery, 3=Textile，4=Fragile goods
-- product_package_type
int
Yes
Parcel type, 0=Package, 1=Envelope
-- reference_no
string
No
Unique reference identifier of the product
-- is_brand
int
Yes
Weather brand, 0=No 1=Yes
-- product_brand
string
No
Product brand, maximum 100 characters. This field required when is_brand=1
-- is_verify
int
Yes
Whether verify: value 0=Only create to draft status, value 1=Create and submit to verify. Default value is 0. If choose create and submit to verify, product will be available and can not be edited.
-- product_model
string
No
Product model, maximum 100 characters. This field required when is_brand=1
-- product_url
string
Yes
Product link (URL)
-- unit
string
Yes
Unit. Enum: pcs, meter, box.. more refers to unit list. The default value is pcs.
-- product_picture_url_list
string[]
No
Product image url
-- category_id
int
Yes
Category id, refers to GetProductCategory
-- import_countries
object[]
Yes
Destination country, refers to Country List
-- country_code
string
Yes
Two-letter country code, refers to Country List
-- declared_value
float
Yes
Product Price,up to 2 decimal places
-- copyright_patent
int
Yes
Copyright/Patent 0=none 1=Owner for Copyright/Patent 2=Use Other’s with Licensing 4=Use Other’s without Licensing
-- certificate_list
string[]
No
Product Certification and other Intellectual Property Related Documents, up to 30 attachments
-- return_auth
int
Yes
Return authorization 0=No 1=Yes
-- rebrand_barcode
string
No
Replacement code
-- is_inbound_collect_serial_number
int
No
Inbound Serial Number Scan, The default value is 0, 0=No 1=Yes
-- is_collect_serial_number
int
No
Outbound Serial Number Scan, The default value is 0, 0=No 1=Yes
-- is_return_collect_serial_number
int
No
Return Serial Number Scan, The default value is 0, 0=No 1=Yes
-- is_whether_batch_management
int
Yes
Batch management: 0 No, 1 Yes
-- batch_info
object
No
Batch information
-- validity_period_info
object
No
-- is_whether_validity_management
int
No
Is shelf life: 0 No, 1 Yes
-- shelf_life_days
int
No
Shelf life (days)
-- warning_days
int
No
Warning days
-- outbound_threshold
int
No
Outbound threshold
-- inbound_threshold
int
No
Inbound threshold
-- sku_wrapper_type
int
No
Sku packing Type, The default value is 1, 1=PRE-package 2=Sales package 3=Original package
-- map_barcode_list
string[]
No
If you choose not to use the CIRRO SKU barcode, you must ensure that the Barcode you provided is visible and scannable on the outer surface of your SKUs. Our warehouse staff are not authorized to open packages of SKUs for the purpose of scanning barcodes. Failure to attach a barcode on the outer surface of SKUs may result in a labelling fee and increased picking errors.
7.4.3 Response
Field
Type
Description
code
int
message
string
data
object
-- product_sku
string
SKU
-- product_barcode
string
Barcode
7.4.4 Response Example
{
"code": 0,
"message": "",
"data": {
"product_sku": "",
"product_barcode": ""
}
}7.5 Product List
7.5.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {
"product_sku_list": [
""
],
"product_update_time_from": "",
"product_update_time_to": "",
"page": 0,
"page_size": 0
}
}7.5.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
-- product_sku_list
string[]
No
Multiple SKUs, array format
-- product_update_time_from
string
No
Update time from (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
-- product_update_time_to
string
No
Update time to (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
-- page
int
No
Number of the current page, default value is page 1
-- page_size
int
No
Number of results per page, default value is 20, maximum value is 200
7.5.3 Response
Field
Type
Description
code
int
message
string
data
object
-- list
object[]
-- product_sku
string
Product SKU (unique identifier of the product)
-- product_name_en
string
Product name
-- product_status
string
Product status: X=Discard, D=Draft, S=Available, W=Verifying, R=Fail to be verified
-- product_weight
float
Product price
-- product_length
float
Forecast weight (lb)
-- product_width
float
Forecast length (inch)
-- product_height
float
Forecast width (inch)
-- receive_weight
float
Forecast height (inch)
-- receive_length
float
Received weight (lb)
-- receive_width
float
Received length (inch)
-- receive_height
float
Received height (inch)
-- goods_attribute
int
Product attribute 0=General product，1=Battery contained，2=Battery, 3=Textile，4=Fragile goods
-- product_package_type
int
Parcel type, 0=Package, 1=Envelope
-- reference_no
string
Unique reference identifier of the product
-- is_brand
int
Weather brand, 0=No 1=Yes
-- product_brand
string
Product brand
-- product_model
string
Product model
-- product_url
string
Product link (URL)
-- unit
string
Unit. Enum: pcs, meter, box.. more refers to unit list. The default value is pcs.
-- product_picture_url_list
string[]
Product image URL
-- copyright_patent
string
Copyright/Patent of product
-- import_countries
string[]
Destination countries
-- return_auth
int
Return authorization 0=No 1=Yes
-- rebrand_barcode
string
Replacement code
-- is_inbound_collect_serial_number
int
inbound Serial Number Scan: 0=No 1=Yes
-- is_collect_serial_number
int
Outbound Serial Number Scan: 0=No 1=Yes
-- is_return_collect_serial_number
int
Return Serial Number Scan: 0=No 1=Yes
-- is_whether_batch_management
int
Batch management: 0 No, 1 Yes
-- is_whether_validity_management
int
Is shelf life: 0 No, 1 Yes
-- sku_wrapper_type
int
Sku packaging type, 1=PRE-package 2=Sales package 3=Original package
-- map_barcode_list
string[]
Barcode: If you choose not to use the CIRRO SKU barcode, you must ensure that the Barcode you provided is visible and scannable on the outer surface of your SKUs. Our warehouse staff are not authorized to open packages of SKUs for the purpose of scanning barcodes. Failure to attach a barcode on the outer surface of SKUs may result in a labelling fee and increased picking errors.
-- page
int
Current page
-- page_size
int
Number of results per page
-- count
int
Total
7.5.4 Response Example
{
"code": 0,
"message": "",
"data": {
"list": [
{
"product_sku": "",
"product_name_en": "",
"product_status": "",
"product_weight": 0.01,
"product_length": 0.01,
"product_width": 0.01,
"product_height": 0.01,
"receive_weight": 0.01,
"receive_length": 0.01,
"receive_width": 0.01,
"receive_height": 0.01,
"goods_attribute": 0,
"product_package_type": 0,
"reference_no": "",
"is_brand": 0,
"product_brand": "",
"product_model": "",
"product_url": "",
"unit": "",
"product_picture_url_list": [
""
],
"copyright_patent": "",
"import_countries": [
""
],
"return_auth": 0,
"rebrand_barcode": "",
"is_inbound_collect_serial_number": 0,
"is_collect_serial_number": 0,
"is_return_collect_serial_number": 0,
"is_whether_batch_management": 0,
"is_whether_validity_management": 0,
"sku_wrapper_type": 0,
"map_barcode_list": [
""
]
}
],
"page": 0,
"page_size": 0,
"count": 0
}
}7.6 Product PrintSku
7.6.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {
"print_size": 0,
"product_sku_list": [
""
]
}
}7.6.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
-- print_size
int
Yes
Print size, 1=3*1, 2=4*1, 3=A4
-- product_sku_list
string[]
Yes
Product SKU (maximum 50 per request)
7.6.3 Response
Field
Type
Description
code
int
message
string
data
object
-- label_image
string
Image returned
-- image_type
int
1：png，2：pdf
7.6.4 Response Example
{
"code": 0,
"message": "",
"data": {
"label_image": "",
"image_type": 0
}
}7.7 Add Destination Country
7.7.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {
"product_country": [
{
"product_sku": "",
"import_country_data": [
{
"country_code": "",
"declared_value": 0.01
}
]
}
]
}
}7.7.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
-- product_country
object[]
Yes
Destination Country Info
-- product_sku
string
Yes
SKU
-- import_country_data
object[]
Yes
Destination Country Info
-- country_code
string
Yes
Two-letter country code, refers to Country List
-- declared_value
float
Yes
Product Price, retains up to 2 decimal places
7.7.3 Response
Field
Type
Description
code
int
message
string
data
object
7.7.4 Response Example
{
"code": 0,
"message": "",
"data": {}
}8 Inbound
8.1 Inbound Create
8.1.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {
"reference_no": "",
"transit_type": 0,
"receiving_shipping_type": 0,
"tracking_number": "",
"warehouse_code": "",
"eta_date": "",
"receiving_desc": "",
"verify": 0,
"box_list": [
{
"box_no": 0,
"box_detail_list": [
{
"product_sku": "",
"quantity": 0,
"fba_product_code": "",
"reference_box_no": "",
"sn_list": [
{
"sn_item_list": [
""
]
}
]
}
]
}
],
"shiper_address": {
"sa_contacter": "",
"sa_contact_phone": "",
"sa_state": "",
"sa_city": "",
"sa_address1": "",
"sa_country_code": ""
},
"cv_id": ""
}
}8.1.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
-- reference_no
string
No
Reference No. of the warehouse receiving order. Maximum 50 characters
-- transit_type
int
Yes
Warehouse receiving order type: 0=FBM (Fulfillment by Merchant) Inbound 5=FBA Removal Order
-- receiving_shipping_type
int
Yes
Shipping mode: 0=Air transport, 1=seaborne bulk cargo 2=Express delivery, 3=Railway container, 4=Sea container, 5=Railway bulk
-- tracking_number
string
No
Tracking No./Sea cabinet No. Maximum 35 characters.Required when create FBA removal order.Required if you choose 1(create and submit to verify) for verify value.
-- warehouse_code
string
Yes
Warehouse code, refers to get warehouse/list
-- eta_date
string
No
Estimated time of arrival for this receiving order (ISO 8601 time format, eg: 2000-01-02T13:48:19-05:00)
-- receiving_desc
string
No
Note, maximum 200 characters
-- verify
int
No
Whether verify: value 0=Only create to draft status, value 1=Create and submit to verify. Default value is 0. If choose create and submit to verify, receiving order cannot be edited.
-- box_list
object[]
Yes
Inbound order details
-- box_no
int
Yes
Box Number,The value cannot be equal to 0.
-- box_detail_list
object[]
Yes
Box Number
-- product_sku
string
Yes
SKU
-- quantity
int
Yes
Quantity
-- fba_product_code
string
No
FBA SKU, Required when transit_type=5 (FBA removal order)
-- reference_box_no
string
No
Carton Label Ref . maximum 30 characters
-- sn_list
object[]
No
serial number list
-- sn_item_list
string[]
No
serial number list
-- shiper_address
object
No
Inbound order shipping address (only for FBM Inbound)
-- sa_contacter
string
Yes
Name, Maximum 15 characters
-- sa_contact_phone
string
Yes
Phone number,Maximum 15 charactersPhone number
-- sa_state
string
Yes
Province/State,Maximum 32 characters
-- sa_city
string
Yes
City, Maximum 32 characters
-- sa_address1
string
Yes
Address 1, Maximum 60 characters
-- sa_country_code
string
Yes
Two-letter country code, Maximum 20 characters
-- cv_id
string
No
Importer cvid (Required, when create inbound order to UK/FR/DE warehouse), Please request "Importer list" to get it.
8.1.3 Response
Field
Type
Description
code
int
message
string
data
object
-- receiving_code
string
Inbound Order
8.1.4 Response Example
{
"code": 0,
"message": "",
"data": {
"receiving_code": ""
}
}8.2 Inbound Update
8.2.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {
"receiving_code": "",
"reference_no": "",
"transit_type": 0,
"receiving_shipping_type": 0,
"tracking_number": "",
"warehouse_code": "",
"eta_date": "",
"receiving_desc": "",
"verify": 0,
"box_list": [
{
"box_no": 0,
"box_detail_list": [
{
"product_sku": "",
"quantity": 0,
"fba_product_code": "",
"reference_box_no": "",
"sn_list": [
{
"sn_item_list": [
""
]
}
]
}
]
}
],
"shiper_address": {
"sa_contacter": "",
"sa_contact_phone": "",
"sa_state": "",
"sa_city": "",
"sa_address1": "",
"sa_country_code": ""
},
"cv_id": ""
}
}8.2.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
-- receiving_code
string
Yes
Unique id of the inbound order(warehouse receiving order)
-- reference_no
string
No
Reference No. of the warehouse receiving order. Maximum 50 characters
-- transit_type
int
Yes
Warehouse receiving order type: 0=FBM (Fulfillment by Merchant) Inbound 5=FBA Removal Order
-- receiving_shipping_type
int
Yes
Shipping mode: 0=Air transport, 1=seaborne bulk cargo 2=Express delivery, 3=Railway container, 4=Sea container, 5=Railway bulk
-- tracking_number
string
No
Tracking No./Sea cabinet No. Maximum 35 characters.Required when create FBA removal order.Required if you choose 1(create and submit to verify) for verify value.
-- warehouse_code
string
Yes
Warehouse code, refers to get warehouse/list
-- eta_date
string
No
Estimated time of arrival for this receiving order (ISO 8601 time format, eg: 2000-01-02T13:48:19-05:00)
-- receiving_desc
string
No
Note, maximum 200 characters
-- verify
int
No
Whether verify: value 0=Only create to draft status, value 1=Create and submit to verify. Default value is 0. If choose create and submit to verify, receiving order cannot be edited.
-- box_list
object[]
Yes
Inbound order details
-- box_no
int
Yes
Box Number,The value cannot be equal to 0.
-- box_detail_list
object[]
Yes
Box Number
-- product_sku
string
Yes
SKU
-- quantity
int
Yes
Quantity
-- fba_product_code
string
No
FBA SKU, Required when transit_type=5 (FBA removal order)
-- reference_box_no
string
No
Carton Label Ref . maximum 30 characters
-- sn_list
object[]
No
serial number list
-- sn_item_list
string[]
No
serial number list
-- shiper_address
object
No
Inbound order shipping address (only for FBM Inbound)
-- sa_contacter
string
Yes
Name, Maximum 15 characters
-- sa_contact_phone
string
Yes
Phone number,Maximum 15 charactersPhone number
-- sa_state
string
Yes
Province/State,Maximum 32 characters
-- sa_city
string
Yes
City, Maximum 32 characters
-- sa_address1
string
Yes
Address 1, Maximum 60 characters
-- sa_country_code
string
Yes
Two-letter country code, Maximum 20 characters
-- cv_id
string
No
Importer cvid (Required, when create inbound order to UK/FR/DE warehouse), Please request "Importer list" to get it.
8.2.3 Response
Field
Type
Description
code
int
message
string
data
object
-- receiving_code
string
Inbound Order
8.2.4 Response Example
{
"code": 0,
"message": "",
"data": {
"receiving_code": ""
}
}8.3 Inbound Delete
8.3.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {
"receiving_code": ""
}
}8.3.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
-- receiving_code
string
Yes
Inbound Order
8.3.3 Response
Field
Type
Description
code
int
message
string
data
object
8.3.4 Response Example
{
"code": 0,
"message": "",
"data": {}
}8.4 Inbound Detail
8.4.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {
"receiving_code": ""
}
}8.4.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
-- receiving_code
string
Yes
Inbound Order
8.4.3 Response
Field
Type
Description
code
int
message
string
data
object
-- receiving_code
string
Unique id of the inbound order(warehouse receiving order)
-- receiving_shipping_type
int
Shipping mode: 0=Air transport, 1=seaborne bulk cargo 2=Express delivery, 3=Railway transport, 4=Sea container
-- transit_type
int
Warehouse receiving order type: 0=FBM (Fulfillment by Merchant) Inbound 5=FBA Removal Order
-- reference_no
string
Reference No. of the warehouse receiving order
-- receiving_status
int
Inbound order status: 0=Discard 1=Draft 5=In Transit 6=Receiving 7=Receipt Complete 8=Stocking Complete
-- receiving_desc
string
Note
-- create_at
string
Creation time (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
-- udpate_at
string
Update time (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
-- warehouse_code
string
Receiving warehouse code
-- box_total_count
int
Forecast qty of boxes
-- sku_total_count
int
Forecast qty of SKUs
-- tracking_number
string
Tracking No.
-- eta_date
string
Estimated time of arrival for this receiving order (ISO 8601 time format, eg: 2000-01-02T13:48:19-05:00)
-- shiper_address
object
Shipping address
-- sa_contacter
string
Name
-- sa_contact_phone
string
Phone number
-- sa_country_code
string
Two-letter country code
-- sa_state
string
Province/State
-- sa_city
string
City
-- sa_address1
string
Address1
-- overseas_detail
object[]
Inbound order details by Box
-- box_no
int
Box number
-- product_sku
string
SKU
-- fba_product_code
string
fba SKU
-- overseas_pre_count
int
Forecast qty
-- overseas_receiving_count
int
Receiving qty
-- overseas_shelves_count
int
Receiving qty
-- reference_box_no
string
Carton Label Ref#
-- inbound_list_detail
object[]
Inbound order details by SKU
-- product_sku
string
SKU
-- fba_product_code
int
FBA SKU
-- forecast_qty
int
Total forecast qty
-- putaway_qty
int
Total put away qty
-- update_time
string
Update time (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
-- shelf_lift
string
Is shelf life(0:No, 1:Yes)
-- shelf_lift_day
string
Shelf life (days)
-- shelf_life_list
object[]
Shelf life list
-- manufacture_date
string
date of manufacture (format, eg: 2000-01-02)
-- expiration_date
string
date of expiration (format, eg: 2000-01-02)
-- rbd_putaway_qty
int
Quantity of warehouse shelves
-- sn_item_list
string[]
serial number list
-- cv_id
int
cv_id
8.4.4 Response Example
{
"code": 0,
"message": "",
"data": {
"receiving_code": "",
"receiving_shipping_type": 0,
"transit_type": 0,
"reference_no": "",
"receiving_status": 0,
"receiving_desc": "",
"create_at": "",
"udpate_at": "",
"warehouse_code": "",
"box_total_count": 0,
"sku_total_count": 0,
"tracking_number": "",
"eta_date": "",
"shiper_address": {
"sa_contacter": "",
"sa_contact_phone": "",
"sa_country_code": "",
"sa_state": "",
"sa_city": "",
"sa_address1": ""
},
"overseas_detail": [
{
"box_no": 0,
"product_sku": "",
"fba_product_code": "",
"overseas_pre_count": 0,
"overseas_receiving_count": 0,
"overseas_shelves_count": 0,
"reference_box_no": ""
}
],
"inbound_list_detail": [
{
"product_sku": "",
"fba_product_code": 0,
"forecast_qty": 0,
"putaway_qty": 0,
"update_time": "",
"shelf_lift": "",
"shelf_lift_day": "",
"shelf_life_list": [
{
"manufacture_date": "",
"expiration_date": "",
"rbd_putaway_qty": 0
}
],
"sn_item_list": [
""
]
}
],
"cv_id": 0
}
}8.5 Inbound PrintBox
8.5.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {
"receiving_code": "",
"receiving_box_no_list": [
""
],
"print_size": 0
}
}8.5.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
-- receiving_code
string
Yes
Unique id of the inbound order(warehouse receiving order)
-- receiving_box_no_list
string[]
Yes
Box Number, maximum array length is 50
-- print_size
int
Yes
Print size: 1=4*2, 2=4*4, 3=4*6, 4=A4
8.5.3 Response
Field
Type
Description
code
int
message
string
data
object
-- label_image
string
Return image
-- image_type
int
1：png，2：pdf
8.5.4 Response Example
{
"code": 0,
"message": "",
"data": {
"label_image": "",
"image_type": 0
}
}8.6 Inbound List
8.6.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {
"search_type": 0,
"tracking_number": "",
"container_number": "",
"receiving_shipping_type": 0,
"receiving_type": 0,
"warehouse_code": "",
"product_barcode": "",
"receiving_add_time_for": "",
"receiving_add_time_to": "",
"receiving_status": 0,
"page": 0,
"page_size": 0
}
}8.6.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
-- search_type
int
No
Search type, 1=Tracking No. 2=Sea Cabinet No.
-- tracking_number
string
No
Tracking No.
-- container_number
string
No
Sea Cabinet No., available when search type=2
-- receiving_shipping_type
int
No
Shipping mode: 0=Air transport, 1=seaborne bulk cargo 2=Express delivery, 3=Railway container, 4=Sea container, 5=Railway bulk
-- receiving_type
int
No
Warehouse receiving order type: 0=FBM (Fulfillment by Merchant) Inbound 5=FBA Removal Order
-- warehouse_code
string
No
Warehouse code, refers to get warehouse/list
-- product_barcode
string
No
SKU code
-- receiving_add_time_for
string
No
Receiving time from (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
-- receiving_add_time_to
string
No
Receiving time to (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
-- receiving_status
int
No
Inbound order status: 0=Discard 1=Draft 5=In Transit 6=Receiving 7=Receipt Complete 8=Stocking Complete
-- page
int
No
Number of the current page, default value is page 1
-- page_size
int
No
Number of results per page, default value is 20, maximum value is 200
8.6.3 Response
Field
Type
Description
code
int
message
string
data
object
-- list
object[]
-- receiving_code
string
Inbound order id
-- reference_no
string
Reference No. of the inbound order (warehouse receiving order)
-- transit_type
int
Inbound order type: 0=FBM (Fulfillment by Merchant) Inbound 5=FBA Removal Order
-- receiving_status
int
Inbound order status: 0=Discard 1=Draft 5=In Transit 6=Receiving 7=Receipt Complete 8=Stocking Complete
-- receiving_shipping_type
int
Shipping mode: 0=Air transport, 1=seaborne bulk cargo 2=Express delivery, 3=Railway container, 4=Sea container, 5=Railway bulk
-- create_at
string
Creation time
-- update_at
string
Update time
-- warehouse_code
string
Receiving warehouse code
-- box_total_count
int
Forecast qty of boxes
-- sku_total_count
int
Forecast qty of SKUs
-- tracking_number
string
Tracking No.
-- cv_id
int
cv_id
-- page
int
Current page
-- page_size
int
Number of results per page
-- count
int
Total
8.6.4 Response Example
{
"code": 0,
"message": "",
"data": {
"list": [
{
"receiving_code": "",
"reference_no": "",
"transit_type": 0,
"receiving_status": 0,
"receiving_shipping_type": 0,
"create_at": "",
"update_at": "",
"warehouse_code": "",
"box_total_count": 0,
"sku_total_count": 0,
"tracking_number": "",
"cv_id": 0
}
],
"page": 0,
"page_size": 0,
"count": 0
}
}9 Inventory
9.1 Inventory List
9.1.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {
"page": 0,
"page_size": 0,
"product_sku_list": [
""
],
"warehouse_code": ""
}
}9.1.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
-- page
int
No
Number of the current page, default value is page 1
-- page_size
int
No
Number of results per page, default value is 20, maximum value is 100
-- product_sku_list
string[]
No
Multiple SKUs, eg:[product_sku1, product_sku2...]
-- warehouse_code
string
No
Warehouse code, refers to get warehouse/list
9.1.3 Response
Field
Type
Description
code
int
message
string
data
object
-- list
object[]
List
-- product_sku
string
SKU
-- warehouse_code
string
Warehouse code
-- onway
int
In transit qty
-- pending
int
Wait putaway qty
-- sellable
int
Sellable
-- unsellable
int
Unqualified qty
-- reserved
int
Wait outbound qty
-- shipped
int
Outbound qty
-- product_barcode
string
Product barcode (customer code-SKU)
-- warehouse_en
int
Warehouse name
-- page
int
Current page
-- page_size
int
Number of results per page
-- count
int
Total
9.1.4 Response Example
{
"code": 0,
"message": "",
"data": {
"list": [
{
"product_sku": "",
"warehouse_code": "",
"onway": 0,
"pending": 0,
"sellable": 0,
"unsellable": 0,
"reserved": 0,
"shipped": 0,
"product_barcode": "",
"warehouse_en": 0
}
],
"page": 0,
"page_size": 0,
"count": 0
}
}9.2 Inventory History List
9.2.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {
"page": 0,
"page_size": 0,
"product_sku_list": [
""
],
"warehouse_code": "",
"application_code": "",
"business_code_list": [
""
],
"create_time_from": "",
"create_time_end": ""
}
}9.2.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
-- page
int
No
Number of the current page, default value is page 1
-- page_size
int
No
Number of results per page, default value is 20, maximum value is 200
-- product_sku_list
string[]
No
Multiple SKUs(Without Client ID ), eg:[product_sku1, product_sku2...]
-- warehouse_code
string
No
Warehouse Code, refers to get warehouse/list
-- application_code
string
No
Operating Type: 1(Inventory count), 2(Signout), 3(Inventory adjustment), 4(Return Restock), 5(Inbound Stock-in), 6(VAS complete)
-- business_code_list
string[]
No
Order Number
-- create_time_from
string
Yes
Start Time, The maximum support query interval is 31 days (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
-- create_time_end
string
Yes
End Time, The maximum support query interval is 31 days (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
9.2.3 Response
Field
Type
Description
code
int
message
string
data
object
-- list
object[]
List
-- product_sku
string
SKU(Without Client ID )
-- warehouse_code
string
Warehouse Code
-- business_code
string
Order Number
-- application_code
int
Operating Type: Operating Type: 1(Inventory count), 2(Signout), 3(Inventory adjustment), 4(Return Restock), 5(Inbound Stock-in), 6(VAS complete)
-- inventory_change_type
int
Adjustment Type: 1(increase), 2(decrease)
-- change_num
string
Adjustment count
-- create_time
string
Operating Time (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
-- count
int
Total Count
9.2.4 Response Example
{
"code": 0,
"message": "",
"data": {
"list": [
{
"product_sku": "",
"warehouse_code": "",
"business_code": "",
"application_code": 0,
"inventory_change_type": 0,
"change_num": "",
"create_time": ""
}
],
"count": 0
}
}10 Serial Number
10.1 Serial Number Discard
10.1.1 Request Example
Request:
{
"request_id": "",
"request_time": "",
"request_data": {
"serial_number_list": [
""
]
}
}10.1.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
string
Yes
request_data
object
Yes
-- serial_number_list
string[]
Yes
Number up to 100
10.1.3 Response
Field
Type
Description
code
int
message
string
data
object
-- list
object[]
Error details of response results; An empty array means all were successful
error_id
string
10.1.4 Response Example
{
"code": 0,
"message": "",
"data": {
"list": [
{}
]
},
"error_id": ""
}10.2 Serial Number List
10.2.1 Request Example
Request:
{
"request_id": "",
"request_time": "",
"request_data": {
"status": 0,
"inbound_code_list": [
""
],
"order_code_list": [
""
],
"product_sku_list": [
""
],
"serial_number_list": [
""
],
"create_date_from": "",
"create_date_to": "",
"modify_date_from": "",
"modify_date_to": "",
"shipping_date_from": "",
"shipping_date_to": "",
"discard_date_from": "",
"discard_date_to": "",
"page": 0,
"page_size": 0
}
}10.2.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
string
Yes
request_data
object
Yes
-- status
int
No
value:null(all),0(Wait Inbound),1(Wait Outbound),2(Shipped),3(Discarded)
-- inbound_code_list
string[]
No
inbound code list
-- order_code_list
string[]
No
order code list
-- product_sku_list
string[]
No
product sku list
-- serial_number_list
string[]
No
serial number list
-- create_date_from
string
No
ISO 8601 format, eg: 2000-01-02T13:48:19-05:00 "Start date" and "End date" are both required
-- create_date_to
string
No
ISO 8601 format, eg: 2000-01-02T13:48:19-05:00 "Start date" and "End date" are both required
-- modify_date_from
string
No
ISO 8601 format, eg: 2000-01-02T13:48:19-05:00 "Start date" and "End date" are both required
-- modify_date_to
string
No
ISO 8601 format, eg: 2000-01-02T13:48:19-05:00 "Start date" and "End date" are both required
-- shipping_date_from
string
No
ISO 8601 format, eg: 2000-01-02T13:48:19-05:00 "Start date" and "End date" are both required
-- shipping_date_to
string
No
ISO 8601 format, eg: 2000-01-02T13:48:19-05:00 "Start date" and "End date" are both required
-- discard_date_from
string
No
ISO 8601 format, eg: 2000-01-02T13:48:19-05:00 "Start date" and "End date" are both required
-- discard_date_to
string
No
ISO 8601 format, eg: 2000-01-02T13:48:19-05:00 "Start date" and "End date" are both required
-- page
int
Yes
-- page_size
int
Yes
10.2.3 Response
Field
Type
Description
code
int
message
string
data
object
-- list
object[]
-- order_code
string
order code
-- inbound_code
string
inbound code
-- product_sku
string
product sku
-- serial_number
string
serial number
-- status
int
value:0(Wait Inbound),1(Wait Outbound),2(Shipped),3(Discarded)
-- create_time
string
ISO 8601 format, eg: 2000-01-02T13:48:19-05:00
-- update_time
string
ISO 8601 format, eg: 2000-01-02T13:48:19-05:00
-- ship_time
string
ISO 8601 format, eg: 2000-01-02T13:48:19-05:00
-- discard_time
string
ISO 8601 format, eg: 2000-01-02T13:48:19-05:00
-- page
int
-- page_size
int
-- count
int
error_id
string
10.2.4 Response Example
{
"code": 0,
"message": "",
"data": {
"list": [
{
"order_code": "",
"inbound_code": "",
"product_sku": "",
"serial_number": "",
"status": 0,
"create_time": "",
"update_time": "",
"ship_time": "",
"discard_time": ""
}
],
"page": 0,
"page_size": 0,
"count": 0
},
"error_id": ""
}10.3 Serial Number Add
10.3.1 Request Example
Request:
{
"request_id": "",
"request_time": "",
"request_data": {
"product_sku": "",
"serial_number_list": [
""
]
}
}10.3.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
string
Yes
request_data
object
Yes
-- product_sku
string
Yes
Available SKU
-- serial_number_list
string[]
Yes
Number up to 100;Each length is 1-100 characters
10.3.3 Response
Field
Type
Description
code
int
message
string
data
object
-- list
string[]
Error details of response results; An empty array means all were successful
error_id
string
10.3.4 Response Example
{
"code": 0,
"message": "",
"data": {
"list": [
""
]
},
"error_id": ""
}10.4 Serial Number List by Location
API description： Prerequisites: All serial number products have enabled the serial number inbound and outbound scanning service, and serial number needs to be sent along with the inbound order.
Test
10.4.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {
"page": 0,
"page_size": 0,
"warehouse_code": "",
"status": 0,
"product_sku": "",
"create_time_from": "",
"create_time_end": ""
}
}10.4.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
-- page
int
No
Number of the current page, default value is page 1
-- page_size
int
No
Number of results per page, default value is 20, maximum value is 200
-- warehouse_code
string
Yes
warehouse code
-- status
int
No
Value:null(all), 0(Wait Inbound), 1(Wait Outbound)=Sellable, 2(Shipped), 3(Discarded); Default value: null(all)
-- product_sku
string
No
product sku
-- create_time_from
string
No
Inbound create time. The default is the latest 1 year. The maximum support query interval is 1 year (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
-- create_time_end
string
No
Inbound create time.The default is the latest 1 year. The maximum support query interval is 1 year (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
10.4.3 Response
Field
Type
Description
code
int
message
string
data
object
-- list
object[]
-- product_sku
string
product sku
-- serial_number
string
serial number
-- warehouse_code
string
warehouse code
-- status
int
Value:0(Wait Inbound),1(Wait Outbound),2(Shipped),3(Discarded)
-- count
int
total
10.4.4 Response Example
{
"code": 0,
"message": "",
"data": {
"list": [
{
"product_sku": "",
"serial_number": "",
"warehouse_code": "",
"status": 0
}
],
"count": 0
}
}11 Order
11.1 Order Create
11.1.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {
"reference_no": "",
"warehouse_code": "",
"platform": "",
"shipping_method": "",
"order_desc": "",
"is_signature": "",
"is_insurance": "",
"insurance_value": 0.01,
"verify": "",
"fba_info": {
"is_change_label": "",
"fba_shipment_id": "",
"fba_shipment_id_create_time": ""
},
"items": [
{
"product_sku": "",
"quantity": 0,
"transaction_id": "",
"item_id": "",
"fba_product_code": "",
"hs_code": "",
"product_declared_value": ""
}
],
"consignee_info": {
"name": "",
"last_name": "",
"country": "",
"province": "",
"city": "",
"address1": "",
"address2": "",
"zipcode": "",
"phone": "",
"cell_phone": "",
"email": "",
"company": "",
"doorplate": ""
},
"vat_change_info": {
"ioss_number": "",
"shipper_vat": "",
"shipper_eori": "",
"shipper_company_name": "",
"recipient_vat": "",
"recipient_eori": "",
"pid_number": "",
"recipient_vat_country": "",
"recipient_eori_country": ""
},
"customer_package_requirement": 0,
"extend_info": {
"property_label": ""
},
"truck_info": {
"reference_id": "",
"seller_name": "",
"fba_warehouse_code": ""
},
"order_business_type": 0,
"attachment_ids": [
""
]
}
}11.1.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
-- reference_no
string
No
Client-defined external unique id of the order (eg: platform order ID)
-- warehouse_code
string
Yes
Shipping warehouse code, refers to warehouse/list
-- platform
string
No
Platform: Aliexpress, Amazon, Wish, eBay, 3dcart, Woocomerce, Bigcommerce, CA, Easyship, Linnworks, Magento, Shopify, Walmart, OTHER, default value is OTHER
-- shipping_method
string
Yes
Shipping method, refers to get shipping-method/list
-- order_desc
string
No
Order note, maximum 255 characters
-- is_signature
string
No
Signature service, 0=No，1=Yes，default value is 0
-- is_insurance
string
No
Insurance service, 0=No，1=Yes，default value is 0
-- insurance_value
float
No
Insurance value, the value is 0 when left it as blank
-- verify
string
No
Whether verify: value 0=Only create to draft status, value 1=Create and submit to verify. Default value is 0. If choose create and submit to verify, order cannot be edited.
-- fba_info
object
No
FBA order info(required when FBA order)
-- is_change_label
string
No
FBA change label service 1=Yes 0=No, default value is 0
-- fba_shipment_id
string
No
FBA Shipment ID, Required when create Tracking No.. 12 Characters consist of numbers and letters.
-- fba_shipment_id_create_time
string
No
Creation time of FBA Shipment ID, Required when create Tracking No.. (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
-- items
object[]
Yes
Product info
-- product_sku
string
Yes
SKU
-- quantity
int
Yes
Quantity
-- transaction_id
string
No
ebay transaction id
-- item_id
string
No
ebay item id
-- fba_product_code
string
No
FNSKU, required when is_change_label=1
-- hs_code
string
No
HS Code(6 to 10 digits)
-- product_declared_value
string
No
Declared value of goods
-- consignee_info
object
Yes
Recipient Info
-- name
string
Yes
Recipient First Name,, maximum 48 characters
-- last_name
string
No
Recipient Last Name, maximum 48 characters
-- country
string
Yes
Recipient country, refers to get country/list
-- province
string
No
Province, If the country is US, AU or CN, the province field is mandatory
-- city
string
Yes
City
-- address1
string
Yes
Address 1
-- address2
string
No
Address 2
-- zipcode
string
Yes
Zip Code
-- phone
string
No
Phone number
-- cell_phone
string
No
Ext
-- email
string
No
Email
-- company
string
No
Company name
-- doorplate
string
No
House number
-- vat_change_info
object
No
Additional order info related to "EU regulation update" (This field will only be effective without fba_info)
-- ioss_number
string
No
IOSS number
-- shipper_vat
string
No
Sender VAT
-- shipper_eori
string
No
Sender EORI
-- shipper_company_name
string
No
Sender Company Name
-- recipient_vat
string
No
Recipient VAT
-- recipient_eori
string
No
Recipient EORI
-- pid_number
string
No
PID Number
-- recipient_vat_country
string
No
Recipient VAT country of registration
-- recipient_eori_country
string
No
Recipient eori No. country of registration
-- customer_package_requirement
int
No
Specify your prefered method to package, The default value is null. 1=Box，2=Poly Mailer，3=Poly Bubble Mailer, 4=Recycle Bag
-- extend_info
object
No
Extend Info
-- property_label
string
No
Platform Model : SFP
-- truck_info
object
No
FBA Truck Info
-- reference_id
string
No
Reference ID. Required if you choose shipping method of truck transportation in a FBA order
-- seller_name
string
No
Seller Name. Required if you choose shipping method of truck transportation in a FBA order
-- fba_warehouse_code
string
No
FBA warehouse code. Required if you choose shipping method of truck transportation in a FBA order
-- order_business_type
int
No
default 0；0:Full fulfilment service 1:Warehouse service only. when order_business_type=1,'verify' must be 1.
-- attachment_ids
string[]
No
Attachment ID, returned by "/attachment/upload" (category value=order_attachment) end point. Maximum items: 50
11.1.3 Response
Field
Type
Description
code
int
message
string
data
object
-- order_code
string
Unique id of the order
-- wp_code
string
Order deduction main physical warehouse；when verify=1 return
11.1.4 Response Example
{
"code": 0,
"message": "",
"data": {
"order_code": "",
"wp_code": ""
}
}11.2 Order Update
11.2.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {
"order_code": "",
"reference_no": "",
"warehouse_code": "",
"platform": "",
"shipping_method": "",
"order_desc": "",
"is_signature": "",
"is_insurance": "",
"insurance_value": 0.01,
"verify": "",
"fba_info": {
"is_change_label": "",
"fba_shipment_id": "",
"fba_shipment_id_create_time": ""
},
"items": [
{
"product_sku": "",
"quantity": 0,
"transaction_id": "",
"item_id": "",
"fba_product_code": "",
"hs_code": "",
"product_declared_value": ""
}
],
"consignee_info": {
"name": "",
"last_name": "",
"country": "",
"province": "",
"city": "",
"address1": "",
"address2": "",
"zipcode": "",
"phone": "",
"cell_phone": "",
"email": "",
"company": "",
"doorplate": ""
},
"vat_change_info": {
"ioss_number": "",
"shipper_vat": "",
"shipper_eori": "",
"shipper_company_name": "",
"recipient_vat": "",
"recipient_eori": "",
"pid_number": "",
"recipient_vat_country": "",
"recipient_eori_country": ""
},
"customer_package_requirement": 0,
"extend_info": {
"property_label": ""
},
"truck_info": {
"reference_id": "",
"seller_name": "",
"fba_warehouse_code": ""
},
"order_business_type": 0,
"attachment_ids": [
""
]
}
}11.2.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
-- order_code
string
Yes
Order ID
-- reference_no
string
No
Client-defined external unique id of the order (eg: platform order ID)
-- warehouse_code
string
Yes
Shipping warehouse code, refers to warehouse/list
-- platform
string
No
Platform: Aliexpress, Amazon, Wish, eBay, 3dcart, Woocomerce, Bigcommerce, CA, Easyship, Linnworks, Magento, Shopify, Walmart, OTHER, default value is OTHER
-- shipping_method
string
Yes
Shipping method, refers to get shipping-method/list
-- order_desc
string
No
Order note, maximum 255 characters
-- is_signature
string
No
Signature service, 0=No，1=Yes，default value is 0
-- is_insurance
string
No
Insurance service, 0=No，1=Yes，default value is 0
-- insurance_value
float
No
Insurance value, the value is 0 when left it as blank
-- verify
string
No
Whether verify: value 0=Only create to draft status, value 1=Create and submit to verify. Default value is 0. If choose create and submit to verify, order cannot be edited.
-- fba_info
object
No
FBA order info(required when FBA order)
-- is_change_label
string
No
FBA change label service 1=Yes 0=No, default value is 0
-- fba_shipment_id
string
No
FBA Shipment ID, Required when create Tracking No.. 12 Characters consist of numbers and letters.
-- fba_shipment_id_create_time
string
No
Creation time of FBA Shipment ID, Required when create Tracking No.. (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
-- items
object[]
Yes
Product info
-- product_sku
string
Yes
SKU
-- quantity
int
Yes
Quantity
-- transaction_id
string
No
ebay transaction id
-- item_id
string
No
ebay item id
-- fba_product_code
string
No
FNSKU, required when is_change_label=1
-- hs_code
string
No
HS Code(6 to 10 digits)
-- product_declared_value
string
No
Declared value of goods
-- consignee_info
object
Yes
Recipient Info
-- name
string
Yes
Recipient First Name,, maximum 48 characters
-- last_name
string
No
Recipient Last Name, maximum 48 characters
-- country
string
Yes
Recipient country, refers to get country/list
-- province
string
No
Province, If the country is US, AU or CN, the province field is mandatory
-- city
string
Yes
City
-- address1
string
Yes
Address 1
-- address2
string
No
Address 2
-- zipcode
string
Yes
Zip Code
-- phone
string
No
Phone number
-- cell_phone
string
No
Ext
-- email
string
No
Email
-- company
string
No
Company name
-- doorplate
string
No
House number
-- vat_change_info
object
No
Additional order info related to "EU regulation update" (This field will only be effective without fba_info)
-- ioss_number
string
No
IOSS number
-- shipper_vat
string
No
Sender VAT
-- shipper_eori
string
No
Sender EORI
-- shipper_company_name
string
No
Sender Company Name
-- recipient_vat
string
No
Recipient VAT
-- recipient_eori
string
No
Recipient EORI
-- pid_number
string
No
PID Number
-- recipient_vat_country
string
No
Recipient VAT country of registration
-- recipient_eori_country
string
No
Recipient eori No. country of registration
-- customer_package_requirement
int
No
Specify your prefered method to package, The default value is null. 1=Box，2=Poly Mailer，3=Poly Bubble Mailer, 4=Recycle Bag
-- extend_info
object
No
Extend Info
-- property_label
string
No
Platform Model : SFP
-- truck_info
object
No
FBA Truck Info
-- reference_id
string
No
Reference ID. Required if you choose shipping method of truck transportation in a FBA order
-- seller_name
string
No
Seller Name.Required if you choose shipping method of truck transportation in a FBA order
-- fba_warehouse_code
string
No
FBA warehouse code. Required if you choose shipping method of truck transportation in a FBA order
-- order_business_type
int
No
default 0；0:Full fulfilment service 1:Warehouse service only. when order_business_type=1,'verify' must be 1.
-- attachment_ids
string[]
No
Attachment ID, returned by "/attachment/upload" (category value=order_attachment) end point. Maximum items: 50
11.2.3 Response
Field
Type
Description
code
int
message
string
data
object
-- order_code
string
Unique id of the order
-- wp_code
string
Order deduction main physical warehouse；when verify=1 renturn
11.2.4 Response Example
{
"code": 0,
"message": "",
"data": {
"order_code": "",
"wp_code": ""
}
}11.3 Order Cancel
11.3.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {
"order_code": "",
"reason": ""
}
}11.3.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
-- order_code
string
Yes
Order ID
-- reason
string
No
The reason of order cancelled, maximum 255 characters
11.3.3 Response
Field
Type
Description
code
int
message
string
data
object
-- order_code
string
Unique id of the order
-- cancel_status
int
Cancel status: 0 =No abnormal, 1 =cancelling, 2=Cancelled, 3 =Cancel failed
11.3.4 Response Example
{
"code": 0,
"message": "",
"data": {
"order_code": "",
"cancel_status": 0
}
}11.4 Order List
11.4.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {
"order_code_list": [
""
],
"shipping_method": "",
"create_date_from": "",
"create_date_to": "",
"modify_date_from": "",
"modify_date_to": "",
"date_shipping_from": "",
"date_shipping_to": "",
"order_status": 0,
"page": 0,
"page_size": 0,
"property_label": ""
}
}11.4.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
-- order_code_list
string[]
No
Multiple orders, eg.[order_code1,order_code2,...]
-- shipping_method
string
No
Shipping method code, refers to shipping-method/list
-- create_date_from
string
No
Order creation time from, (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00) When order code was sent,this parameter will be invalid
-- create_date_to
string
No
Order creation time to, (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00) When order code was sent,this parameter will be invalid
-- modify_date_from
string
No
Order update date from,(ISO 8601 format, eg: 2000-01-02T13:48:19-05:00) When order code was sent,this parameter will be invalid
-- modify_date_to
string
No
Order update date to,(ISO 8601 format, eg: 2000-01-02T13:48:19-05:00) When order code was sent,this parameter will be invalid
-- date_shipping_from
string
No
Order shipped date from,(ISO 8601 format, eg: 2000-01-02T13:48:19-05:00) When order code was sent,this parameter will be invalid
-- date_shipping_to
string
No
Order shipped date to,(ISO 8601 format, eg: 2000-01-02T13:48:19-05:00) When order code was sent,this parameter will be invalid
-- order_status
int
Yes
Order status: 3=Pending 4=Shipped 6=Exception 7=Problem 0=Discard
-- page
int
No
Number of the current page, default value is page 1
-- page_size
int
No
Number of results per page, default value is 20, maximum value is 200
-- property_label
string
No
Platform model : SFP
11.4.3 Response
Field
Type
Description
code
int
message
string
data
object
-- list
object[]
Order list
-- order_code
string
Order ID
-- reference_no
string
Client-defined external unique id of the order (eg: platform order ID)
-- platform
string
Platform
-- order_status
string
Order status: C=Draft W=Pending D=Shipped H=On hold N=Exception P=Problem X=Discard
-- abnormal_problem_reason
string
Exception reason
-- shipping_method
string
Shipping method
-- tracking_no
string
Tracking No.
-- is_fba
string
FBA order
-- warehouse_code
string
Shipping warehouse code
-- order_weight
float
Order weight (lb)
-- volume_length
float
length (inch)
-- volume_width
float
width (inch)
-- volume_height
float
height (inch)
-- order_desc
string
Order note
-- date_create
string
Creation time (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
-- date_release
string
Release time (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
-- date_shipping
string
Shipped time (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
-- date_modify
string
Update time (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
-- consignee_info
object
Consignee info
-- name
string
Recipient Name
-- last_name
string
Recipient Last Name
-- country
string
Recipient country, refers to get country/list
-- province
string
Province
-- city
string
City
-- address1
string
Address 1
-- address2
string
Address 2
-- zipcode
string
Zip Code
-- phone
string
Phone number
-- email
string
Email
-- company
string
Company name
-- doorplate
string
House number
-- vat_change_info
object
Additional order info related to "EU regulation update" (This field will only be effective without fba_info)
-- ioss_number
string
IOSS number
-- shipper_vat
string
Sender VAT
-- shipper_eori
string
Sender EORI
-- shipper_company_name
string
Sender Company Name
-- recipient_vat
string
Recipient VAT
-- recipient_eori
string
Recipient EORI
-- pid_number
string
PID Number
-- recipient_vat_country
string
Recipient VAT country of registration
-- recipient_eori_country
string
Recipient eori No. country of registration
-- customer_package_requirement
int
Specify your prefered method to package, The default value is null. 1=Box，2=Poly Mailer，3=Poly Bubble Mailer, 4=Recycle Bag
-- extend_info
object
extend info
-- property_label
string
Platform model: SFP
-- truck_info
object
FBA Truck Info
-- reference_id
string
Reference ID. Required if you choose shipping method of truck transportation in a FBA order
-- seller_name
string
Seller Name.Required if you choose shipping method of truck transportation in a FBA order
-- fba_warehouse_code
string
FBA warehouse code. Required if you choose shipping method of truck transportation in a FBA order
-- page
int
Current page
-- page_size
int
Number of results per page
-- count
int
Total
11.4.4 Response Example
{
"code": 0,
"message": "",
"data": {
"list": [
{
"order_code": "",
"reference_no": "",
"platform": "",
"order_status": "",
"abnormal_problem_reason": "",
"shipping_method": "",
"tracking_no": "",
"is_fba": "",
"warehouse_code": "",
"order_weight": 0.01,
"volume_length": 0.01,
"volume_width": 0.01,
"volume_height": 0.01,
"order_desc": "",
"date_create": "",
"date_release": "",
"date_shipping": "",
"date_modify": "",
"consignee_info": {
"name": "",
"last_name": "",
"country": "",
"province": "",
"city": "",
"address1": "",
"address2": "",
"zipcode": "",
"phone": "",
"email": "",
"company": "",
"doorplate": ""
},
"vat_change_info": {
"ioss_number": "",
"shipper_vat": "",
"shipper_eori": "",
"shipper_company_name": "",
"recipient_vat": "",
"recipient_eori": "",
"pid_number": "",
"recipient_vat_country": "",
"recipient_eori_country": ""
},
"customer_package_requirement": 0,
"extend_info": {
"property_label": ""
},
"truck_info": {
"reference_id": "",
"seller_name": "",
"fba_warehouse_code": ""
}
}
],
"page": 0,
"page_size": 0,
"count": 0
}
}11.5 Draft Order List
11.5.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {
"order_code_list": [
""
],
"shipping_method": "",
"create_date_from": "",
"create_date_to": "",
"order_status": 0,
"page": 0,
"page_size": 0
}
}11.5.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
-- order_code_list
string[]
No
Multiple orders, eg.[order_code1,order_code2,...]
-- shipping_method
string
No
Shipping method code, refers to shipping-method/list
-- create_date_from
string
No
Order creation time from, (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00) When order code was sent,this parameter will be invalid
-- create_date_to
string
No
Order creation time to, (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00) When order code was sent,this parameter will be invalid
-- order_status
int
Yes
Order status: 2=Draft 5=On hold 0=Discard
-- page
int
No
Number of the current page, default value is page 1
-- page_size
int
No
Number of results per page, default value is 20, maximum value is 200
11.5.3 Response
Field
Type
Description
code
int
message
string
data
object
-- list
object[]
Order list
-- order_code
string
Order ID
-- reference_no
string
Client-defined external unique id of the order (eg: platform order ID)
-- platform
string
Platform
-- order_status
string
Order status: C=Draft W=Pending D=Shipped H=On hold N=Exception P=Problem X=Discard
-- abnormal_problem_reason
string
Exception reason
-- shipping_method
string
Shipping method
-- tracking_no
string
Tracking No.
-- is_fba
string
FBA order
-- warehouse_code
string
Shipping warehouse code
-- order_weight
float
Order weight (lb)
-- volume_length
float
length (inch)
-- volume_width
float
width (inch)
-- volume_height
float
height (inch)
-- order_desc
string
Order note
-- date_create
string
Creation time (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
-- date_release
string
Release time (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
-- date_shipping
string
Shipped time (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
-- date_modify
string
Update time (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
-- consignee_info
object
Consignee Info
-- name
string
Recipient Name
-- last_name
string
Recipient Last Name
-- country
string
Recipient country, refers to get country/list
-- province
string
Province
-- city
string
City
-- address1
string
Address 1
-- address2
string
Address 2
-- zipcode
string
Zip Code
-- phone
string
Phone number
-- email
string
Email
-- company
string
Company name
-- doorplate
string
House number
-- vat_change_info
object
Additional order info related to "EU regulation update" (This field will only be effective without fba_info)
-- ioss_number
string
IOSS number
-- shipper_vat
string
Sender VAT
-- shipper_eori
string
Sender EORI
-- shipper_company_name
string
Sender Company Name
-- recipient_vat
string
Recipient VAT
-- recipient_eori
string
Recipient EORI
-- pid_number
string
PID Number
-- recipient_vat_country
string
Recipient VAT country of registration
-- recipient_eori_country
string
Recipient eori No. country of registration
-- customer_package_requirement
int
Specify your prefered method to package, The default value is 1. 1=Box，2=Poly Mailer，3=Poly Bubble Mailer, 4=Recycle Bag
-- truck_info
object
FBA Truck Info
-- reference_id
string
Reference ID. Required if you choose shipping method of truck transportation in a FBA order
-- seller_name
string
Seller Name.Required if you choose shipping method of truck transportation in a FBA order
-- fba_warehouse_code
string
FBA warehouse code. Required if you choose shipping method of truck transportation in a FBA order
-- page
int
Current page
-- page_size
int
Number of results per page
-- count
int
Total
11.5.4 Response Example
{
"code": 0,
"message": "",
"data": {
"list": [
{
"order_code": "",
"reference_no": "",
"platform": "",
"order_status": "",
"abnormal_problem_reason": "",
"shipping_method": "",
"tracking_no": "",
"is_fba": "",
"warehouse_code": "",
"order_weight": 0.01,
"volume_length": 0.01,
"volume_width": 0.01,
"volume_height": 0.01,
"order_desc": "",
"date_create": "",
"date_release": "",
"date_shipping": "",
"date_modify": "",
"consignee_info": {
"name": "",
"last_name": "",
"country": "",
"province": "",
"city": "",
"address1": "",
"address2": "",
"zipcode": "",
"phone": "",
"email": "",
"company": "",
"doorplate": ""
},
"vat_change_info": {
"ioss_number": "",
"shipper_vat": "",
"shipper_eori": "",
"shipper_company_name": "",
"recipient_vat": "",
"recipient_eori": "",
"pid_number": "",
"recipient_vat_country": "",
"recipient_eori_country": ""
},
"customer_package_requirement": 0,
"truck_info": {
"reference_id": "",
"seller_name": "",
"fba_warehouse_code": ""
}
}
],
"page": 0,
"page_size": 0,
"count": 0
}
}11.6 Order Detail
11.6.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {
"order_code": "",
"reference_no": ""
}
}11.6.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
-- order_code
string
No
Unique id of the order
-- reference_no
string
No
Client-defined external unique id of the order, only return valid order data
11.6.3 Response
Field
Type
Description
code
int
message
string
data
object
-- order_code
string
Order ID
-- reference_no
string
Client-defined external unique id of the order (eg: platform order ID)
-- platform
string
Platform
-- order_status
string
Order status: 2=Draft 3=Pending 4=Shipped 5=On hold 6=Exception 7=Problem 0=Discard
-- abnormal_problem_reason
string
Exception reason
-- shipping_method
string
Shipping method
-- tracking_no
string
Tracking No.
-- warehouse_code
string
Shipping warehouse code
-- order_weight
float
Order weight (lb)
-- volume_length
float
length (inch)
-- volume_width
float
width (inch)
-- volume_height
float
height (inch)
-- order_desc
string
Order note
-- date_create
string
Creation time (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
-- date_release
string
Release time (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
-- date_shipping
string
Shipped time (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
-- date_modify
string
Update time (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
-- is_insurance
string
Insurance service, 0=No，1=Yes
-- insurance_value
float
Insurance value
-- is_fba
float
FBA order
-- items
object[]
Order details
-- product_sku
string
SKU
-- product_barcode
string
Barcode
-- quantity
int
Quantity
-- transaction_id
string
ebay transaction id
-- item_id
string
ebay item id
-- fba_product_code
string
fba SKU
-- hs_code
string
HS Code(6 to 10 digits)
-- product_declared_value
string
Declared value of goods
-- serial_number_list
object[]
serial number list
-- product_sku
string
product_sku
-- serial_number
string
serial_number
-- box_items
object[]
Details for multiple boxes per order
-- box_no
string
Box number
-- ob_length
float
Length(inch)
-- ob_width
float
Width(inch)
-- ob_height
float
Height(inch)
-- ob_weight
float
Weight(lb)
-- ob_add_time
string
Creation time (ISO 8601 format, eg: 2000-01-02T13:48:19-05:00)
-- tracking_number
string
Tracking No.
-- product_barcode
string
Product barcode (customer code-SKU)
-- order_code
string
Order ID
-- ob_qty
int
QTY
-- fee_details
object[]
Order fee
-- name
string
Cost Type
-- amount
float
Amount
-- billing_date
string
Billing Time
-- currency_code
string
Currency
-- fba_info
object
FBA info
-- fba_shipment_id
string
shipment_id
-- fba_shipment_id_create_time
string
Creation time
-- is_change_label
string
Change label service
-- consignee_info
object
Consignee info
-- cell_phone
string
Ext
-- name
string
Recipient Name
-- last_name
string
Recipient Last Name
-- country
string
Recipient country, refers to get country/list
-- province
string
Province
-- city
string
City
-- address1
string
Address 1
-- address2
string
Address 2
-- zipcode
string
Zip Code
-- phone
string
Phone number
-- email
string
Email
-- company
string
Company name
-- doorplate
string
House number
-- vat_change_info
object
Additional order info related to "EU regulation update" (This field will only be effective without fba_info)
-- ioss_number
string
IOSS number
-- shipper_vat
string
Sender VAT
-- shipper_eori
string
Sender EORI
-- shipper_company_name
string
Sender Company Name
-- recipient_vat
string
Recipient VAT
-- recipient_eori
string
Recipient EORI
-- pid_number
string
PID Number
-- recipient_vat_country
string
Recipient VAT country of registration
-- recipient_eori_country
string
Recipient eori No. country of registration
-- customer_package_requirement
int
Specify your prefered method to package, The default value is null. 1=Box，2=Poly Mailer，3=Poly Bubble Mailer, 4=Recycle Bag
-- extend_info
object
Extend Info
-- property_label
string
Platform Model ：SFP
-- truck_info
object
FBA Truck Info
-- reference_id
string
Reference ID. Required if you choose shipping method of truck transportation in a FBA order
-- seller_name
string
Seller Name.Required if you choose shipping method of truck transportation in a FBA order
-- fba_warehouse_code
string
FBA warehouse code. Required if you choose shipping method of truck transportation in a FBA order
11.6.4 Response Example
{
"code": 0,
"message": "",
"data": {
"order_code": "",
"reference_no": "",
"platform": "",
"order_status": "",
"abnormal_problem_reason": "",
"shipping_method": "",
"tracking_no": "",
"warehouse_code": "",
"order_weight": 0.01,
"volume_length": 0.01,
"volume_width": 0.01,
"volume_height": 0.01,
"order_desc": "",
"date_create": "",
"date_release": "",
"date_shipping": "",
"date_modify": "",
"is_insurance": "",
"insurance_value": 0.01,
"is_fba": 0.01,
"items": [
{
"product_sku": "",
"product_barcode": "",
"quantity": 0,
"transaction_id": "",
"item_id": "",
"fba_product_code": "",
"hs_code": "",
"product_declared_value": ""
}
],
"serial_number_list": [
{
"product_sku": "",
"serial_number": ""
}
],
"box_items": [
{
"box_no": "",
"ob_length": 0.01,
"ob_width": 0.01,
"ob_height": 0.01,
"ob_weight": 0.01,
"ob_add_time": "",
"tracking_number": "",
"product_barcode": "",
"order_code": "",
"ob_qty": 0
}
],
"fee_details": [
{
"name": "",
"amount": 0.01,
"billing_date": "",
"currency_code": ""
}
],
"fba_info": {
"fba_shipment_id": "",
"fba_shipment_id_create_time": "",
"is_change_label": ""
},
"consignee_info": {
"cell_phone": "",
"name": "",
"last_name": "",
"country": "",
"province": "",
"city": "",
"address1": "",
"address2": "",
"zipcode": "",
"phone": "",
"email": "",
"company": "",
"doorplate": ""
},
"vat_change_info": {
"ioss_number": "",
"shipper_vat": "",
"shipper_eori": "",
"shipper_company_name": "",
"recipient_vat": "",
"recipient_eori": "",
"pid_number": "",
"recipient_vat_country": "",
"recipient_eori_country ": ""
},
"customer_package_requirement": 0,
"extend_info": {
"property_label": ""
},
"truck_info": {
"reference_id": "",
"seller_name": "",
"fba_warehouse_code": ""
}
}
}11.7 Order Tracking Status
11.7.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {
"code_list": [
""
],
"code_type": ""
}
}11.7.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
-- code_list
string[]
Yes
Order ID,Reference number,Tracking number are supported
-- code_type
string
Yes
code type: order_code or reference_no or tracking_number
11.7.3 Response
Field
Type
Description
code
int
message
string
data
object[]
-- code
string
-- order_code
string
Order ID
-- tracking_list
object[]
Tracking list
-- tracking_number
string
Tracking number
-- status_list
object[]
List of tracking details
-- code
string
Tracking code:
-- info
string
Tracking information
-- local_time
string
Local time
-- location
string
Location
-- code_info
string
Tracking code info
11.7.4 Response Example
{
"code": 0,
"message": "",
"data": [
{
"code": "",
"order_code": "",
"tracking_list": [
{
"tracking_number": "",
"status_list": [
{
"code": "",
"info": "",
"local_time": "",
"location": "",
"code_info": ""
}
]
}
]
}
]
}11.8 Order upload Label
11.8.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {
"base64": "",
"ext": "",
"filename": "",
"order_code": "",
"tracking_no": ""
}
}11.8.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
-- base64
string
Yes
file base64；maximum 10M；
-- ext
string
Yes
file extension(pdf、png)
-- filename
string
Yes
file name
-- order_code
string
Yes
order code
-- tracking_no
string
Yes
maximum 50 characters
11.8.3 Response
Field
Type
Description
code
int
message
string
11.8.4 Response Example
{
"code": 0,
"message": ""
}12 Attachment
12.1 Upload Attachment
12.1.1 Request Example
Request:
{
"request_id": "",
"request_time": 0,
"request_data": {
"category": "",
"base64": "",
"filename": ""
}
}12.1.2 Request Parameter
Field
Type
Required
Description
request_id
string
Yes
request_time
int
Yes
request_data
object
Yes
-- category
string
Yes
value: order_attachment(support PNG, JPG, XLSX, DOCX, PDF format, the maximum support for a single file 5M)
-- base64
string
Yes
base64 format
-- filename
string
Yes
The file name needs to include the file type extension. eg: picture.jpg
12.1.3 Response
Field
Type
Description
code
int
message
string
data
object
-- attachment_id
string
Attachment ID
12.1.4 Response Example
{
"code": 0,
"message": "",
"data": {
"attachment_id": ""
}
}
