Issues
No results found.
You're not signed in. Please sign-in to report an issue or post a comment.
Frequently Asked Questions
In order to receive coverage on shipments transactionally and complete payment the partner must integrate with the Insurance, Invoice, and Payment APIs.
Verify you are using the proper endpoint URL provided on each API page. Ensure you have the correct bearer token and Client ID in your header for the environment you are attempting to access.
For questions and help regarding your integration, please reach out to your sales representative directly or call 877.263.8772.
Each field is described in the Developer Guide to advise what value is expected from the user. If a required field is described that you are currently not collecting, please add that field to your process or discuss an alternative suitable value with your sales engineer.
Yes, the UPS Capital Transactional Cargo APIs are RESTful.
The APIs purpose is to allow customers to receive quotes and purchase insurance coverage for safe and timely package/cargo delivery. These APIs also allow for the user to file claims, receive a monthly invoice, and submit payment remittance.
Section 7.2 from the Developer's Guide Here
| Field Name | Validations |
|---|---|
| All Address Fields - Name | Alphanumeric; Only the following special characters are allowed: - + & () / , ~ ` # . : ; “ * ‘ |
| All Address Fields- City | Alphabetical |
| All Address Fields - Address 1, 2 | Alphanumeric; Only the following special characters are allowed: - + & () / , ~ ` # . : ; “ * ‘ |
| All Address Fields - State | Valid US State Code for US, CA, or PR Country Code |
| All Address Fields - Country | Alphabetical |
| ProductId | Numeric |
| Location | Alphanumeric |
| Shipper Principle | Alphanumeric; Only the following special characters are allowed: - + & () / , ~ ` # . : ; “ * ‘ |
| Payables Attention To | Alphanumeric; Only the following special characters are allowed: - + & () / , ~ ` # . : ; “ * ‘ |
| PartnerId | Alphanumeric |
| UpscCustomerId | Alphanumeric |
| TransactionId | Numeric |
| Status | Confirmed/Unconfirmed/Void |
| ShipperId | Alphanumeric |
| ShipperName | Alphanumeric; Only the following special characters are allowed: - + & () / , ~ ` # . : ; “ * ‘ |
| Carrier | Alphanumeric |
| ShipDate | Date/Validation |
| Bol | Numeric |
| InsuredValue | Decimal |
| CommodityCodeType | Alphanumeric |
| CommodityCode | Numeric |
| Oversize/usedGoods | Y/N |
| ModeOfTransport | Numeric |
| ConsigneeName | Alphanumeric; Only the following special characters are allowed: - + & () / , ~ ` # . : ; “ * ‘ |
| InsuranceAuthorization | Numeric |
| TrackingNumber | Numeric |
| Description | None |
| TransactionType | Numeric |
| ShipmentType | Numeric |
| Contact First Name | Alphanumeric; Only the following special characters are allowed: - + & () / , ~ ` # . : ; “ * ‘ |
| Contact Last Name | Alphanumeric; Only the following special characters are allowed: - + & () / , ~ ` # . : ; “ * ‘ |
| Secondary Contact Name | Alphanumeric; Only the following special characters are allowed: - + & () / , ~ ` # . : ; “ * ‘ |