Third-Party Carrier Integration Requirement
With your testing accounts provided, Shipber provides free integration service with the carriers, including UPS, USPS, Pitney Bowes, etc. For the third-party carriers, API verification and an integration fee are required. In order for us to integrate with third-party carriers successfully, please ensure your API document meets the below integration requirement. We are unable to provide integration without an approved API verification.
Requirements
Required Information
- Testing Environment Accounts
- Production Environment Accounts
- API Documentation
💡 Please provide all supported carrier services in the testing environment or accounts |
Shipping API Requirements
API Function | Mandatory | Description |
---|---|---|
Shipping Service | Get a list of supported services; If there is no interface, provide the service list supported by the system | |
Shipping Rate | ✔ | Allow users to get the shipping rate by filling in the ship-from zip code, package dimension, and weight |
Create Shipment | ✔ | Synchronized the return shipment docs and supports Idempotence after creating shipments, to avoid creating duplicate labels |
Get Shipment | If a real-time shipment response is returned after created label, retrieving the shipment is required | |
Void Shipment | ✔ | Allow users to cancel an unused shipping label, idempotence is required |
Address Validation | Ensures the customers’ address is valid for shipping. Checks a customer's address and provides suggested alternatives if the address is not valid, in order to ensure the address validly | |
Tracking | Track packages with the order number you provide once shipped.【This API is mandatory for non-FedEx and non-UPS generated tracking numbers】 | |
Ship-From List | If the ship-from address is restricted, API on retrieving a ship-from list is recommended |
Other Requirements
Carrier Services
- Self-defining carrier services are not supported
For example
Combining FedEx Ground Delivery and FedEx Home Delivery into one carrier service
Please send the above required documents to support@shipber.com for API verification Process. If you have any questions, please contact us at "Submit a Request" |
Comments
0 comments
Please sign in to leave a comment.