Skip to content
Last updated
Image description

This Appendix contains reference tables for the ShipSaving New API (v2).

These tables define the valid values and expected behavior for parameters used in New API (v2) endpoints and may differ from those in other ShipSaving API versions.


Click on any section below to expand and view the full table.

📦 Carrier Service Types (New API v2)

This section documents the relationship between carrier_code, provider_id, and service_level used in the ShipSaving New API (v2).

Values for these fields must be compatible as defined in the tables below.

USPS

carrier_codeprovider_idservice_level
USPSUSPS_BUSPS_FIRST_CLASS_MAIL
USPSUSPS_BUSPS_GROUND_ADVANTAGE
USPSUSPS_BUSPS_PRIORITY_MAIL
USPSUSPS_BUSPS_PRIORITY_MAIL_EXPRESS
USPSUSPS_BUSPS_MEDIA_MAIL
USPSUSPS_BUSPS_LIBRARY_MAIL
USPSUSPS_BUSPS_FIRST_CLASS_MAIL_INTERNATIONAL
USPSUSPS_BUSPS_PRIORITY_MAIL_INTERNATIONAL
USPSUSPS_BUSPS_PRIORITY_MAIL_EXPRESS_INTERNATIONAL

USPS Returns

carrier_codeprovider_idservice_level
USPSUSPS_RUSPS_GROUND_ADVANTAGE_RETURN
USPSUSPS_RUSPS_PRIORITY_MAIL_RETURN
USPSUSPS_RUSPS_PRIORITY_MAIL_EXPRESS_RETURN

UPS

carrier_codeprovider_idservice_level
UPSUPS_SS_DNIUPS_GROUND
UPSUPS_SS_DNIUPS_GROUND_SAVER
UPSUPS_SS_DNIUPS_NEXT_DAY_AIR
UPSUPS_SS_DNIUPS_NEXT_DAY_AIR_SAVER
UPSUPS_SS_DNIUPS_NEXT_DAY_AIR_EARLY
UPSUPS_SS_DNIUPS_2ND_DAY_AIR
UPSUPS_SS_DNIUPS_2ND_DAY_AIR_AM
UPSUPS_SS_DNIUPS_3_DAY_SELECT
UPSUPS_SS_DNIUPS_STANDARD
UPSUPS_SS_DNIUPS_WORLDWIDE_SAVER
UPSUPS_SS_DNIUPS_WORLDWIDE_EXPRESS
UPSUPS_SS_DNIUPS_WORLDWIDE_EXPRESS_PLUS
UPSUPS_SS_DNIUPS_WORLDWIDE_EXPEDITED
UPSUPS_SS_DNIUPS_SUREPOST_LESS_THAN_1_LB
UPSUPS_SS_DNIUPS_SUREPOST_1_LB_OR_GREATER

FedEx

carrier_codeprovider_idservice_level
FEDEXFEDEX_XFEDEX_GROUND
FEDEXFEDEX_XFEDEX_2_DAY
FEDEXFEDEX_XFEDEX_2_DAY_AM
FEDEXFEDEX_XFEDEX_EXPRESS_SAVER
FEDEXFEDEX_XFEDEX_STANDARD_OVERNIGHT
FEDEXFEDEX_XFEDEX_FIRST_OVERNIGHT
FEDEXFEDEX_XFEDEX_PRIORITY_OVERNIGHT
FEDEXFEDEX_XFEDEX_HOME_DELIVERY
FEDEXFEDEX_XFEDEX_SMARTPOST
FEDEXFEDEX_XFEDEX_STANDARD_OVERNIGHT_EXTRA_HOURS
FEDEXFEDEX_XFEDEX_FIRST_OVERNIGHT_EXTRA_HOURS
FEDEXFEDEX_XFEDEX_PRIORITY_OVERNIGHT_EXTRA_HOURS
FEDEXFEDEX_XFEDEX_INTERNATIONAL_ECONOMY
FEDEXFEDEX_XFEDEX_INTERNATIONAL_FIRST
FEDEXFEDEX_XFEDEX_INTERNATIONAL_PRIORITY
FEDEXFEDEX_XFEDEX_INTERNATIONAL_PRIORITY_EXPRESS
FEDEXFEDEX_XFEDEX_INTERNATIONAL_CONNECT_PLUS
FEDEXFEDEX_XFEDEX_DATE_CERTAIN_HOME_DELIVERY
FEDEXFEDEX_XFEDEX_EVENING_HOME_DELIVERY
FEDEXFEDEX_XFEDEX_APPOINTMENT_HOME_DELIVERY
FEDEXFEDEX_XFEDEX_INTERNATIONAL_PRIORITY_PR

DHL Express

carrier_codeprovider_idservice_level
DHL_EXPRESSDHL_ADHL_EXPRESS_WORLDWIDE_B2C
DHL_EXPRESSDHL_ADHL_EXPRESS_WORLDWIDE_B2C_NONDOC
DHL_EXPRESSDHL_ADHL_EXPRESS_WORLDWIDE_DOC
DHL_EXPRESSDHL_ADHL_EXPRESS_WORLDWIDE_NONDOC
DHL_EXPRESSDHL_ADHL_EXPRESS_JET_LINE_NONDOC
DHL_EXPRESSDHL_ADHL_EXPRESS_SPRINT_LINE
DHL_EXPRESSDHL_ADHL_EXPRESS_EURO_PACK_DOC
DHL_EXPRESSDHL_ADHL_EXPRESS_EURO_PACK_NONDOC
DHL_EXPRESSDHL_ADHL_EXPRESS_BREAK_BULK_EXPRESS
DHL_EXPRESSDHL_ADHL_EXPRESS_MEDICAL_EXPRESS
DHL_EXPRESSDHL_ADHL_EXPRESS_MEDICAL_EXPRESS_NODOC
DHL_EXPRESSDHL_ADHL_EXPRESS_GLOBAL_MAIL_BUSINESS
DHL_EXPRESSDHL_ADHL_EXPRESS_SAME_DAY
DHL_EXPRESSDHL_ADHL_EXPRESS_ENVELOPE
DHL_EXPRESSDHL_ADHL_EXPRESS_0900
DHL_EXPRESSDHL_ADHL_EXPRESS_0900_NONDOC
DHL_EXPRESSDHL_ADHL_EXPRESS_1030
DHL_EXPRESSDHL_ADHL_EXPRESS_1030_NONDOC
DHL_EXPRESSDHL_ADHL_EXPRESS_1200_DOC
DHL_EXPRESSDHL_ADHL_EXPRESS_1200_NONDOC
DHL_EXPRESSDHL_ADHL_EXPRESS_DOMESTIC_EXPRESS
DHL_EXPRESSDHL_ADHL_EXPRESS_DOMESTIC_EXPRESS_0900
DHL_EXPRESSDHL_ADHL_EXPRESS_DOMESTIC_EXPRESS_1030
DHL_EXPRESSDHL_ADHL_EXPRESS_DOMESTIC_EXPRESS_1200
DHL_EXPRESSDHL_ADHL_EXPRESS_DOMESTIC_ECONOMY_SELECT
DHL_EXPRESSDHL_ADHL_EXPRESS_ECONOMY_SELECT
DHL_EXPRESSDHL_ADHL_EXPRESS_ECONOMY_SELECT_NONDOC
DHL_EXPRESSDHL_ADHL_EXPRESS_FREIGHT_WORLDWIDE_NONDOC
DHL_EXPRESSDHL_ADHL_EXPRESS_WORLDWIDE_ECX

UPS Canada

carrier_codeprovider_idservice_level
UPS_CANADAUPS_CANADAUPS_CANADA_EXPEDITED
UPS_CANADAUPS_CANADAUPS_CANADA_EXPRESS_EARLY
UPS_CANADAUPS_CANADAUPS_CANADA_EXPRESS_SAVER
UPS_CANADAUPS_CANADAUPS_CANADA_EXPRESS
UPS_CANADAUPS_CANADAUPS_CANADA_STANDARD
UPS_CANADAUPS_CANADAUPS_CANADA_3_DAY_SELECT
UPS_CANADAUPS_CANADAUPS_CANADA_EXPRESS_EARLY_SM
UPS_CANADAUPS_CANADAUPS_CANADA_WORLDWIDE_EXPEDITED_SM
UPS_CANADAUPS_CANADAUPS_CANADA_WORLDWIDE_EXPRESS_PLUS_SM
UPS_CANADAUPS_CANADAUPS_CANADA_WORLDWIDE_EXPRESS_SM
UPS_CANADAUPS_CANADAUPS_CANADA_EXPRESS_SAVER_SM

GOFO Express

carrier_codeprovider_idservice_level
GOFO_EXPRESSGOFO_EXPRESS_AGOFO_EXPRESS_ECO

SWIFTX

carrier_codeprovider_idservice_level
SWIFTXSWIFTXSWIFTX_EXP
📦 Carrier Package Codes (New API v2)

The table below lists all supported carrier_package_code values for the ShipSaving New API (v2).

USPS

carrier_package_code
USPS_LETTER
USPS_LARGE_ENVELOPE_OR_FLAT
USPS_THICK_ENVELOPE
USPS_SMALL_FLAT_RATE_BOX
USPS_MEDIUM_FLAT_RATE_BOX
USPS_LARGE_FLAT_RATE_BOX
USPS_FLAT_RATE_ENVELOPE
USPS_PADDED_FLAT_RATE_ENVELOPE
USPS_LEGAL_FLAT_RATE_ENVELOPE

UPS

carrier_package_code
UPS_LETTER
UPS_25KG_BOX
UPS_10KG_BOX
UPS_TUBE
UPS_PAK
UPS_EXPRESS_BOX_SMALL
UPS_EXPRESS_BOX_MEDIUM
UPS_EXPRESS_BOX_LARGE

FedEx

carrier_package_code
FEDEX_ENVELOPE
FEDEX_PAK
FEDEX_TUBE
FEDEX_EXTRA_SMALL_BOX
FEDEX_SMALL_BOX
FEDEX_MEDIUM_BOX
FEDEX_LARGE_BOX
FEDEX_EXTRA_LARGE_BOX
FEDEX_BOX
FEDEX_10KG_BOX
FEDEX_25KG_BOX

UPS Canada

carrier_package_code
UPS_CANADA_LETTER
UPS_CANADA_25KG_BOX
UPS_CANADA_10KG_BOX
UPS_CANADA_TUBE
UPS_CANADA_PAK
UPS_CANADA_EXPRESS_BOX
UPS_CANADA_EXPRESS_BOX_SMALL
UPS_CANADA_EXPRESS_BOX_MEDIUM
UPS_CANADA_EXPRESS_BOX_LARGE
🛃 Exemption Code Name Table

The table below lists all supported exemption code name values that may be used for the eel_pfc_code field across ShipSaving APIs.

These values are applicable only when the corresponding eel_pfc_type is set to EXEMPTION_CODE.

Exemption Code Name
NOEEI 30.2(d)(1)
NOEEI 30.2(d)(2)
NOEEI 30.2(d)(4)
NOEEI 30.26(a)
NOEEI 30.30(j)
NOEEI 30.36
NOEEI 30.37(a)
NOEEI 30.37(b)
NOEEI 30.37(c)
NOEEI 30.37(d)
NOEEI 30.37(e)
NOEEI 30.37(f)
NOEEI 30.37(g)
NOEEI 30.37(h)
NOEEI 30.37(i)
NOEEI 30.37(j)
NOEEI 30.37(k)
NOEEI 30.37(l)
NOEEI 30.37(m)
NOEEI 30.37(n)
NOEEI 30.37(o)
NOEEI 30.37(p)
NOEEI 30.37(q)
NOEEI 30.37(r)
NOEEI 30.37(s)
NOEEI 30.37(t)
NOEEI 30.37(u)
NOEEI 30.37 (v)
NOEEI 30.37 (w)
NOEEI 30.37(x)
NOEEI 30.37(y)
NOEEI 30.37(y)(1)
NOEEI 30.37(y)(2)
NOEEI 30.37(y)(3)
NOEEI 30.37(y)(4)
NOEEI 30.37(y)(5)
NOEEI 30.37(y)(6)
NOEEI 30.39
NOEEI 30.40(a)
NOEEI 30.40(b)
NOEEI 30.40(c)
NOEEI 30.40(d)
NOEEI 30.8(b)