The “List Shipping Rate” API allows to retrieve a list of shipping rate.
GET https://services.leadconnectorhq.com/store/shipping-zone/{shippingZoneId}/shipping-rate
Autorización
Bearer token generado desde el portal Leadway. Ver Autenticación. Version
string
default:"2021-07-28"
required
Versión de la API.
Path parameters
shippingZoneId
string
default:"6578278e879ad2646715ba9c"
required
ID of the item that needs to be returned
Query parameters
altId
string
default:"6578278e879ad2646715ba9c"
required
Account Id or Agency Id
The maximum number of items to be included in a single page of results
The starting index of the page, indicating the position from which the results should be retrieved.
Respuestas
200 - Successful response
total
number
default:"20"
required
Total number of items
An array of items
altId
string
default:"6578278e879ad2646715ba9c"
required
Account Id or Agency Id
Posibles valores: ‘account’
name
string
default:"North zone"
required
Name of the shipping zone
description
string
default:"Ships next day"
Delivery description
currency
string
default:"USD"
required
The currency of the amount of the rate / handling fee
amount
number
default:"99.99"
required
The amount of the shipping rate if it is normal rate (0 means free ). Fixed Handling fee if it is a carrier rate (it will add to the carrier rate).
conditionType
string
default:"price"
required
Type of condition to provide the conditional pricing Posibles valores: ‘none’, ‘price’, ‘weight’
minCondition
number
default:"99.99"
required
Minimum condition for applying this price. set 0 or null if there is no minimum
maxCondition
number
default:"99.99"
required
Maximum condition for applying this price. set 0 or null if there is no maximum
shippingCarrierId
string
default:"655b33a82209e60b6adb87a5"
required
Shipping carrier id
Percentage of rate fee if it is a carrier rate.
An array of items
name
string
default:"Priority Mail Express International"
required
Name of the shipping carrier service
value
string
default:"PriorityMailExpressInternational"
required
Value of the shipping carrier service
_id
string
default:"655b33a82209e60b6adb87a5"
required
The unique identifier for the product.
shippingZoneId
string
default:"655b33a82209e60b6adb87a5"
required
The unique identifier for the shipping zone.
createdAt
string
default:"2023-12-12T09:27:42.355Z"
required
created at
updatedAt
string
default:"2023-12-12T09:27:42.355Z"
required
updated at
{
"total": 20,
"data": [
{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "North zone",
"description": "Ships next day",
"currency": "USD",
"amount": 99.99,
"conditionType": "price",
"minCondition": 99.99,
"maxCondition": 99.99,
"isCarrierRate": true,
"shippingCarrierId": "655b33a82209e60b6adb87a5",
"percentageOfRateFee": 10.99,
"shippingCarrierServices": [
{}
],
"_id": "655b33a82209e60b6adb87a5",
"shippingZoneId": "655b33a82209e60b6adb87a5",
"createdAt": "2023-12-12T09:27:42.355Z",
"updatedAt": "2023-12-12T09:27:42.355Z"
}
]
}
422 - Unprocessable Entity
Ejemplo
curl -X GET 'https://services.leadconnectorhq.com/store/shipping-zone/YOUR_shippingZoneId/shipping-rate' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
const response = await fetch('https://services.leadconnectorhq.com/store/shipping-zone/YOUR_shippingZoneId/shipping-rate', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/store/shipping-zone/YOUR_shippingZoneId/shipping-rate',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
<?php
$ch = curl_init('https://services.leadconnectorhq.com/store/shipping-zone/YOUR_shippingZoneId/shipping-rate');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
