Description

The carrier is used to collect and punch in one parcel.

Path

HTTP Verb 

URL

POST

/services/integration/carrier/parcelclockin

Request field

1

Field (API)

Data Type

Length

Mandatory

Details

2

barcode

String

40

M

Tracking No

3

dateClockIn

Date

80

O

Clock In Time, Format: yyyy-MM-dd'T'HH:mm:ssZ

If not filled in, the current time will be used by default

4

courierNumber

String

80

O

Courier No

5

courierCompany

String

80

O

Courier Company


Request message

{
    "barcode": ["UG690000759BE", "UG690000745BE", "UG690000731BE", "UG690000728BE", "UG690000714BE"],
    "dateClockIn": "2020-08-12T18:37:47+08:00",
    "courierNumber": "SF1193176263351",
    "courierCompany": "顺丰"
}

Response message

{
    "status": "Success",
    "errors": null
}


Error message Pending

Error CodeError Message

Order does not exist


No clock in permission

(if there is a corresponding operation station in step 1 of the service hub configuration, the operation station has the permission to clock in for orders of this service, otherwise an error message will be reported and no clock in permission will be granted)