1. Introduction

2. Order Module API

2.1. Create Order API

2.1.1. SERVICE_TYPE

GLINK_CREATE_ORDER_NOTIFY

2.1.2. Request Parameters

Create order request

Parameter Type List Required Notes
orderNumber string N Y Order number
customerCode string N Y Customer code. Must be unique.
warehouseCode string N Y Warehouse code
extOrderNumber string N N Customer sales platform number, namely the customer order number.
poNumber string N N PO number
storeNumber string N N Store
orderTime string N Y Order time. Format: yyyy-MM-dd'T'HH:mm:ssZ, for example 2017-05-01T16:00:00+0800.
latestShipDate string N N Latest ship date
startShipDate date N N Start ship date
originalOrderTime string N N Original orderTime
notes string N N Warehouse notes
signatureService boolean N N Whether signature service is required
cashOnDelivery boolean N N Cash on delivery service
freightCollect string N N Freight collect service
collectingPaymentAmount string N N Collecting payment amount
shippingRate string N N Shipping fee
totalAmount string N N Total order amount
declaringValueAmount string N N Declared value amount
orderType string N N Document type. Optional values: B2C (standard 2C outbound, default), B2B (standard 2B outbound), RETURN_TO_SUPPLIER (return inbound).
salesChannel string N N Sales channel
currencyCode string N N Currency code. Currently supports USD, CAD, CNY, and THB. Other currencies require additional configuration.
priority string N N Order priority. LOW: low, NORMAL: normal, URGENT: urgent, CRITICAL: critical.
extUserId string N N
isCb boolean N N Whether it is a cross-border store
externalPackageNumList string Y N External package code
orderTagList long Y N Order tag list. Pre-sale: 1, bundle: 4, platform cancellation: 8.
addedServices string Y N Signature service list. ADULT: adult signature, INDIRECT: indirect signature, DIRECT: direct signature, ORDINARY: ordinary signature.
supplier string N N Supplier
cartonization boolean N N Whether specified cartonization is required. 0: no cartonization; 1: specified cartonization information is required. Defaults to 0 if not provided.
isSpecifyBatch boolean N N A marker used by WMS to filter orders with specified batches or as a condition in the order pool.
addressType int N N Address type. 1: unknown, 2: commercial address, 3: residential address.
shippingInstructions object N Y Shipping instructions
└ carrier string N Y Carrier
└ carrierService string N Y Carrier service. Use STD when there are no special requirements.
└ carrierBillingType string N N Freight payment method. SENDER or PREPAID/Prepaid: sender pays; 3RDPARTY or BillThirdParty: third party pays; RECEIVER or FreightCollect: recipient pays; OWNER: cargo owner pays.
└ shippingNotes string N N Carrier notes
└ shippingLabelSource string N Y Shipping label source. ATTACHMENT: label is provided with the order as an attachment. When this value is used, tracking number and carrier information must be provided, and exactly one Shipping Label attachment must be included. API: the warehouse obtains the tracking number from the carrier system. PRE_FILE: pre-generated label file. WMS_GEN: label generated by the warehouse from a configured template.
└ trackingNumber string N N Tracking number
└ carrierAccount string N N Carrier account
└ carrierAccountZipcode string N N Carrier account ZIP code
└ externalCarrierCode string N N External carrier code
└ serviceLevel string N N Service level. STD: standard service; GND: Ground Service; 1DP: Next Day Air Saver; 2DA: 2nd Day Air; 3DS: 3 Day Select; LTL: freight; DEFAULT: BEST overseas warehouse system selects a suitable carrier. FRT is equivalent to LTL.
└ actualLogistic string N N Actual logistics code
shipTo object N Y Recipient information
└ name string N Y Name, mainly used for B2B shipping
└ company string N N Company name
└ phoneNumber string N N Phone number, including area code, phone number, and extension, separated by "-".
└ mobileNumber string N Y Mobile number
└ email string N N Email
└ streetLine1 string N Y Detailed address. Currently limited to 30 characters.
└ streetLine2 string N N Detailed address. Currently limited to 30 characters.
└ district string N N County or district. Note that some cities do not have districts, for example Yiwu City.
└ city string N Y City, for example Hangzhou or Shanghai.
└ state string N Y Province or state, for example Zhejiang, Beijing, New York, or New Jersey.
└ postalCode string N Y Postal code. Required because downstream systems validate it.
└ countryCode string N Y Country
└ companyName string N N Company name
└ streetLine3 string N N Detailed address. Currently limited to 30 characters.
shipFrom object N Y Sender information
└ name string N Y Name, mainly used for B2B shipping
└ company string N N Company name
└ phoneNumber string N N Phone number, including area code, phone number, and extension, separated by "-".
└ mobileNumber string N Y Mobile number
└ email string N N Email
└ streetLine1 string N Y Detailed address. Currently limited to 30 characters.
└ streetLine2 string N N Detailed address. Currently limited to 30 characters.
└ district string N N County or district. Note that some cities do not have districts, for example Yiwu City.
└ city string N Y City, for example Hangzhou or Shanghai.
└ state string N Y Province or state, for example Zhejiang, Beijing, New York, or New Jersey.
└ postalCode string N Y Postal code. Required because downstream systems validate it.
└ countryCode string N Y Country
└ companyName string N N Company name
└ streetLine3 string N N Detailed address. Currently limited to 30 characters.
items object Y Y Order item information
└ sku string N Y Item code
└ name string N N Order item name. It may differ from the item name.
└ quantity int N Y Item quantity
└ hsCode string N N HS code
└ countryOfOrigin string N N Country of origin
└ boxCode string N N Packaging material code
└ retailSku string N N Retail SKU
└ unitCost double N N Cost price
└ retailDescription string N N Retail description
└ barCodeEA string N N EA specification barcode
└ kitItemID string N N Kit item ID. If multiple identical kit items are split into separate child-item lines, different IDs must be provided to uniquely identify each kit item line.
└ kitItemCode string N N Kit item code
└ kitItemDesc string N N Kit item name. Required when kit item ID is provided.
└ kitItemQty string N N Kit item quantity. Required when kit item ID is provided.
└ kitItemImage string N N Kit item image
└ ifDistributionItem boolean N N Whether it is a distribution item
└ ownerShipOfItem string N N Item ownership
└ orderQuantity int N N Order quantity
└ lineNo string N N Line number
└ stockStatus string N N Stock status. GOOD: good stock; DAMAGE: damaged stock.
└ unitPrice string N N Unit price
└ erpLineNo string N N ERP line number
└ batchNo string N N Batch number
└ mfgDate string N N Manufacturing date
└ expDate string N N Expiration date
└ originCountry string N N Batch country of origin
└ udf1 string N N
└ udf2 string N N
└ udf3 string N N
└ udf4 string N N
└ udf5 string N N
└ udf6 string N N
└ udf7 string N N
└ udf8 string N N
└ udf9 string N N
└ udf10 string N N
└ udf11 string N N
└ udf12 string N N
files object Y N Order attachment information
└ fileType string N N File type. Shipping Label: shipping label; Commercial Invoice: invoice; Bill of Lading: bill of lading; Product Label: product label; Carton Label: carton label; Packing List: packing list; Pallet Label: pallet label; Other: other.
└ fileUrl string N N URL file. Recommended. HTML is not currently supported.
└ fileName string N N File name, including the full file name such as yywof.pdf. The file name must include the file format.
└ fileFormat string N N File format
└ isUpdate string N N Whether the file is updated again
invoiceList object Y N Invoice information sent by the external system
└ invoiceNo string N N Invoice number
└ taxCode string N N VAT tax code
└ branchNo string N N Tax department code
└ paymentMethod string N N Payment method
└ address string N N Detailed address 1
└ road string N N Detailed address 2
└ subDistrict string N N District/county
└ district string N N City
└ province string N N Province/prefecture
└ country string N N Country
└ zipCode string N N Postal code
└ phone string N N Phone number
└ phone2 string N N Phone number 2
└ firstName string N N First name
└ lastName string N N Last name
└ invoiceDetailList object Y N Invoice details
└ lineNo int N N Line number
└ productSku string N N Item code
└ productName string N N Item name
└ shopSku string N N External item code
└ qty int N N Item quantity
└ shippingFee double N N Shipping fee
└ itemPrice double N N Item list price
└ taxAmount double N N Tax amount
└ voucherPlatform double N N Platform discount
└ voucherSeller double N N Seller
└ paidPrice double N N Item sale price
palletInfoList object Y N Order-specified pallet and carton information
└ palletCode string N N Specified pallet number
└ boxCode string N N Specified carton number
└ skuCode string N N SKU code
└ skuQty string N N SKU quantity (EA)
udf5 string N N
udf6 string N N
udf7 string N N
udf8 string N N
udf9 string N N
udf10 string N N
udf11 string N N
udf12 string N N
udf13 string N N
udf14 string N N
udf15 string N N

2.1.3. Request Example

JSON

{
  "orderNumber": "orderNumber_c9dac8c1f68e",
  "customerCode": "customerCode_dc6c0ddeec80",
  "warehouseCode": "warehouseCode_2f851a4e9e82",
  "extOrderNumber": "extOrderNumber_f6f61a722688",
  "extUserId": "extUserId_109a85cf74eb",
  "orderTime": "2025-08-21 15:56:39",
  "poNumber": "poNumber_346095b9dc0b",
  "notes": "notes_09316a020905",
  "orderType": "B2C",
  "signatureService": false,
  "addedServices": [
    "ORDINARY"
  ],
  "shippingInstructions": {
    "carrier": "carrier_22718bbec889",
    "carrierService": "carrierService_9f2c15c51e80",
    "carrierAccount": "carrierAccount_c1ede600f163",
    "carrierAccountZipcode": "carrierAccountZipcode_c5003fb70382",
    "serviceLevel": "STD",
    "carrierBillingType": "SENDER",
    "shippingNotes": "shippingNotes_a48b84fb2cd8",
    "trackingNumber": "trackingNumber_94bb2f1774cc",
    "shippingLabelSource": "API",
    "externalCarrierCode": "externalCarrierCode_d315011bb99b",
    "actualLogistic": "actualLogistic_6303ce4f6553"
  },
  "shipTo": {
    "name": "name_a037fa666057",
    "company": "company_cfd0bfcc9bbb",
    "companyName": "companyName_42089aff96f4",
    "phoneNumber": "phoneNumber_7fcaa1911a91",
    "mobileNumber": "mobileNumber_d168f5f79b99",
    "email": "email_70360681fbbf",
    "streetLine1": "streetLine1_6de30fad6773",
    "streetLine2": "streetLine2_d822c9121029",
    "streetLine3": "streetLine3_df1d609fe3cc",
    "district": "district_d3415bf42b53",
    "city": "city_a1ce8f5bdf24",
    "state": "state_893a0bc733f1",
    "postalCode": "postalCode_a66e9983b2ea",
    "countryCode": "countryCode_f28523e1379a",
    "houseNumber": "houseNumber_b2813a963d0a"
  },
  "shipFrom": {
    "name": "name_6b898c782081",
    "company": "company_b0ce6fa0bcb1",
    "companyName": "companyName_e458d120a5be",
    "phoneNumber": "phoneNumber_a1b2ae35a359",
    "mobileNumber": "mobileNumber_f613272692e5",
    "email": "email_673844d71e79",
    "streetLine1": "streetLine1_f39b7a12b188",
    "streetLine2": "streetLine2_164870f602b5",
    "streetLine3": "streetLine3_801872a0ea91",
    "district": "district_8089da1dda63",
    "city": "city_a8f082e1f599",
    "state": "state_1a114ad46d9d",
    "postalCode": "postalCode_b7be4d305970",
    "countryCode": "countryCode_c6d3b726b23d",
    "houseNumber": "houseNumber_5b1362665247"
  },
  "items": [
    {
      "sku": "sku_2d8952660609",
      "name": "name_9bbcc4a5ea0e",
      "quantity": 1,
      "orderQuantity": 1,
      "boxCode": "boxCode_5d207fdee5c4",
      "countryOfOrigin": "countryOfOrigin_951c04101889",
      "hsCode": "hsCode_9f46da6962f8",
      "lineNo": "lineNo_97fe21eb5059",
      "stockStatus": "GOOD",
      "retailSku": "retailSku_447b5063dda2",
      "retailDescription": "retailDescription_6c50dc2066de",
      "unitCost": 1.00,
      "unitPrice": 1.00,
      "erpLineNo": "erpLineNo_5dbfa5825cf7",
      "barCodeEA": "barCodeEA_dede313da8c9",
      "udf1": "udf1_0eb6a7f0ab0a",
      "udf2": "udf2_778265625c24",
      "udf3": "udf3_abcba7c4222c",
      "udf4": "udf4_b82241a920fd",
      "udf5": "udf5_2659bbabf7c1",
      "udf6": "udf6_395d24da1e34",
      "udf7": "udf7_3897d5ac2596",
      "udf8": "udf8_6aa39924d500",
      "udf9": "udf9_c2396f540959",
      "udf10": "udf10_ef32c23cd655",
      "udf11": "udf11_9d53f4572931",
      "udf12": "udf12_7762d50b4e21",
      "kitItemID": "kitItemID_0ba8e057d79e",
      "kitItemCode": "kitItemCode_b1c77bb92ef7",
      "kitItemDesc": "kitItemDesc_356a33768923",
      "kitItemQty": 1,
      "kitItemImage": "kitItemImage_d3cae8b83726",
      "ifDistributionItem": false,
      "ownerShipOfItem": "ownerShipOfItem_143bc685af29",
      "mfgDate": "mfgDate_d106948e803e",
      "expDate": "expDate_5fe1a4c99de9",
      "batchNo": "batchNo_1673fe828b31",
      "originCountry": "originCountry_6e09c0cecd68"
    }
  ],
  "totalAmount": 0.00,
  "collectingPaymentAmount": 0.00,
  "declaringValueAmount": 0.00,
  "shippingRate": 0.00,
  "freightCollect": false,
  "cashOnDelivery": false,
  "files": [
    {
      "fileType": "Shipping Label",
      "fileBase64": "fileBase64_7e3f0fb30006",
      "fileUrl": "fileUrl_06b61df15ce0",
      "fileName": "fileName_555334208839",
      "fileFormat": "fileFormat_e5a2d0625fe0",
      "isUpdate": false
    }
  ],
  "storeNumber": "storeNumber_134aa75c508b",
  "isCb": false,
  "currencyCode": "USD",
  "salesChannel": "salesChannel_fb44d16584b3",
  "invoiceList": [
    {
      "invoiceNo": "invoiceNo_db6c64696406",
      "taxCode": "taxCode_bef06039e383",
      "branchNo": "branchNo_1b4c552ecffa",
      "paymentMethod": "paymentMethod_bd5cf05a93f9",
      "address": "address_15678c2c6058",
      "road": "road_31224298f902",
      "subDistrict": "subDistrict_b087121f6cd7",
      "district": "district_ff534b0ad7c8",
      "province": "province_a2c39e1a3ff9",
      "country": "country_9a3213a081ec",
      "zipCode": "zipCode_6cb5c88e7c72",
      "phone": "phone_b8fee4a9f946",
      "phone2": "phone2_af5d9fbc59d2",
      "firstName": "firstName_0368c4d2bd27",
      "lastName": "lastName_2aa36fdf776f",
      "invoiceDetailList": [
        {
          "lineNo": 0,
          "productSku": "productSku_93db7f536874",
          "productName": "productName_6fcfd3d0b235",
          "shopSku": "shopSku_2c7e372d6cb5",
          "qty": 0,
          "shippingFee": 0.00,
          "itemPrice": 0.00,
          "paidPrice": 0.00,
          "taxAmount": 0.00,
          "voucherPlatform": 0.00,
          "voucherSeller": 0.00
        }
      ]
    }
  ],
  "startShipDate": "2025-08-21 15:56:39",
  "latestShipDate": "2025-08-21 15:56:39",
  "externalPackageNumList": [
    "externalPackageNumList_b61ffd7808c3"
  ],
  "originalOrderTime": "originalOrderTime_48dafc95ea95",
  "orderTagList": [
    0
  ],
  "addressType": 1,
  "supplier": "supplier_60bdecce269c",
  "udf5": "udf5_96f9c982e460",
  "udf6": "udf6_8c2486826872",
  "udf7": "udf7_8f6f37a05a3a",
  "udf8": "udf8_4024d35dbcba",
  "udf9": "udf9_8fa7b4a03c94",
  "udf10": "udf10_deeabf5ee023",
  "udf11": "udf11_7efa467249e5",
  "udf12": "udf12_6edcd8fa459b",
  "udf13": "udf13_3a0cf6aad151",
  "udf14": "udf14_7785170c3845",
  "udf15": "udf15_a33feb115abb",
  "cartonization": false,
  "palletInfoList": [
    {
      "palletCode": "palletCode_f92b009983af",
      "boxCode": "boxCode_0954543f7607",
      "skuCode": "skuCode_f2e028c41f04",
      "skuQty": 1
    }
  ],
  "platformOriginTrackingVos": [
    {
      "platformTrackingType": "platformTrackingType_fa021088eda4",
      "platformTrackingInfo": "platformTrackingInfo_615846c9ef27"
    }
  ],
  "isSpecifyBatch": false,
  "partnerId": "partnerId_f5f1566b795b"
}

2.1.4. Response Parameters

Parameter Type List Required Notes
success boolean N Y Operation result. true indicates successful processing, and false indicates failed processing.
code string N N Operation status code. If the operation fails, it indicates the error type.
message string N N Message

2.1.5. Response Example

JSON

{
  "success": false,
  "code": "code_074664f08113",
  "message": "message_5c9f9d220da5"
}

2.2. Cancel Order API

2.2.1. SERVICE_TYPE

GLINK_CANCEL_ORDER_NOTIFY

2.2.2. Request Parameters

Cancel order request

Parameter Type List Required Notes
partnerId string N N Partner ID. cancelOrders validates whether the customer matches partnerId.
customerCode string N Y Customer code. Returns INVALID_DATA when it or the order number list is empty.
orderNumbers string Y Y Outbound order number list. For a single order, the cancellation result for that order is returned; for multiple orders, the successfully canceled order numbers are returned.
extUserId string N N External user ID. Used for order matching.
orderTagList long Y N Order tag list

2.2.3. Request Example

JSON

{
  "customerCode": "customerCode_d6d6954c2d0b",
  "orderNumbers": [
    "orderNumbers_b2cbd98b5ffd"
  ],
  "extUserId": "extUserId_df7272d371ac",
  "orderTagList": [
    0
  ],
  "partnerId": "partnerId_fafdfc59583f"
}

2.2.4. Response Parameters

Parameter Type List Required Notes
success boolean N Y Operation result. true indicates successful processing, and false indicates failed processing.
code string N N Operation status code. If the operation fails, it indicates the error type.
message string N N Message

2.2.5. Response Example

JSON

{
  "success": false,
  "code": "code_074664f08113",
  "message": "message_5c9f9d220da5"
}

2.3. Query Order API

2.3.1. SERVICE_TYPE

GLINK_QUERY_ORDER_NOTIFY

2.3.2. Request Parameters

Query outbound order request

Parameter Type List Required Notes
partnerId string N N Partner ID. The routing layer selects the processor by customer and partnerId.
customerCode string N Y Customer code. An invalid-parameter error is returned when it is empty.
orderNumbers string Y Y Outbound order number list. A maximum of 100 orders can be queried at a time.
extUserId string N N External user ID. Used for order matching.
queryPackageContentsFromWms boolean N N Whether to query package contents from WMS. Query V2 forces this value to true.

Request Example

JSON

{
  "customerCode": "customerCode_6e3d9deb050c",
  "extUserId": "extUserId_56e517d15898",
  "orderNumbers": [
    "orderNumbers_c75a35d298fa"
  ],
  "queryPackageContentsFromWms": false,
  "partnerId": "partnerId_86e8efcd34ee"
}

Response Parameters

Parameter Type List Required Notes
total int N N Total records. Populated when execution succeeds.
success boolean N Y Success flag
code string N N Error code
message string N N Error message
orderInfoList object Y N Outbound order information on the current page
└ orderNumber string N Y Outbound order number
└ customerCode string N Y Customer code
└ warehouseCode string N Y Warehouse code
└ extOrderNumber string N N External order number
└ extUserId string N N External user ID
└ poNumber string N N PO number
└ orderTime string N N Order time
└ shippingTime string N N Shipping time
└ trackingNumber string N N Primary logistics tracking number
└ billOfLadingNumber string N N Bill of lading number
└ carrier string N N Carrier
└ carrierService string N N Carrier service
└ wmsOrderNumber string N N WMS order number
└ status string N N Order status. Creating: creating; Processing: processing; SendingToWms: sending to warehouse; Received: received by warehouse/pending processing; Shipped: shipped; Error: exception; OverAllocated: over-allocated; Voided: canceled; InsufficientInventory: insufficient inventory.
└ storeNumber string N N Store number
└ salesChannel string N N Sales channel
└ endShipDate string N N Latest ship date
└ dimensionUnit string N N Dimension unit. cm: centimeters; inch: inches.
└ weightUnit string N N Weight unit. kg: kilograms; lb: pounds.
└ packages object Y N Package information
└ orderNumber string N N Order number
└ customerCode string N N Customer code
└ packageNumber string N N Package number
└ carrier string N N Carrier
└ carrierService string N N Carrier service
└ trackingNumber string N N Tracking number
└ length double N N Package length
└ width double N N Package width
└ height double N N Package height
└ weight double N N Package weight
└ packageContents object Y N Package contents
└ sku string N N SKU code
└ quantity double N N Quantity
└ retailSKU string N N Retail SKU
└ retailDescription string N N Retail name
└ shipTo object N N Recipient information
└ name string N N Name
└ company string N N Company
└ phoneNumber string N N Phone
└ email string N N Email
└ streetLine1 string N N Address line 1
└ streetLine2 string N N Address line 2
└ district string N N District/county
└ city string N N City
└ state string N N Province/state
└ postalCode string N N Postal code
└ countryCode string N N Country code
└ shippingExceptionVO object N N Shipping exception
└ code string N N Exception code
└ message string N N Exception message

Response Example

{
  "total": null,
  "success": true,
  "code": "success",
  "message": null,
  "orderInfoList": [
    {
      "orderNumber": "SO202606050001",
      "customerCode": "CUSTOMER001",
      "warehouseCode": "WH001",
      "extOrderNumber": "EXT202606050001",
      "extUserId": "USER001",
      "poNumber": "PO202606050001",
      "orderTime": "2026-06-05 15:00:00",
      "shippingTime": "2026-06-05 16:00:00",
      "trackingNumber": "YT123456789CN",
      "billOfLadingNumber": "BOL202606050001",
      "carrier": "UPS",
      "carrierService": "GROUND",
      "wmsOrderNumber": "WMS202606050001",
      "status": "Shipped",
      "storeNumber": "STORE001",
      "salesChannel": "SHOPIFY",
      "endShipDate": "2026-06-06 23:59:59",
      "dimensionUnit": "cm",
      "weightUnit": "kg",
      "shipTo": {
        "name": "Tom",
        "phoneNumber": "1234567890",
        "streetLine1": "Address 1",
        "city": "LA",
        "state": "CA",
        "postalCode": "90001",
        "countryCode": "US"
      },
      "packages": [
        {
          "orderNumber": "SO202606050001",
          "customerCode": "CUSTOMER001",
          "packageNumber": "PKG001",
          "carrier": "UPS",
          "carrierService": "GROUND",
          "trackingNumber": "YT123456789CN",
          "length": 10.0,
          "width": 8.0,
          "height": 6.0,
          "weight": 1.2,
          "packageContents": [
            {
              "sku": "SKU001",
              "quantity": 1.0,
              "retailSKU": "RSKU001",
              "retailDescription": "商品1"
            }
          ]
        }
      ],
      "shippingExceptionVO": {
        "code": null,
        "message": null
      }
    }
  ]
}

2.4. Query Order API (V2)

2.4.1. SERVICE_TYPE

GLINK_BATCH_QUERY_ORDER_NOTIFY

2.4.2. Request Parameters

Query outbound order request

Parameter Type List Required Notes
partnerId string N N Partner ID
customerCode string N Y Customer code
warehouseCode string N Y Warehouse code
extUserId string N N External user ID
orderNumbers string Y N Outbound order number list. Maximum 100.
extOrderNumbers string Y N External order number list
shippingTimeFrom string N Conditional Shipping time start, format yyyy-MM-dd HH:mm:ss
shippingTimeTo string N Conditional Shipping time end, format yyyy-MM-dd HH:mm:ss
createdTimeFrom string N Conditional Creation time start, format yyyy-MM-dd HH:mm:ss
createdTimeTo string N Conditional Creation time end, format yyyy-MM-dd HH:mm:ss
orderedTimeFrom string N Conditional Order time start, format yyyy-MM-dd HH:mm:ss
orderedTimeTo string N Conditional Order time end, format yyyy-MM-dd HH:mm:ss
odoType string N N Outbound order type
stage string N N Order stage. Common values: CREATED (created), REVIEW (under review), DUE_OUT (pending outbound), ALLOCATED (allocated), RELEASED (released), PICK/PICKING/PICKED (picking/picked), PACK/PACKING (packing), PACKED (packed), ROUTING (routing), SHIPPED (shipped).
status string N N Order status. Common values: VALID (valid), HELD (held), CANCELLED (canceled).
ifNeedBatchInfo boolean N N Whether to return batch information. Default: false.
queryFile boolean N N Whether to return attachment information
page int N N Page number. Default: 1.
pageSize int N N Records per page. Default: 100, maximum 200.

When orderNumbers is empty, at least one query condition group must be provided among shippingTimeFrom/shippingTimeTo, createdTimeFrom/createdTimeTo, orderedTimeFrom/orderedTimeTo, and extOrderNumbers.

2.4.3. Request Example

JSON

{
  "partnerId": "GLINK",
  "customerCode": "CUSTOMER001",
  "warehouseCode": "WH001",
  "extUserId": "EXT_USER_001",
  "orderNumbers": [
    "SO202606050001"
  ],
  "extOrderNumbers": [
    "EXT202606050001"
  ],
  "shippingTimeFrom": "2026-06-05 00:00:00",
  "shippingTimeTo": "2026-06-05 23:59:59",
  "stage": "SHIPPED",
  "status": "VALID",
  "ifNeedBatchInfo": true,
  "queryFile": true,
  "page": 1,
  "pageSize": 50
}

2.4.4. Response Parameters

Parameter Type List Required Notes
success boolean N Y Success flag
code string N N Error code
message string N N Error message
total long N N Total records
orderInfoList object Y N Outbound order information on the current page
└ partnerId string N N Partner ID
└ orderNumber string N Y Outbound order number
└ customerCode string N Y Customer code
└ warehouseCode string N Y Warehouse code
└ extOrderNumber string N N External order number
└ extUserId string N N External user ID
└ poNumber string N N PO number
└ orderTime string N N Order time
└ shippingTime string N N Shipping time
└ trackingNumber string N N Primary tracking number
└ carrier string N N Carrier
└ carrierService string N N Carrier service
└ wmsOrderNumber string N N WMS order number
└ status string N N Order status. Common values: VALID (valid), HELD (held), CANCELLED (canceled).
└ stage string N N Order stage. Common values: CREATED (created), REVIEW (under review), DUE_OUT (pending outbound), ALLOCATED (allocated), RELEASED (released), PICK/PICKING/PICKED (picking/picked), PACK/PACKING (packing), PACKED (packed), ROUTING (routing), SHIPPED (shipped).
└ omsOrderStatus string N N OMS order status
└ orderType string N N Order type. Common values: B2C (standard 2C outbound), B2B (standard 2B outbound).
└ storeNumber string N N Store number
└ salesChannel string N N Sales channel
└ startShipDate string N N Start ship date
└ endShipDate string N N Latest ship date
└ dimensionUnit string N N Dimension unit. cm: centimeters; inch: inches.
└ weightUnit string N N Weight unit. kg: kilograms; lb: pounds.
└ createTime date N N Creation time
└ orderCreatedTime string N N Order creation time
└ cashOnDelivery boolean N N Whether cash on delivery is required
└ signatureService boolean N N Whether signature service is required
└ externalProviderId string N N External provider code
└ externalWarehouseCode string N N External warehouse code
└ externalCarrierCode string N N External carrier code
└ logisticsProvider string N N Logistics provider
└ actualLogistic string N N Actual logistics
└ addressType int N N Address type. 1: unknown, 2: commercial address, 3: residential address.
└ theoreticalWeightEA double N N Order theoretical weight (EA)
└ theoreticalVolumeEA double N N Order theoretical volume (EA)
└ skuMaxLengthEA double N N Maximum item length (EA)
└ supplier string N N Supplier
└ udf5 string N N User-defined field 5
└ udf6 string N N User-defined field 6
└ udf7 string N N User-defined field 7
└ udf8 string N N User-defined field 8
└ udf9 string N N User-defined field 9
└ udf10 string N N User-defined field 10
└ udf11 string N N User-defined field 11
└ udf12 string N N User-defined field 12
└ udf13 string N N User-defined field 13
└ udf14 string N N User-defined field 14
└ udf15 string N N User-defined field 15
└ snUrl string N N Serial number file URL
└ shipTo object N N Recipient information
  └ name string N N Name
  └ company string N N Company
  └ companyName string N N Company name
  └ phoneNumber string N N Phone
  └ mobileNumber string N N Mobile number
  └ email string N N Email
  └ streetLine1 string N N Address line 1
  └ streetLine2 string N N Address line 2
  └ district string N N District/county
  └ city string N N City
  └ state string N N Province/state
  └ postalCode string N N Postal code
  └ countryCode string N N Country code
└ shipFrom object N N Sender information
  └ name string N N Name
  └ company string N N Company
  └ phoneNumber string N N Phone
  └ email string N N Email
  └ streetLine1 string N N Address line 1
  └ streetLine2 string N N Address line 2
  └ district string N N District/county
  └ city string N N City
  └ state string N N Province/state
  └ postalCode string N N Postal code
  └ countryCode string N N Country code
└ items object Y N Item details
  └ sku string N N SKU code
  └ lineNo string N N Line number
  └ quantity int N N Shipped quantity
  └ skuStatus string N N Stock status. GOOD: good stock; DAMAGE: damaged stock.
  └ mfgDate string N N Manufacturing date
  └ expDate string N N Expiration date
  └ batchNo string N N Batch number
  └ originCountry string N N Country of origin
  └ skuDescription string N N Item description
  └ skuCategory string N N Item category
  └ udf1 string N N User-defined field 1
  └ udf2 string N N User-defined field 2
  └ udf3 string N N User-defined field 3
  └ udf4 string N N User-defined field 4
  └ retailSKU string N N Retail SKU
  └ retailDescription string N N Retail name
  └ exception boolean N N Whether there is an exception
  └ exceptionMessage string N N Exception message
  └ unitCost double N N Unit cost
  └ unitPrice double N N Unit price
└ handlings object N N Order handling/billing information
  └ standardPallets int N N Number of standard pallets
  └ oversizedPallets int N N Number of oversized pallets
  └ preStandardPallets int N N Number of pre-built standard pallets
  └ preOversizedPallets int N N Number of pre-built oversized pallets
  └ handlingDetails object Y N Handling details
    └ chargeType string N N Handling/billing activity type
    └ chargeUnit string N N Handling/billing activity unit
    └ chargeQty float N N Handling quantity
    └ chargeManHour float N N Handling labor hours
    └ chargeNote string N N Notes
└ packages object Y N Package information
  └ packageNumber string N N Package number
  └ trackingNumber string N N Tracking number
  └ weight float N N Package weight
  └ length float N N Package length
  └ width float N N Package width
  └ height float N N Package height
  └ volume float N N Package volume
  └ packageContents object Y N Package item details
    └ sku string N N SKU code
    └ quantity double N N Quantity
    └ retailSKU string N N Retail SKU
    └ retailDescription string N N Retail name
    └ skuStockStatus string N N Stock status
    └ mfgDate string N N Manufacturing date
    └ expDate string N N Expiration date
    └ batchNo string N N Batch number
    └ originCountry string N N Country of origin
└ pallets object Y N Pallet information
  └ palletCode string N N Pallet number
  └ preBuilt boolean N N Whether pre-built
  └ weight float N N Pallet weight
  └ length float N N Pallet length
  └ width float N N Pallet width
  └ height float N N Pallet height
  └ volume float N N Pallet volume
└ snList object Y N Serial number details
  └ skuCode string N N SKU code
  └ snList string Y N Serial number list
└ batchInfo object Y N Batch information. Returned only when ifNeedBatchInfo=true.
  └ lineNo int N N Line number
  └ sku string N N SKU code
  └ qty int N N Batch quantity
  └ stockStatus string N N Stock status
  └ batchNumber string N N Batch number
  └ mfgDate string N N Manufacturing date
  └ expDate string N N Expiration date
  └ retailSKU string N N Retail SKU
  └ coo string N N Country of origin
└ fileInfoList object Y N Attachment information. Returned only when queryFile=true.
  └ fileName string N N File name
  └ fileUrl string N N File URL
  └ fileType string N N File type
  └ fileFormat string N N File format
  └ isUpdate boolean N N Whether updated
└ additionalInfoList object Y N Additional information
  └ infoType string N N Additional information type name
  └ infoTypeCode string N N Additional information type code
  └ content string N N Information content
  └ note string N N Information description
  └ uploadedTime string N N Upload time
  └ orderAdditionalFiles object Y N Attachment list
    └ fileName string N N File name
    └ fileUrl string N N File URL
    └ fileType string N N File type
    └ fileFormat string N N File format
    └ isUpdate boolean N N Whether updated
└ shippingExceptionVO object N N Shipping exception
  └ code string N N Exception code
  └ message string N N Exception message

2.4.5. Response Example

JSON

{
  "success": true,
  "code": null,
  "message": null,
  "total": 1,
  "orderInfoList": [
    {
      "partnerId": "GLINK",
      "orderNumber": "SO202606050001",
      "customerCode": "CUSTOMER001",
      "warehouseCode": "WH001",
      "extOrderNumber": "EXT202606050001",
      "extUserId": "EXT_USER_001",
      "poNumber": "PO202606050001",
      "orderTime": "2026-06-05 15:00:00",
      "shippingTime": "2026-06-05 16:00:00",
      "trackingNumber": "YT123456789CN",
      "carrier": "UPS",
      "carrierService": "GROUND",
      "wmsOrderNumber": "WMS202606050001",
      "status": "VALID",
      "stage": "SHIPPED",
      "omsOrderStatus": "WMSShipped",
      "orderType": "B2C",
      "storeNumber": "STORE001",
      "salesChannel": "SHOPIFY",
      "startShipDate": "2026-06-05 00:00:00",
      "endShipDate": "2026-06-06 23:59:59",
      "dimensionUnit": "cm",
      "weightUnit": "kg",
      "actualLogistic": "UPS",
      "addressType": 3,
      "shipTo": {
        "name": "Tom",
        "phoneNumber": "1234567890",
        "streetLine1": "Address 1",
        "city": "LA",
        "state": "CA",
        "postalCode": "90001",
        "countryCode": "US"
      },
      "shipFrom": {
        "name": "BEST Warehouse",
        "phoneNumber": "1234567890",
        "streetLine1": "Warehouse Address",
        "city": "LA",
        "state": "CA",
        "postalCode": "90002",
        "countryCode": "US"
      },
      "items": [
        {
          "sku": "SKU001",
          "lineNo": "1",
          "quantity": 1,
          "skuStatus": "GOOD",
          "batchNo": "BATCH001",
          "originCountry": "CN",
          "skuDescription": "商品1",
          "retailSKU": "RSKU001",
          "retailDescription": "商品1"
        }
      ],
      "packages": [
        {
          "packageNumber": "PKG001",
          "trackingNumber": "YT123456789CN",
          "length": 10.0,
          "width": 8.0,
          "height": 6.0,
          "weight": 1.2,
          "packageContents": [
            {
              "sku": "SKU001",
              "quantity": 1.0,
              "retailSKU": "RSKU001",
              "retailDescription": "商品1",
              "skuStockStatus": "GOOD",
              "batchNo": "BATCH001",
              "originCountry": "CN"
            }
          ]
        }
      ],
      "batchInfo": [
        {
          "lineNo": 1,
          "sku": "SKU001",
          "qty": 1,
          "stockStatus": "GOOD",
          "batchNumber": "BATCH001",
          "coo": "CN"
        }
      ],
      "shippingExceptionVO": {
        "code": null,
        "message": null
      }
    }
  ]
}

2.5. Order Feedback API

2.5.1. SERVICE_TYPE

GLINK_UPDATE_ORDER_STATUS

2.5.2. API Description

When the order status changes, the platform pushes order information to the customer system according to the configured rules. The customer system must return the processing result.

2.5.3. Request Parameters

Order feedback request

Parameter Type List Required Notes
partnerId string N Y Partner ID
orderNumber string N Y Outbound order number
customerCode string N Y Customer code
warehouseCode string N Y Warehouse code
extOrderNumber string N N External order number
extUserId string N N External user ID
poNumber string N N PO number
orderTime string N N Order time
shippingTime string N N Shipping time
trackingNumber string N N Primary tracking number
billOfLadingNumber string N N Bill of lading number
carrier string N N Carrier
carrierService string N N Carrier service
wmsOrderNumber string N N WMS order number
status string N N Order status. WMSReview: pending review; WMSDueOut: pending outbound; WMSReleased: released; WMSPicking: picking; WMSReceived: received by warehouse; Packed: packed; Routing: routing; WMSShipped: shipped.
stage string N N Order stage. Common values: CREATED (created), REVIEW (under review), DUE_OUT (pending outbound), ALLOCATED (allocated), RELEASED (released), PICK/PICKING/PICKED (picking/picked), PACK/PACKING (packing), PACKED (packed), ROUTING (routing), SHIPPED (shipped).
storeNumber string N N Store number
salesChannel string N N Sales channel
orderType string N N Order type. Common values: B2C (standard 2C outbound), B2B (standard 2B outbound).
externalProviderId string N N External provider code
externalWarehouseCode string N N External warehouse code
externalWarehouseName string N N External warehouse name
tcwWarehouseType string N N TCW warehouse type
externalCarrierCode string N N External carrier code
dimensionUnit string N N Dimension unit. cm: centimeters; inch: inches.
weightUnit string N N Weight unit. kg: kilograms; lb: pounds.
createTime date N N Creation time
actualLogistic string N N Actual logistics
logisticsProvider string N N Logistics provider
addressType int N N Address type. 1: unknown, 2: commercial address, 3: residential address.
snUrl string N N Serial number file URL
shipTo object N N Recipient information
└ name string N N Name
└ company string N N Company
└ companyName string N N Company name
└ phoneNumber string N N Phone
└ mobileNumber string N N Mobile number
└ email string N N Email
└ streetLine1 string N N Address line 1
└ streetLine2 string N N Address line 2
└ district string N N District/address line 3
└ city string N N City
└ state string N N Province/state
└ postalCode string N N Postal code
└ countryCode string N N Country
shipFrom object N N Sender information
└ name string N N Name
└ company string N N Company
└ companyName string N N Company name
└ phoneNumber string N N Phone
└ mobileNumber string N N Mobile number
└ email string N N Email
└ streetLine1 string N N Address line 1
└ streetLine2 string N N Address line 2
└ district string N N District/address line 3
└ city string N N City
└ state string N N Province/state
└ postalCode string N N Postal code
└ countryCode string N N Country
items object Y N Item details
└ sku string N N SKU code
└ lineNo string N N Line number
└ quantity int N N Actually shipped quantity
└ skuStatus string N N Stock status. GOOD: good stock; DAMAGE: damaged stock.
└ mfgDate string N N Manufacturing date
└ expDate string N N Expiration date
└ batchNo string N N Batch number
└ originCountry string N N Country of origin
└ skuDescription string N N Cargo description
└ skuCategory string N N Cargo category
└ udf1 string N N User-defined field
└ udf2 string N N User-defined field
└ udf3 string N N User-defined field
└ udf4 string N N User-defined field
└ retailSKU string N N Retail SKU
└ retailDescription string N N Retail description
└ exception boolean N N Whether there is an exception
└ exceptionMessage string N N Exception message
packages object Y N Package information
└ packageType string N N Package type
└ materialCode string N N Packaging material code
└ volume double N N Package volume
└ height double N N Package height
└ width double N N Package width
└ length double N N Package length
└ weight double N N Package weight
└ trackingNumber string N N Tracking number
└ packageNumber string N N Package number
└ externalPackageNumList string Y N External package code
└ logisticsProvider string N N Logistics provider
└ actualLogistic string N N Actual logistics
└ packageContents object Y N Package contents
└ sku string N N SKU code
└ quantity double N N Quantity
└ retailSKU string N N Retail SKU
└ retailDescription string N N Retail name
└ skuStockStatus string N N Stock status. GOOD: good stock; DAMAGE: damaged stock.
└ mfgDate string N N Manufacturing date
└ expDate string N N Expiration date
└ batchNo string N N Batch number
└ originCountry string N N Country of origin
pallets object Y N Pallet information
└ palletCode string N N Pallet code
└ preBuilt boolean N N Whether pre-built
└ weight double N N Weight
└ length double N N Length
└ width double N N Width
└ height double N N Height
└ volume double N N Volume
snList object Y N Serial number list
└ skuCode string N N SKU
└ snList string Y N SN list
batchInfo object Y N Batch information
└ lineNo int N N Line number
└ sku string N N SKU
└ qty int N N Quantity
└ stockStatus string N N Stock status. GOOD: good stock; DAMAGE: damaged stock.
└ batchNumber string N N Batch number
└ mfgDate string N N Manufacturing date
└ expDate string N N Expiration date
└ coo string N N Country of origin
└ retailSKU string N N Retail SKU
└ udf1 string N N User-defined field
└ udf2 string N N User-defined field
└ udf3 string N N User-defined field
└ udf4 string N N User-defined field
└ udf5 string N N User-defined field
└ udf6 string N N User-defined field
└ udf7 string N N User-defined field
└ udf8 string N N User-defined field
└ udf9 string N N User-defined field
└ udf10 string N N User-defined field
└ udf11 string N N User-defined field
└ udf12 string N N User-defined field
└ wmsReceiptNo string N N WMS receipt number
└ receiptDate date N N Receipt date
handlings object N N Order handling information
└ standardPallets int N N Number of standard pallets
└ oversizedPallets int N N Number of oversized pallets
└ preStandardPallets int N N Number of pre-standard pallets
└ preOversizedPallets int N N Number of pre-oversized pallets
└ handlingDetails object Y N Handling detail information
└ chargeType string N N Charge type for billing details
└ chargeUnit string N N Charge unit for billing details
└ chargeQty double N N Charge quantity
└ chargeManHour double N N Labor hours
└ chargeNote string N N Notes
shippingExceptionVO object N N Shipping exception information
└ code string N N Exception code
└ message string N N Exception message
additionalInfoList object Y N Outbound order additional information

2.5.4. Request Example

JSON

{
  "partnerId": "QIANYI",
  "orderNumber": "SO202606050001",
  "customerCode": "CUSTOMER001",
  "warehouseCode": "WH001",
  "extUserId": "USER001",
  "wmsOrderNumber": "WMS202606050001",
  "status": "Shipped",
  "stage": "SHIPPED",
  "trackingNumber": "YT123456789CN",
  "carrier": "UPS",
  "carrierService": "GROUND",
  "shippingTime": "2026-06-05 15:30:00",
  "items": [
    {
      "sku": "SKU001",
      "lineNo": "1",
      "quantity": 1,
      "skuStatus": "GOOD"
    }
  ],
  "packages": [
    {
      "packageNumber": "PKG001",
      "trackingNumber": "YT123456789CN",
      "packageType": "Carton",
      "weight": 1.2,
      "packageContents": [
        {
          "sku": "SKU001",
          "quantity": 1
        }
      ]
    }
  ]
}

2.5.5. Response Parameters

The external system must return the processing result as a MetaResponse.

Parameter Type List Required Notes
success boolean N Y Operation result. true indicates successful processing, and false indicates failed processing.
code string N N Operation status code. Returns the error type when processing fails.
message string N N Message

2.5.6. Response Example

JSON

{
  "success": true,
  "code": "SUCCESS",
  "message": "success"
}

2.6. Add Order Attachment API

2.6.1. SERVICE_TYPE

GLINK_CREATE_FILE_NOTIFY

2.6.2. Request Parameters

Add order attachment request

Parameter Type List Required Notes
partnerId string N N Partner ID. The routing layer selects the processor by customer and partnerId.
customerCode string N Y Customer code. Must be unique.
orderNumber string N Y Logistics order number generated by the customer transaction. The customer system must ensure uniqueness.
extUserId string N N External user ID. Used for matching when querying orders.
files object Y Y Order attachment information. A single request must use either only URL attachments or only Base64 attachments.
└ fileType string N Y File type. Shipping Label: shipping label; Commercial Invoice: invoice; Bill of Lading: bill of lading; Product Label: product label; Carton Label: carton label; Packing List: packing list; Pallet Label: pallet label; Other: other.
└ fileUrl string N C URL file address. Mutually exclusive with fileBase64; URL attachments and Base64 attachments cannot be mixed in the same request.
└ fileBase64 string N C Base64 file content. Mutually exclusive with fileUrl; URL attachments and Base64 attachments cannot be mixed in the same request. The Base64 file size must not exceed the system order attachment size limit.
└ fileName string N Y File name, for example SO202606050001-label.pdf. Used to identify the file extension. Non-ASCII characters in the file name are removed.
└ fileFormat string N N File format. If provided, it must belong to the system file type configuration. If omitted, it is identified from fileName, fileUrl, or Base64 content.
└ isUpdate boolean N N Whether the file is updated again. Defaults to false if not provided.
shippingInstructions object N N Shipping instructions
└ carrier string N N Carrier
└ carrierService string N N Carrier service
└ trackingNumber string N N Tracking number
pickupCode string N N Pickup code

2.6.3. Request Example

URL Attachment

{
  "partnerId": "GERP",
  "customerCode": "CUSTOMER001",
  "orderNumber": "SO202606050001",
  "extUserId": "USER001",
  "shippingInstructions": {
    "carrier": "UPS",
    "carrierService": "GROUND",
    "trackingNumber": "1Z999AA10123456784"
  },
  "pickupCode": "PK001",
  "files": [
    {
      "fileType": "Shipping Label",
      "fileUrl": "https://example.com/files/SO202606050001-label.pdf",
      "fileName": "SO202606050001-label.pdf",
      "fileFormat": "pdf",
      "isUpdate": false
    }
  ]
}

Base64 Attachment

{
  "customerCode": "CUSTOMER001",
  "orderNumber": "SO202606050001",
  "files": [
    {
      "fileType": "Commercial Invoice",
      "fileBase64": "JVBERi0xLjQKJcfsj6IK",
      "fileName": "SO202606050001-invoice.pdf",
      "fileFormat": "pdf",
      "isUpdate": false
    }
  ]
}

2.6.4. Response Parameters

Parameter Type List Required Notes
success boolean N Y Operation result. true indicates successful processing, and false indicates failed processing.
code string N N Operation status code. The current implementation does not set this value on success; returns the error type on failure.
message string N N Message. This API returns an empty string on success.

2.6.5. Response Example

JSON

{
  "success": true,
  "message": ""
}

2.7. Logistics Status Push API

2.7.1. SERVICE_TYPE

GLINK_UPDATE_LOGISTIC_STATUS_NOTIFY_V2

2.7.2. Request Parameters

Logistics status push request

Parameter Type List Required Notes
partnerId string N N Partner ID
customerCode string N N Customer code. When provided, logistics status is updated by customer code plus ERP order number. When omitted, it is updated by WMS order number.
warehouseCode string N N Warehouse code. Required when customerCode is not provided.
updateTrackNo boolean N N Whether to also update the tracking number on the order header and packages. true means update.
orderNumberList object Y Y Order logistics status details. Cannot be empty.
└ orderNumber string N N ERP order number. Required when customerCode is provided.
└ wmsOrderNumber string N N WMS order number. Required when customerCode is not provided.
└ trackingNumber string N N Tracking number
└ status string N Y Logistics status. PENDING: pending pickup; SHIPPED: picked up; IN_TRANSIT: in transit; DELIVERYING: out for delivery; DELIVERED: delivered; NOT_FOUND: not found; EXCEPTION: exception; CANCELLED: canceled.
└ extUserId string N N External user ID
└ eventList object Y N Logistics event list
└ event string N N Logistics event description
└ eventDate long N N Event timestamp, Unix timestamp in milliseconds.

2.7.3. Request Example

JSON

{
  "partnerId": "GERP",
  "customerCode": "CUSTOMER001",
  "warehouseCode": "WH001",
  "updateTrackNo": true,
  "orderNumberList": [
    {
      "orderNumber": "SO202606050001",
      "trackingNumber": "YT123456789CN",
      "status": "IN_TRANSIT",
      "extUserId": "EXT_USER_001",
      "eventList": [
        {
          "event": "Arrived at sorting center",
          "eventDate": 1780632000000
        }
      ]
    }
  ]
}

2.7.4. Response Parameters

Parameter Type List Required Notes
success boolean N Y Operation result. true indicates successful processing, and false indicates failed processing.
code string N N Operation status code
message string N N Message
result object N Y Logistics status push result
└ success boolean N Y Business processing result. true means all succeeded; false means failed details exist.
└ code string N N Business status code. Failure scenarios may return INVALID_DATA.
└ message string N N Business message
└ warehouseCode string N N Warehouse code. The target method fills it from the request parameters.
└ orderNumberList object Y N Failed detail list. May be omitted when all records succeed.
└ orderNumber string N N ERP order number
└ wmsOrderNumber string N N WMS order number
└ trackingNumber string N N Tracking number
└ status string N N Logistics status. PENDING: pending pickup; SHIPPED: picked up; IN_TRANSIT: in transit; DELIVERYING: out for delivery; DELIVERED: delivered; NOT_FOUND: not found; EXCEPTION: exception; CANCELLED: canceled.
└ extUserId string N N External user ID
└ errorMessage string N N Failure reason for the detail line

2.7.5. Response Example

JSON

{
  "success": true,
  "result": {
    "success": true,
    "warehouseCode": "WH001"
  }
}

Failure Response Example

{
  "success": true,
  "result": {
    "success": false,
    "code": "INVALID_DATA",
    "message": "orderNumberList doesn't empty",
    "warehouseCode": "WH001",
    "orderNumberList": [
      {
        "orderNumber": "",
        "trackingNumber": "YT123456789CN",
        "status": "IN_TRANSIT",
        "extUserId": "EXT_USER_001",
        "errorMessage": "orderNumber doesn't empty"
      }
    ]
  }
}

2.8. Online Order Status Update API

Used to batch update online order statuses by ERP order number.

2.8.1. SERVICE_TYPE

GLINK_UPDATE_ORDER_ONLINE_STATUS_NOTIFY

2.8.2. Request Parameters

Online order status update request

Parameter Type List Required Notes
partnerId string N N Partner ID
customerCode string N Y Customer code
warehouseCode string N N Warehouse code
orderNumberList object Y Y Order status detail list. Cannot be empty.
└ orderNumber string N Y ERP order number
└ onlineStatus string N Y Online order status. Values vary by channel and are passed through as-is.
└ extUserId string N N External user ID

2.8.3. Request Example

JSON

{
  "partnerId": "GERP",
  "customerCode": "CUSTOMER001",
  "warehouseCode": "WH001",
  "orderNumberList": [
    {
      "orderNumber": "SO202606050001",
      "onlineStatus": "PAID",
      "extUserId": "USER001"
    }
  ]
}

2.8.4. Response Parameters

The API returns GomsResponse<OrderOnlineStatusVo>.

Parameter Type List Required Notes
success boolean N Y Operation result. true indicates successful processing, and false indicates failed processing.
code string N N Operation status code
message string N N Message
result object N Y Business processing result
└ success boolean N Y Processing result for a single record. false when processing fails.
└ code string N N Business status code. This API explicitly uses INVALID_DATA as a failure code.
└ message string N N Business message, such as customer doesn't exist, warehouse doesn't exist, or orderNumberList doesn't empty.
└ warehouseCode string N N Warehouse code. Filled from warehouseCode in the request.
└ orderNumberList object Y N Error detail list. Not set when all records succeed; returned when failed details exist.
└ orderNumber string N N ERP order number
└ onlineStatus string N N Online order status from the request
└ extUserId string N N External user ID from the request
└ errorMessage string N N Detail error message

2.8.5. Response Example

JSON

{
  "success": true,
  "result": {
    "success": true,
    "warehouseCode": "WH001"
  }
}

Failure Response Example (Order Not Found)

{
  "success": true,
  "result": {
    "success": false,
    "code": "INVALID_DATA",
    "message": "orderNumberList doesn't empty",
    "warehouseCode": "WH001",
    "orderNumberList": [
      {
        "orderNumber": "SO202606050001",
        "onlineStatus": "PAID",
        "extUserId": "USER001",
        "errorMessage": "Order doesn't exist."
      }
    ]
  }
}

2.9. Adjustment Feedback API

2.9.1. SERVICE_TYPE

GLINK_ADJUST_STOCK_PUSH

2.9.2. API Description

When the order status changes, the platform pushes order information to the customer system according to the configured rules. The customer system must return the processing result.

2.9.3. Request Parameters

Adjustment feedback request

Parameter Type List Required Notes
partnerId string N Y Partner ID
customerCode string N Y Customer code
warehouseCode string N Y Warehouse code
adjustNumber string N Y Adjustment number
referenceType string N Y Adjustment source type. Common values: RECEIPT (inbound), GENERAL (general).
referenceNo string N N Adjustment source reference number
confirmDate date N Y Adjustment confirmation time. Serialized as a timestamp in JSON.
type string N Y Adjustment type. Common values: VARIANCE_ADJUSTMENT (variance adjustment), VARIANCE_INV (variance inventory), CYCLE_COUNT (cycle count), and others.
reason string N N Adjustment reason
note string N N Notes
adjustList object Y Y Adjustment details
└ sku string N Y Item code
└ adjustQty int N Y Adjustment quantity. Can be positive or negative.
└ invType string N Y Inventory adjustment type. ADJUST_AVAILABLE_QTY: available inventory; ADJUST_HOLD_QTY: held inventory; ADJUST_QUARANTINE_QTY: quarantined inventory.
└ status string N N Stock status. GOOD: good stock; DAMAGE: damaged stock.
└ batchNo string N N Cargo batch
└ mfgDate string N N Cargo manufacturing date
└ expDate string N N Cargo expiration date
└ countryOfOrigin string N N Cargo country of origin
└ unit string N N Unit
└ receiptDate date N N Inventory receipt time. Serialized as a timestamp in JSON.

2.9.4. Request Example

JSON

{
  "partnerId": "QIANYI",
  "customerCode": "CUSTOMER001",
  "warehouseCode": "WH001",
  "adjustNumber": "ADJ202606050001",
  "referenceType": "GENERAL",
  "referenceNo": "REF202606050001",
  "confirmDate": 1780632000000,
  "type": "VARIANCE_ADJUSTMENT",
  "reason": "库存差异调整",
  "note": "库存差异调整",
  "adjustList": [
    {
      "sku": "SKU001",
      "adjustQty": 5,
      "invType": "ADJUST_AVAILABLE_QTY",
      "status": "GOOD",
      "batchNo": "BATCH20260605",
      "mfgDate": "2026-01-01",
      "expDate": "2027-01-01",
      "countryOfOrigin": "CN",
      "unit": "EA",
      "receiptDate": 1780632000000
    },
    {
      "sku": "SKU002",
      "adjustQty": -2,
      "invType": "ADJUST_HOLD_QTY",
      "status": "GOOD",
      "batchNo": "BATCH20260606",
      "mfgDate": "2026-02-01",
      "expDate": "2027-02-01",
      "countryOfOrigin": "CN",
      "unit": "EA",
      "receiptDate": 1780632000000
    }
  ]
}

2.9.5. Response Parameters

Parameter Type List Required Notes
success boolean N Y Operation result. true indicates successful processing, and false indicates failed processing.
code string N N Operation status code. If the operation fails, it indicates the error type.
message string N N Message

2.9.6. Response Example

JSON

{
  "success": true,
  "code": "SUCCESS",
  "message": "success"
}

2.10. Create Processing Order API

2.10.1. SERVICE_TYPE

GLINK_CREATE_PRODUCTION_ORDER

2.10.2. Request Parameters

Create processing order request

Parameter Type List Required Notes
partnerId string N N Partner ID. The API validates whether the customer matches partnerId.
productionOrderNumber string N Y Processing order number
customerCode string N Y Customer code
warehouseCode string N Y Warehouse code. Must be an enabled warehouse available to the customer.
productionType string N Y Processing type. KITTING: kitting/assembly processing; UNKITTING: unkitting/disassembly processing.
note string N N Notes
itemList object Y Y Processing item list. At least one detail line must be provided.
└ lineNo string N Y Line number
└ fromItemList object Y Y Source item list. Cannot be empty.
└ skuCode string N Y Item code. Must exist and be enabled.
└ description string N N Cargo description
└ unit string N N Processing unit. Common value: EA (piece). Valid values depend on warehouse configuration.
└ expectQty int N Y Processing quantity. Must be greater than 0.
└ toItemList object Y Y Target item list. Cannot be empty.
└ skuCode string N Y Item code. Must exist and be enabled.
└ description string N N Cargo description
└ unit string N N Processing unit. Common value: EA (piece). Valid values depend on warehouse configuration.
└ expectQty int N Y Processing quantity. Must be greater than 0.

2.10.3. Request Example

JSON

{
  "partnerId": "GLINK",
  "productionOrderNumber": "PO202606050001",
  "customerCode": "CUSTOMER001",
  "warehouseCode": "WH001",
  "productionType": "KITTING",
  "note": "套装加工",
  "itemList": [
    {
      "lineNo": "1",
      "fromItemList": [
        {
          "skuCode": "SKU-FROM-001",
          "description": "原料商品1",
          "unit": "EA",
          "expectQty": 2
        }
      ],
      "toItemList": [
        {
          "skuCode": "SKU-TO-001",
          "description": "成品商品1",
          "unit": "EA",
          "expectQty": 1
        }
      ]
    }
  ]
}

2.10.4. Response Parameters

Parameter Type List Required Notes
success boolean N Y Operation result. true indicates successful processing, and false indicates failed processing.
code string N N Operation status code. Returns success when creation succeeds, or a specific error code when it fails.
message string N N Message. This field is not returned or is empty when creation succeeds.

2.10.5. Response Example

JSON

{
  "success": true,
  "code": "success"
}

2.11. Cancel Processing Order API

2.11.1. SERVICE_TYPE

GLINK_CANCEL_PRODUCTION_ORDER

2.11.2. Request Parameters

Cancel processing order request

Parameter Type List Required Notes
partnerId string N N Partner ID. The API validates whether the customer matches partnerId.
productionOrderNumber string N Y Processing order number
customerCode string N Y Customer code

2.11.3. Request Example

JSON

{
  "partnerId": "GLINK",
  "productionOrderNumber": "PO202606050001",
  "customerCode": "CUSTOMER001"
}

2.11.4. Response Parameters

Parameter Type List Required Notes
success boolean N Y Operation result. true indicates successful processing, and false indicates failed processing.
code string N N Operation status code. Returns success when cancellation succeeds, or a specific error code when the order does not exist or another failure occurs.
message string N N Message

2.11.5. Response Example

JSON

{
  "success": true,
  "code": "success"
}
© Copyright QianYi Team 2025 All Rights Reserved            Updated 2026-06-23 11:32:33

results matching ""

    No results matching ""