Sign in

v1

latestOpenAPI 3.0.12026-08-061158187.8 KB
Order API

Generate waybill

Generates a waybill for an order.

You can generate a waybill only for an order that is successfully processed. After an order creation request is accepted by the order creation endpoint, the order goes into a queue for further processing. When it's fully processed, the platform generates a Pending Pickup webhook (see Sample webhook payloads). This webhook gives your system an indication that a waybill can be generated.

How to request access

By default, Ninja Van doesn't grant the permission to use the waybill generation endpoint to any shipper, even in the sandbox environment. To request access, take these steps:

  1. Review the Integration requirements.
  2. Send an email to developer support.
get/{countryCode}/2.0/reports/waybill

Path parameters

countryCode'SG' | 'MY' | 'TH' | 'ID' | 'VN' | 'PH' | 'MM' required

Country code.

Query parameters

tidsstring required

The tracking_number as generated by the Order API.

hinteger

A flag for hiding shipper's details, such as contact information, on the waybill. If no flag is provided with the query, the details are hidden. To explicitly hide the details, set to 1. To show the details, set to 0.

orientation'portrait' | 'landscape'

Specifies the orientation of the generated waybill. The default value is portrait.

Headers

Authorizationstring required

Your Bearer token.

Response

Waybill successfully generated. A PDF file will be returned in the response.