Platform document
/platform-api/platform-overview/platform-api/interface-details/platform-api/interface-details/dispatch/platform-api/interface-details/dispatch/dispatch-order-list/platform-api/interface-details/dispatch/delivery-record/platform-api/interface-details/sending-parcel/platform-api/interface-details/sending-parcel/place-order/platform-api/interface-details/sending-parcel/cancel/platform-api/interface-details/sending-parcel/order-search/platform-api/interface-details/sending-parcel/modify-order-information/platform-api/interface-details/sending-parcel/get-pickup-code/platform-api/interface-details/sending-parcel/sending-code-inquiry-interface/platform-api/interface-details/storage/platform-api/interface-details/storage/create-a-storage-order/platform-api/interface-details/storage/order-enquiry/platform-api/interface-details/storage/send-pickup-code/platform-api/interface-details/storage/sending-deposit-code/platform-api/interface-details/storage/cancel-the-order/platform-api/interface-details/routing-service/platform-api/interface-details/routing-service/order-routing-information-report/platform-api/interface-details/routing-service/courier-delivery-success-report/platform-api/interface-details/routing-service/courier-pickup-successfully-report/platform-api/interface-details/routing-service/user-pickup-report/platform-api/interface-details/routing-service/compartment-failure-report

Delivery a list of orders


  • Interface Path: /order/dispatch/pageList
  • Request method: POST

Parameter

Parameter nameRequiredtypeinstructions
trackingNumberKeyNoStringTracking number
recipientsKeyNoStringRecipient
courierNameKeyNoStringCourier
deliveryStartTimeNoStringInto the locker time to start
deliveryEndTimeNoStringInto the locker the end of time
pickupStartTimeNoStringTake time to start
pickupEndTimeNoStringTake time to an end
pageNumYesLongPage number of rows
pageSizeYesLongThe page number

Return parameter description

Parameter nametypeinstructionsValue of the sample
codeString-000000000
msgString-success
codeObject--
recordsArray--
postIdStringOrder numberFCPJ20211010-1
trackingNumberStringTracking numberXXXXIS123
cellIdStringCompartment numberRO1O1
cellPriceStringFee amount11.00
currencyTypeStringCurrency type, the currency: RMB
courierPhoneStringCourier135xxxxxxxx
lockerAddrStringLocker locationChina,Shenzhen
recipientsPhoneStringRecipient contact139xxxxxxxx
deliveryTimeStringDelivery time04:18 21/03/2022
deliveryTimezoneStringDelivery time zones-04:00
pickupStatusLongOrder status1
pickupStatusTextStringOrder status textTo receive
lockerCodeStringLocker codeFC75527590
pickupTimeStringPickup time04:21 21/03/2022
pickupTimezoneStringPickup time zone+08:00
recipientsMailStringRecipient emailxxxx@aa.com
recipientsAreaNoStringThe user mobile phone area code86
cellTypeLongCompartments type:1:Large、2:Medium、3:Small1
cellTypeTextStringCompartments type textLarge
totalLongThe total number of article18
pagesLongTotal number of pages2
pageSizeLongPage number of rows10
pageNumLongThe page number1

Return the sample

{
  "msg": "success",
  "code": "000000000",
  "data": {
    "total": 10,
    "pages": 1,
    "records": [
      {
        "currencyType": "",
        "recipientsPhone": "13222331122",
        "deliveryTime": "2021",
        "pickupStatusText": "待领取",
        "postId": "FCPJ20211010-1",
        "cellId": "RO1O1",
        "recipientsKey": "Recipientname",
        "deliveryTimezone": "+08:00",
        "cellPrice": "11.00",
        "pickupStatus": 1,
        "lockerCode": "FC75527590",
        "pickupTime": "04:18 21/03/2022",
        "cellType": 1,
        "courierPhone": "13233221122",
        "cellTypeText": "",
        "lockerAddr": "shanghai",
        "trackingNumber": "JIADIS123",
        "pickupTimezone": "上海"
      }
    ],
    "pageSize": 20,
    "pageNum": 1
  }
}