Overview
The purpose of the following article to provide guidance to Developers to make authorized request for authenticated users to the Share A Refund API.
Getting started
- Go to the
- Share A Refund API docs.
- Navigate to the Getting Started section to download the Postman collection provided to Developers
-
Use the Share A Refund API Sandbox from within the API docs.
Tip: Obtain your credentials from the Edit User page inside your Admin Dashboard.
-
Use Postman to make an authorized connection to the Share A Refund API.
- Tip: Make request from Postman.
- More →
-
Build your application and make an authorized connection to the Share A Refund API.
- Tip: Make requests outside of Postman.
- More →
- Explore the methods under each category to craft requests.
What can users do with the Share A Refund API?
- Shortlinks API overview: Create, update, list shortlinks by code, tag, visits and health status checks.
- Agreement API overview: Create, delete, update and view agreements that use agreements for billing, compliance and modeling. You can develop applications that integration with Share A Refund and create extended functionality in your application using the Share A Refund API.
- Auth API overview: View logs and status of all authentication requests for users within your Share A Refund Instance.
- Carrier Agreement Optimization API overview: Create, modify, text and update Carrier Agreement Optimization projects within your Share A Refund instance.
- Carrier Invoices API overview: Request download of multiple file actions for carrier statements for a specific shipping account within your Share A Refund instance and for customers.
- Currency API overview: Get current and historical currency rates for a specific, previous date, and explore currently supported currency types.
- Email API overview: Validate email addresses for merchant users and customer users.
- Fuel Surcharge Rate API overview: Find Fuel Surcharge rates for a carrier for a specific date range, and import fuel surcharges.
- GL Coding API overview: Create, delete export, modify, update and export gl coding templates for a given customer user.
- Graph API overview: Show billings by product or service within JSON data, and see frequency of customer or merchant billings, as well as see activity by shipping account, staff user and beyond.
- Invoice API overview: Upload invoice files by type for a given customer.
- Job API overview: View the status of existing jobs and cancel jobs already running within your Share A Refund instance.
- Merchant API overview: Add, delete, detail, list any merchant within your Share A Refund instance, and get the shipment price for any given shipment.
- Prospectus API overview: Add new Prospectus and get the state of any existing Propsectus.
- Report API overview: Enable or disable report schedules or scheduled reports.
- SFTP API overview: Validate sftp credentials for a given merchant or customer user.
- Shipment API overview: Download bath template csv files, get the cost components for any given shipment, as well as get the zone, phone activity specific to a shipment, the price, as well as file a claim, dispute or void a shipment.
- Statement API overview: Fetch carrier invoices, reimport shipping account statements or save a statement with rolling averages.
- Stripe API overview: Validate Stripe API credentials for a given merchant.
- User API overview: Request a callback action and get confirmation of requests related to a user, along with user statuses.
- Additional Info API overview: Request additional features and methods through the Share A Refund API.
Additional info
- Learn more about developing with Share A Refund Agreements 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 Agreements API app, read the Developer Getting Started Guide.
- More →
