Skip to main content
POST
/
api
/
Prealert
Submit Pre-Alert
curl --request POST \
  --url https://api.aeoral.com/api/Prealert \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "UserCode": "AE12345",
  "TrackingNumber": "1Z999AA10123456784",
  "Reference": "ORDER-10025",
  "Vendor": "Amazon",
  "Description": "Wireless Keyboard"
}
'
{}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
UserCode
string
required
Example:

"AE12345"

​
TrackingNumber
string
required
Example:

"1Z999AA10123456784"

​
Reference
string
Example:

"ORDER-10025"

​
Vendor
string
Example:

"Amazon"

​
Description
string
Example:

"Wireless Keyboard"

Response

Pre-alert created

The response is of type object.