Get shipping settings
curl --request GET \
--url https://app.papelship.com/api/v1/shipping \
--header 'x-api-key: <api-key>' \
--header 'x-store-hash: <api-key>'const options = {
method: 'GET',
headers: {'x-api-key': '<api-key>', 'x-store-hash': '<api-key>'}
};
fetch('https://app.papelship.com/api/v1/shipping', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.papelship.com/api/v1/shipping"
headers = {
"x-api-key": "<api-key>",
"x-store-hash": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.papelship.com/api/v1/shipping",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>",
"x-store-hash: <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"
"net/http"
"io"
)
func main() {
url := "https://app.papelship.com/api/v1/shipping"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-store-hash", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"success": true,
"enabled": true,
"currency": "<string>",
"locations": [
{
"id": 123,
"name": "Main warehouse",
"is_default_origin": true,
"is_return": true,
"contact_name": "<string>",
"phone": "<string>",
"active": true,
"address": {
"country_code": "<string>",
"region": "<string>",
"city": "<string>",
"district": "<string>",
"line1": "<string>",
"line2": "<string>",
"postal_code": "<string>"
}
}
],
"zones": [
{
"id": 123,
"name": "Europe",
"countries": [
"DE",
"FR"
],
"regions": {},
"active": true,
"position": 123,
"rates": [
{
"id": 123,
"name": "Standard",
"description": "<string>",
"carrier_code": "dhl_express",
"calc_type": "flat",
"price_cents": 500,
"tiers": [
{
"min": 123,
"max": 123,
"price_cents": 123
}
],
"volumetric_divisor": 123,
"free_over_cents": 123,
"min_days": 123,
"max_days": 123,
"active": true
}
]
}
],
"carriers": [
{
"code": "ups",
"name": "UPS",
"regions": [
"<string>"
],
"has_tracking_link": true
}
]
}{
"success": false,
"code": "INVALID_API_KEY",
"error": "Invalid API Key",
"request_id": "req_7YbK2mQ9xP1cRt4v"
}{
"success": false,
"code": "INSUFFICIENT_SCOPE",
"error": "This API key needs the orders:write permission",
"request_id": "req_7YbK2mQ9xP1cRt4v"
}{
"success": false,
"code": "RATE_LIMITED",
"error": "Too many requests. The limit is 300 requests per minute per key.",
"request_id": "req_7YbK2mQ9xP1cRt4v"
}Shipping settings
Get shipping settings
Locations, zones with rates and the carrier list.
Permission: fulfillment:read
GET
/
shipping
Get shipping settings
curl --request GET \
--url https://app.papelship.com/api/v1/shipping \
--header 'x-api-key: <api-key>' \
--header 'x-store-hash: <api-key>'const options = {
method: 'GET',
headers: {'x-api-key': '<api-key>', 'x-store-hash': '<api-key>'}
};
fetch('https://app.papelship.com/api/v1/shipping', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.papelship.com/api/v1/shipping"
headers = {
"x-api-key": "<api-key>",
"x-store-hash": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.papelship.com/api/v1/shipping",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>",
"x-store-hash: <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"
"net/http"
"io"
)
func main() {
url := "https://app.papelship.com/api/v1/shipping"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-store-hash", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"success": true,
"enabled": true,
"currency": "<string>",
"locations": [
{
"id": 123,
"name": "Main warehouse",
"is_default_origin": true,
"is_return": true,
"contact_name": "<string>",
"phone": "<string>",
"active": true,
"address": {
"country_code": "<string>",
"region": "<string>",
"city": "<string>",
"district": "<string>",
"line1": "<string>",
"line2": "<string>",
"postal_code": "<string>"
}
}
],
"zones": [
{
"id": 123,
"name": "Europe",
"countries": [
"DE",
"FR"
],
"regions": {},
"active": true,
"position": 123,
"rates": [
{
"id": 123,
"name": "Standard",
"description": "<string>",
"carrier_code": "dhl_express",
"calc_type": "flat",
"price_cents": 500,
"tiers": [
{
"min": 123,
"max": 123,
"price_cents": 123
}
],
"volumetric_divisor": 123,
"free_over_cents": 123,
"min_days": 123,
"max_days": 123,
"active": true
}
]
}
],
"carriers": [
{
"code": "ups",
"name": "UPS",
"regions": [
"<string>"
],
"has_tracking_link": true
}
]
}{
"success": false,
"code": "INVALID_API_KEY",
"error": "Invalid API Key",
"request_id": "req_7YbK2mQ9xP1cRt4v"
}{
"success": false,
"code": "INSUFFICIENT_SCOPE",
"error": "This API key needs the orders:write permission",
"request_id": "req_7YbK2mQ9xP1cRt4v"
}{
"success": false,
"code": "RATE_LIMITED",
"error": "Too many requests. The limit is 300 requests per minute per key.",
"request_id": "req_7YbK2mQ9xP1cRt4v"
}Authorizations
Your Store API key (pk_live_...). Create it in Developers › API keys.
The ID of the store the request is for. Shown in Developers › API keys.