Version 3, last updated on 2020-10-19
Please note:
It is your responsibility to properly set up all translation features, perform testing, and request support from Shipedge in a timely manner. It is your responsibility to test and verify the integration between ShipEdge and any 3rd party selling channel. We strongly recommend frequent testing of any integration, especially when changes occur on your selling channel (e.g. SKU renaming, shipping method variations, permissions, and credentials). ShipEdge is not responsible for translation issues, omitted orders, or any other issues related to communication with any 3rd party selling channel. Support for channel automation requires at least 24 hours for investigation before any action can be taken (hourly development charges may apply). The warehouse is not responsible for any omission, duplication or error in your orders coming through this system, and you agree not to get the warehouse involved in integration issues, nor will they make any exception or procedure changes due to the use of this feature.
Base
http://<integration>.shipedge.com/API/Rest/v2/Rates <integration>
This will be found in your Shipedge account. Preferences > API Integration > Web Services Production
Ping
Ping to check the system status.
POST /ping
Parameters
Parameter | Type | Description |
username | varchar | Admin username |
account_id (*) | int | Your account ID |
key (*) | varchar | Your API Key |
warehouse (*) | varchar | This will be found in your ShipEdge account. Preferences > API Integration > Warehouse. |
Example request
{
"key": "123abc",
"warehouse": "whx",
"account_id": 1
}
Example response
{
"status": "successful",
"result": "pong!"
}
Get rates
Gets estimated shipping rates.
POST /get_rates
Parameters
Paremeter | Type | Description |
account_id (*) | int | Your account ID |
key (*) | varchar | Your API Key |
warehouse (*) | varchar | This will be found in your ShipEdge account. Preferences > API Integration > Warehouse. |
rate_information (*) | * | |
rate_information.weight (*) | float | Weight information (pounds) |
rate_information.length (*) | int | Length information (in) |
rate_information.width (*) | int | Width information (in) |
rate_information.height (*) | int | Height information (in) |
rate_information.postal_code (*) | varchar | Postal code (zip) |
rate_information.state (*) | varchar | State |
rate_information.country (*) | varchar | Country |
rate_information.street | | |
rate_information.city | | |
rate_information.order_number | | |
rate_information.source | | |
rate_information.shipping_services | * | |
rate_information.shipping_services.insurance_value | float | |
rate_information.shipping_services.certified_mail | boolean | |
rate_information.shipping_services.cod | float | |
rate_information.shipping_services.delivery_confirmation | boolean | |
rate_information.shipping_services.express_sunday_holiday | boolean | |
rate_information.shipping_services.registered_mail | boolean | |
rate_information.shipping_services.signature_confirmation | boolean | |
rate_information.shipping_services.adult_signature_confirmation | boolean | |
rate_information.shipping_services.fragile | boolean | |
rate_information.shipping_services.hazardous_materials | boolean | |
rate_information.shipping_services.perishable | boolean | |
rate_information.shipping_services.saturday_delivery | boolean | |
rate_information.shipping_services.residential | boolean | |
Example request
{
"key": "123abc",
"warehouse": "whx",
"account_id": 1,
"rate_information": {
"weight": 1,
"length": 2,
"width": 3,
"height": 4,
"postal_code": "27227",
"state": "NC",
"country": "US"
}
}
Example response
{
"status": "successful",
"rates": [{
"carrier": "UPS",
"shipping-method": "EUPSNDAM",
"description": null,
"price": 35.289,
"transit-days": "1",
"delivery-date": "2020-10-21T09:00:00Z"
}, {
"carrier": "UPS",
"shipping-method": "EUPS3DPM",
"description": null,
"price": 11.7315,
"transit-days": "3",
"delivery-date": "2020-10-23T09:00:00Z"
}, {
"carrier": "UPS",
"shipping-method": "EUPSGRND",
"description": null,
"price": 11.259,
"transit-days": "",
"delivery-date": ""
}, {
"carrier": "UPS",
"shipping-method": "EUPS2DPM",
"description": null,
"price": 14.2155,
"transit-days": "2",
"delivery-date": "2020-10-22T09:00:00Z"
}]
}