2026-02-13 14:01:00 -07:00
<!doctype html>
< html lang = "en" class = "no-js" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width,initial-scale=1" >
< link rel = "prev" href = "../settings/" >
< link rel = "next" href = "../storage/" >
< link rel = "icon" href = "../../assets/external/postalpoint.app/images/favicon-voxel.png" >
< meta name = "generator" content = "mkdocs-1.6.1, mkdocs-material-9.7.1" >
< title > Shipping - PostalPoint Plugin Development< / title >
< link rel = "stylesheet" href = "../../assets/stylesheets/main.484c7ddc.min.css" >
< link rel = "stylesheet" href = "../../assets/stylesheets/palette.ab4e12ef.min.css" >
< link rel = "stylesheet" href = "../../assets/external/fonts.googleapis.com/css.49ea35f2.css" >
< style > : root { --md-text-font : "Roboto" ; --md-code-font : "Roboto Mono" } < / style >
< link rel = "stylesheet" href = "../../assets/styles.css" >
< script > _ _md _scope = new URL ( "../.." , location ) , _ _md _hash = e => [ ... e ] . reduce ( ( ( e , _ ) => ( e << 5 ) - e + _ . charCodeAt ( 0 ) ) , 0 ) , _ _md _get = ( e , _ = localStorage , t = _ _md _scope ) => JSON . parse ( _ . getItem ( t . pathname + "." + e ) ) , _ _md _set = ( e , _ , t = localStorage , a = _ _md _scope ) => { try { t . setItem ( a . pathname + "." + e , JSON . stringify ( _ ) ) } catch ( e ) { } } < / script >
<!-- Matomo -->
< script >
var _paq = window._paq = window._paq || [];
/* tracker methods like "setCustomDimension" should be called before "trackPageView" */
_paq.push(['trackPageView']);
_paq.push(['enableLinkTracking']);
(function() {
var u="https://analytics.netsyms.net/";
_paq.push(['setTrackerUrl', u+'matomo.php']);
_paq.push(['setSiteId', '57']);
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
})();
< / script >
<!-- End Matomo Code -->
< script > "undefined" != typeof _ _md _analytics && _ _md _analytics ( ) < / script >
< / head >
< body dir = "ltr" data-md-color-scheme = "default" data-md-color-primary = "blue" data-md-color-accent = "indigo" >
< input class = "md-toggle" data-md-toggle = "drawer" type = "checkbox" id = "__drawer" autocomplete = "off" >
< input class = "md-toggle" data-md-toggle = "search" type = "checkbox" id = "__search" autocomplete = "off" >
< label class = "md-overlay" for = "__drawer" > < / label >
< div data-md-component = "skip" >
< a href = "#shipping-object" class = "md-skip" >
Skip to content
< / a >
< / div >
< div data-md-component = "announce" >
< / div >
2026-02-13 14:02:44 -07:00
< div data-md-color-scheme = "default" data-md-component = "outdated" hidden >
< / div >
2026-02-13 14:01:00 -07:00
< header class = "md-header md-header--shadow" data-md-component = "header" >
< nav class = "md-header__inner md-grid" aria-label = "Header" >
< a href = "https://postalpoint.app" title = "PostalPoint Plugin Development" class = "md-header__button md-logo" aria-label = "PostalPoint Plugin Development" data-md-component = "logo" >
< img src = "../../assets/logo.svg" alt = "logo" >
< / a >
< label class = "md-header__button md-icon" for = "__drawer" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z" / > < / svg >
< / label >
< div class = "md-header__title" data-md-component = "header-title" >
< div class = "md-header__ellipsis" >
< div class = "md-header__topic" >
< span class = "md-ellipsis" >
PostalPoint Plugin Development
< / span >
< / div >
< div class = "md-header__topic" data-md-component = "header-topic" >
< span class = "md-ellipsis" >
Shipping
< / span >
< / div >
< / div >
< / div >
< label class = "md-header__button md-icon" for = "__search" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5" / > < / svg >
< / label >
< div class = "md-search" data-md-component = "search" role = "dialog" >
< label class = "md-search__overlay" for = "__search" > < / label >
< div class = "md-search__inner" role = "search" >
< form class = "md-search__form" name = "search" >
< input type = "text" class = "md-search__input" name = "query" aria-label = "Search" placeholder = "Search" autocapitalize = "off" autocorrect = "off" autocomplete = "off" spellcheck = "false" data-md-component = "search-query" required >
< label class = "md-search__icon md-icon" for = "__search" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5" / > < / svg >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z" / > < / svg >
< / label >
< nav class = "md-search__options" aria-label = "Search" >
< button type = "reset" class = "md-search__icon md-icon" title = "Clear" aria-label = "Clear" tabindex = "-1" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z" / > < / svg >
< / button >
< / nav >
< / form >
< div class = "md-search__output" >
< div class = "md-search__scrollwrap" tabindex = "0" data-md-scrollfix >
< div class = "md-search-result" data-md-component = "search-result" >
< div class = "md-search-result__meta" >
Initializing search
< / div >
< ol class = "md-search-result__list" role = "presentation" > < / ol >
< / div >
< / div >
< / div >
< / div >
< / div >
< / nav >
< / header >
< div class = "md-container" data-md-component = "container" >
< main class = "md-main" data-md-component = "main" >
< div class = "md-main__inner md-grid" >
< div class = "md-sidebar md-sidebar--primary" data-md-component = "sidebar" data-md-type = "navigation" >
< div class = "md-sidebar__scrollwrap" >
< div class = "md-sidebar__inner" >
< nav class = "md-nav md-nav--primary" aria-label = "Navigation" data-md-level = "0" >
< label class = "md-nav__title" for = "__drawer" >
< a href = "https://postalpoint.app" title = "PostalPoint Plugin Development" class = "md-nav__button md-logo" aria-label = "PostalPoint Plugin Development" data-md-component = "logo" >
< img src = "../../assets/logo.svg" alt = "logo" >
< / a >
PostalPoint Plugin Development
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../.." class = "md-nav__link" >
< span class = "md-ellipsis" >
Overview
< / span >
< / a >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_2" >
< label class = "md-nav__link" for = "__nav_2" id = "__nav_2_label" tabindex = "0" >
< span class = "md-ellipsis" >
Docs
< / span >
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_2_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_2" >
< span class = "md-nav__icon md-icon" > < / span >
Docs
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../../Docs/Address/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Address object
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../Docs/Carrier_Service/" class = "md-nav__link" >
< span class = "md-ellipsis" >
getCarrierName and getServiceName
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../Docs/Database/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Database Drivers
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../Docs/Events/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Event Bus
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../Docs/FormPS1583/" class = "md-nav__link" >
< span class = "md-ellipsis" >
FormPS1583 object
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../Docs/Parcel/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Parcel/Package Object
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../Docs/Receipt/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Receipt Objects
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../Docs/ReceiptPrinter/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Receipt Printer driver functions
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../Docs/TrackingBarcode/" class = "md-nav__link" >
< span class = "md-ellipsis" >
TrackingBarcode class
< / span >
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_3" >
< label class = "md-nav__link" for = "__nav_3" id = "__nav_3_label" tabindex = "0" >
< span class = "md-ellipsis" >
Examples
< / span >
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_3_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_3" >
< span class = "md-nav__icon md-icon" > < / span >
Examples
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../../Examples/01Minimal/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Minimal Plugin
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../Examples/02Basic/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Basic Plugin
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../Examples/03Shipping/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Shipping Plugin
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../Examples/04CardProcessor/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Card Payments
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../Examples/05CryptoProcessor/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Cryptocurrency Payments
< / span >
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--active md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_4" checked >
< label class = "md-nav__link" for = "__nav_4" id = "__nav_4_label" tabindex = "0" >
< span class = "md-ellipsis" >
Plugin API
< / span >
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_4_label" aria-expanded = "true" >
< label class = "md-nav__title" for = "__nav_4" >
< span class = "md-nav__icon md-icon" > < / span >
Plugin API
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../barcode/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Barcode
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../database/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Database
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../fs/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Fs
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../global%20functions/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Global functions
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../graphics/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Graphics
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../i18n/" class = "md-nav__link" >
< span class = "md-ellipsis" >
I18n
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../kiosk/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Kiosk
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../mailboxes/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Mailboxes
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../pos/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Pos
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../print/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Print
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../reports/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Reports
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../settings/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Settings
< / span >
< / a >
< / li >
< li class = "md-nav__item md-nav__item--active" >
< input class = "md-nav__toggle md-toggle" type = "checkbox" id = "__toc" >
< label class = "md-nav__link md-nav__link--active" for = "__toc" >
< span class = "md-ellipsis" >
Shipping
< / span >
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< a href = "./" class = "md-nav__link md-nav__link--active" >
< span class = "md-ellipsis" >
Shipping
< / span >
< / a >
< nav class = "md-nav md-nav--secondary" aria-label = "Table of contents" >
< label class = "md-nav__title" for = "__toc" >
< span class = "md-nav__icon md-icon" > < / span >
Table of contents
< / label >
< ul class = "md-nav__list" data-md-component = "toc" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#shipping-object" class = "md-nav__link" >
< span class = "md-ellipsis" >
shipping : object
< / span >
< / a >
< nav class = "md-nav" aria-label = "shipping : object" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#shippingaddress" class = "md-nav__link" >
< span class = "md-ellipsis" >
shipping.Address
< / span >
< / a >
< nav class = "md-nav" aria-label = "shipping.Address" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#new-address" class = "md-nav__link" >
< span class = "md-ellipsis" >
new Address()
< / span >
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#shippinggetzipcodezipcode-country-object" class = "md-nav__link" >
< span class = "md-ellipsis" >
shipping.getZIPCode(zipcode, country) ⇒ Object
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#shippinggetpackagingbyidid-promiseobject" class = "md-nav__link" >
< span class = "md-ellipsis" >
shipping.getPackagingByID(id) ⇒ Promise.< Object>
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#shippinggetretailpricewithmarkupcost-retail-carrier-service-weightoz-packaging-promisenumber" class = "md-nav__link" >
< span class = "md-ellipsis" >
shipping.getRetailPriceWithMarkup(cost, retail, carrier, service, weightOz, packaging) ⇒ Promise.< number>
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#shippinggetcarriernamecarrierid-string" class = "md-nav__link" >
< span class = "md-ellipsis" >
shipping.getCarrierName(carrierId) ⇒ string
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#shippinggetservicenameserviceid-carrier-string" class = "md-nav__link" >
< span class = "md-ellipsis" >
shipping.getServiceName(serviceId, carrier) ⇒ string
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#shippingregisterrateendpointgetrates-purchase-idprefix" class = "md-nav__link" >
< span class = "md-ellipsis" >
shipping.registerRateEndpoint(getRates, purchase, idPrefix)
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#shippingregistermarkupcalculatormarkupfn" class = "md-nav__link" >
< span class = "md-ellipsis" >
shipping.registerMarkupCalculator(markupFn)
< / span >
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "../storage/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Storage
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../ui/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Ui
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../user/" class = "md-nav__link" >
< span class = "md-ellipsis" >
User
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../util/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Util
< / span >
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-sidebar md-sidebar--secondary" data-md-component = "sidebar" data-md-type = "toc" >
< div class = "md-sidebar__scrollwrap" >
< div class = "md-sidebar__inner" >
< nav class = "md-nav md-nav--secondary" aria-label = "Table of contents" >
< label class = "md-nav__title" for = "__toc" >
< span class = "md-nav__icon md-icon" > < / span >
Table of contents
< / label >
< ul class = "md-nav__list" data-md-component = "toc" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#shipping-object" class = "md-nav__link" >
< span class = "md-ellipsis" >
shipping : object
< / span >
< / a >
< nav class = "md-nav" aria-label = "shipping : object" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#shippingaddress" class = "md-nav__link" >
< span class = "md-ellipsis" >
shipping.Address
< / span >
< / a >
< nav class = "md-nav" aria-label = "shipping.Address" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#new-address" class = "md-nav__link" >
< span class = "md-ellipsis" >
new Address()
< / span >
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#shippinggetzipcodezipcode-country-object" class = "md-nav__link" >
< span class = "md-ellipsis" >
shipping.getZIPCode(zipcode, country) ⇒ Object
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#shippinggetpackagingbyidid-promiseobject" class = "md-nav__link" >
< span class = "md-ellipsis" >
shipping.getPackagingByID(id) ⇒ Promise.< Object>
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#shippinggetretailpricewithmarkupcost-retail-carrier-service-weightoz-packaging-promisenumber" class = "md-nav__link" >
< span class = "md-ellipsis" >
shipping.getRetailPriceWithMarkup(cost, retail, carrier, service, weightOz, packaging) ⇒ Promise.< number>
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#shippinggetcarriernamecarrierid-string" class = "md-nav__link" >
< span class = "md-ellipsis" >
shipping.getCarrierName(carrierId) ⇒ string
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#shippinggetservicenameserviceid-carrier-string" class = "md-nav__link" >
< span class = "md-ellipsis" >
shipping.getServiceName(serviceId, carrier) ⇒ string
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#shippingregisterrateendpointgetrates-purchase-idprefix" class = "md-nav__link" >
< span class = "md-ellipsis" >
shipping.registerRateEndpoint(getRates, purchase, idPrefix)
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#shippingregistermarkupcalculatormarkupfn" class = "md-nav__link" >
< span class = "md-ellipsis" >
shipping.registerMarkupCalculator(markupFn)
< / span >
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-content" data-md-component = "content" >
< article class = "md-content__inner md-typeset" >
< h1 > Shipping< / h1 >
< p > < a name = "shipping" > < / a > < / p >
< h2 id = "shipping-object" > shipping : < code > object< / code > < / h2 >
< p > Add custom carrier and rates, and adjust markup.< / p >
< p > < strong > Kind< / strong > : global namespace < / p >
< ul >
< li > < a href = "#shipping" > shipping< / a > : < code > object< / code > < ul >
< li > < a href = "#shipping.Address" > .Address< / a > < ul >
< li > < a href = "#new_shipping.Address_new" > new Address()< / a > < / li >
< / ul >
< / li >
< li > < a href = "#shipping.getZIPCode" > .getZIPCode(zipcode, country)< / a > ⇒ < code > Object< / code > < / li >
< li > < a href = "#shipping.getPackagingByID" > .getPackagingByID(id)< / a > ⇒ < code > Promise.< Object> < / code > < / li >
< li > < a href = "#shipping.getRetailPriceWithMarkup" > .getRetailPriceWithMarkup(cost, retail, carrier, service, weightOz, packaging)< / a > ⇒ < code > Promise.< number> < / code > < / li >
< li > < a href = "#shipping.getCarrierName" > .getCarrierName(carrierId)< / a > ⇒ < code > string< / code > < / li >
< li > < a href = "#shipping.getServiceName" > .getServiceName(serviceId, carrier)< / a > ⇒ < code > string< / code > < / li >
< li > < a href = "#shipping.registerRateEndpoint" > .registerRateEndpoint(getRates, purchase, idPrefix)< / a > < / li >
< li > < a href = "#shipping.registerMarkupCalculator" > .registerMarkupCalculator(markupFn)< / a > < / li >
< / ul >
< / li >
< / ul >
< p > < a name = "shipping.Address" > < / a > < / p >
< h3 id = "shippingaddress" > shipping.Address< / h3 >
< p > < strong > Kind< / strong > : static class of < a href = "#shipping" > < code > shipping< / code > < / a > < br / >
< a name = "new_shipping.Address_new" > < / a > < / p >
< h4 id = "new-address" > new Address()< / h4 >
< p > A class representing an address.< / p >
< p > < a name = "shipping.getZIPCode" > < / a > < / p >
< h3 id = "shippinggetzipcodezipcode-country-object" > shipping.getZIPCode(zipcode, country) ⇒ < code > Object< / code > < / h3 >
< p > Get data for a ZIP Code.< / p >
< p > < strong > Kind< / strong > : static method of < a href = "#shipping" > < code > shipping< / code > < / a > < br / >
< strong > Returns< / strong > : < code > Object< / code > - Data about the ZIP code. See example. Fields may be empty if not available. Type may be "STANDARD", "UNIQUE", "PO BOX", or "MILITARY". < / p >
< table >
< thead >
< tr >
< th > Param< / th >
< th > Type< / th >
< th > Default< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > zipcode< / td >
< td > < code > string< / code > < / td >
< td > < / td >
< td > ZIP or postal code.< / td >
< / tr >
< tr >
< td > country< / td >
< td > < code > string< / code > < / td >
< td > < code > " US" < / code > < / td >
< td > Currently only "US" and "CA" are supported.< / td >
< / tr >
< / tbody >
< / table >
< p > < strong > Example< / strong > < br / >
< div class = "language-js highlight" > < pre > < span > < / span > < code > < span id = "__span-0-1" > < a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" > < / a > < span class = "p" > {< / span > < span class = "nx" > city< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " NEW YORK" < / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "nx" > state< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " NY" < / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "nx" > type< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " STANDARD" < / span > < span class = "p" > }< / span >
< / span > < / code > < / pre > < / div >
< a name = "shipping.getPackagingByID" > < / a > < / p >
< h3 id = "shippinggetpackagingbyidid-promiseobject" > shipping.getPackagingByID(id) ⇒ < code > Promise.< Object> < / code > < / h3 >
< p > Get a parcel's packaging type from PostalPoint's internal ID for it.< / p >
< p > < strong > Kind< / strong > : static method of < a href = "#shipping" > < code > shipping< / code > < / a > < br / >
< strong > Returns< / strong > : < code > Promise.< Object> < / code > - See examples. < / p >
< table >
< thead >
< tr >
< th > Param< / th >
< th > Type< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > id< / td >
< td > < code > number< / code > < / td >
< / tr >
< / tbody >
< / table >
< p > < strong > Example< / strong > < br / >
< div class = "language-js highlight" > < pre > < span > < / span > < code > < span id = "__span-1-1" > < a id = "__codelineno-1-1" name = "__codelineno-1-1" href = "#__codelineno-1-1" > < / a > < span class = "p" > {< / span >
< / span > < span id = "__span-1-2" > < a id = "__codelineno-1-2" name = "__codelineno-1-2" href = "#__codelineno-1-2" > < / a > < span class = "w" > < / span > < span class = "nx" > id< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "mf" > 100< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-1-3" > < a id = "__codelineno-1-3" name = "__codelineno-1-3" href = "#__codelineno-1-3" > < / a > < span class = "w" > < / span > < span class = "nx" > type< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " Parcel" < / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-1-4" > < a id = "__codelineno-1-4" name = "__codelineno-1-4" href = "#__codelineno-1-4" > < / a > < span class = "w" > < / span > < span class = "nx" > img< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " box.png" < / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-1-5" > < a id = "__codelineno-1-5" name = "__codelineno-1-5" href = "#__codelineno-1-5" > < / a > < span class = "w" > < / span > < span class = "nx" > name< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " Box" < / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-1-6" > < a id = "__codelineno-1-6" name = "__codelineno-1-6" href = "#__codelineno-1-6" > < / a > < span class = "w" > < / span > < span class = "nx" > service< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-1-7" > < a id = "__codelineno-1-7" name = "__codelineno-1-7" href = "#__codelineno-1-7" > < / a > < span class = "w" > < / span > < span class = "nx" > l< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "o" > -< / span > < span class = "mf" > 1< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-1-8" > < a id = "__codelineno-1-8" name = "__codelineno-1-8" href = "#__codelineno-1-8" > < / a > < span class = "w" > < / span > < span class = "nx" > w< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "o" > -< / span > < span class = "mf" > 1< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-1-9" > < a id = "__codelineno-1-9" name = "__codelineno-1-9" href = "#__codelineno-1-9" > < / a > < span class = "w" > < / span > < span class = "nx" > h< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "o" > -< / span > < span class = "mf" > 1< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-1-10" > < a id = "__codelineno-1-10" name = "__codelineno-1-10" href = "#__codelineno-1-10" > < / a > < span class = "w" > < / span > < span class = "nx" > weight< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-1-11" > < a id = "__codelineno-1-11" name = "__codelineno-1-11" href = "#__codelineno-1-11" > < / a > < span class = "w" > < / span > < span class = "nx" > hazmat< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-1-12" > < a id = "__codelineno-1-12" name = "__codelineno-1-12" href = "#__codelineno-1-12" > < / a > < span class = "w" > < / span > < span class = "nx" > source< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " Customer" < / span >
< / span > < span id = "__span-1-13" > < a id = "__codelineno-1-13" name = "__codelineno-1-13" href = "#__codelineno-1-13" > < / a > < span class = "p" > }< / span >
< / span > < / code > < / pre > < / div >
< strong > Example< / strong > < br / >
< div class = "language-js highlight" > < pre > < span > < / span > < code > < span id = "__span-2-1" > < a id = "__codelineno-2-1" name = "__codelineno-2-1" href = "#__codelineno-2-1" > < / a > < span class = "p" > {< / span >
< / span > < span id = "__span-2-2" > < a id = "__codelineno-2-2" name = "__codelineno-2-2" href = "#__codelineno-2-2" > < / a > < span class = "w" > < / span > < span class = "nx" > id< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "mf" > 1< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-2-3" > < a id = "__codelineno-2-3" name = "__codelineno-2-3" href = "#__codelineno-2-3" > < / a > < span class = "w" > < / span > < span class = "nx" > type< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " FlatRateEnvelope" < / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-2-4" > < a id = "__codelineno-2-4" name = "__codelineno-2-4" href = "#__codelineno-2-4" > < / a > < span class = "w" > < / span > < span class = "nx" > img< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " pm-fres.png" < / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-2-5" > < a id = "__codelineno-2-5" name = "__codelineno-2-5" href = "#__codelineno-2-5" > < / a > < span class = "w" > < / span > < span class = "nx" > name< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " Flat Rate Envelope" < / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-2-6" > < a id = "__codelineno-2-6" name = "__codelineno-2-6" href = "#__codelineno-2-6" > < / a > < span class = "w" > < / span > < span class = "nx" > service< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " Priority" < / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-2-7" > < a id = "__codelineno-2-7" name = "__codelineno-2-7" href = "#__codelineno-2-7" > < / a > < span class = "w" > < / span > < span class = "nx" > l< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "o" > -< / span > < span class = "mf" > 2< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-2-8" > < a id = "__codelineno-2-8" name = "__codelineno-2-8" href = "#__codelineno-2-8" > < / a > < span class = "w" > < / span > < span class = "nx" > w< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "o" > -< / span > < span class = "mf" > 2< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-2-9" > < a id = "__codelineno-2-9" name = "__codelineno-2-9" href = "#__codelineno-2-9" > < / a > < span class = "w" > < / span > < span class = "nx" > h< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "o" > -< / span > < span class = "mf" > 2< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-2-10" > < a id = "__codelineno-2-10" name = "__codelineno-2-10" href = "#__codelineno-2-10" > < / a > < span class = "w" > < / span > < span class = "nx" > weight< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-2-11" > < a id = "__codelineno-2-11" name = "__codelineno-2-11" href = "#__codelineno-2-11" > < / a > < span class = "w" > < / span > < span class = "nx" > hazmat< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-2-12" > < a id = "__codelineno-2-12" name = "__codelineno-2-12" href = "#__codelineno-2-12" > < / a > < span class = "w" > < / span > < span class = "nx" > usps_supplied< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-2-13" > < a id = "__codelineno-2-13" name = "__codelineno-2-13" href = "#__codelineno-2-13" > < / a > < span class = "w" > < / span > < span class = "nx" > envelope< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-2-14" > < a id = "__codelineno-2-14" name = "__codelineno-2-14" href = "#__codelineno-2-14" > < / a > < span class = "w" > < / span > < span class = "nx" > source< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " USPS" < / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-2-15" > < a id = "__codelineno-2-15" name = "__codelineno-2-15" href = "#__codelineno-2-15" > < / a > < span class = "w" > < / span > < span class = "nx" > skus< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "p" > [< / span > < span class = "s2" > " PS00001000014" < / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "s2" > " PS00001000012" < / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "s2" > " PS00001000027" < / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "s2" > " PS00001000064" < / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "s2" > " PS00001001921" < / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "s2" > " PS00001035000" < / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "s2" > " PS00001036014" < / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "s2" > " PS00001128600" < / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "s2" > " https://qr.usps.com/epsspu?p=30" < / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "s2" > " https://qr.usps.com/epsspu?p=8" < / span > < span class = "p" > ]< / span >
< / span > < span id = "__span-2-16" > < a id = "__codelineno-2-16" name = "__codelineno-2-16" href = "#__codelineno-2-16" > < / a > < span class = "p" > }< / span >
< / span > < / code > < / pre > < / div >
< strong > Example< / strong > < br / >
< div class = "language-js highlight" > < pre > < span > < / span > < code > < span id = "__span-3-1" > < a id = "__codelineno-3-1" name = "__codelineno-3-1" href = "#__codelineno-3-1" > < / a > < span class = "p" > {< / span >
< / span > < span id = "__span-3-2" > < a id = "__codelineno-3-2" name = "__codelineno-3-2" href = "#__codelineno-3-2" > < / a > < span class = "w" > < / span > < span class = "nx" > id< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "mf" > 201< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-3-3" > < a id = "__codelineno-3-3" name = "__codelineno-3-3" href = "#__codelineno-3-3" > < / a > < span class = "w" > < / span > < span class = "nx" > type< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " UPSLetter" < / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-3-4" > < a id = "__codelineno-3-4" name = "__codelineno-3-4" href = "#__codelineno-3-4" > < / a > < span class = "w" > < / span > < span class = "nx" > img< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " ups-env.png" < / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-3-5" > < a id = "__codelineno-3-5" name = "__codelineno-3-5" href = "#__codelineno-3-5" > < / a > < span class = "w" > < / span > < span class = "nx" > name< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " Envelope" < / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-3-6" > < a id = "__codelineno-3-6" name = "__codelineno-3-6" href = "#__codelineno-3-6" > < / a > < span class = "w" > < / span > < span class = "nx" > carrier< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " UPS" < / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-3-7" > < a id = "__codelineno-3-7" name = "__codelineno-3-7" href = "#__codelineno-3-7" > < / a > < span class = "w" > < / span > < span class = "nx" > l< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "o" > -< / span > < span class = "mf" > 2< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-3-8" > < a id = "__codelineno-3-8" name = "__codelineno-3-8" href = "#__codelineno-3-8" > < / a > < span class = "w" > < / span > < span class = "nx" > w< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "o" > -< / span > < span class = "mf" > 2< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-3-9" > < a id = "__codelineno-3-9" name = "__codelineno-3-9" href = "#__codelineno-3-9" > < / a > < span class = "w" > < / span > < span class = "nx" > h< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "o" > -< / span > < span class = "mf" > 2< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-3-10" > < a id = "__codelineno-3-10" name = "__codelineno-3-10" href = "#__codelineno-3-10" > < / a > < span class = "w" > < / span > < span class = "nx" > weight< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-3-11" > < a id = "__codelineno-3-11" name = "__codelineno-3-11" href = "#__codelineno-3-11" > < / a > < span class = "w" > < / span > < span class = "nx" > hazmat< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-3-12" > < a id = "__codelineno-3-12" name = "__codelineno-3-12" href = "#__codelineno-3-12" > < / a > < span class = "w" > < / span > < span class = "nx" > source< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " OtherCarrier" < / span >
< / span > < span id = "__span-3-13" > < a id = "__codelineno-3-13" name = "__codelineno-3-13" href = "#__codelineno-3-13" > < / a > < span class = "p" > }< / span >
< / span > < / code > < / pre > < / div >
< a name = "shipping.getRetailPriceWithMarkup" > < / a > < / p >
< h3 id = "shippinggetretailpricewithmarkupcost-retail-carrier-service-weightoz-packaging-promisenumber" > shipping.getRetailPriceWithMarkup(cost, retail, carrier, service, weightOz, packaging) ⇒ < code > Promise.< number> < / code > < / h3 >
< p > Calculate the retail price for a shipment rate based on the configured margin settings.< / p >
< p > < strong > Kind< / strong > : static method of < a href = "#shipping" > < code > shipping< / code > < / a > < br / >
< strong > Returns< / strong > : < code > Promise.< number> < / code > - The amount to charge the customer < / p >
< table >
< thead >
< tr >
< th > Param< / th >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > cost< / td >
< td > < code > number< / code > < / td >
< td > Cost of shipment to business< / td >
< / tr >
< tr >
< td > retail< / td >
< td > < code > number< / code > < / td >
< td > Default retail price from label provider< / td >
< / tr >
< tr >
< td > carrier< / td >
< td > < code > string< / code > < / td >
< td > Shipment carrier< / td >
< / tr >
< tr >
< td > service< / td >
< td > < code > string< / code > < / td >
< td > Shipment service< / td >
< / tr >
< tr >
< td > weightOz< / td >
< td > < code > number< / code > < / td >
< td > The weight of the shipment in ounces, or null if not available.< / td >
< / tr >
< tr >
< td > packaging< / td >
< td > < code > string< / code > < / td >
< td > An empty string if not available, or "Letter", "FlatRateEnvelope", etc.< / td >
< / tr >
< / tbody >
< / table >
< p > < a name = "shipping.getCarrierName" > < / a > < / p >
< h3 id = "shippinggetcarriernamecarrierid-string" > shipping.getCarrierName(carrierId) ⇒ < code > string< / code > < / h3 >
< p > Converts the carrier ID string into a consistent and human-readable name.< / p >
< p > < strong > Kind< / strong > : static method of < a href = "#shipping" > < code > shipping< / code > < / a > < / p >
< table >
< thead >
< tr >
< th > Param< / th >
< th > Type< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > carrierId< / td >
< td > < code > string< / code > < / td >
< / tr >
< / tbody >
< / table >
< p > < a name = "shipping.getServiceName" > < / a > < / p >
< h3 id = "shippinggetservicenameserviceid-carrier-string" > shipping.getServiceName(serviceId, carrier) ⇒ < code > string< / code > < / h3 >
< p > Converts the service ID string into a consistent and human-readable name. Set the carrier ID for better results.< / p >
< p > < strong > Kind< / strong > : static method of < a href = "#shipping" > < code > shipping< / code > < / a > < / p >
< table >
< thead >
< tr >
< th > Param< / th >
< th > Type< / th >
< th > Default< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > serviceId< / td >
< td > < code > string< / code > < / td >
< td > < / td >
< / tr >
< tr >
< td > carrier< / td >
< td > < code > string< / code > < / td >
< td > < code > " USPS" < / code > < / td >
< / tr >
< / tbody >
< / table >
< p > < a name = "shipping.registerRateEndpoint" > < / a > < / p >
< h3 id = "shippingregisterrateendpointgetrates-purchase-idprefix" > shipping.registerRateEndpoint(getRates, purchase, idPrefix)< / h3 >
< p > Register the plugin as a shipping rate and label provider. See the Shipping example plugin.< / p >
< p > < strong > Kind< / strong > : static method of < a href = "#shipping" > < code > shipping< / code > < / a > < / p >
< table >
< thead >
< tr >
< th > Param< / th >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > getRates< / td >
< td > < code > function< / code > < / td >
< td > A function passed a Parcel object to get rates for. Returns a Promise that resolves to an array of rate objects.< / td >
< / tr >
< tr >
< td > purchase< / td >
< td > < code > function< / code > < / td >
< td > A function passed a rate ID to purchase. Returns a Promise that resolves to the label information.< / td >
< / tr >
< tr >
< td > idPrefix< / td >
< td > < code > string< / code > < / td >
< td > A unique string that will be prefixing all rate IDs from this plugin.< / td >
< / tr >
< / tbody >
< / table >
< p > < strong > Example< / strong > < br / >
< div class = "language-js highlight" > < pre > < span > < / span > < code > < span id = "__span-4-1" > < a id = "__codelineno-4-1" name = "__codelineno-4-1" href = "#__codelineno-4-1" > < / a > < span class = "c1" > // getRates sample return value:< / span >
< / span > < span id = "__span-4-2" > < a id = "__codelineno-4-2" name = "__codelineno-4-2" href = "#__codelineno-4-2" > < / a > < span class = "p" > [{< / span >
< / span > < span id = "__span-4-3" > < a id = "__codelineno-4-3" name = "__codelineno-4-3" href = "#__codelineno-4-3" > < / a > < span class = "w" > < / span > < span class = "nx" > rateid< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "sb" > `< / span > < span class = "si" > ${< / span > < span class = "nx" > idPrefix< / span > < span class = "si" > }< / span > < span class = "sb" > _< / span > < span class = "si" > ${< / span > < span class = "nb" > global< / span > < span class = "p" > .< / span > < span class = "nx" > apis< / span > < span class = "p" > .< / span > < span class = "nx" > util< / span > < span class = "p" > .< / span > < span class = "nx" > uuid< / span > < span class = "p" > .< / span > < span class = "nx" > v4< / span > < span class = "p" > ()< / span > < span class = "si" > }< / span > < span class = "sb" > `< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-4-4" > < a id = "__codelineno-4-4" name = "__codelineno-4-4" href = "#__codelineno-4-4" > < / a > < span class = "w" > < / span > < span class = "nx" > carrier< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " CarrierID" < / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-4-5" > < a id = "__codelineno-4-5" name = "__codelineno-4-5" href = "#__codelineno-4-5" > < / a > < span class = "w" > < / span > < span class = "nx" > carrierName< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " Carrier Name" < / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-4-6" > < a id = "__codelineno-4-6" name = "__codelineno-4-6" href = "#__codelineno-4-6" > < / a > < span class = "w" > < / span > < span class = "nx" > service< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " CARRIER_SERVICE_ID" < / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-4-7" > < a id = "__codelineno-4-7" name = "__codelineno-4-7" href = "#__codelineno-4-7" > < / a > < span class = "w" > < / span > < span class = "nx" > cost_rate< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "mf" > 10< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-4-8" > < a id = "__codelineno-4-8" name = "__codelineno-4-8" href = "#__codelineno-4-8" > < / a > < span class = "w" > < / span > < span class = "nx" > retail_rate< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "mf" > 15< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-4-9" > < a id = "__codelineno-4-9" name = "__codelineno-4-9" href = "#__codelineno-4-9" > < / a > < span class = "w" > < / span > < span class = "nx" > delivery_days< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "mf" > 3< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-4-10" > < a id = "__codelineno-4-10" name = "__codelineno-4-10" href = "#__codelineno-4-10" > < / a > < span class = "w" > < / span > < span class = "nx" > delivery_date< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "kc" > null< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-4-11" > < a id = "__codelineno-4-11" name = "__codelineno-4-11" href = "#__codelineno-4-11" > < / a > < span class = "w" > < / span > < span class = "nx" > guaranteed< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-4-12" > < a id = "__codelineno-4-12" name = "__codelineno-4-12" href = "#__codelineno-4-12" > < / a > < span class = "w" > < / span > < span class = "nx" > serviceName< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " Service Name" < / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-4-13" > < a id = "__codelineno-4-13" name = "__codelineno-4-13" href = "#__codelineno-4-13" > < / a > < span class = "w" > < / span > < span class = "nx" > color< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " green" < / span > < span class = "w" > < / span > < span class = "c1" > // Rate card color< / span >
< / span > < span id = "__span-4-14" > < a id = "__codelineno-4-14" name = "__codelineno-4-14" href = "#__codelineno-4-14" > < / a > < span class = "p" > }]< / span >
< / span > < / code > < / pre > < / div >
< strong > Example< / strong > < br / >
< div class = "language-js highlight" > < pre > < span > < / span > < code > < span id = "__span-5-1" > < a id = "__codelineno-5-1" name = "__codelineno-5-1" href = "#__codelineno-5-1" > < / a > < span class = "c1" > // purchase sample return value:< / span >
< / span > < span id = "__span-5-2" > < a id = "__codelineno-5-2" name = "__codelineno-5-2" href = "#__codelineno-5-2" > < / a > < span class = "p" > {< / span >
< / span > < span id = "__span-5-3" > < a id = "__codelineno-5-3" name = "__codelineno-5-3" href = "#__codelineno-5-3" > < / a > < span class = "w" > < / span > < span class = "nx" > label< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "nx" > labelImageToPrint< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-5-4" > < a id = "__codelineno-5-4" name = "__codelineno-5-4" href = "#__codelineno-5-4" > < / a > < span class = "w" > < / span > < span class = "nx" > labeltype< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " PNG" < / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-5-5" > < a id = "__codelineno-5-5" name = "__codelineno-5-5" href = "#__codelineno-5-5" > < / a > < span class = "w" > < / span > < span class = "nx" > receiptItem< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "nx" > ReceiptItem< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-5-6" > < a id = "__codelineno-5-6" name = "__codelineno-5-6" href = "#__codelineno-5-6" > < / a > < span class = "w" > < / span > < span class = "nx" > tracking< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " 12345678901234567890" < / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-5-7" > < a id = "__codelineno-5-7" name = "__codelineno-5-7" href = "#__codelineno-5-7" > < / a > < span class = "w" > < / span > < span class = "nx" > cost< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "mf" > 10.0< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-5-8" > < a id = "__codelineno-5-8" name = "__codelineno-5-8" href = "#__codelineno-5-8" > < / a > < span class = "w" > < / span > < span class = "nx" > price< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "mf" > 15.0< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-5-9" > < a id = "__codelineno-5-9" name = "__codelineno-5-9" href = "#__codelineno-5-9" > < / a > < span class = "w" > < / span > < span class = "nx" > carrier< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " Carrier Name" < / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-5-10" > < a id = "__codelineno-5-10" name = "__codelineno-5-10" href = "#__codelineno-5-10" > < / a > < span class = "w" > < / span > < span class = "nx" > service< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "s2" > " Service Name" < / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-5-11" > < a id = "__codelineno-5-11" name = "__codelineno-5-11" href = "#__codelineno-5-11" > < / a > < span class = "w" > < / span > < span class = "nx" > delivery_days< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "mf" > 3< / span > < span class = "p" > ,< / span >
< / span > < span id = "__span-5-12" > < a id = "__codelineno-5-12" name = "__codelineno-5-12" href = "#__codelineno-5-12" > < / a > < span class = "w" > < / span > < span class = "nx" > delivery_date< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "mf" > 1234567890< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "c1" > // UNIX timestamp< / span >
< / span > < span id = "__span-5-13" > < a id = "__codelineno-5-13" name = "__codelineno-5-13" href = "#__codelineno-5-13" > < / a > < span class = "w" > < / span > < span class = "nx" > to< / span > < span class = "o" > :< / span > < span class = "w" > < / span > < span class = "nx" > toAddressLines< / span > < span class = "w" > < / span > < span class = "c1" > // Array of strings< / span >
< / span > < span id = "__span-5-14" > < a id = "__codelineno-5-14" name = "__codelineno-5-14" href = "#__codelineno-5-14" > < / a > < span class = "p" > }< / span >
< / span > < / code > < / pre > < / div >
< a name = "shipping.registerMarkupCalculator" > < / a > < / p >
< h3 id = "shippingregistermarkupcalculatormarkupfn" > shipping.registerMarkupCalculator(markupFn)< / h3 >
< p > Register the plugin to modify PostalPoint's shipping markup calculation during shipment rating.< / p >
< p > < strong > Kind< / strong > : static method of < a href = "#shipping" > < code > shipping< / code > < / a > < br / >
< strong > Throws< / strong > :< / p >
< ul >
< li > < code > Error< / code > Only one plugin may register with this function;
any subsequent attempts to register will throw an Error.< / li >
< / ul >
< table >
< thead >
< tr >
< th > Param< / th >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > markupFn< / td >
< td > < code > function< / code > < / td >
< td > A function that must return either the retail price to charge for this rate, or < code > false< / code > to opt-out of setting this particular rate.< / td >
< / tr >
< / tbody >
< / table >
< p > < strong > Example< / strong > < br / >
< div class = "language-js highlight" > < pre > < span > < / span > < code > < span id = "__span-6-1" > < a id = "__codelineno-6-1" name = "__codelineno-6-1" href = "#__codelineno-6-1" > < / a > < span class = "nb" > global< / span > < span class = "p" > .< / span > < span class = "nx" > apis< / span > < span class = "p" > .< / span > < span class = "nx" > shipping< / span > < span class = "p" > .< / span > < span class = "nx" > registerMarkupCalculator< / span > < span class = "p" > (< / span >
< / span > < span id = "__span-6-2" > < a id = "__codelineno-6-2" name = "__codelineno-6-2" href = "#__codelineno-6-2" > < / a > < span class = "w" > < / span > < span class = "c1" > // Parameters:< / span >
< / span > < span id = "__span-6-3" > < a id = "__codelineno-6-3" name = "__codelineno-6-3" href = "#__codelineno-6-3" > < / a > < span class = "w" > < / span > < span class = "c1" > // cost: Cost to shipper< / span >
< / span > < span id = "__span-6-4" > < a id = "__codelineno-6-4" name = "__codelineno-6-4" href = "#__codelineno-6-4" > < / a > < span class = "w" > < / span > < span class = "c1" > // retail: Carrier-suggested retail price< / span >
< / span > < span id = "__span-6-5" > < a id = "__codelineno-6-5" name = "__codelineno-6-5" href = "#__codelineno-6-5" > < / a > < span class = "w" > < / span > < span class = "c1" > // suggested: PostalPoint-suggested retail (default margin calc)< / span >
< / span > < span id = "__span-6-6" > < a id = "__codelineno-6-6" name = "__codelineno-6-6" href = "#__codelineno-6-6" > < / a > < span class = "w" > < / span > < span class = "c1" > // carrier: Shipping carrier name< / span >
< / span > < span id = "__span-6-7" > < a id = "__codelineno-6-7" name = "__codelineno-6-7" href = "#__codelineno-6-7" > < / a > < span class = "w" > < / span > < span class = "c1" > // service: Shipping service code< / span >
< / span > < span id = "__span-6-8" > < a id = "__codelineno-6-8" name = "__codelineno-6-8" href = "#__codelineno-6-8" > < / a > < span class = "w" > < / span > < span class = "c1" > // weightOz: The weight of the shipment in ounces, or null if not available.< / span >
< / span > < span id = "__span-6-9" > < a id = "__codelineno-6-9" name = "__codelineno-6-9" href = "#__codelineno-6-9" > < / a > < span class = "w" > < / span > < span class = "c1" > // packaging: An empty string if not available, or " Letter" , " FlatRateEnvelope" , etc. See https://docs.easypost.com/docs/parcels#predefined-package< / span >
< / span > < span id = "__span-6-10" > < a id = "__codelineno-6-10" name = "__codelineno-6-10" href = "#__codelineno-6-10" > < / a > < span class = "w" > < / span > < span class = "c1" > // parcel: The Parcel object for this shipment. May be null for some rate-only requests without a shipment, such as USPS price calculations.< / span >
< / span > < span id = "__span-6-11" > < a id = "__codelineno-6-11" name = "__codelineno-6-11" href = "#__codelineno-6-11" > < / a > < span class = "w" > < / span > < span class = "kd" > function< / span > < span class = "w" > < / span > < span class = "p" > (< / span > < span class = "nx" > cost< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "nx" > retail< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "nx" > suggested< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "nx" > carrier< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "nx" > service< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "nx" > weightOz< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "nx" > packaging< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "nx" > parcel< / span > < span class = "p" > )< / span > < span class = "w" > < / span > < span class = "p" > {< / span >
< / span > < span id = "__span-6-12" > < a id = "__codelineno-6-12" name = "__codelineno-6-12" href = "#__codelineno-6-12" > < / a > < span class = "w" > < / span > < span class = "k" > if< / span > < span class = "w" > < / span > < span class = "p" > (< / span > < span class = "nx" > carrier< / span > < span class = "w" > < / span > < span class = "o" > ==< / span > < span class = "w" > < / span > < span class = "s2" > " USPS" < / span > < span class = "p" > )< / span > < span class = "w" > < / span > < span class = "p" > {< / span >
< / span > < span id = "__span-6-13" > < a id = "__codelineno-6-13" name = "__codelineno-6-13" href = "#__codelineno-6-13" > < / a > < span class = "w" > < / span > < span class = "k" > if< / span > < span class = "w" > < / span > < span class = "p" > (< / span > < span class = "nx" > service< / span > < span class = "w" > < / span > < span class = "o" > ==< / span > < span class = "w" > < / span > < span class = "s2" > " First-Class Mail" < / span > < span class = "p" > )< / span > < span class = "w" > < / span > < span class = "p" > {< / span >
< / span > < span id = "__span-6-14" > < a id = "__codelineno-6-14" name = "__codelineno-6-14" href = "#__codelineno-6-14" > < / a > < span class = "w" > < / span > < span class = "c1" > // Handle First-Class Mail differently if it' s a 1oz letter (i.e. Forever stamp)< / span >
< / span > < span id = "__span-6-15" > < a id = "__codelineno-6-15" name = "__codelineno-6-15" href = "#__codelineno-6-15" > < / a > < span class = "w" > < / span > < span class = "k" > if< / span > < span class = "w" > < / span > < span class = "p" > (< / span > < span class = "nx" > weightOz< / span > < span class = "w" > < / span > < span class = "o" > < =< / span > < span class = "w" > < / span > < span class = "mf" > 1< / span > < span class = "w" > < / span > < span class = "o" > & & < / span > < span class = "w" > < / span > < span class = "nx" > packaging< / span > < span class = "w" > < / span > < span class = "o" > ==< / span > < span class = "w" > < / span > < span class = "s2" > " Letter" < / span > < span class = "p" > )< / span > < span class = "w" > < / span > < span class = "p" > {< / span >
< / span > < span id = "__span-6-16" > < a id = "__codelineno-6-16" name = "__codelineno-6-16" href = "#__codelineno-6-16" > < / a > < span class = "w" > < / span > < span class = "k" > return< / span > < span class = "w" > < / span > < span class = "nx" > retail< / span > < span class = "w" > < / span > < span class = "o" > +< / span > < span class = "w" > < / span > < span class = "mf" > 0.05< / span > < span class = "p" > ;< / span >
< / span > < span id = "__span-6-17" > < a id = "__codelineno-6-17" name = "__codelineno-6-17" href = "#__codelineno-6-17" > < / a > < span class = "w" > < / span > < span class = "p" > }< / span > < span class = "w" > < / span > < span class = "k" > else< / span > < span class = "w" > < / span > < span class = "p" > {< / span >
< / span > < span id = "__span-6-18" > < a id = "__codelineno-6-18" name = "__codelineno-6-18" href = "#__codelineno-6-18" > < / a > < span class = "w" > < / span > < span class = "k" > return< / span > < span class = "w" > < / span > < span class = "nx" > retail< / span > < span class = "w" > < / span > < span class = "o" > +< / span > < span class = "w" > < / span > < span class = "mf" > 0.25< / span > < span class = "p" > ;< / span >
< / span > < span id = "__span-6-19" > < a id = "__codelineno-6-19" name = "__codelineno-6-19" href = "#__codelineno-6-19" > < / a > < span class = "w" > < / span > < span class = "p" > }< / span >
< / span > < span id = "__span-6-20" > < a id = "__codelineno-6-20" name = "__codelineno-6-20" href = "#__codelineno-6-20" > < / a > < span class = "w" > < / span > < span class = "p" > }< / span >
< / span > < span id = "__span-6-21" > < a id = "__codelineno-6-21" name = "__codelineno-6-21" href = "#__codelineno-6-21" > < / a > < span class = "w" > < / span > < span class = "c1" > // Handle flat rate envelopes differently< / span >
< / span > < span id = "__span-6-22" > < a id = "__codelineno-6-22" name = "__codelineno-6-22" href = "#__codelineno-6-22" > < / a > < span class = "w" > < / span > < span class = "k" > if< / span > < span class = "w" > < / span > < span class = "p" > (< / span > < span class = "nb" > global< / span > < span class = "p" > .< / span > < span class = "nx" > apis< / span > < span class = "p" > .< / span > < span class = "nx" > shipping< / span > < span class = "p" > .< / span > < span class = "nx" > getServiceName< / span > < span class = "p" > (< / span > < span class = "nx" > service< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "nx" > carrier< / span > < span class = "p" > )< / span > < span class = "w" > < / span > < span class = "o" > ==< / span > < span class = "w" > < / span > < span class = "s2" > " Priority Mail" < / span > < span class = "w" > < / span > < span class = "o" > & & < / span > < span class = "w" > < / span > < span class = "nx" > packaging< / span > < span class = "w" > < / span > < span class = "o" > ==< / span > < span class = "w" > < / span > < span class = "s2" > " FlatRateEnvelope" < / span > < span class = "p" > )< / span > < span class = "w" > < / span > < span class = "p" > {< / span >
< / span > < span id = "__span-6-23" > < a id = "__codelineno-6-23" name = "__codelineno-6-23" href = "#__codelineno-6-23" > < / a > < span class = "w" > < / span > < span class = "k" > return< / span > < span class = "w" > < / span > < span class = "nx" > retail< / span > < span class = "w" > < / span > < span class = "o" > +< / span > < span class = "w" > < / span > < span class = "mf" > 1.0< / span > < span class = "p" > ;< / span >
< / span > < span id = "__span-6-24" > < a id = "__codelineno-6-24" name = "__codelineno-6-24" href = "#__codelineno-6-24" > < / a > < span class = "w" > < / span > < span class = "p" > }< / span >
< / span > < span id = "__span-6-25" > < a id = "__codelineno-6-25" name = "__codelineno-6-25" href = "#__codelineno-6-25" > < / a > < span class = "w" > < / span > < span class = "k" > return< / span > < span class = "w" > < / span > < span class = "nx" > suggested< / span > < span class = "w" > < / span > < span class = "o" > +< / span > < span class = "w" > < / span > < span class = "mf" > 2.0< / span > < span class = "p" > ;< / span > < span class = "w" > < / span > < span class = "c1" > // Charge the PostalPoint-calculated amount plus $2< / span >
< / span > < span id = "__span-6-26" > < a id = "__codelineno-6-26" name = "__codelineno-6-26" href = "#__codelineno-6-26" > < / a > < span class = "w" > < / span > < span class = "p" > }< / span > < span class = "w" > < / span > < span class = "k" > else< / span > < span class = "w" > < / span > < span class = "p" > {< / span >
< / span > < span id = "__span-6-27" > < a id = "__codelineno-6-27" name = "__codelineno-6-27" href = "#__codelineno-6-27" > < / a > < span class = "w" > < / span > < span class = "k" > return< / span > < span class = "w" > < / span > < span class = "nx" > cost< / span > < span class = "w" > < / span > < span class = "o" > *< / span > < span class = "w" > < / span > < span class = "mf" > 2< / span > < span class = "p" > ;< / span > < span class = "w" > < / span > < span class = "c1" > // Charges the customer double the shipment' s cost.< / span >
< / span > < span id = "__span-6-28" > < a id = "__codelineno-6-28" name = "__codelineno-6-28" href = "#__codelineno-6-28" > < / a > < span class = "w" > < / span > < span class = "p" > }< / span >
< / span > < span id = "__span-6-29" > < a id = "__codelineno-6-29" name = "__codelineno-6-29" href = "#__codelineno-6-29" > < / a > < span class = "w" > < / span > < span class = "p" > }< / span >
< / span > < span id = "__span-6-30" > < a id = "__codelineno-6-30" name = "__codelineno-6-30" href = "#__codelineno-6-30" > < / a > < span class = "p" > );< / span >
< / span > < / code > < / pre > < / div > < / p >
< / article >
< / div >
< script > var target = document . getElementById ( location . hash . slice ( 1 ) ) ; target && target . name && ( target . checked = target . name . startsWith ( "__tabbed_" ) ) < / script >
< / div >
< / main >
< footer class = "md-footer" >
< div class = "md-footer-meta md-typeset" >
< div class = "md-footer-meta__inner md-grid" >
< div class = "md-copyright" >
Made with
< a href = "https://squidfunk.github.io/mkdocs-material/" target = "_blank" rel = "noopener" >
Material for MkDocs
< / a >
< / div >
< / div >
< / div >
< / footer >
< / div >
< div class = "md-dialog" data-md-component = "dialog" >
< div class = "md-dialog__inner md-typeset" > < / div >
< / div >
2026-02-13 14:02:44 -07:00
< script id = "__config" type = "application/json" > { "annotate" : null , "base" : "../.." , "features" : [ "content.code.copy" ] , "search" : "../../assets/javascripts/workers/search.2c215733.min.js" , "tags" : null , "translations" : { "clipboard.copied" : "Copied to clipboard" , "clipboard.copy" : "Copy to clipboard" , "search.result.more.one" : "1 more on this page" , "search.result.more.other" : "# more on this page" , "search.result.none" : "No matching documents" , "search.result.one" : "1 matching document" , "search.result.other" : "# matching documents" , "search.result.placeholder" : "Type to start searching" , "search.result.term.missing" : "Missing" , "select.version" : "Select version" } , "version" : { "provider" : "mike" } } < / script >
2026-02-13 14:01:00 -07:00
< script src = "../../assets/javascripts/bundle.79ae519e.min.js" > < / script >
< script src = "../../assets/external/unpkg.com/mermaid@11/dist/mermaid.min.js" > < / script >
< / body >
< / html >
