Add a Parcel Pro account
This guide walks through setting up a Parcel Pro account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field Parcel Pro expects.
At a glance
Before you start
- A Parcel Pro account in good standing, plus its API credentials. The required fields are listed in All Parcel Pro settings below.
- Decide the account country and the default service and label format this account uses.
Open the carrier accounts page
In the Carriyo Dashboard, open Settings in the left sidebar. Under Carrier Management, choose Carrier Accounts, then click the + add icon to start a new account.
Open settings
Go to Carrier Accounts
Add a new carrier account
Pick Parcel Pro
In the carrier picker, search for Parcel Pro and click Select. Carriyo creates a Parcel Pro account and opens the credential step.
Search for the carrier
Enter the basics
The first wizard page collects two fields:
- Account name
- A label that's meaningful to your team (e.g.
Parcel Pro Germany). Keep it short and unique. - Account country
- The country this account ships from. Determines the routes and services available.
Fill in the account name and country.
- 1Account Name
- 2Account Country
Enter your Parcel Pro account details
Enter the required Parcel Pro account details, then click Next. Every field is documented in All Parcel Pro settings below, with examples and accepted values.
Enter parcel pro username.
- 1Parcel Pro Username
Enter password.
- 1Password
Select service.
- 1Service
Configure the account
The new account opens on its detail page. General settings work the same way for every carrier: the Active toggle, default label and service, and currency. See Add a carrier account for the full reference to these shared settings — default label, merchant access, going live, and common mistakes.
Go to the account page
View the account details
Set the default label format
Merchant access
On multi-merchant tenants, restrict the account to specific merchants via the Permissions tab, then Save.
Add merchants to this carrier account
All Parcel Pro settings
Every field Parcel Pro exposes in the carrier account, grouped by section. Carriyo stores secrets encrypted and never shows them after saving.
Authentication
2 fieldsAccount identifiers and API credentials used to connect to the carrier.
| Field | Type | What to enter |
|---|---|---|
| UsernameRequired | Text | Parcel Pro API username. Parcel Pro issues separate users for the beta and production systems. Example: APIXX000000 |
| PasswordRequired | Secret | Password paired with the Parcel Pro API username. Example: xxxxxxxx-xxxx-xxxx |
Account Details
6 fieldsAccount-level configuration and defaults applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| ServiceRequired | Select | Default UPS service to book shipments with. Example: UPS Express Saver (65) UPS Express (07)UPS Standard (11)UPS Express Saver (65)UPS Express 12:00 (74), domestic only UPS Express 12:00 (74) books domestic shipments only. UPS Standard (11) allows only Your Packaging as the package type. |
| Package TypeOptional | Select | Package type sent on every shipment. Defaults to Your Packaging (02). Options depend on the service. Example: Your Packaging (02) Parcel dimensions are sent only for Your Packaging. The other package types have fixed sizes. |
| Pickup TypeOptional | Select | How parcels reach UPS. Defaults to Regular Pickup. Example: Regular Pickup Regular PickupScheduled PickupDrop-off Scheduled Pickup books a UPS pickup for the shipment's collection window, and Carriyo stores the UPS dispatch confirmation number as the pickup id. Canceling the shipment also cancels the pickup. |
| Direct Delivery OnlyOptional | Toggle | Deliver only to the recipient address, with no redirection to a neighbor or access point. |
| Direct SignatureOptional | Toggle | Require a signature from the recipient on delivery. |
| Thermal LabelOptional | Toggle | Ask Parcel Pro for a label in thermal printer size. Carriyo stores the label as a PDF either way. |
Returns
1 fieldReturn service Parcel Pro uses when Carriyo books a return shipment.
| Field | Type | What to enter |
|---|---|---|
| Return Service CodeOptional | Select | Return service Parcel Pro uses for return shipments. Required to book returns. Example: UPS Print Return Label (9) UPS Prints and Posts Return Label (2)UPS 1 Attempt Returns Plus (3)UPS 3 Attempts Returns Plus (5)UPS Electronic Return Label (8)UPS Print Return Label (9) |
Insurance
1 fieldFallback insured value for shipments that carry no insurance amount.
| Field | Type | What to enter |
|---|---|---|
| Default Insured ValueOptional | Number | Parcel Pro insures every shipment. Whole number in the Parcel Pro account currency, sent when the shipment has no insurance amount. If both are empty, the quote is sent without an insured value. Example: 500Carriyo rounds the shipment's insurance amount to a whole number before sending it. |
Cross Border
18 fieldsCustoms, commercial invoice and duties settings for shipments leaving the EU. Domestic and EU-to-EU shipments carry no customs data. For other destinations Carriyo builds the customs lines from the shipment items. Every item needs a description, origin country and price, or the booking fails with a validation error naming the item field. German exports outside the EU with a customs value above EUR 1000 also need a Movement Reference Number. Put the MRN of the Export Accompanying Document in the shipment custom attribute movement_reference_number.
| Field | Type | What to enter |
|---|---|---|
| Shipment PurposeOptional | Select | Purpose declared on shipments leaving the EU. Defaults to Commercial. Example: CommercialCommercialGiftPersonal EffectsPersonal UseReturn and RepairSample |
| Commercial InvoiceOptional | Select | Who produces the commercial invoice for shipments leaving the EU. With your own invoice, Parcel Pro e-files the documents uploaded on the shipment that are mapped under Documents. With the other options Parcel Pro produces the invoice. Type 3 needs your signature and letterhead set up in the Parcel Pro portal first. Example: Parcel Pro prints the invoice with the label (Type 1) Parcel Pro prints the invoice with the label (Type 1)Send your own invoice and documents, Parcel Pro e-files them (Type 2)Parcel Pro creates and e-files the invoice (Type 3) Leave the field empty when Parcel Pro should not produce an invoice. With Type 1 or Type 3, Carriyo fetches the invoice PDF after booking and stores it on the shipment as the carrier commercial invoice. Type 3 without the signature and letterhead in the Parcel Pro portal passes the quote but fails at booking with "Object reference not set to an instance of an object." |
| Bill Duties ToOptional | Select | Bill duties and taxes to a third party UPS account. Leave empty to use the account default. Example: Account default Third Party |
| Third Party Account NumberOptional | Text | UPS account number of the third party that pays duties and taxes. |
| Third Party Country CodeOptional | Text | Two-letter country code of the third party UPS account. Example: DE |
| Third Party Postal CodeOptional | Text | Postal code of the third party UPS account. Example: 12345 |
| Use Own Customs BrokerOptional | Toggle | Send your own customs broker on shipments leaving the EU. The broker fields appear when this is on. |
| Broker Account NumberOptional | Text | Account number of your customs broker. |
| Broker Company NameOptional | Text | Company name of your customs broker. Example: Acme Inc |
| Broker Contact NameOptional | Text | Contact person at your customs broker. Example: John Smith |
| Broker Phone NumberOptional | Text | Phone number of your customs broker. Example: +491700000000 |
| Broker Address Line 1Optional | Text | Street address of your customs broker. Example: 123 Example Street |
| Broker Address Line 2Optional | Text | Second address line of your customs broker, if any. |
| Broker CityOptional | Text | City of your customs broker. Example: Berlin |
| Broker StateOptional | Text | State or region of your customs broker, if the country uses one. |
| Broker Postal CodeOptional | Text | Postal code of your customs broker. Example: 12345 |
| Broker Country CodeOptional | Text | Two-letter country code of your customs broker. Example: DE |
| Broker Tax IDOptional | Text | Tax identifier of your customs broker. |
Reference Mappings
2 fieldsMap Carriyo fields to the reference values the carrier expects.
| Field | Type | What to enter |
|---|---|---|
| Reference NumberOptional | Select | Carriyo reference printed on the label and shown in Parcel Pro shipment details. Defaults to the shipment reference. Example: Shipment Reference Order ReferenceShipment ReferenceAlternate Reference |
| Customer Reference NumberOptional | Select | Carriyo reference shown in Parcel Pro shipment details and on your Parcel Pro invoice. Defaults to the order reference. Example: Order Reference Order ReferenceShipment ReferenceAlternate Reference |
Document Upload
1 fieldCustoms and shipping documents to attach to shipments.
| Field | Type | What to enter |
|---|---|---|
| Required | Text | Applies with Type 2 only. Map each Carriyo document (Settings > Administration > Documents) to its Parcel Pro type here, the commercial invoice included (type 002). Only mapped documents are sent. Parcel Pro accepts PDF files up to 5 MB. Commercial InvoiceCertificate of OriginExport Accompanying DocumentExport LicenseImport PermitPacking List Upload documents to the shipment before you book it, on a draft shipment you then submit. If a booking failed because the invoice was missing, upload it and update the shipment to rebook it. With Type 1 or 3, uploaded documents stay on the Carriyo shipment and are not sent. |
Capability notes
Behavior that follows from Parcel Pro's capabilities. Read these before you go live.