Get all shipment

GET

/{owner}/shipment

Parameters

Path Parameters

owner

required

string

Responses

200

object

meta

A meta object that contains non-standard meta-information

object

key

additional properties

string

data

The document’s ‘primary data’.

Array<object>

object

id

required

Unique ID of the Entity

string

type

required

Type of entity

string

attributes

This contains a data blob of the entity, this is where the main payload of data is

Array<object>

object

shipmentReference

required

string

shipTo

required

object

name

required

string

companyName

required

string

houseNameOrNumber

required

string

streetAddress

required

string

line2

required

string

city

required

string

state

required

string

country

required

string

orderCurrency

required

string

>= 3 characters <= 3 characters

Allowed values: AED AFN ALL AMD ANG AOA ARS AUD AWG AZN BAM BBD BDT BGN BHD BIF BMD BND BOB BOV BRL BSD BTN BWP BYN BZD CAD CDF CHE CHF CHW CLF CLP CNY COP COU CRC CUC CUP CVE CZK DJF DKK DOP DZD EGP ERN ETB EUR FJD FKP GBP GEL GHS GIP GMD GNF GTQ GYD HKD HNL HRK HTG HUF IDR ILS INR IQD IRR ISK JMD JOD JPY KES KGS KHR KMF KPW KRW KWD KYD KZT LAK LBP LKR LRD LSL LYD MAD MDL MGA MKD MMK MNT MOP MRU MUR MVR MWK MXN MXV MYR MZN NAD NGN NIO NOK NPR NZD OMR PAB PEN PGK PHP PKR PLN PYG QAR RON RSD RUB RWF SAR SBD SCR SDG SEK SGD SHP SLE SLL SOS SRD SSP STN SVC SYP SZL THB TJS TMT TND TOP TRY TTD TWD TZS UAH UGX USD USN UYI UYU UYW UZS VED VES VND VUV WST XAF XCD XOF XPF XSU XUA YER ZAR ZMW ZWL

orderReference

required

string

despatchDateExpectation

required

string format: date-time

contentDescription

required

string

courierServiceLevel

required

string

customer

required

object

emailAddress

required

string

phoneNumber

required

string

citizenId

required

string

items

required

Array<object>

object

lineReference

required

string

inventoryItem

required

string format: reference

condition

required

string

Allowed values: GOOD DAMAGED HELD TRANSFER

quantity

required

integer

> 0

shipmentBehaviour

required

object

captureSerialNumber

required

boolean

captureBatch

required

boolean

captureExpiryDate

required

boolean

minimumExpiryDays

required

integer

> 0

shipmentType

required

string

Allowed values: B2B B2C RTS IWT

links

Links to any relevant information or entities

object

self

required

Link to the current resource.

string

related

Link of a related resource.

string

describedBy

Link to API documentation for that resource.

string

meta

Additional information about the entity which isn’t provided in the main data blob

object

key

additional properties

string

links

A links object related to the primary data

object

self

required

Link to the current resource.

string

related

Link of a related resource.

string

next

Link of the next page.

string

prev

Link of the previous page.

string

first

Link of the first page.

string

describedBy

Link to API documentation for that resource.

string

401

Unauthorized access, credentials are invalid.

403

Forbidden access, this is returned when you do not have sufficient permissions to access the resource

404

Not found

429

Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again.

500

Unexpected internal error, could not process request

object

meta

A meta object that contains non-standard meta-information

object

key

additional properties

string

errors

An array of error objects

Array<object>

object

id

A unique identifier for this particular occurrence of the problem

string

links

Links explaining the error

object

about

A link that leads to further details about this particular occurrence of the problem.

string

type

A link that identifies the type of error that this particular error is an instance of.

string

status

The HTTP status code applicable to this problem

string

code

An application-specific error code

string

title

A summary of the problem

string

detail

Explanation specific to this occurrence of the problem

string

source

References to the primary source of the error

object

pointer

Any of:

string

string

null

null

parameter

Any of:

string

string

null

null

header

Any of:

string

string

null

null

meta

A meta object that contains non-standard meta-information

object

key

additional properties

string

503

The API is currently unavailable, please try again later

504

A request timed out while processing, please try again; if it persists try reducing the payload size.