Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ninja Van Order API API

Create and cancel delivery orders and generate waybills.

Ninja Van Order API API is one of 5 APIs that Ninja Van publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Order API. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 5 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 4.1.0.

Requests are made against 2 base URLs: https://api.ninjavan.co/{countryCode}, https://api-sandbox.ninjavan.co/{countryCode}.

5 operations 5 paths 6 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
4.1.0
Base URL
https://api.ninjavan.co/{countryCode}
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Ninja Van Order API API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth2 client-credentials access token obtained from POST /{countryCode}/2.0/oauth/accesstoken, passed as Authorization: Bearer ACCESSTOKEN.

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Order API 5

Create and cancel delivery orders and generate waybills.

POST
/4.2/orders
Create delivery order (v4.2)
createOrderV42 body → 200400401403
POST
/4.1/orders
Create delivery order (v4.1)
createOrderV41 body → 200400401403
DELETE
/2.2/orders/{trackingNo}
Cancel order
cancelOrder 1 param → 200401404
GET
/2.0/reports/waybill
Generate waybill
generateWaybill 3 params → 200401403
GET
/2.0/reports/international-waybills
Generate international waybill
generateInternationalWaybill 1 param → 200401403

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are OrderInput (8 properties), ParcelJob (8 properties), Contact (4 properties), CancelResponse (2 properties). Each schema is shown below with its type and property counts.

Order
Error
object
1 property
Contact
object
A pickup or delivery party.
4 properties
ParcelJob
object
Details of the parcel and how it should be handled.
8 properties
CancelResponse
object
2 properties
OrderInput
object
8 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ninjavan-order-api-api-openapi.yml Raw ↑

Other APIs Ninja Van publishes across the network.

Ninja Van OAuth API API
Ninja Van PUDO API API
Ninja Van Tariff API API
Ninja Van Tracking API API