API Integration
UPS
upsproduction-ready
UPS is an American multinational shipping & receiving and supply chain management company.
PaperlessRatingTrackingShipping
Connection Requirements
| Field | Type | Required |
|---|---|---|
| client_id | string | |
| client_secret | string | |
| account_number | string | |
| account_country_code | string | |
| metadata | object | |
| config | object |
Carrier Configuration
| Field | Type |
|---|---|
| cost_center | string |
| merchant_id | string |
| enforce_zpl | boolean |
| label_type PDF_6x4PDF_8x4ZPL_6x4 | string |
| shipping_options | list |
| shipping_services | list |
Available Services
| Service Name | Service Code |
|---|---|
| UPS Standard | ups_standard |
| UPS Worldwide Express | ups_worldwide_express |
| UPS Worldwide Expedited | ups_worldwide_expedited |
| UPS Worldwide Express Plus | ups_worldwide_express_plus |
| UPS Worldwide Saver | ups_worldwide_saver |
| UPS 2nd Day Air | ups_2nd_day_air |
| UPS 2nd Day Air A.M. | ups_2nd_day_air_am |
| UPS 3 Day Select | ups_3_day_select |
| UPS Ground | ups_ground |
| UPS Next Day Air | ups_next_day_air |
| UPS Next Day Air Early | ups_next_day_air_early |
| UPS Next Day Air Saver | ups_next_day_air_saver |
| UPS Expedited CA | ups_expedited_ca |
| UPS Express Saver CA | ups_express_saver_ca |
| UPS 3 Day Select CA US | ups_3_day_select_ca_us |
| UPS Access Point Economy CA | ups_access_point_economy_ca |
| UPS Express CA | ups_express_ca |
| UPS Express Early CA | ups_express_early_ca |
| UPS Express Saver Intl CA | ups_express_saver_intl_ca |
| UPS Standard CA | ups_standard_ca |
| UPS Worldwide Expedited CA | ups_worldwide_expedited_ca |
| UPS Worldwide Express CA | ups_worldwide_express_ca |
| UPS Worldwide Express Plus CA | ups_worldwide_express_plus_ca |
| UPS Express Early CA US | ups_express_early_ca_us |
| UPS Access Point Economy EU | ups_access_point_economy_eu |
| UPS Expedited EU | ups_expedited_eu |
| UPS Express EU | ups_express_eu |
| UPS Standard EU | ups_standard_eu |
| UPS Worldwide Express Plus EU | ups_worldwide_express_plus_eu |
| UPS Worldwide Saver EU | ups_worldwide_saver_eu |
| UPS Access Point Economy MX | ups_access_point_economy_mx |
| UPS Expedited MX | ups_expedited_mx |
| UPS Express MX | ups_express_mx |
| UPS Standard MX | ups_standard_mx |
| UPS Worldwide Express Plus MX | ups_worldwide_express_plus_mx |
| UPS Worldwide Saver MX | ups_worldwide_saver_mx |
| UPS Access Point Economy PL | ups_access_point_economy_pl |
| UPS Today Dedicated Courrier PL | ups_today_dedicated_courrier_pl |
| UPS Today Express PL | ups_today_express_pl |
| UPS Today Express Saver PL | ups_today_express_saver_pl |
| UPS Today Standard PL | ups_today_standard_pl |
| UPS Expedited PL | ups_expedited_pl |
| UPS Express PL | ups_express_pl |
| UPS Express Plus PL | ups_express_plus_pl |
| UPS Express Saver PL | ups_express_saver_pl |
| UPS Standard PL | ups_standard_pl |
| UPS 2nd Day Air PR | ups_2nd_day_air_pr |
| UPS Ground PR | ups_ground_pr |
| UPS Next Day Air PR | ups_next_day_air_pr |
| UPS Next Day Air Early PR | ups_next_day_air_early_pr |
| UPS Worldwide Expedited PR | ups_worldwide_expedited_pr |
| UPS Worldwide Express PR | ups_worldwide_express_pr |
| UPS Worldwide Express Plus PR | ups_worldwide_express_plus_pr |
| UPS Worldwide Saver PR | ups_worldwide_saver_pr |
| UPS Express 12:00 DE | ups_express_12_00_de |
| UPS Worldwide Express Freight | ups_worldwide_express_freight |
| UPS Worldwide Express Freight Midday | ups_worldwide_express_freight_midday |
| UPS Worldwide Economy DDU | ups_worldwide_economy_ddu |
| UPS Worldwide Economy DDP | ups_worldwide_economy_ddp |
Shipping Options
| Option | Code | Type |
|---|---|---|
| ups_saturday_pickup_indicator | SaturdayPickupIndicator | boolean |
| ups_saturday_delivery_indicator | SaturdayDeliveryIndicator | boolean |
| ups_sunday_delivery_indicator | SundayDeliveryIndicator | boolean |
| ups_access_point_cod | AccessPointCOD | float |
| ups_deliver_to_addressee_only_indicator | DeliverToAddresseeOnlyIndicator | boolean |
| ups_direct_delivery_only_indicator | DirectDeliveryOnlyIndicator | boolean |
| ups_cod | COD | float |
| ups_return_of_document_indicator | ReturnOfDocumentIndicator | boolean |
| ups_carbonneutral_indicator | UPScarbonneutralIndicator | boolean |
| ups_certificate_of_origin_indicator | CertificateOfOriginIndicator | string |
| ups_shipper_export_declaration_indicator | ShipperExportDeclarationIndicator | boolean |
| ups_commercial_invoice_removal_indicator | CommercialInvoiceRemovalIndicator | boolean |
| ups_import_control | ImportControl | boolean |
| ups_return_service | ReturnService | boolean |
| ups_epra_indicator | EPRAIndicator | boolean |
| ups_lift_gate_at_pickup_indicator | LiftGateAtPickupIndicator | boolean |
| ups_lift_gate_at_delivery_indicator | LiftGateAtDeliveryIndicator | boolean |
| ups_drop_off_at_ups_facility_indicator | DropOffAtUPSFacilityIndicator | boolean |
| ups_master_carton_indicator | MasterCartonIndicator | boolean |
| ups_exchange_forward_indicator | ExchangeForwardIndicator | boolean |
| ups_hold_for_pickup_indicator | HoldForPickupIndicator | boolean |
| ups_dropoff_at_ups_facility_indicator | DropoffAtUPSFacilityIndicator | boolean |
| ups_lift_gate_for_pickup_indicator | LiftGateForPickupIndicator | boolean |
| ups_lift_gate_for_delivery_indicator | LiftGateForDeliveryIndicator | boolean |
| ups_sdl_shipment_indicator | SDLShipmentIndicator | boolean |
| ups_item_disposal | ItemDisposal | boolean |
| ups_available_services_option | AvailableServicesOption | string |
| ups_delivery_confirmation | DeliveryConfirmation | string |
| ups_delivery_confirmation_level | DeliveryConfirmationLevel | string |
| ups_inside_delivery | InsideDelivery | string |
| ups_restricted_articles | RestrictedArticles | boolean |
| ups_alcoholic_beverages_indicator | AlcoholicBeveragesIndicator | boolean |
| ups_diagnostic_specimens_indicator | DiagnosticSpecimensIndicator | boolean |
| ups_perishables_indicator | PerishablesIndicator | boolean |
| ups_plants_indicator | PlantsIndicator | boolean |
| ups_seeds_indicator | SeedsIndicator | boolean |
| ups_special_exceptions_indicator | SpecialExceptionsIndicator | boolean |
| ups_tobacco_indicator | TobaccoIndicator | boolean |
| ups_ecigarettes_indicator | ECigarettesIndicator | boolean |
| ups_hemp_cbd_indicator | HempCBDIndicator | boolean |
| ups_negotiated_rates_indicator | NegotiatedRatesIndicator | boolean |
| ups_frs_shipment_indicator | FRSShipmentIndicator | boolean |
| ups_rate_chart_indicator | RateChartIndicator | boolean |
| ups_user_level_discount_indicator | UserLevelDiscountIndicator | boolean |
| ups_tpfc_negotiated_rates_indicator | TPFCNegotiatedRatesIndicator | boolean |
| ups_access_point_pickup | 01 | boolean |
| ups_access_point_delivery | 02 | boolean |
