# ShipSaving New Open API

Version: v1.0.5
License: Apache 2.0

## Servers

Sandbox server
```
https://x-api.shipsaving.us
```

Production server
```
https://x-api.shipsaving.com
```

## Security

### BearerAuth

Type: http
Scheme: bearer
Bearer Format: JWT

### basicAuth

Type: http
Scheme: basic

## Download OpenAPI description

[ShipSaving New Open API](https://docs.shipsaving.com/_spec/x-api/x-api.yaml)

## Authentication

### Get Access Token

 - [POST /oauth2/token](https://docs.shipsaving.com/x-api/x-api/authentication/paths/~1oauth2~1token/post.md): Issue a short-lived access token using the OAuth 2.1  grant.

Provide:
- 
- 


## Shipment

### Batch Quick Rate

 - [POST /api/shipment/batch/quick_rate](https://docs.shipsaving.com/x-api/x-api/shipment/batchquickrate.md): This endpoint allows you to quickly retrieve shipment rate quotes by providing the , ,  and the .
Currently, only the USPS Ground Advantage service level is supported. 



### Get Rates

 - [POST /api/shipment/get_rates](https://docs.shipsaving.com/x-api/x-api/shipment/getrates.md): Retrieves shipping rates from all active carriers and service levels under your account, optionally filtered by specified carriers and service levels, and returns results sorted by fastest, cheapest, and other criteria along with any applicable error information.


### Buy Label

 - [POST /api/shipment/create_and_pay](https://docs.shipsaving.com/x-api/x-api/shipment/createandpay.md): Creates and pays for a shipment label using the  obtained from a prior  call. 
This endpoint also allows purchasing shipment insurance in the same request (insurance cannot be purchased separately). 

To prevent duplicate purchases caused by network fluctuations or retries, the API checks ether a shipment already exists under the specified . 
- If a related shipment is found, the existing shipment information will be returned, and the  field in the response will be set to .  
- If no shipment exists, a new shipment will be created as normal, and the  
  field will be .


### Directly Buy Label

 - [POST /api/shipment/direct_buy](https://docs.shipsaving.com/x-api/x-api/shipment/sheindirectbuy.md): Creates and purchases a shipment label in a single step without calling  separately. 

To prevent duplicate purchases caused by network fluctuations or retries, the API checks ether a shipment already exists under the specified . 
- If a related shipment is found, the existing shipment information will be returned, and the  field in the response will be set to .  
- If no shipment exists, a new shipment will be created as normal, and the  
  field will be .


### Void Label

 - [POST /api/shipment/void_label](https://docs.shipsaving.com/x-api/x-api/shipment/voidlabel.md): This endpoint allows voiding label by providing 
 or . Only one parameter is required to uniquely
identify a shipment.


### Query Insurance Rate

 - [GET /api/shipment/insurance/rate](https://docs.shipsaving.com/x-api/x-api/shipment/paths/~1api~1shipment~1insurance~1rate/get.md)

### Query Shipment Tracking Status

 - [GET /api/shipment/tracking](https://docs.shipsaving.com/x-api/x-api/shipment/getshipmenttracking.md): Indicates the current location or state of a package within the supply chain (e.g., in_transit, out for delivery). 
Use the tracking status object to monitor shipment progress. 
In test mode, this API will return fixed mock data to facilitate testing and integration validation.


### Query Shipment Tracking Status by 


 - [GET /api/shipment/tracking_by_platform_uk_id](https://docs.shipsaving.com/x-api/x-api/shipment/getshipmenttrackingbyplatformukid.md): Indicates the current location or state of a package within the supply chain (e.g., in_transit, out for delivery). 
Use the tracking status object to monitor shipment progress. 
In test mode, this API will return fixed mock data to facilitate testing and integration validation.


## Other

### Address Validation

 - [POST /api/address/validate](https://docs.shipsaving.com/x-api/x-api/other/validateaddress.md): The Address Validation API checks the validity of U.S. domestic addresses 
and returns standardized address components in accordance with USPS® 
addressing standards. 
This helps improve delivery accuracy, reduce undeliverable mail, and 
support consistent pricing for shipping and logistics.

#### Validation Rules
1.   
   If , the validation process is skipped (the API is designed
   for U.S. domestic addresses only).  

2.   
   If , the  array is returned and should be used 
   directly as the error message(s).  

3.   
   If , use the returned address fields 
   (, , , , , , ) as 
   the standardized address.  
   - The  array provides machine-readable codes that indicate 
     how to improve the original input for a better match.  

4.   
   The field  indicates whether the returned address differs 
   from the original input:  
   - If , .  
   - If  (e.g., casing, ZIP+4 adjustments, or street corrections), 
     then .