UPS from ShipStation Guide | ShipEngine
šShipEngine is becoming ShipStation APIš
Over the next few months you'll notice the ShipEngine website, documentation portal, and dashboard being rebranded as ShipStation API. For our ShipEngine customers, you don't need to take any action or change any of your integrations in any way. All endpoints will remain the same and continue to function as they always have.
To learn more about what's coming, review our New ShipStation API page.
UPS from ShipStation
UPS from ShipStation offers domestic and international shipping services at pre-negotiated rates to ShipStation API accounts in the following countries:
- US
- Canada
- UK
- Australia
- New Zealand
- France
- Germany
This guide provides developers with the details needed to build UPS from ShipStation shipping capabilities into your ShipStation API workflows.
ShipStation API also allows you to connect your own existing UPS account. The requirements and service details are different than those for UPS from ShipStation. For details about connecting and using your own UPS account with ShipStation API, see our UPS Guide.
Requirements
carrier_name: ups_walleted
- A ShipStation API account based in one of the supported countries.
- ShipStation Carriers must be activated for the account and have a positive account balance to create labels. See our Using ShipStation Carriers page for details about activating it in your account.
- A weight value is required for all shipments.
- Available services will vary by country. See the Service Details section for specifics.
Rates
UPS from ShipStation supports rate shopping with ShipStation API.
Service Details
The services available with UPS from ShipStation are provided in this table. Please note that carriers may update their available services at any time. To ensure you are always using valid services, you can use the list carrier services endpoint at any time.
Domestic Services
| Service | Transit Time | Service Codes | Countries |
|---|---|---|---|
| UPSĀ® Ground | 1-5 Business days | ups_ground |
US |
| UPSĀ® Ground Saver | 3-7 Business days | ups_ground_saver |
US |
| UPS Standard | 1-5 Business days | ups_standard |
CA, GB |
| UPS 3 Day SelectĀ® | 3 Business days | ups_3_day_select |
US |
| UPS 2nd Day AirĀ® | 2 Business days | ups_2nd_day_air |
US, CA |
| UPS 2nd Day Air AMĀ® | 2 Business days (before noon) | ups_2nd_day_air_am |
US |
| UPS Next Day Air SaverĀ® | 1 Business day (End of day) | ups_next_day_air_saver |
US, CA |
| UPS Next Day AirĀ® | 1 Business day | ups_next_day_air |
US, CA |
| UPS Next Day AirĀ® Early | 1 Business day (delivery between 8am-10am) | ups_next_day_air_early_am |
US, CA |
| UPS ExpressĀ® | ups_express |
AU, DE, FR, GB, NZ | |
| UPS Express PlusĀ® | ups_express_plus |
AU, DE, FR, GB, NZ | |
| UPS Worldwide SaverĀ® | ups_worldwide_saver |
AU, DE, FR, GB, NZ |
NOTE:
UPS Ground Saver
Please note the following when using the UPS Ground Saver service:
- Ships to and from the lower 48 states only (excludes AK, HI)
- Max size: 130 total inches
- Max weight: If the package is over the DIM weight threshold (L x W x H / 166), the max weight is 10 lbs. If the package is under the DIM weight threshold, the max weight is 70 lbs.
- Does not qualify for UPS Guaranteed Service refunds.
- UPS Ground Saver packages MUST be dropped off with UPS, even if the USPS makes the final delivery.
- DO NOT drop off UPS Ground Saver packages with the USPS. The USPS may deny delivery of packages and claim that postage was not paid for.
International Services
| Service | Transit Time | Service Codes | Countries |
|---|---|---|---|
| UPS GroundĀ® (International) | ups_ground_international |
US | |
| UPS 3 Day SelectĀ® | 3 Business days | ups_3_day_select |
CA |
| UPS Worldwide ExpressĀ® | Varies by country | ups_worldwide_express |
US, CA, GB |
| UPS Worldwide ExpeditedĀ® | ups_worldwide_expedited |
US, CA, GB | |
| UPS Worldwide SaverĀ® | ups_worldwide_saver |
US, CA, GB | |
| UPS StandardĀ® | ups_standard |
US, CA, GB | |
| UPS Worldwide Express PlusĀ® | ups_worldwide_express_plus |
US, CA, GB |
NOTE:
UPS Service Alert: Middle East Service Impact
UPS is closely monitoring the situation in the Middle East and using established contingency plans to manage our operations safely and efficiently.
Our focus is on safety while we work to minimize impacts for our customers.
For the most up-to-date information on the status of shipments, customers can track a package on ups.com. Note that the UPS Service Guarantee does not apply to shipments affected.
Shipping from Great Britain to Northern Ireland
As of 1st May 2025, UPS will support all movement types (B2B, B2C, C2C, and C2B) for shipping from Great Britain (GB) to Northern Ireland (NI), as related to the Windsor Framework.
Let UPS know in advance if your goods are considered 'at risk' of moving through Northern Ireland to be sold in the EU. To learn when goods can be considered as ānot at riskā, see the page UK Government Guidance page Moving goods you bring into Northern Ireland as 'not at riskā of moving to the EU.
Shippers must send an email to windsorframework@ups.com for UPS to add instructions to their UPS UK shipping account number, along with UKIMS approval number & XI Duty Deferment number, when applicable. They must also enter their B2B NI customerās XI EORI number with the shipping data in the Destination Tax ID field, if they know it.
NI Importers, and if required, some GB shippers, will need to be authorised under the new UK Internal Market Scheme (UKIMS) to avoid EU duties. Merchants may want to consider signing up for the UK Government's Trader Support Service.
Windsor Framework Parameters
| Parameter | Required? | Description |
|---|---|---|
| Movement Indicator | ā | Movement Indicator required for GB-NI shipments. |
| Not at risk flag | ā | B2B: Default value = Unknown. You can set to āat riskā/'not at risk' for B2B. B2B/C2C/C2B: Default value = NotAtRisk |
| Commercial Invoice | ā | See the UPS Commercial Invoice Guide. |
| UKIMS Number (NI Importer of Record UKIMS Number) |
||
| Required for B2B Movements NI Importers, and if required, some GB shippers, need to be authorised under the new UK Internal Market Scheme(UKIMS) to avoid EU duties. Not required for B2C/C2C/C2B Can be Recipient UKIMS Number or Sender UKIMS Number (an entity who is the NI Importer of Record) UKIMS can also be assigned to a UPS Account Number within the UPS store settings. |
||
| EORI | ||
| Required for B2B Movements EORI Number (registered in NI starts with āNIā) EORI can also be assigned to a UPS Account Number within the UPS store settings. |
Data Expectations
NOTE: Clear goods descriptions, values, and commodity codes are required for all movement types.
*Please specify each item in the shipment with its commodity code, weight, and a concise description, e.g., "Ladies woven 100% cotton blouseā, āMenās leather shoesā, or "iPhone" instead of a general one.
- Incorrect: Nuts
- Correct: 26 hexagonal aluminum bicycle nuts
- Incorrect: T-Shirts
- Correct: 15 men's T-Shirts, Size L, 100% Cotton
B2B parcels with UKIMS authorisation:
- Product.Description*
- Product.Value
- Product.ValueCurrency
- Product.Quantity
- Product.Country
- 6-Digit HS Code [Product.HarmonisedCode]
- EORI Number (Importer of Record)
Present in the *QAID2 Identification Numbers segment.
- UKIMS Number (Importer of Record)
Present in the *QAID2 Identification Numbers segment.
- NI Importer of Record Duty Deferment Number(if applicable)
Present in the *QAID2 Identification Numbers segment.
B2B parcels without UKIMS authorisation:
Present in the *QAID2 Identification Numbers segment.
- NI Importer of Record Duty Deferment Number(if applicable)
Present in the *QAID2 Identification Numbers segment.
B2B/B2C/C2B parcels
- Product.Description*
- Product.Value
- Product.ValueCurrency
- Product.Quantity
- Product.Country
- 6-Digit HS Code [Product.HarmonisedCode]
TIP: You may find it helpful to see the Products Object section of our International Shipping page.
Additional Considerations for Validation
- Comply with weight limits for parcels.
* B2C / C2B / C2C shipments with any number of items or multiple parcels must weigh less than 31.5kg. If a parcel exceeds this limit, it will be considered a B2B shipment that requires customs clearance.
* B2C / C2B / C2C shipments must contain only one (single) item of goods and weigh less than 100kg. If not, it will be considered a B2B shipment that requires customs clearance.
- Commercial Invoice or Paperless Invoice
Paperless Invoice is the default. If a physical Commercial Invoice is required, then Shipment.ContentType must be set to InvoiceGenerated.
- Statement at risk/not at risk (recommended for B2B - default is
Unknown, optional for B2C/C2C/C2B) - NI Importer of Record ā Duty Deferment Number (if applicable)
- For additional assistance, please email your queries to windsorframework@ups.com.
Return Services
You can use the following UPS from ShipStation domestic services for returns:
- UPSĀ® Ground
- UPS 3 Day SelectĀ®
- UPS 2nd Day AirĀ®
- UPS Next Day Air SaverĀ®
- UPS Next Day AirĀ®
- UPS Next Day AirĀ® Early
- UPS 2nd Day Air AMĀ®
- UPS ExpressĀ®
- UPS Express PlusĀ®
- UPS Worldwide SaverĀ®
Review the Return Shipping Labels page for details on creating return labels with ShipStation API.
Packages
UPS from ShipStation does not specify carrier package types. You can use custom package types or the generic package package type.
Adding Shipment Insurance
UPS from ShipStation does not support adding carrier insurance to shipments created with ShipStation API. US accounts can add Parcelguard protection to shipments with UPS from ShipStation.
Review the Parcel Insurance page for details about adding shipment insurance with ShipStation API.
Label Support
- Label sizes: 4" x 6"
- Label formats: PDF, PNG, ZPL
Label Reference Fields
UPS from ShipStation supports adding custom label messages.
Multi-Package Labels
All UPS from ShipStation services support creating multi-package labels.
See our Multi-Package Shipping page for details about creating multi-package labels.
Label Branding
UPS from ShipStation does not support label branding.
Voiding Labels
UPS from ShipStation supports voiding labels with ShipStation API. Labels must be voided within 30 days of the label's creation date and must not have been scanned by UPS.
See our Void a Label page for details about voiding labels with ShipStation API.
Paperless Labels
UPS from ShipStation supports creating paperless labels.
See our Paperless Labels page for details about creating paperless labels with ShipStation API.
Customs Declarations
UPS from ShipStation electronically submits customs declarations in a commercial invoice. The label will display "EDI" to indicate electronic submission. If you wish to print the commercial invoice, you can access it from the label response form_download object.
On the customs form, UPS will display the first 35 characters of the itemās description. Any additional characters will not show. This differs from what is described for description in the Product Object table on the International Shipments page.
NOTE: Action Required: :nz: New Zealand Border Levy Changes
Effective ā April 1, 2026ā ā, a new ā NZD $2.21 (+ GST) levyā applies to low-value air freight consignments entering New Zealand. This fee is āseparate fromāā the 15% GST already being collected, and it applies per package, not per item.
To see how this change impacts your shipping rates and carrier invoices, see the Shipping to New Zealand: Low Value Goods (LVG) Levy section of International Shipments.
Delivery Confirmation
UPS from ShipStation supports the following delivery confirmation options (options other than online may incur an additional fee from UPS).
| Confirmation Type | API Code | Description |
|---|---|---|
| Online | online |
This is the default option if no confirmation type is specified. |
| Delivery | delivery |
Delivery confirmation requested. |
| Signature | signature |
Signature confirmation requested. |
| Adult signature | adult_signature |
Adult signature confirmation requested. |
| Verbal | verbal |
Verbal confirmation requested. |
See our Delivery Confirmation page for more details about using the confirmation property.
Advanced Options
UPS from ShipStation supports certain advanced options, which you can add to the shipment object when creating a shipment or label.
| Option | Type | Default Value | Description |
|---|---|---|---|
additional_handling |
boolean | null |
Indicates the package requires special handling. |
delivered_duty_paid |
boolean | false |
Indicates the shipment is DDP (that is, the shipper is paying the duties/taxes for the shipment rather than the recipient). |
non_machinable |
boolean | false |
Indicates that the package cannot be processed through sorting machines. |
saturday_delivery |
boolean | false |
Indicates that the carrier should charge for delivery on Saturday for services that do not otherwise include Saturday delivery. Only valid for certain services. |
To ensure you always have the most up-to-date information about a carrier's advanced options, use the list carrier options call.
Dangerous Goods
UPS from ShipStation does not support shipping dangerous goods.
Manifests
UPS from ShipStation does not support creating printable manifests. All shipment data is submitted electronically to UPS at the time of label creation, so UPS will have the shipment data in their system.
Scheduling Pickups
UPS from ShipStation supports schedule carrier pickups. Using this option may incur additional fees.
Service Points (PUDO)
UPS from ShipStation does not support shipping to service points.
Tracking
UPS from ShipStation supports receiving tracking updates. Review our Track a Package guides for details on tracking with the ShipStation API.