Overview
- The Optimum Parcel Merchant API lets you manage account-level details and preferences for individual shippers. You can develop applications that integrate with Optimum Parcel to configure merchant settings, update contact information, and align system behavior with specific business requirements.
- View Doc →
- The following figure shows the relationship between your Optimum Parcel app, the Optimum Parcel API, and Merchant services.
Optimum Parcel App
Optimum Parcel’s merchant services give users a central location to maintain profile data to ensure that communication, billing, and operational settings reflect the current state of the business.
Optimum Parcel API
The REST API that allows users to retrieve profile details, update addresses, and modify account configurations from within your app.
Profile Management
A system that stores essential identity information, such as company name, tax ID, and primary contact details.
Account Configuration
A mechanism that controls global settings and preferences that allows customization of how the platform handles data and services for the specific merchant.
What can users do with the Optimum Parcel Merchant API?
Users can use the Optimum Parcel Merchant API to perform common workflows, such as:
- Retrieve current merchant profile details
- Update business address and contact information
- Configure notification preferences
- Manage associated payment methods
- View account status and subscription tier
- Link multiple sub-accounts for consolidated reporting
Merchant properties available to create, modify, update and delete through the Optimum Parcel Merchant API:
- Account Settings
- Business Profiles
- Contact Information
- Preferences
- Subscriptions
Additional info
- Learn more about developing with Optimum Parcel Merchant API, including handling authentication, authorization, reference the Develop on Optimum Parcel API for your workspace.
- More →
- Learn more about how to launch and run a Optimum Parcel Merchant API app, read the Developer Getting Started Guide.
- More →
