Overview
- The Optimum Parcel Additional Info API lets you manage custom metadata and system reference data. You can develop applications that integrate with Optimum Parcel to attach proprietary business data (such as internal cost codes or project IDs) to standard objects and retrieve static system lists for validation.
- View Doc →
- The following figure shows the relationship between your Optimum Parcel app, the Optimum Parcel API, and Additional Info services.
Optimum Parcel App
Optimum Parcel’s additional info services give users the flexibility to extend the platform’s standard data models to add custom fields and tags that are relevant to their specific organizational workflows.
Optimum Parcel API
The REST API that allows users to create custom key-value pairs, manage metadata schemas, and fetch system values from within your app.
Custom Metadata
A system that allows the attachment of arbitrary data fields to shipments, invoices, and users, ensuring that internal business context travels with Optimum Parcel records.
Reference Data
A mechanism that provides access to static system lists, such as supported country codes, carrier service enums, and time zone definitions, ensuring data integrity across integrations.
What can users do with the Optimum Parcel Additional Info API?
Users can use the Optimum Parcel Additional Info API to perform common workflows, such as:
- Attach an internal Project ID to a specific shipment
- Retrieve a list of supported carrier service codes
- Validate a country code against the ISO standard list
- Add custom notes or tags to an invoice record
- Fetch the current API server time and health status
- Define custom field labels for the dashboard UI
Additional Info properties available to create, view, and manage through the Optimum Parcel Additional Info API:
- Custom Fields
- Enum Lists
- Health Status
- Metadata Tags
- System Constants
Additional info
- Learn more about developing with Optimum Parcel Additional Info 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 Additional Info API app, read the Developer Getting Started Guide.
- More →
