New transport process is a function where deliveries' information manipulated. When this function used, Hoopkapida API immediately responds to the operation's success or failure.
For JSON protocol operations : api.hoopkapida.com/v1/json/post-new-transport-detail
For XML protocol operations : api.hoopkapida.com/v1/xml/post-new-transport-detail
Name | Type | Mandatory | Explanation |
---|---|---|---|
API_USER_ID | String | Yes | Special customer ID for each client generated by Hoopkapida in order to achieve Api requests |
API_USER_PASSWORD | String | Yes | Special customer password for each client generated by Hoopkapida in order to achieve Api requests |
DETAIL_API_ID | String | Yes | Despatch which delivered to Hoopkapida has an ID information in the database. Every despatch that will deliver has a unique ID information at Hoopkapida. For instance, while a Standard shoe box corresponds to an ID, a standard size television has a different ID. Before post operations, IDs which have different delivery types, need to be generated and given to you. |
CUSTOMER_TRACKING_NUMBER | String | No | A tracking system that you can use, special for your own delivery. Example, order tracking number in the online sale system. |
PICKUP_ADDRESS_HEADER | String | No | The location where the package will be taken |
SHIP_TO_PERSON_NAME | String | Yes | Recipient's first name and last name |
SHIP_TO_COMPANY_NAME | String | No | Recipient’s company name |
SHIP_TO_ADDRESS_FULL_TEXT | String | Yes | Recipient’s full address |
SHIP_TO_ADDRESS_COUNTY_TEXT | String | No | Recipient’s county.(Example: KADIKÖY,ŞİŞLİ,BEYOĞLU) |
SHIP_TO_ADDRESS_CITY_TEXT | String | No | Recipient’s city.(Example: İSTANBUL,ANKARA,ANTALYA) |
SHIP_TO_PHONE_NUMBER_1 | String | Yes | Recipient’s phone number |
SHIP_TO_PHONE_NUMBER_2 | String | No | Recipient’s second phone number |
SHIP_TO_EMAIL_ADDRESS | String | No | Recipient’s e-mail address |
f_TRANSPORT_DETAIL_CUSTOMER_PRIVATE_FIELD | String | No | You can use as personal, private area(etc. Order Number, Shipment Number or Customer Number ) |
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_NAME | String | Despatch’s name that will deliver to Hoopkapida, matches with DETAIL_API_ID |
CUSTOMER_PRODUCT_ID | String | Despatch’s ID which 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 | İnteger | Despatch’s volumetric weight information |
TRANSPORT_FIRST_PRICE | Decimal | Despatch’s first price without additional cost |
PICKUP_ADDRESS_HEADER | String | The location where the package will be taken |
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 information |
SHIP_TO_PHONE_NUMBER_1 | String | Recipient’s phone number |
SHIP_TO_PHONE_NUMBER_2 | String | Recipient’s second phone number |
SHIP_TO_EMAIL_ADDRESS | String | Recipient’s e-mail address |
f_TRANSPORT_DETAIL_CUSTOMER_PRIVATE_FIELD | String | You can use as personal, private area(etc. Order Number, Shipment Number or Customer Number ) |
BARCODE | String | Base64 information of CTN number translated into barcode |