API Reference
  1. Stok.ly API
  2. Couriers

Create a courier

post
https://api.stok.ly/v0/couriers

apidoc lists this route under /v1/couriers, but this file is mounted under /v0 - documented at the real path. No dedicated scope exists for couriers - documented under dispatch.providers.create for now.

Body Params
string
required

An arbitrary, human readable identifier for this courier

string
required

The reference for the courier account assigned by the user

integer
enum
required

0: User Defined, 1: DPD, 2: Royal Mail DMO - deprecated, 3: Click And Drop

Allowed:
data
object
required

The properties provided in the data object will be based on the courier type

options
array of objects

The available courier options - this is only respected by a user defined courier

options
Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?