Our API is currently in open beta, if you encounter any issues or have a suggestion, please email us at [email protected]. Your insights are invaluable to us.

Lumaprints API

Shipping cost

Sandbox

POST

https://us.api-sandbox.lumaprints.com/api/v1/pricing/shipping

Calculates 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

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string {{Username}}:{{Password}}

Example:

Authorization: Basic *****************

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

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://us.api-sandbox.lumaprints.com/api/v1/pricing/shipping' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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
            ]
        }
    ]
}'

Responses

🟢200Success

application/json

Body

message

string

required

shippingMethods

array [object {3}]

required

carrier

string

required

method

string

required

cost

number

required

Examples

SuccessFreightIncorrect address

{
  "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
    }
  ]
}

🟠406No shipping method available

Modified at 2024-10-08 20:42:17

Get shipments of an order

Subscribe to a new event