Arvato Tracking API
We currently do not support this API. If you are interested in this API, please request for an integration .
Arvato Last Checkpoint API
We currently do not support this API. If you are interested in this API, please request for an integration .
Arvato Estimated delivery date API
We currently do not support this API. If you are interested in this API, please request for an integration .
Arvato Rate API
We currently do not support this API. If you are interested in this API, please request for an integration .
Arvato Label API
We currently do not support this API. If you are interested in this API, please request for an integration .
Arvato Manifest API
We currently do not support this API. If you are interested in this API, please request for an integration .
Arvato Cancel Label API
We currently do not support this API. If you are interested in this API, please request for an integration .
Arvato Pickup API
We currently do not support this API. If you are interested in this API, please request for an integration .
Arvato Cancel Pickup API
We currently do not support this API. If you are interested in this API, please request for an integration .
Arvato Shipper Account API
Create a shipper account
This endpoint allows you to create your shipper account via API. You can integrate our API with your system and manage the shipper account according to your needs.
Please ensure that your account credentials are correct. Different carriers have different requirements for account credentials, you can refer to Shipper account's credetials for more details.
Parameters
slugstringarvatodescriptionstringtimezonestringcredentialsobject
Please refer to Shipper account's credetialsaddressAddress
Address object: the description of address informationstreet1string required
address_line1 of addresscountrystring required
Country in ISO 3166-1 alpha 3 codecontact_namestring required
contact_name of address
Returns
metaMeta
Meta data object.codeinteger required
Code of Metamessagestring required
Message of Metadetailsarray[Error]
Details of Metaretryableboolean
Whether this request will be retryable or not
dataShipperAccount
ShipperAccount object: the description of shipper account informationidstring
Shipper Account IDaddressAddress
Address object: the description of address information
curl --request POST \
--url https://api.aftership.com/postmen/v3/shipper-accounts \
--header 'Content-Type: application/json'\
--data '{"slug":"dhl","address":{"city":"Salt Lake City","state":"UT","phone":"123456789","email":"[email protected]","street1":"230 W 200 S LBBY","country":"USA","postal_code":"84101","contact_name":"AfterShip Shipping","company_name":"AfterShip Shipping"},"timezone":"Asia/Hong_Kong","description":"My Shipper Account","credentials":{"site_id":"******","password":"******","account_number":"******"}}'const url = 'https://api.aftership.com/postmen/v3/shipper-accounts';
const options = {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: "{\"slug\":\"dhl\",\"address\":{\"city\":\"Salt Lake City\",\"state\":\"UT\",\"phone\":\"123456789\",\"email\":\"[email protected]\",\"street1\":\"230 W 200 S LBBY\",\"country\":\"USA\",\"postal_code\":\"84101\",\"contact_name\":\"AfterShip Shipping\",\"company_name\":\"AfterShip Shipping\"},\"timezone\":\"Asia/Hong_Kong\",\"description\":\"My Shipper Account\",\"credentials\":{\"site_id\":\"******\",\"password\":\"******\",\"account_number\":\"******\"}}"
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aftership.com/postmen/v3/shipper-accounts"
payload := strings.NewReader("{\"slug\":\"dhl\",\"address\":{\"city\":\"Salt Lake City\",\"state\":\"UT\",\"phone\":\"123456789\",\"email\":\"[email protected]\",\"street1\":\"230 W 200 S LBBY\",\"country\":\"USA\",\"postal_code\":\"84101\",\"contact_name\":\"AfterShip Shipping\",\"company_name\":\"AfterShip Shipping\"},\"timezone\":\"Asia/Hong_Kong\",\"description\":\"My Shipper Account\",\"credentials\":{\"site_id\":\"******\",\"password\":\"******\",\"account_number\":\"******\"}}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.aftership.com/postmen/v3/shipper-accounts"))
.method("POST", HttpRequest.BodyPublishers.ofString("{\"slug\":\"dhl\",\"address\":{\"city\":\"Salt Lake City\",\"state\":\"UT\",\"phone\":\"123456789\",\"email\":\"[email protected]\",\"street1\":\"230 W 200 S LBBY\",\"country\":\"USA\",\"postal_code\":\"84101\",\"contact_name\":\"AfterShip Shipping\",\"company_name\":\"AfterShip Shipping\"},\"timezone\":\"Asia/Hong_Kong\",\"description\":\"My Shipper Account\",\"credentials\":{\"site_id\":\"******\",\"password\":\"******\",\"account_number\":\"******\"}}"))
.header("Content-Type", "application/json")
.build();
HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());import requests
headers = {
'Content-Type': 'application/json',
}
response = requests.post('https://api.aftership.com/postmen/v3/shipper-accounts', headers=headers, json={"slug":"dhl","address":{"city":"Salt Lake City","state":"UT","phone":"123456789","email":"[email protected]","street1":"230 W 200 S LBBY","country":"USA","postal_code":"84101","contact_name":"AfterShip Shipping","company_name":"AfterShip Shipping"},"timezone":"Asia/Hong_Kong","description":"My Shipper Account","credentials":{"site_id":"******","password":"******","account_number":"******"}}){
"meta": {
"code": 200,
"message": "OK",
"details": []
},
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"slug": "arvato",
"type": "default",
"status": "enabled",
"address": {
"fax": "+1 206-654-3100",
"city": "Lai Chi Kok",
"type": "business",
"phone": "11111111",
"email": "[email protected]",
"state": null,
"tax_id": null,
"country": "HKG",
"street1": "Workshop A, 10/F, Wah Shing Industrial Building",
"street2": "18 Cheung Shun Street, Lai Chi Kok",
"street3": null,
"postal_code": null,
"contact_name": "Sir Foo",
"company_name": "Foo Store"
},
"timezone": "Asia/Hong_Kong",
"created_at": "2016-02-12T10:30:50+00:00",
"updated_at": "2016-09-23T04:56:26+00:00",
"description": "My Shipper Account"
}
}Get a shipper account
This endpoint allows you get a specific shipper account details by shipper account id.
Parameters
idstring required
Shipper account id
Returns
metaMeta
Meta data object.codeinteger required
Code of Metamessagestring required
Message of Metadetailsarray[Error]
Details of Metaretryableboolean
Whether this request will be retryable or not
dataShipperAccount
ShipperAccount object: the description of shipper account informationidstring
Shipper Account IDaddressAddress
Address object: the description of address information
curl --request GET \
--url https://api.aftership.com/postmen/v3/shipper-accounts/id \
--header 'Content-Type: application/json'const url = 'https://api.aftership.com/postmen/v3/shipper-accounts/id';
const options = {
method: 'GET',
headers: {
'Content-Type': 'application/json'
},
body: undefined
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.aftership.com/postmen/v3/shipper-accounts/id"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.aftership.com/postmen/v3/shipper-accounts/id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.header("Content-Type", "application/json")
.build();
HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());import requests
headers = {
'Content-Type': 'application/json',
}
response = requests.get('https://api.aftership.com/postmen/v3/shipper-accounts/id', headers=headers){
"meta": {
"code": 200,
"type": "OK",
"message": "Everything worked as expected."
},
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"slug": "arvato",
"type": "default",
"status": "enabled",
"address": {
"fax": "+1 206-654-3100",
"city": "Lai Chi Kok",
"type": "business",
"phone": "11111111",
"email": "[email protected]",
"state": null,
"tax_id": null,
"country": "HKG",
"street1": "Workshop A, 10/F, Wah Shing Industrial Building",
"street2": "18 Cheung Shun Street, Lai Chi Kok",
"street3": null,
"postal_code": null,
"contact_name": "Sir Foo",
"company_name": "Foo Store"
},
"timezone": "Asia/Hong_Kong",
"created_at": "2016-02-12T10:30:50+00:00",
"updated_at": "2016-09-23T04:56:26+00:00",
"description": "My Shipper Account"
}
}Arvato Address Validation (Beta) API
Create an address validation
Create an address validation
Parameters
addressAddress
Address object: the description of address informationstreet1string required
address_line1 of addresscountrystring required
Country in ISO 3166-1 alpha 3 codecontact\_namestring required
contact_name of address
Returns
metaMeta
Meta data object.codeinteger required
Code of Metamessagestring required
Message of Metadetailsarray[Error]
Details of Metaretryableboolean
Whether this request will be retryable or not
dataShipperAccount
ShipperAccount object: the description of shipper account informationidstring
Shipper Account IDaddressAddress
Address object: the description of address information
curl --request POST \
--url https://api.aftership.com/postmen/v3/address-validations \
--header 'Content-Type: application/json'\
--data '{"address":{"city":"Salt Lake City","state":"UT","phone":"123456789","email":"[email protected]","street1":"230 W 200 S LBBY","country":"USA","postal_code":"84101","contact_name":"AfterShip Shipping","company_name":"AfterShip Shipping"}}'const url = 'https://api.aftership.com/postmen/v3/address-validations';
const options = {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: "{\"address\":{\"city\":\"Salt Lake City\",\"state\":\"UT\",\"phone\":\"123456789\",\"email\":\"[email protected]\",\"street1\":\"230 W 200 S LBBY\",\"country\":\"USA\",\"postal_code\":\"84101\",\"contact_name\":\"AfterShip Shipping\",\"company_name\":\"AfterShip Shipping\"}}"
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aftership.com/postmen/v3/address-validations"
payload := strings.NewReader("{\"address\":{\"city\":\"Salt Lake City\",\"state\":\"UT\",\"phone\":\"123456789\",\"email\":\"[email protected]\",\"street1\":\"230 W 200 S LBBY\",\"country\":\"USA\",\"postal_code\":\"84101\",\"contact_name\":\"AfterShip Shipping\",\"company_name\":\"AfterShip Shipping\"}}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.aftership.com/postmen/v3/address-validations"))
.method("POST", HttpRequest.BodyPublishers.ofString("{\"address\":{\"city\":\"Salt Lake City\",\"state\":\"UT\",\"phone\":\"123456789\",\"email\":\"[email protected]\",\"street1\":\"230 W 200 S LBBY\",\"country\":\"USA\",\"postal_code\":\"84101\",\"contact_name\":\"AfterShip Shipping\",\"company_name\":\"AfterShip Shipping\"}}"))
.header("Content-Type", "application/json")
.build();
HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());import requests
headers = {
'Content-Type': 'application/json',
}
response = requests.post('https://api.aftership.com/postmen/v3/address-validations', headers=headers, json={"address":{"city":"Salt Lake City","state":"UT","phone":"123456789","email":"[email protected]","street1":"230 W 200 S LBBY","country":"USA","postal_code":"84101","contact_name":"AfterShip Shipping","company_name":"AfterShip Shipping"}}){
"meta": {
"code": 200,
"type": "OK",
"message": "Everything worked as expected."
},
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"status": "valid",
"address": {
"city": "New York",
"type": "residential",
"state": "New York",
"phone": "1-123-456-5496",
"email": "[email protected]",
"street1": "This is the first streeet",
"street2": "This is the second streeet",
"country": "USA",
"postal_code": "10001",
"contact_name": "AfterShip Shipping"
},
"created_at": "2022-02-11T08:10:47+00:00",
"updated_at": "2022-02-11T08:10:47+00:00",
"recommended_address": {
"city": "New York",
"type": "residential",
"state": "New York",
"phone": "1-123-456-5496",
"email": "[email protected]",
"street1": "This is the first streeet",
"street2": "This is the second streeet",
"country": "USA",
"postal_code": "10001",
"contact_name": "AfterShip Shipping"
}
}
}