HTTP(S) Service API Documentation
Revision History
| Date | Module | Description | Related Documentation | Notes |
|---|---|---|---|---|
| 2024/7/15 | Despatch Advice | Added DESADV Despatch Advice API | Added DESADV Despatch Advice API | |
| 2024/7/29 | Despatch Advice | Added Body request parameter fields | Added interface fields: shipment_gross_weight shipment_net_weight mark_supplier_number quantity See request parameter description. | |
| 2024/9/12 | Despatch Advice | Modified date-time format; Added Body request parameter fields | Added interface fields: bill_of_lading delivery_order_number equipment_number package_type See request parameter description. | |
| 2024/10/17 | Despatch Advice | Added ASN number parameter field | Added interface field: delivery_number See request parameter description. | |
| 2025/04/17 | Despatch Advice | Added Body request parameter fields | Added interface fields: equipment_initial lot_number See request parameter description. | |
| 2025/04/25 | Despatch Advice | Added Body request parameter fields; item_detail_loop node | Added interface field: line_item_number See request parameter description. | |
| 2025/07/16 | Despatch Advice | Added Despatch Advice API: Outer Packaging (Pallet) + Inner Packaging Scenario | Added Despatch Advice API: Outer Packaging (Pallet) + Inner Packaging Scenario See request parameter description. | |
| 2025/07/25 | Despatch Advice | Added Partner ID parameter field | Added interface field: receiver_id See request parameter description. |
API Description
Through the API interface, submit offline shipping information/invoice information to the EDI system, which generates 856/810 or DESADV/INVOIC messages and sends them to customers.
Message sending business processing logic is executed asynchronously.
Special Parameter Description
Type of Marking
- Single Packaging S (1J): Packaging without subdivision. Consists of one unit that is both inner and outer packaging.
- Homogeneous Packaging M (6J): Homogeneous loading unit/(master) wholesale unit package. Consists of one or more inner packages, but contains only one type of product.
- Mixed Packaging G (5J): Mixed loading unit/mixed pallet/mixed wholesale unit packaging. Consists of one or more inner packages, but can contain multiple products.
Label Weight
Weight on labels is displayed as integers, using standard rounding rules.
- Net Weight
Total weight in kilograms of the parts inside a package printed without decimals.
Standard rounding rules apply. In case of M or G package structure, the master label will indicate the total weight in kilograms of all parts in the structure.
- Gross Weight
Total weight in kilograms of the package printed without decimals.
Standard rounding rules apply. In case of M or G package structure, the master label will indicate the total weight in kilograms of the complete transport handling unit.
Despatch Advice API - Outer Packaging (Pallet) + Inner Packaging Scenario
Request Description
| Request Address | http://xxx.xxx.xxx.xxx:8491/api/edi |
|---|---|
| Request Method | POST |
The specific API address and port number are subject to the deployed server address and port.
Request Parameters
Body Parameters
| Parameter Name | Type | Description | Required | Example Value | Notes |
|---|---|---|---|---|---|
| edi_flag | String | Despatch Advice ASN Identifier | Yes | A6577DF788A2 | Fixed value |
| receiver_id | String | Receiver ID (Partner ID) | Yes | O000000CLIP | Partner ID, generally used when connecting with multiple partners |
| delivery_number | String | ASN Number (Advanced Shipping Note) | Yes | 00000110025 | Despatch advice number, unique number, recommended maximum 8 digits (varies by customer requirements) |
| despatch_datetime | String | Despatch Date/Time | Yes | 20240627 or 20240627091201 | Format: CCYYMMDD or CCYYMMDDHHmmss |
| delivery_datetime | String | Estimated Delivery Date/Time | No | 20240715 or 20240715120603 | Format: CCYYMMDD or CCYYMMDDHHmmss |
| estimated_arrival_date | String | Estimated Arrival Date | Yes | 20240715 | Format: CCYYMMDD |
| shipment_gross_weight | Number | Shipment Gross Weight (Unit: KGM) | Yes | 520.00 | Total gross weight of all goods in ASN (accurate to two decimal places) |
| shipment_net_weight | Number | Shipment Net Weight (Unit: KGM) | Yes | 480.00 | Total net weight of all goods in ASN (accurate to two decimal places) |
| ship_from_id | String | Ship From Code | Yes | According to agency_code parameter, generally 92, provided by customer (buyer) | |
| ship_from_name | String | Ship From Name | Yes | ||
| ship_from_agency_code | String | Ship From Code Type | Yes | 92 | (91) Assigned by seller or seller's agent (92) Assigned by buyer or buyer's agent |
| ship_from_address | String | Address | Yes | ||
| ship_from_address_info | String | Detailed Address | No | ||
| ship_from_city_name | String | City | Yes | ||
| ship_from_state_province_code | String | State/Province Code | No | ||
| ship_from_postal_code | String | Postal Code | No | ||
| ship_from_country_code | String | Country/Region Code | No | ||
| ship_to_id | String | Ship To Code | Yes | According to agency_code parameter, generally 92, provided by customer (buyer) | |
| ship_to_name | String | Ship To Name | Yes | ||
| ship_to_agency_code | String | Ship To Code Type | Yes | 92 | (91) Assigned by seller or seller's agent (92) Assigned by buyer or buyer's agent |
| ship_to_address | String | Address | Yes | ||
| ship_to_address_info | String | Detailed Address | No | ||
| ship_to_city_name | String | City | Yes | ||
| ship_to_state_province_code | String | State/Province Code | No | ||
| ship_to_postal_code | String | Postal Code | No | ||
| ship_to_country_code | String | Country/Region Code | No | ||
| buyer_id | String | Buyer/Purchaser Code | Yes | According to agency_code parameter, generally 92, provided by customer (buyer) | |
| buyer_name | String | Buyer/Purchaser Name | Yes | ||
| buyer_agency_code | String | Buyer/Purchaser Code Type | Yes | 92 | (91) Assigned by seller or seller's agent (92) Assigned by buyer or buyer's agent |
| buyer_address | String | Address | Yes | ||
| seller_id | String | Seller/Vendor Code | Yes | According to agency_code parameter, generally 92, provided by customer (buyer) | |
| seller_name | String | Seller/Vendor Name | Yes | ||
| seller_agency_code | String | Seller/Vendor Code Type | Yes | 92 | (91) Assigned by seller or seller's agent (92) Assigned by buyer or buyer's agent |
| seller_address | String | Address | Yes | ||
| consignee_id | String | Consignee Code | Yes | According to agency_code parameter, generally 92, provided by customer (buyer) | |
| consignee_name | String | Consignee Name | Yes | ||
| consignee_agency_code | String | Consignee Code Type | Yes | 92 | (91) Assigned by seller or seller's agent (92) Assigned by buyer or buyer's agent |
| consignee_address | String | Address | Yes | ||
| consignor_id | String | Consignor Code | Yes | According to agency_code parameter, generally 92, provided by customer (buyer) | |
| consignor_name | String | Consignor Name | Yes | ||
| consignor_agency_code | String | Consignor Code Type | Yes | 92 | (91) Assigned by seller or seller's agent (92) Assigned by buyer or buyer's agent |
| consignor_address | String | Address | Yes | ||
| supplier_id | String | Supplier Code | Yes | According to agency_code parameter, generally 92, provided by customer (buyer) | |
| supplier_name | String | Supplier Name | Yes | ||
| supplier_agency_code | String | Supplier Code Type | Yes | 92 | (91) Assigned by seller or seller's agent (92) Assigned by buyer or buyer's agent |
| bill_of_lading | String | Bill of Lading | Yes | 2024123456987 | |
| packing_list_number | String | Packing List Number | Yes | PL2404120011 | |
| delivery_note_number | String | Delivery Note Number | Yes | ASN000006461 | |
| transport_document_number | String | Transport Document Number | Yes | VDFNL0733 | |
| place_of_delivery | String | Place of Delivery Code | Yes | HE01 | Place of Delivery Code from customer order |
| place_port_discharge | String | Place/Port of Discharge Code | Yes | SDNF | Place/Port of Discharge Code from customer order |
| additional_internal_destination | String | Additional Internal Destination Code | Yes | 3256 | Additional Internal Destination Code from customer order |
| carrier_bill_number | String | Carrier Bill Number | No | CN00001 | |
| carrier_scac | String | Carrier SCAC Code | No | UPSN | Generally consists of four letters |
| transport_mode | String | Transport Mode (Transportation Method) | No | LT | (A) Air (AE) Air Express (LT) Less than trailer load (M) Motor (Full truck) (R) Rail (SE) Sea |
| transport_type_name | String | Transport Type Name | No | AC-DC 1234 | Length within 35 characters |
| equipment_unit | String | Equipment Unit (Equipment Description Code) | No | TE | (CN) Container (RR) Railcar (TE) Trailer (TL) Trailer (not otherwise specified) |
| equipment_initial | String | Equipment Initial | Yes | UPSN | |
| equipment_number | String | Equipment Number (Transport vehicle number or container number) | Yes | 200003211 | Customer Equipment Number |
| packages.package_loop | Array | Package/Product Details |
package_loop Parameters
| Parameter Name | Description | Description | Required | Example Value | Notes |
|---|---|---|---|---|---|
| package_level | String | Package Level | Yes | 4 | (1) Inner package (3) Outer package (4) No packaging hierarchy |
| outer_package | Object | Outer Package (Pallet) Information | No | Required when package_level=3 | |
| cps_items.cps_item_loop | Array | (Inner) Package and Material Information | Yes |
outer_package Parameters
| Parameter Name | Description | Description | Required | Example Value | Notes |
|---|---|---|---|---|---|
| pac_items.pac_item_loop | Array | Outer Package (Pallet) Information | Yes |
cps_item_loop Parameters
| Parameter Name | Description | Description | Required | Example Value | Notes |
|---|---|---|---|---|---|
| pac_items.pac_item_loop | Array | (Inner) Package Information | Yes | ||
| line_items.line_item_loop | Array | Material Information | Yes |
pac_item_loop Parameters
| Parameter Name | Description | Description | Required | Example Value | Notes |
|---|---|---|---|---|---|
| package_type | String | Package Type | Yes | BOX | |
| package_type_agency_code | String | Package Type Agency Code | Yes | 92 | (91) Assigned by seller or seller's agent (92) Assigned by buyer or buyer's agent |
| quantity_of_pack | String | Quantity of Pack | Yes | 5 | |
| quantity_per_pack | String | Quantity Per Pack | Yes | 100 | |
| type_of_marking | String | Type of Marking | Yes | S | (S) Simplified Handling Unit (M) Homogeneous Handling Unit (G) Mixed Handling Unit |
| type_of_marking_agency_code | String | Type of Marking Agency Code | Yes | 92 | (91) Assigned by seller or seller's agent (92) Assigned by buyer or buyer's agent |
| package_gross_weight | Number | Package Gross Weight (Unit: KGM) | Yes | 129.47 | |
| package_net_weight | Number | Package Net Weight (Unit: KGM) | Yes | 109.05 | |
| gir_items.gir_item_loop | Array | Package Details | Yes |
gir_item_loop Parameters
| Parameter Name | Description | Description | Required | Example Value | Notes |
|---|---|---|---|---|---|
| label_number | String | Package/Pallet Label Number | Yes | 25071404 | |
| batch_number | String | Batch Number | No |
line_item_loop Parameters
| Parameter Name | Description | Description | Required | Example Value | Notes |
|---|---|---|---|---|---|
| line_item_number | String | Line Item Number | Yes | 00010 | Line Item Number from customer order |
| buyer_item_number | String | Buyer Item Number | Yes | SN240112A01AB | Material number from customer delivery schedule |
| seller_item_number | String | Seller Item Number | Yes | SI240418001 | |
| supplier_item_number | String | Supplier Item Number | Yes | SI240418001 | |
| quantity | Number | Quantity | Yes | 500 | Quantity of materials in package (integer) |
| quantity_unit | String | Unit | Yes | EA | |
| order_number | String | Order Number | Yes | 991935452615 | |
| order_line_number | String | Order Line Number | Yes | 00010 | |
| country_origin | String | Country of Origin | No | CN | (CN) China (DE) Germany (PL) Poland (US) America |
| item_description | String | Item Description | No |
Return Parameters
| Parameter Name | Type | Description | Example Value | Notes |
|---|---|---|---|---|
| status | String | Return Status | success | success or failure |
| message | String | Return Message | xxx |
Example
Request Example 1 (Mixed Scenario)
This is a request example under general configuration. Optional fields can be set to empty strings.
json5
{
"edi_flag": "A6577DF788A2",
"delivery_number": "00000110025",
"despatch_datetime": "20240627091201",
"delivery_datetime": "20240720151210",
"estimated_arrival_date": "20240715",
"shipment_gross_weight": "520",
"shipment_net_weight": "480",
"ship_from_id": "1001",
"ship_from_name": "ChinLink",
"ship_from_agency_code": "92",
"ship_from_address": "Fenghui South Road, High tech Zone",
"ship_from_address_info": "1107B, Building B, Huajing Plaza, No. 20",
"ship_from_city": "Xian",
"ship_from_street": "",
"ship_from_state_province_code": "XA",
"ship_from_postal_code": "710075",
"ship_from_country_code": "CN",
"ship_to_id": "1002",
"ship_to_name": "Ship To Name",
"ship_to_agency_code": "92",
"ship_to_address": "Ship To Address",
"ship_to_address_info": "Ship To Address Info",
"ship_to_city": "Ship To City",
"ship_to_state_province_code": "",
"ship_to_postal_code": "111000",
"ship_to_country_code": "US",
"supplier_id": "1001",
"supplier_name": "ChinLink",
"supplier_agency_code": "92",
"supplier_city": "Xian",
"bill_of_lading": "2024123456987",
"packing_list_number": "PL2404120011",
"carrier_scac": "UPSN",
"transport_mode": "LT",
"equipment_unit": "TE",
"equipment_initial": "UPSN",
"equipment_number": "2400008112",
"packages": {
"package_loop": [
{
"package_level": 4,
"cps_items": {
"cps_item_loop": [
{
"pac_items": {
"pac_item_loop": [
{
"package_type": "BOX",
"package_type_agency_code": 92,
"quantity_of_pack": 1,
"quantity_per_pack": 100,
"type_of_marking": "S",
"type_of_marking_agency_code": 92,
"package_gross_weight": 129.49,
"package_net_weight": 109.05,
"gir_items": {
"gir_item_loop": [
{
"label_number": 250716001,
"batch_number": "CN001"
}
]
}
}
]
},
"line_items": {
"line_item_loop": [
{
"buyer_item_number": "80024936A",
"seller_item_number": "10400001A",
"supplier_item_number": "10400001A",
"quantity": 100,
"quantity_unit": "EA",
"item_description": "CRASH FRONT SUSPENSION",
"order_number": 991935452615,
"additional_internal_destination": "TCFS",
"country_origin": "CN"
}
]
}
}
]
}
},
{
"package_level": 1,
"cps_items": {
"cps_item_loop": [
{
"pac_items": {
"pac_item_loop": [
{
"package_type": "BOX",
"package_type_agency_code": 92,
"quantity_of_pack": 2,
"quantity_per_pack": 120,
"type_of_marking": "S",
"type_of_marking_agency_code": 92,
"package_gross_weight": 129.49,
"package_net_weight": 109.05,
"gir_items": {
"gir_item_loop": [
{
"label_number": 250716002,
"batch_number": "CN002"
},
{
"label_number": 250716003,
"batch_number": "CN002"
}
]
}
}
]
},
"line_items": {
"line_item_loop": [
{
"buyer_item_number": "80024936A",
"seller_item_number": "10400001A",
"supplier_item_number": "10400001A",
"quantity": 250,
"quantity_unit": "EA",
"item_description": "CRASH FRONT SUSPENSION",
"order_number": 991935452615,
"additional_internal_destination": "TCFS",
"country_origin": "CN"
}
]
}
}
]
}
},
{
"package_level": 3,
"outer_package": {
"pac_items": {
"pac_item_loop": [
{
"package_type": "PAL",
"package_type_agency_code": 92,
"quantity_of_pack": 1,
"type_of_marking": "M",
"type_of_marking_agency_code": 92,
"package_gross_weight": 184.06,
"package_net_weight": 436.2,
"gir_items": {
"gir_item_loop": {
"label_number": 250716004,
"batch_number": ""
}
}
}
]
}
},
"cps_items": {
"cps_item_loop": [
{
"pac_items": {
"pac_item_loop": [
{
"package_type": "BOX",
"package_type_agency_code": 92,
"quantity_of_pack": 4,
"quantity_per_pack": 30,
"type_of_marking": "S",
"type_of_marking_agency_code": 92,
"package_gross_weight": 129.49,
"package_net_weight": 109.05,
"gir_items": {
"gir_item_loop": [
{
"label_number": 250716005,
"batch_number": ""
},
{
"label_number": 250716006,
"batch_number": ""
},
{
"label_number": 250716007,
"batch_number": ""
},
{
"label_number": 250716008,
"batch_number": ""
}
]
}
}
]
},
"line_items": {
"line_item_loop": [
{
"buyer_item_number": "80024936B",
"seller_item_number": "10400001B",
"supplier_item_number": "10400001B",
"quantity": 120,
"quantity_unit": "EA",
"item_description": "CRASH FRONT SUSPENSION",
"order_number": 991935452615,
"additional_internal_destination": "TCFS",
"country_origin": "CN"
}
]
}
}
]
}
},
{
"package_level": 3,
"outer_package": {
"pac_items": {
"pac_item_loop": [
{
"package_type": "PAL",
"package_type_agency_code": 92,
"quantity_of_pack": 1,
"type_of_marking": "M",
"type_of_marking_agency_code": 92,
"package_gross_weight": 184.06,
"package_net_weight": 436.2,
"gir_items": {
"gir_item_loop": [
{
"label_number": 250716009,
"batch_number": ""
}
]
}
}
]
}
},
"cps_items": {
"cps_item_loop": [
{
"pac_items": {
"pac_item_loop": [
{
"package_type": "BOX",
"package_type_agency_code": 92,
"quantity_of_pack": 2,
"quantity_per_pack": 50,
"type_of_marking": "S",
"type_of_marking_agency_code": 92,
"package_gross_weight": 129.49,
"package_net_weight": 109.05,
"gir_items": {
"gir_item_loop": [
{
"label_number": 250716010,
"batch_number": ""
},
{
"label_number": 250716011,
"batch_number": ""
}
]
}
},
{
"package_type": "BOX",
"package_type_agency_code": 92,
"quantity_of_pack": 2,
"quantity_per_pack": 100,
"type_of_marking": "S",
"type_of_marking_agency_code": 92,
"package_gross_weight": 129.49,
"package_net_weight": 109.05,
"gir_items": {
"gir_item_loop": [
{
"label_number": 250716012,
"batch_number": ""
},
{
"label_number": 250716013,
"batch_number": ""
}
]
}
}
]
},
"line_items": {
"line_item_loop": [
{
"buyer_item_number": "80024936C",
"seller_item_number": "10400001C",
"supplier_item_number": "10400001C",
"quantity": 300,
"quantity_unit": "EA",
"item_description": "CRASH FRONT SUSPENSION",
"order_number": 991935452615,
"additional_internal_destination": "TCFS",
"country_origin": "CN"
}
]
}
}
]
}
},
{
"package_level": 3,
"outer_package": {
"pac_items": {
"pac_item_loop": [
{
"package_type": "PAL",
"package_type_agency_code": 92,
"quantity_of_pack": 1,
"type_of_marking": "G",
"type_of_marking_agency_code": 92,
"package_gross_weight": 184.06,
"package_net_weight": 436.2,
"gir_items": {
"gir_item_loop": [
{
"label_number": 250716014,
"batch_number": ""
}
]
}
}
]
}
},
"cps_items": {
"cps_item_loop": [
{
"pac_items": {
"pac_item_loop": [
{
"package_type": "BOX",
"package_type_agency_code": 92,
"quantity_of_pack": 2,
"quantity_per_pack": 30,
"type_of_marking": "S",
"type_of_marking_agency_code": 92,
"package_gross_weight": 129.49,
"package_net_weight": 109.05,
"gir_items": {
"gir_item_loop": [
{
"label_number": 250716015,
"batch_number": ""
},
{
"label_number": 250716016,
"batch_number": ""
}
]
}
},
{
"package_type": "BOX",
"package_type_agency_code": 92,
"quantity_of_pack": 2,
"quantity_per_pack": 20,
"type_of_marking": "S",
"type_of_marking_agency_code": 92,
"package_gross_weight": 129.49,
"package_net_weight": 109.05,
"gir_items": {
"gir_item_loop": [
{
"label_number": 250716017,
"batch_number": ""
},
{
"label_number": 250716018,
"batch_number": ""
}
]
}
}
]
},
"line_items": {
"line_item_loop": [
{
"buyer_item_number": "80024936D",
"seller_item_number": "10400001D",
"supplier_item_number": "10400001D",
"quantity": 100,
"quantity_unit": "EA",
"item_description": "CRASH FRONT SUSPENSION",
"order_number": 991935452615,
"additional_internal_destination": "TCFS",
"country_origin": "CN"
}
]
}
},
{
"pac_items": {
"pac_item_loop": [
{
"package_type": "BOX",
"package_type_agency_code": 92,
"quantity_of_pack": 2,
"quantity_per_pack": 40,
"type_of_marking": "S",
"type_of_marking_agency_code": 92,
"package_gross_weight": 129.49,
"package_net_weight": 109.05,
"gir_items": {
"gir_item_loop": [
{
"label_number": 250716019,
"batch_number": ""
},
{
"label_number": 250716020,
"batch_number": ""
}
]
}
},
{
"package_type": "BOX",
"package_type_agency_code": 92,
"quantity_of_pack": 2,
"quantity_per_pack": 50,
"type_of_marking": "S",
"type_of_marking_agency_code": 92,
"package_gross_weight": 129.49,
"package_net_weight": 109.05,
"gir_items": {
"gir_item_loop": [
{
"label_number": 250716021,
"batch_number": ""
},
{
"label_number": 250716022,
"batch_number": ""
}
]
}
}
]
},
"line_items": {
"line_item_loop": [
{
"buyer_item_number": "80024936E",
"seller_item_number": "10400001E",
"supplier_item_number": "10400001E",
"quantity": 180,
"quantity_unit": "EA",
"item_description": "CRASH FRONT SUSPENSION",
"order_number": 991935452615,
"additional_internal_destination": "TCFS",
"country_origin": "CN"
}
]
}
},
{
"pac_items": {
"pac_item_loop": [
{
"package_type": "BOX",
"package_type_agency_code": 92,
"quantity_of_pack": 2,
"quantity_per_pack": 80,
"type_of_marking": "S",
"type_of_marking_agency_code": 92,
"package_gross_weight": 129.49,
"package_net_weight": 109.05,
"gir_items": {
"gir_item_loop": [
{
"label_number": 250716023,
"batch_number": ""
},
{
"label_number": 250716024,
"batch_number": ""
}
]
}
}
]
},
"line_items": {
"line_item_loop": [
{
"buyer_item_number": "80024936F",
"seller_item_number": "10400001F",
"supplier_item_number": "10400001F",
"quantity": 160,
"quantity_unit": "EA",
"item_description": "CRASH FRONT SUSPENSION",
"order_number": 991935452615,
"additional_internal_destination": "TCFS",
"country_origin": "CN"
}
]
}
}
]
}
}
]
}
}Request Example 2 (Pallet + Single Material Scenario + Full Box)
Example shows only the packages parameter section.
json5
{
"packages": {
"package_loop": [
{
"package_level": 3,
"outer_package": {
"pac_items": {
"pac_item_loop": [
{
"package_type": "PAL",
"package_type_agency_code": 92,
"quantity_of_pack": 1,
"type_of_marking": "M",
"type_of_marking_agency_code": 92,
"package_gross_weight": 184.06,
"package_net_weight": 436.2,
"gir_items": {
"gir_item_loop": [
{
"label_number": 250714005,
"batch_number": ""
}
]
}
}
]
}
},
"cps_items": {
"cps_item_loop": [
{
"pac_items": {
"pac_item_loop": [
{
"package_type": "BOX",
"package_type_agency_code": 92,
"quantity_of_pack": 4,
"quantity_per_pack": 20,
"type_of_marking": "S",
"type_of_marking_agency_code": 92,
"package_gross_weight": 129.49,
"package_net_weight": 109.05,
"gir_items": {
"gir_item_loop": [
{
"label_number": 250714001
},
{
"label_number": 250714002
},
{
"label_number": 250714003
},
{
"label_number": 250714004
}
]
}
}
]
},
"line_items": {
"line_item_loop": [
{
"buyer_item_number": "BY_A",
"seller_item_number": "SE_A",
"supplier_item_number": "SE_A",
"quantity": 80,
"quantity_unit": "EA",
"item_description": "",
"order_number": "991935452615",
"country_origin": "CN"
}
]
}
}
]
}
}
]
}
}Request Example 2 (Pallet + Single Material Scenario + Material Not Full)
Example shows only the packages parameter section.
json5
{
"packages": {
"package_loop": [
{
"package_level": 3,
"outer_package": {
"pac_items": {
"pac_item_loop": [
{
"package_type": "PAL",
"package_type_agency_code": 92,
"quantity_of_pack": 1,
"type_of_marking": "M",
"type_of_marking_agency_code": 92,
"package_gross_weight": 184.06,
"package_net_weight": 436.2,
"gir_items": {
"gir_item_loop": [
{
"label_number": 250714005,
"batch_number": ""
}
]
}
}
]
}
},
"cps_items": {
"cps_item_loop": [
{
"pac_items": {
"pac_item_loop": [
{
"package_type": "BOX1",
"package_type_agency_code": 92,
"quantity_of_pack": 3,
"quantity_per_pack": 20,
"type_of_marking": "S",
"type_of_marking_agency_code": 92,
"package_gross_weight": 129.49,
"package_net_weight": 109.05,
"gir_items": {
"gir_item_loop": [
{
"label_number": 250714001
},
{
"label_number": 250714003
},
{
"label_number": 250714004
}
]
}
},
{
"package_type": "BOX1",
"package_type_agency_code": 92,
"quantity_of_pack": 1,
"quantity_per_pack": 15,
"type_of_marking": "S",
"type_of_marking_agency_code": 92,
"package_gross_weight": 129.49,
"package_net_weight": 109.05,
"gir_items": {
"gir_item_loop": [
{
"label_number": 250714002,
"batch_number": ""
}
]
}
}
]
},
"line_items": {
"line_item_loop": [
{
"buyer_item_number": "BY_A",
"seller_item_number": "SE_A",
"supplier_item_number": "SE_A",
"quantity": 75,
"quantity_unit": "EA",
"item_description": "",
"order_number": "991935452615",
"country_origin": "CN"
}
]
}
}
]
}
}
]
}
}Request Example 3 (Pallet + Multi-Material Mixed Scenario)
Example shows only the packages parameter section.
json5
{
"packages": {
"package_loop": [
{
"package_level": 3,
"outer_package": {
"pac_items": {
"pac_item_loop": [
{
"package_type": "PAL",
"package_type_agency_code": 92,
"quantity_of_pack": 1,
"type_of_marking": "G",
"type_of_marking_agency_code": 92,
"package_gross_weight": 184.06,
"package_net_weight": 436.2,
"gir_items": {
"gir_item_loop": [
{
"label_number": 250714005,
"batch_number": ""
}
]
}
}
]
}
},
"cps_items": {
"cps_item_loop": [
{
"pac_items": {
"pac_item_loop": [
{
"package_type": "BOX1",
"package_type_agency_code": 92,
"quantity_of_pack": 1,
"quantity_per_pack": 20,
"type_of_marking": "S",
"type_of_marking_agency_code": 92,
"package_gross_weight": 129.49,
"package_net_weight": 109.05,
"gir_items": {
"gir_item_loop": [
{
"label_number": 250714001
}
]
}
}
]
},
"line_items": {
"line_item_loop": [
{
"buyer_item_number": "BY_A",
"seller_item_number": "SE_A",
"supplier_item_number": "SE_A",
"quantity": 20,
"quantity_unit": "EA",
"item_description": "",
"order_number": "991935452615",
"country_origin": "CN"
}
]
}
},
{
"pac_items": {
"pac_item_loop": [
{
"package_type": "BOX1",
"package_type_agency_code": 92,
"quantity_of_pack": 1,
"quantity_per_pack": 20,
"type_of_marking": "S",
"type_of_marking_agency_code": 92,
"package_gross_weight": 129.49,
"package_net_weight": 109.05,
"gir_items": {
"gir_item_loop": [
{
"label_number": 250714002
}
]
}
}
]
},
"line_items": {
"line_item_loop": [
{
"buyer_item_number": "BY_B",
"seller_item_number": "SE_B",
"supplier_item_number": "SE_B",
"quantity": 20,
"quantity_unit": "EA",
"item_description": "",
"order_number": "991935452615",
"country_origin": "CN"
}
]
}
},
{
"pac_items": {
"pac_item_loop": [
{
"package_type": "BOX1",
"package_type_agency_code": 92,
"quantity_of_pack": 1,
"quantity_per_pack": 20,
"type_of_marking": "S",
"type_of_marking_agency_code": 92,
"package_gross_weight": 129.49,
"package_net_weight": 109.05,
"gir_items": {
"gir_item_loop": [
{
"label_number": 250714003
}
]
}
}
]
},
"line_items": {
"line_item_loop": [
{
"buyer_item_number": "BY_C",
"seller_item_number": "SE_C",
"supplier_item_number": "SE_C",
"quantity": 20,
"quantity_unit": "EA",
"item_description": "",
"order_number": "991935452615",
"country_origin": "CN"
}
]
}
},
{
"pac_items": {
"pac_item_loop": [
{
"package_type": "BOX1",
"package_type_agency_code": 92,
"quantity_of_pack": 1,
"quantity_per_pack": 20,
"type_of_marking": "S",
"type_of_marking_agency_code": 92,
"package_gross_weight": 129.49,
"package_net_weight": 109.05,
"gir_items": {
"gir_item_loop": [
{
"label_number": 250714004
}
]
}
}
]
},
"line_items": {
"line_item_loop": [
{
"buyer_item_number": "BY_D",
"seller_item_number": "SE_D",
"supplier_item_number": "SE_D",
"quantity": 20,
"quantity_unit": "EA",
"item_description": "",
"order_number": "991935452615",
"country_origin": "CN"
}
]
}
}
]
}
}
]
}
}Return Example
- Normal Return Example
json5
{
"status": "success",
"message": "File received: inbound-240712144235484 (1658 Bytes)"
}- Error Return Example
json5
{
"status": "failure",
"message": "File received failure."
}Request parameters, required fields are subject to customer message standards.