List Shipping Carriers
1 min
GET
https://api.upstartcommerce.com/v1/shipping-carriers
Query Parameters
- qstringDescriptionMax Length100
- sortstringDescriptionAllowednameidrelevance
- sortDirstringDescriptionAllowedascdesc
- pageinteger<int32>DescriptionDefault0Formatint32Minimum0Maximum1000
- pageSizeinteger<int32>DescriptionDefault25Formatint32Minimum1Maximum50
Header Parameters
- x-upstart-tenantstringrequiredDescription
- x-upstart-sitestringDescription
Responses
200
- ShippingCarrierPageDescription
- itemsShippingCarrier[]requiredDescription
- idstringrequiredExampleDescription
- namestringrequiredExampleDescription
- siteIdsstring[]required
- descriptionstring
- trackingUrlstringExampleDescription
- accountNumberstringDescription
- pageinteger<int32>requiredDescriptionFormatint32
- pageSizeinteger<int32>requiredDescriptionFormatint32
- totalinteger<int32>requiredDescriptionFormatint32
400
- ValidationErrorResponseDescription
- namestringrequired
- codestringrequired
- detailstring
- reasonstring
401
- ErrorResponseDescription
- namestringrequired
- codestringrequired
- detailstringrequired
- reasonstring
curl
curl --request GET \
--url 'https://api.upstartcommerce.com/v1/shipping-carriers?page=integer%3Cint32%3E&pageSize=25' \
--header 'accept: application/json' \
--header 'x-upstart-tenant: string'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-upstart-tenant", "string");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.upstartcommerce.com/v1/shipping-carriers?page=integer<int32>&pageSize=25", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.upstartcommerce.com/v1/shipping-carriers?page=integer<int32>&pageSize=25")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-upstart-tenant"] = "string"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.upstartcommerce.com/v1/shipping-carriers?page=integer<int32>&pageSize=25"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json',
'x-upstart-tenant': 'string'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Success-one page of shipping carriers returned.
{
"items": [
{
"id": "usps",
"name": "USPS",
"siteIds": [
""
],
"description": "",
"trackingUrl": "https://tools.usps.com/go/TrackConfirmAction?tRef=fullpage&tLc=2&text28777=&tLabels={{trackingNumber}}",
"accountNumber": ""
}
],
"page": "",
"pageSize": "",
"total": ""
}400
// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.
{
"name": "",
"code": "",
"detail": "",
"reason": ""
}401
// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.
{
"name": "",
"code": "",
"detail": "",
"reason": ""
}