Get all shipment complete

GET

/{owner}/v1/shipment/{shipment}/shipment-complete

Parameters

Path Parameters

owner

required

string

version

required

string

shipment

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

consumerOrderReference

Any of:

string

string

null

null

consumerShipmentReference

Any of:

string

string

null

null

inventoryItems

required

List of items that were dispatched

Array<object>

object

consumerReference

Any of:

string

string

null

null

inventoryItem

required

Reference to the inventory item

string format: reference

condition

required

Condition of the stock being shipped

string

Allowed values: GOOD DAMAGED HELD TRANSFER

expectedQuantity

required

The quantity of items that were requested to be dispatched

integer

dispatchedQuantity

required

The quantity of items that have been dispatched

integer

batchNumber

Any of:

string

string

<= 64 characters

null

null

expiryDate

Any of:

string

string

<= 20 characters

null

null

serialNumber

Any of:

string

string

<= 36 characters

null

null

courierAllocation

required

Reference identifier for the courier allocation of the shipment

string format: reference

dispatchDate

required

Date when the shipment was dispatched

string format: date-time

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.