Create a Shipment

This endpoint creates a Shipment. It is utilized by the KIF user when shipping Devices to a Client. The shipment can contain multiple Devices. Each Device will have its tamper label and serial recorded as part of the shipment.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Shipment to be created.

partner
object
required

Reference to the associated Partner. When used for POST and PATCH API calls, the reference can contain either the ID or Name. With GET API calls, both properties are populated.

client
object
required

Reference to the associated Client resource. When used for POST and PATCH API calls, the reference can contain either the ID or Name. With GET API calls, both properties are populated.

location
object
required

Reference to the associated Location resource. When used for POST and PATCH API calls, the reference can contain either the ID or Name. With GET API calls, both properties are populated.

kif
object
required

Reference to the associated KIF resource. When used for POST and PATCH API calls, the reference can contain either the ID or Name. With GET API calls, both properties are populated.

dcKif
object

Reference to the associated KIF resource. When used for POST and PATCH API calls, the reference can contain either the ID or Name. With GET API calls, both properties are populated.

string
enum
required

The name of the courier.

Allowed:
string
required
length ≤ 255

The courier's tracking number.

string
required

The date and time that a package is shipped.

items
array of objects
required
items*
Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json