The Share A Refund Additional Info API lets you manage custom metadata and system reference data. You can develop applications that integrate with Share A Refund to attach proprietary business data (such as internal cost codes or project IDs) to standard objects and retrieve static system lists for validation.

The following figure shows the relationship between your Share A Refund app, the Share A Refund API, and Additional Info services.

Additional Info API diagram svg

Figure 1. Share A Refund API relationship diagram.

Share A Refund App

Share A Refund’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.

Share A Refund 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 Share A Refund 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 Share A Refund Additional Info API?

Users can use the Share A Refund 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 Share A Refund Additional Info API:

  • Custom Fields
  • Enum Lists
  • Health Status
  • Metadata Tags
  • System Constants

Additional info

Learn more about developing with Share A Refund Additional Info API, including handling authentication, authorization, reference the Develop on Share A Refund API for your workspace. More

Learn more about how to launch and run a Share A Refund Additional Info API app, read the Developer Getting Started Guide. More