Create a new Shipment.

post

https://api.portal.clickbox.com/api/shipments

Shipment will be created in draft status. Use the /register endpoint to register it.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Shipment data

type

string

enum

Shipment type

Allowed:

first_name

string

Consignee first name

last_name

string

Consignee last name

string

Consignee email

country

string

length between 2 and 2

Country code(for phone number)

phone

string

Consignee phone number(without country prefix)

locale

string

length between 2 and 2

Defaults to en

Preferred locale(language)

external_reference_id

string

Merchant reference number or order number

pickup_location_id

integer

Pickup location

dropoff_location_id

integer

Dropoff location

payment_type

string

enum

Payment type(Only if Postpayment feature is enabled)

Allowed:

paid

boolean

Required if payment_type is postpaid

manifest_id

integer

Manifest(Only if Manifest feature is enabled)

contents

string

Custom content(Only if Custom content feature is enabled)

hook

string

Webhook url to receive package status updates. See PackageStatusUpdateWebhook Schema.

packages

array of objects

Packages

packages

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response