When despatch is in operation area (every status from storage to despatch’s delivery), despatch’s status inquiry is provided with this service.
For JSON protocol inquiry : api.hoopkapida.com/v1/json/get-full-transport-detail-ctn/{CUSTOMER_TRACKING_NUMER}/UID={API_USER_ID}-PW={API_USER_PASSWORD}-{LN}
For XML protocol inquiry : api.hoopkapida.com/v1/xml/get-full-transport-detail-ctn/{CUSTOMER_TRACKING_NUMER}/UID={API_USER_ID}-PW={API_USER_PASSWORD}-{LN}
Name | Type | Mandatory | Explanation |
---|---|---|---|
API_USER_ID | String | Evet | Customer ID which is special for each client, generated by Hoopkapida in order to achieve Api requests |
API_USER_PASSWORD | String | Evet | Customer password for each client generated by Hoopkapida in order to achieve Api requests |
CUSTOMER_TRACKING_NUMBER | String | Evet | Customer tracking number which you want to inquire |
LN | String | Evet | Your preferred language for API answer ( en / tr ) |
Name | Type | Statement |
---|---|---|
API_REQUEST_STATUS | String | APIs’ positive or negative information to API request creation. If it is accepted, it will respond as "Accept". If it is not approved, it will respond Reject with a reason. |
CREATED_DATE_TIME_FULL | String | Request creation time. yyyy-MM-dd hh:mm |
CREATED_DATE | String | Request creation date. yyyy-MM-dd |
CREATED_TIME | String | Request creation hour . hh:mm |
HOOPKAPIDA_TRACKING_NUMBER | String | If you don’t have despatch’s tracking number originated by you, you can use unique tracking number originated by Hoopkapida. |
CUSTOMER_TRACKING_NUMBER | String | Customer tracking number for the relevant despatch. |
CUSTOMER_PRODUCT_ID | String | Despatch’s ID which will deliver to Hoopkapida, matches with DETAIL_API_ID |
CUSTOMER_PRODUCT_NAME | String | Despatch’s name that will deliver to Hoopkapida, matches with DETAIL_API_ID |
TRANSPORT_SERVICE_NAME | String | Despatch delivery type name, Example; DELIVERY–ONE WAY |
TRANSPORT_SERVICE_TIME_NAME | String | Despatch's delivery product name that belongs to the time period at Hoopkapida |
TRANSPORT_START_ADDRESS_NAME | String | Despatch’s delivery address information. |
TRANSPORT_CUT_OFF_TIME | String | Despatch’s receiving time information |
TRANSPORT_VOLUME_WEIGHT | Integer | Despatch’s volumetric weight information |
TRANSPORT_FIRST_PRICE | decimal | Despatch’s first price without additional cost |
SHIP_TO_PERSON_NAME | String | Recipient’s full name |
SHIP_TO_COMPANY_NAME | String | Recipient’s company information |
SHIP_TO_ADDRESS_FULL_TEXT | String | Recipient’s full address |
SHIP_TO_ADDRESS_COUNTY_TEXT | String | Recipient’s county information |
SHIP_TO_ADDRESS_CITY_TEXT | String | Recipient’s city address information |
SHIP_TO_PHONE_NUMBER_1 | String | Recipients phone number |
SHIP_TO_PHONE_NUMBER_2 | String | Recipient’s second phone number |
SHIP_TO_EMAIL_ADDRESS | String | Recipient’s e-mail address |
LAST_TRANSACTION_DATE_TIME_FULL | String | Despatch’s last process full time |
LAST_TRANSACTION_DATE | String | Despatch’s last process date |
LAST_TRANSACTION_TIME | String | Despatch’s last process hour |
LAST_TRANSACTION_STATUS_NAME | String | Despatch’s process last status information. |
DELIVERED_PERSON_NAME | String | If despatch's is delivered: Delivered person name |
DELIVERED_PERSON_TITLE | String | If despatch's is delivered: Delivered person recipient's proximity or relationship |
DELIVERED_PERSON_PHONE | String | If despatch's is delivered: Delivered person phone number |
RETURN_STATUS_ID | String | If despatch's is not delivered return status id from courier(example wrong recipient’s address) |
RETURN_STATUS_NAME | String | If despatch's is not delivered return information from courier(example wrong recipient’s address) |
LAST_INFO | String | Last status info that contain delivery or nondelivery notice |
LAST_OPERATION_CODE | String | Despatch’s process last status code |
BARCODE | String | Base64 information of CTN number translated into barcode |
GetURL | String | "APP" application URL where you can check last status of your shipment |