Skip to content
Frontier Platform Integration - FOR INTERNAL USE ONLY

DOCUMENTATION FOR INTERNAL USE ONLY

Get pre advice

GET
/{owner}/v1/pre-advice/{pre_advice}

Parameters

Path Parameters

owner
required
string
version
required
string
pre_advice
required
string

Responses

200

object
meta

A meta object that contains non-standard meta-information

object
data

The document’s ‘primary data’.

object
id
required

Unique ID of the Entity

string
type
required

Type of entity

string
version
Any of:
string
attributes

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

object
consumerReference
Any of:
string
delivery
required
object
estimatedNumberOfLogisticsUnits
required
integer
> 0
logisticsUnitType
required
string
Allowed values: PALLET CARTON
requestedDeliveryDate
required
string format: date-time
deliveryType
required
string
Allowed values: FREIGHT COURIER
inventoryItems
required
Array<object>
object
consumerReference
Any of:
string
inventoryItem
required
string format: reference
advisedQuantity
required
integer
> 0
advisedCondition
required
string
Allowed values: GOOD DAMAGED HELD TRANSFER
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
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
parameter
Any of:
string
header
Any of:
string
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.