Developers

Use Postman to call the Share A Refund API

Postman is an app available to developers as a tool to share, test, document & monitor APIs. Get Postman. Making….

Just getting started?

Find instructions specific to obtaining authentication credentials to the Share A Refund API within the developer section of this help center.

Postman is an app available to developers as a tool to share, test, document & monitor APIs. Get Postman.

Making the connection

Get started with using Postman to send and receive through the Share A Refund API with the following steps:

1. Launch Postman

Both the native application and the browser extension have been tested and work for the example below.

2. Specify the endpoint

Direct customer user type
				
					 [ship_base_url]/{api_path}
Reseller customer user type
				
					[ship_base_url]/{api_path}
Note: Explore methods within the API Docs

3. Input the required headers

A minimum of two Headers are required to make a request of any type. 
				
					Header: Content Type
Token: Content-Type
Value: application/json
Header: x-api-key
Token: x-api-key
Value: YOUR-API-KEY
Enter API key
Your API Token

API tokens are unique and available upon request. More information on obtaining an API Token is available within the Developer area of the Share A Refund help center.

The figure showcases the location within Postman to enter the required Header values defined in this section.

4. Add body for an example request

For post request types, required parameters are made in json format. 
				
					{
“tracking_number”: “775635651223”
}
Tracking number for testing

Access to shipments and related tracking numbers are specific to your account and the privileges defined by user type. Ensure that you’re using a valid tracking number that’s available within your Share A Refund account.

The figure showcases the raw body input and associated parameters required.

5. Send request

Tap the send button to submit the post request provided in this example.

6. Read the response

Exception handling

Invalid access token
Ensure that the access token matches the values defined for your account, and that the requested endpoint is indeed valid.

403 forbidden
Ensure the URL used in making the request, is valid for the your user type.

Missing parameter required
Ensure that formatting of the body input is valid json and matches the parameters defined for the method requested.

Put X-API-Key in header In C# and various languages, the token must be placed into the header. Also, try the…

New user tip

API credentials can be requested from inside your account and through contacting customer service.

Put X-API-Key in header

In C# and various languages, the key must be placed into the header. Also, try the following statement when making a test request.

				
					request.Headers.Add(“x-api-key”, “YOUR_API_KEY”);
Note: Rather than adding x-api-key in the post data.

Test in Postman

Ensure that a successful connection is made is Postman.