1. Introduction

2. Customer and Warehouse Module API

2.1. Customer Domain Code Query API

2.1.1. SERVICE_TYPE

GLINK_QUERY_OWNER_NOTIFY

2.1.2. Request Parameters

Customer domain code query request

Parameter Type List Required Description
customerCode string N Y Customer code
partnerId string N N Partner ID

2.1.3. Request Example

JSON

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

2.1.4. Response Parameters

Parameter Type List Required Description
success boolean N Y Operation result. true indicates success, and false indicates failure
errorMessageList object Y N Error message list; defaults to an empty array on success, and returns error details when parameter validation or query fails
└ code string N N Error code
└ message string N N Error message
customerDTOList object Y N Customer information list; converted from CustomerVO and populated with domainCode when the query succeeds
└ id long N N Primary key ID, inherited from BaseDTO
└ creatorId long N N Creator ID, inherited from BaseDTO
└ creator string N N Creator username, inherited from BaseDTO
└ createTime date N N Creation time, inherited from BaseDTO
└ updaterId long N N Last updater ID, inherited from BaseDTO
└ updater string N N Last updater username, inherited from BaseDTO
└ updateTime date N N Last update time, inherited from BaseDTO
└ version long N N Optimistic lock version, inherited from BaseDTO
└ remark string N N Remark, inherited from BaseDTO
└ operateType string N N Operation type, default NONE; enum values: NONE, CREATE, UPDATE, DELETE, DISABLE, INCREASE, DECREASE, EDIT, SYNC
└ customerCode string N N Customer code
└ saConfig string N N Service agreement configuration
└ domainCode string N N Customer domain code; queried by DomainDao#getDomainCodeByCustomerCode and then assembled
└ warehouseCodes string N N Warehouse codes bound to the customer
└ carriers string N N Carrier configuration
└ inventoryReportRecipients string N N Inventory report recipients; returned by CustomerVO#getInventoryReportRecipients, and may be empty when inventory reports are not enabled
└ orderMonitorRecipients string N N Order monitoring report recipients
└ serviceLevels string N N Service level configuration
└ subAccounts string N N Sub-account configuration
└ allowOverAllocated boolean N N Whether over-allocation is allowed
└ allowSplitOrder boolean N N Whether order splitting is allowed
└ showZeroInventory boolean N N Whether zero inventory is displayed
└ trackingReportRecipients string N N Tracking report recipients
└ enable boolean N N Whether the customer is enabled
└ receiveInventoryReport boolean N N Whether inventory reports are received
└ receiveTrackingReport boolean N N Whether tracking reports are received
└ receiveOrderMonitorReport boolean N N Whether order monitoring reports are received
└ needSignatureService boolean N N Whether signature service is required
└ workOrderRecipients string N N Work order recipients
└ managerEmail string N N Customer manager email
└ base string N N Customer base
└ allowExternalData boolean N N Whether external data is allowed
└ shipToPhoneRequired boolean N N Whether the recipient phone number is required
└ shipToPhoneDefault string N N Default recipient phone number
└ needFillServiceLevel boolean N N Whether the service level must be provided
└ requireItemCOO boolean N N Whether the item country of origin is required
└ osDReportRecipients string N N ASN feedback report recipients for overage, shortage, or damage
└ enableLargeSize boolean N N Whether large-size items are allowed
└ partnerId string N N Partner ID
└ zipCodeRequired boolean N N Whether the zip code is required
└ returnNotificationRecipients string N N Return notification recipients
└ billingInAdvance boolean N N Whether billing in advance is enabled
└ simpleBillingInAdvance boolean N N Whether simplified billing in advance is enabled
└ billCustomer string N N Billing customer
└ needMarkNumber boolean N N Whether carton marks are required

2.1.5. Response Example

JSON

{
  "success": true,
  "errorMessageList": [],
  "customerDTOList": [
    {
      "id": 10001,
      "creatorId": 20001,
      "creator": "admin",
      "createTime": 1771391400000,
      "updaterId": 20002,
      "updater": "ops",
      "updateTime": 1771480800000,
      "version": 3,
      "remark": "测试客户",
      "operateType": "NONE",
      "customerCode": "CUSTOMER001",
      "saConfig": "STANDARD",
      "domainCode": "US",
      "warehouseCodes": "USLA01:BEST,USNY01:BEST",
      "carriers": "UPS,FEDEX",
      "inventoryReportRecipients": "inventory@example.com",
      "orderMonitorRecipients": "order@example.com",
      "serviceLevels": "GROUND,EXPRESS",
      "subAccounts": "SUB001,SUB002",
      "allowOverAllocated": false,
      "allowSplitOrder": true,
      "showZeroInventory": false,
      "trackingReportRecipients": "tracking@example.com",
      "enable": true,
      "receiveInventoryReport": true,
      "receiveTrackingReport": true,
      "receiveOrderMonitorReport": false,
      "needSignatureService": false,
      "workOrderRecipients": "workorder@example.com",
      "managerEmail": "manager@example.com",
      "base": "US",
      "allowExternalData": true,
      "shipToPhoneRequired": false,
      "shipToPhoneDefault": "13800138000",
      "needFillServiceLevel": false,
      "requireItemCOO": true,
      "osDReportRecipients": "osd@example.com",
      "enableLargeSize": false,
      "partnerId": "GLINK",
      "zipCodeRequired": true,
      "returnNotificationRecipients": "return@example.com",
      "billingInAdvance": false,
      "simpleBillingInAdvance": false,
      "billCustomer": "BILL_CUSTOMER001",
      "needMarkNumber": true
    }
  ]
}

Failed Response JSON

{
  "success": false,
  "errorMessageList": [
    {
      "code": "INVALID_DATA",
      "message": "Customer is required"
    }
  ]
}

2.2. Warehouse Query API

2.2.1. SERVICE_TYPE

GLINK_QUERY_WAREHOUSE_NOTIFY

2.2.2. Request Parameters

Warehouse query request

Parameter Type List Required Description
customerCode string N Y Customer code; the domain for the customer is queried by this field. If it is not provided or no domain is found, a customer-not-found error is returned
partnerId string N N Partner ID

2.2.3. Request Example

JSON

{
  "customerCode": "CUSTOMER001"
}

2.2.4. Response Parameters

Parameter Type List Required Description
success boolean N Y Operation result; true when the query succeeds
code string N N Error status code; not assigned on success, and uniformly set to INVALID_OPERATION by exception handling on failure
message string N N Error message; not assigned on success, and returned after exception handling on failure
resultList object Y N Warehouse information list; returns an empty array when no data is found
└ warehouseCode string N N Warehouse code
└ warehouseDescription string N N Warehouse description
└ timeZone string N N Time zone
└ country string N N Country
└ state string N N State or province
└ city string N N City
└ address1 string N N Address line 1
└ address2 string N N Address line 2
└ zipcode string N N Zip code
└ contact string N N Contact person
└ email string N N Email
└ phone string N N Phone number

2.2.5. Response Example

JSON

{
  "success": true,
  "resultList": [
    {
      "warehouseCode": "WH001",
      "warehouseDescription": "示例仓库",
      "timeZone": "Asia/Shanghai",
      "country": "CN",
      "state": "Zhejiang",
      "city": "Hangzhou",
      "address1": "No.1 Warehouse Road",
      "address2": "Building A",
      "zipcode": "310000",
      "contact": "Zhang San",
      "email": "warehouse@example.com",
      "phone": "0571-12345678"
    }
  ]
}

Failed Response JSON

{
  "code": "INVALID_OPERATION",
  "message": "客户编码不存在",
  "success": false
}
© Copyright QianYi Team 2025 All Rights Reserved            Updated 2026-06-23 11:32:33

results matching ""

    No results matching ""