Shipping cost
POST/api/v1/pricing/shippingCalculates and retrieves shipping costs for available shipping methods based on the provided order details, including the destination address, product type, and specific configuration.
:::note
PRO Tip: You can use the same payload used for submitting an order to check shipping costs.
:::
Request
Body Params application/json
recipient
object
required
firstName
string
optional
lastName
string
optional
company
string
optional
addressLine1
string
required
addressLine2
string
optional
city
string
required
state
string
required
zipCode
string
required
country
string
required
phone
string
optional
orderItems
array [object {5}]
required
subcategoryId
integer
required
quantity
integer
required
width
integer
required
height
integer
required
orderItemOptions
array[integer]
optional
If the product is a Framed Fine Art Paper, the orderItemOptions must include the mat size. If the mat size is not specified, it will default to a ‘No Mat’ option.
Example
{
"recipient": {
"firstName": "John",
"lastName": "Smith",
"company": "",
"addressLine1": "955 E Ball Rd",
"addressLine2": "",
"city": "Anaheim",
"state": "CA",
"zipCode": "92805",
"country": "US",
"phone": "8003806038"
},
"orderItems": [
{
"subcategoryId": 101001,
"quantity": 1,
"width": 8,
"height": 10,
"orderItemOptions": [
2
]
}
]
}Request samples
Responses
Success(200)
No shipping method available(406)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
message
string
required
shippingMethods
array [object {3}]
required
carrier
string
required
method
string
required
cost
number
required
Example
Success
{
"message": "",
"shippingMethods": [
{
"carrier": "USPS",
"method": "usps_ground_advantage",
"cost": 9.35
},
{
"carrier": "USPS",
"method": "usps_priority_mail",
"cost": 10.75
},
{
"carrier": "FedEx/UPS/GLS",
"method": "ground",
"cost": 11.8
},
{
"carrier": "FedEx/UPS/GLS",
"method": "2_day",
"cost": 25.1
},
{
"carrier": "FedEx/UPS/GLS",
"method": "overnight",
"cost": 32.15
},
{
"carrier": "USPS",
"method": "usps_priority_mail_express",
"cost": 32.55
}
]
}Last modified: a month ago