TNH API Document for shop

• Welcome to the TNH API! You can use our API to access TNH API endpoints, which can get information on various trackings, businesses and payments in our database.

• We have language bindings in HTTP and you can view code examples in the dark area to the right.

As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile). You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).

The portal provides documentation for the following APIs and services:

• Package API. Create delivery orders, generate waybills, and cancel orders.
• Location API. Get location informations.

All TNH APIs are RESTful APIs.

Production base URL

• URL: https://gateway.tnhlog.vn

Staging base URL

• URL: https://stg-apigw.tnhlog.vn

In order to provide a high-quality of service for all customers, our API is rate limited. If the rate limit is exceeded, the API responds with an HTTP 400 API rate limit exceeded status code, and you get temporarily blocked from accessing the API. In this case, retry your request after a few hours.

Returns a new Bearer access token.

Prerequisites

To make requests to this endpoint, you need to have the Email and Password. You can obtain by registration new account here:

1. Production: khachhang.tnhlog.vn
2. Staging: stg-khachhang.tnhlog.vn

Implementation flow

Your implementation must adhere to this flow:

1. Login and get the access_token.
2. Store the token, along with the expiration timestamp, in a persistent storage.
3. Attach the token as a Bearer token with every API request to a TNH API. This means that for the Authorization HTTP header, the value must be Bearer <INSERT ACCESS TOKEN>.
4. This token is live forever

The purpose of the Package API is to create delivery orders, generate awb, and cancel orders...

Show address with port codes.

Create/Update warehouse

Webhooks help you register to listen to events arising from Quick.vn's system, for example:

• Receive package status change
• Package has dim weight changed

Sample webhook payloads

package status

{
    "type": "package-update-status",
    "code": "PKG2210897312",
    "reason": "recipient reschedule",
    "epod": "https://domain.com/url-to-epod-image-here",
    "status": "Delivery_failed_attempt"
}

package re-weight

{
    "type": "package-re-weight",
    "code": "PKG2210897312",
    "length": 10.02,
    "width": 12.01,
    "height": 8.2,
    "weight": 2.5
}