Skip to content
Stashtab Docs
Esc
↑↓navigate↵open⌘Jpreview

Compare customer-priced parcel shipping estimates

Compare customer-priced parcel shipping estimates for all products and quantities at the selected physical inventory source. Preview first; copy physicalSource.selected unchanged as fulfillmentSource. Source selections are opaque handoff bundles, not display labels. Insurance defaults to kind: none, the native no-additional-insurance choice; carrier-included baseline coverage is unaffected. An optional kind: native choice names an eligible provider and one insured value for the shipment’s one parcel, with explicit amount and USD currency. Goods/customs declarations remain independent. Supported opt-in requires current account and shipment-update evidence for the insurer, collectibles, carrier, destination, values, signature and claims rules; schema fields alone do not enable coverage. Native full rates expose the premium separately as insuranceAmount, alongside shippingAmount, fulfillmentAmount and configured fees; totalAmount includes those amounts. Delivery confirmation defaults to none. Set deliveryConfirmation to signature or adult_signature for an eligible shipment; delivery and FedEx direct_signature are also admitted. Restricted and other V2-only modes are unavailable through this shared V1 order path. Non-default confirmation excludes Ground Saver, SurePost and Media Mail; omitted or none retains existing configured service behavior. The actual confirmationAmount is an included component of the shipping pricing basis, not an extra amount to add to totalAmount. Customer shipping pricing still applies once to the combined carrier cost or retail comparison. A non-default confirmation requires a current priced selection. Test confirmation is unavailable. A quote prices one parcel at the order’s total weight, and only the warehouse’s configured carrier accounts are offered. Current provider rejection is distinct from an unavailable lookup; no mode is silently substituted. Copy the returned selection, including deliveryConfirmation and insurance, unchanged as shippingQuote for ordinary orders or redemptions. Create revalidates the physical source, recipient, parcels, service, coverage and prices; changed facts require a fresh quote. Vault does not buy the label or insured coverage; creating the order writes the chosen insurance to the warehouse order as a coverage request, and order.current.insurance.label shows the coverage the warehouse’s label reports, once it exists. A quote or creation receipt does not buy or prove insurance. Delivery timing is a carrier estimate when supplied. Import duties, taxes and later adjustments are not guaranteed. Quotes create no order, reservation, label, charge, shipment or price lock. A completed lookup with no eligible service returns quotes: []; incomplete configuration or provider failure is unavailable. Pallet freight retains its separate workflow.

POST/v1/organizations/{orgId}/shipping-quotes
Authorization
AuthorizationBasic auth · headerrequired

Registered confidential integration credentials. Keep the secret server-side.

or
CookieAPI key · headerrequired

Console-managed Vault session cookie; secure cookie naming may vary by environment.

or
AuthorizationBearer token (Vault organization API key) · headerrequired

Organization-owned credential with immutable mode and Read-only or Read/write permissions. Only explicitly declared ordinary customer operations accept it. Test business access refuses until shared Test composition is available; no staff, team, key-management or protocol authority is granted.

Path parameters
orgIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Request body
requiredapplication/json
deliveryConfirmationstring
Allowed:nonedeliverysignatureadult_signaturedirect_signature
linesobject[]required
min items 1 · max items 100
Show properties
Array of object
declaredUnitValueobject
Show properties
amountstringrequired
matches ^(0|[1-9]\d{0,8})(\.\d{1,4})?$
productIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
quantityintegerrequired
min 1 · max 100000
recipientobjectrequired
Show properties
addressLine1stringrequired
max length 500
addressLine2stringrequired
max length 500
citystringrequired
max length 200
companystringrequired
max length 200
countrystringrequired
max length 200
emailstringrequired
max length 200
namestringrequired
max length 200
phonestringrequired
max length 200
postalCodestringrequired
max length 200
regionstringrequired
max length 200
fulfillmentSourceobject
Show properties
Any of:
object
configurationRevisionstringrequired
matches ^[1-9][0-9]*$
sourceSignaturestringrequired
matches ^[0-9a-f]{64}$
physicalOriginEquivalenceRefstringrequired
min length 1 · max length 200
v1WarehouseIdintegerrequired
max 9007199254740991
object
modestringrequired
configurationRevisionstringrequired
matches ^[1-9][0-9]*$
sourceSignaturestringrequired
matches ^[0-9a-f]{64}$
physicalOriginEquivalenceRefstringrequired
min length 1 · max length 200
insuranceobject
Show properties
One of:
object
kindstringrequired
object
kindstringrequired
packagesobject[]required
min items 1 · max items 100
Show properties
Array of object
amountstringrequired
matches ^(0|[1-9]\d{0,8})(\.\d{1,4})?$
currencystringrequired
matches ^[A-Z]{3}$
providerstringrequired
Allowed:carrierparcelguardshipsurancexcover
Responses
200

Success

dataobjectrequired
Show properties
fulfillmentSourceobjectrequired
Show properties
Any of:
object
configurationRevisionstringrequired
matches ^[1-9][0-9]*$
sourceSignaturestringrequired
matches ^[0-9a-f]{64}$
physicalOriginEquivalenceRefstringrequired
min length 1 · max length 200
v1WarehouseIdintegerrequired
max 9007199254740991
object
modestringrequired
configurationRevisionstringrequired
matches ^[1-9][0-9]*$
sourceSignaturestringrequired
matches ^[0-9a-f]{64}$
physicalOriginEquivalenceRefstringrequired
min length 1 · max length 200
parcelCountintegerrequired
min 1 · max 100
quotesobject[]required
max items 1000
Show properties
Array of object
serviceobjectrequired
Show properties
namestringrequired
min length 1 · max length 200
carrierstringrequired
min length 1 · max length 200
deliveryobjectrequired
Show properties
daysinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
datestring | nullrequired
confirmationAmountobjectrequired

Actual native confirmation fee included in the shipping pricing basis. Do not add it to totalAmount again.

Show properties
amountstringrequired
matches ^(0|[1-9]\d{0,8})(\.\d{1,4})?$
currencystringrequired
matches ^[A-Z]{3}$
shippingAmountobjectrequired
Show properties
amountstringrequired
matches ^(0|[1-9]\d{0,8})(\.\d{1,4})?$
currencystringrequired
matches ^[A-Z]{3}$
fulfillmentAmountobjectrequired
Show properties
amountstringrequired
matches ^(0|[1-9]\d{0,8})(\.\d{1,4})?$
currencystringrequired
matches ^[A-Z]{3}$
insuranceAmountobjectrequired
Show properties
amountstringrequired
matches ^(0|[1-9]\d{0,8})(\.\d{1,4})?$
currencystringrequired
matches ^[A-Z]{3}$
feesobject[]required
Show properties
Array of object
namestringrequired
amountobjectrequired
Show properties
amountstringrequired
matches ^(0|[1-9]\d{0,8})(\.\d{1,4})?$
currencystringrequired
matches ^[A-Z]{3}$
totalAmountobjectrequired
Show properties
amountstringrequired
matches ^(0|[1-9]\d{0,8})(\.\d{1,4})?$
currencystringrequired
matches ^[A-Z]{3}$
selectionobjectrequired
Show properties
deliveryConfirmationstring
Allowed:nonedeliverysignatureadult_signaturedirect_signature
insuranceobject
Show properties
One of:
object
kindstringrequired
object
kindstringrequired
packagesobject[]required
min items 1 · max items 100
Show properties
Array of object
amountstringrequired
matches ^(0|[1-9]\d{0,8})(\.\d{1,4})?$
currencystringrequired
matches ^[A-Z]{3}$
providerstringrequired
Allowed:carrierparcelguardshipsurancexcover
reviewstringrequired
matches ^[0-9a-f]{64}$
requestedShippingServicestringrequired
min length 1 · max length 200
requestedShippingServiceReviewstringrequired
matches ^[0-9a-f]{64}$
metaobjectrequired
Show properties
requestIdstringrequired
default

Error

errorobjectrequired
Show properties
codestringrequired
Allowed:forbiddeninternal_errornot_foundprovider_data_invalidprovider_outcome_unknownprovider_unavailablerate_limitedstate_conflictunauthenticatedvalidation_errorwarehouse_not_ready
fieldsobject[]
Show properties
Array of object
codestringrequired
messagestringrequired
pathstringrequired
messagestringrequired
operationIdstring
metaobjectrequired
Show properties
requestIdstringrequired
Request
curl -X POST '/v1/organizations/org_example/shipping-quotes' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "lines": [
    {
      "productId": "product_order_demo",
      "quantity": 2
    }
  ],
  "recipient": {
    "addressLine1": "1 Example Street",
    "addressLine2": "",
    "city": "Toronto",
    "company": "",
    "country": "CA",
    "email": "taylor@example.test",
    "name": "Taylor Example",
    "phone": "4165550100",
    "postalCode": "M5V 2T6",
    "region": "ON"
  },
  "fulfillmentSource": {
    "configurationRevision": "2",
    "sourceSignature": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "physicalOriginEquivalenceRef": "physical_demo",
    "v1WarehouseId": 401
  },
  "insurance": {
    "kind": "native",
    "packages": [
      {
        "amount": "45.00",
        "currency": "USD"
      }
    ],
    "provider": "carrier"
  }
}'
Response
{
  "data": {
    "fulfillmentSource": {
      "configurationRevision": "2",
      "sourceSignature": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "physicalOriginEquivalenceRef": "physical_demo",
      "v1WarehouseId": 401
    },
    "parcelCount": 1,
    "quotes": [
      {
        "service": {
          "name": "Example Ground",
          "carrier": "Example Carrier"
        },
        "delivery": {
          "days": 3,
          "date": null
        },
        "confirmationAmount": {
          "amount": "0.00",
          "currency": "USD"
        },
        "shippingAmount": {
          "amount": "12.50",
          "currency": "USD"
        },
        "fulfillmentAmount": {
          "amount": "2.00",
          "currency": "USD"
        },
        "insuranceAmount": {
          "amount": "1.35",
          "currency": "USD"
        },
        "fees": [],
        "totalAmount": {
          "amount": "15.85",
          "currency": "USD"
        },
        "selection": {
          "deliveryConfirmation": "none",
          "insurance": {
            "kind": "native",
            "packages": [
              {
                "amount": "45.00",
                "currency": "USD"
              }
            ],
            "provider": "carrier"
          },
          "review": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
          "requestedShippingService": "Example Ground",
          "requestedShippingServiceReview": "cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc"
        }
      }
    ]
  },
  "meta": {
    "requestId": "example-createShippingQuote"
  }
}

Was this page helpful?