Get all shipment

GET

/{owner}/v1/shipment

Parameters

Path Parameters

owner

required

string

version

required

string

Responses

200

object

meta

A meta object that contains non-standard meta-information

object

data

The document’s ‘primary data’.

Array<object>

object

id

required

Unique ID of the Entity

string

type

required

Type of entity

string

version

Any of:

string

string

null

null

attributes

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

Array<object>

object

consumerReference

required

Consumer’s reference for this shipment

string

deliveryAddress

required

Delivery address for the shipment

object

name

Any of:

string

string

null

null

companyName

Any of:

string

string

null

null

houseNameOrNumber

required

House name or number in the address

string

streetAddress

required

Street address of the delivery address

string

line2

Any of:

string

string

null

null

city

required

City of the address

string

state

required

State or region of the address

string

countryCode

required

Country code of the address in ISO 3166-1 alpha-2 format

string

postcode

required

Postal code of the address

string

customer

required

Customer details for the shipment

object

emailAddress

required

Email address of the customer

string

phoneNumber

required

Phone number of the customer

string

citizenId

required

Citizen ID or identification number of the customer

string

orderInformation

required

Information related to the order being shipped

object

consumerReference

Any of:

string

string

null

null

orderCurrency

required

Currency used for the order following ISO 4217 currency codes

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

replacement

required

Indicates if this order is a replacement

boolean

dutiesInformation

required

Duties information for the shipment

object

dimensions

required

Dimensions of the shipment

object

height

required

Any of:

number

number

string

string

width

required

Any of:

number

number

string

string

depth

required

Any of:

number

number

string

string

mass

required

Any of:

number

number

string

string

value

required

Any of:

number

number

string

string

shippingCost

required

Any of:

number

number

string

string

shippingTax

required

Any of:

number

number

string

string

incoterms

required

Incoterms for the shipment

string

Allowed values: EXW FCA FAS FOB CFR CIF CPT CIP DPU DAP DDP

contentDescription

required

Description of the contents in the shipment

string

deliveryTypes

required

List of possible delivery types for the shipment

Array<string>

Allowed values: UK_STANDARD UK_NEXT_DAY INTERNATIONAL_TRACKED WORLD_WIDE_EXPRESS CLICK_AND_COLLECT_UK_STANDARD CLICK_AND_COLLECT_INTERNATIONAL_STANDARD

inventoryItems

required

List of items in the shipment

Array<object>

object

consumerReference

Any of:

string

string

null

null

inventoryItem

required

string format: reference

quantity

required

The quantity of this item being shipped

integer

> 0

condition

required

Condition of the stock being shipped

string

Allowed values: GOOD DAMAGED HELD TRANSFER

customsValue

required

Customs value of the item

object

currency

required

The currency in which the price is denominated following ISO 4217 currency codes

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

value

required

Any of:

number

number

string

string

nonDiscountedValueIncTax

Any of:

number

number

string

string

null

null

tax

required

Any of:

number

number

string

string

fxRates

required

Foreign exchange rates applicable to the shipment

object

key

additional properties

Any of:

number

number

string

string

expectedDispatchDate

required

Date when the shipment is expected to be dispatched

string format: date-time

shipmentBehaviour

required

Behaviour settings for the shipment

object

captureSerialNumber

required

Indicates if serial numbers should be captured

boolean

captureBatch

required

Indicates if batch numbers should be captured

boolean

captureExpiryDate

required

Indicates if expiry dates should be captured

boolean

minimumExpiryDays

required

Minimum number of days before expiry that a product is allowed to ship

integer

> 0

shipmentType

required

Type of shipment

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

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

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

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.