Prealerts
Submit Pre-Alert
Submit a shipment pre-alert.
POST
/
api
/
Prealert
Submit Pre-Alert
curl --request POST \
--url https://wh.shiipp.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"
}
'import requests
url = "https://wh.shiipp.com/api/Prealert"
payload = {
"UserCode": "AE12345",
"TrackingNumber": "1Z999AA10123456784",
"Reference": "ORDER-10025",
"Vendor": "Amazon",
"Description": "Wireless Keyboard"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
UserCode: 'AE12345',
TrackingNumber: '1Z999AA10123456784',
Reference: 'ORDER-10025',
Vendor: 'Amazon',
Description: 'Wireless Keyboard'
})
};
fetch('https://wh.shiipp.com/api/Prealert', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://wh.shiipp.com/api/Prealert",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'UserCode' => 'AE12345',
'TrackingNumber' => '1Z999AA10123456784',
'Reference' => 'ORDER-10025',
'Vendor' => 'Amazon',
'Description' => 'Wireless Keyboard'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://wh.shiipp.com/api/Prealert"
payload := strings.NewReader("{\n \"UserCode\": \"AE12345\",\n \"TrackingNumber\": \"1Z999AA10123456784\",\n \"Reference\": \"ORDER-10025\",\n \"Vendor\": \"Amazon\",\n \"Description\": \"Wireless Keyboard\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://wh.shiipp.com/api/Prealert")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"UserCode\": \"AE12345\",\n \"TrackingNumber\": \"1Z999AA10123456784\",\n \"Reference\": \"ORDER-10025\",\n \"Vendor\": \"Amazon\",\n \"Description\": \"Wireless Keyboard\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://wh.shiipp.com/api/Prealert")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"UserCode\": \"AE12345\",\n \"TrackingNumber\": \"1Z999AA10123456784\",\n \"Reference\": \"ORDER-10025\",\n \"Vendor\": \"Amazon\",\n \"Description\": \"Wireless Keyboard\"\n}"
response = http.request(request)
puts response.read_body{}Authorizations
Body
application/json
Response
Pre-alert created
The response is of type object.
Was this page helpful?
⌘I
Submit Pre-Alert
curl --request POST \
--url https://wh.shiipp.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"
}
'import requests
url = "https://wh.shiipp.com/api/Prealert"
payload = {
"UserCode": "AE12345",
"TrackingNumber": "1Z999AA10123456784",
"Reference": "ORDER-10025",
"Vendor": "Amazon",
"Description": "Wireless Keyboard"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
UserCode: 'AE12345',
TrackingNumber: '1Z999AA10123456784',
Reference: 'ORDER-10025',
Vendor: 'Amazon',
Description: 'Wireless Keyboard'
})
};
fetch('https://wh.shiipp.com/api/Prealert', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://wh.shiipp.com/api/Prealert",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'UserCode' => 'AE12345',
'TrackingNumber' => '1Z999AA10123456784',
'Reference' => 'ORDER-10025',
'Vendor' => 'Amazon',
'Description' => 'Wireless Keyboard'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://wh.shiipp.com/api/Prealert"
payload := strings.NewReader("{\n \"UserCode\": \"AE12345\",\n \"TrackingNumber\": \"1Z999AA10123456784\",\n \"Reference\": \"ORDER-10025\",\n \"Vendor\": \"Amazon\",\n \"Description\": \"Wireless Keyboard\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://wh.shiipp.com/api/Prealert")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"UserCode\": \"AE12345\",\n \"TrackingNumber\": \"1Z999AA10123456784\",\n \"Reference\": \"ORDER-10025\",\n \"Vendor\": \"Amazon\",\n \"Description\": \"Wireless Keyboard\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://wh.shiipp.com/api/Prealert")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"UserCode\": \"AE12345\",\n \"TrackingNumber\": \"1Z999AA10123456784\",\n \"Reference\": \"ORDER-10025\",\n \"Vendor\": \"Amazon\",\n \"Description\": \"Wireless Keyboard\"\n}"
response = http.request(request)
puts response.read_body{}