Postage
Get user's current postage
UserTotalPostage Object
| Attributes | Definitions |
|---|---|
| currentPostage | User's current postage that is available for creating label. |
| allPostage | User's current balance |
| holdPostage | The pending postage for the unbilled shipment |
| frozenBalance | User's frozen balance for specific operations |
| importDeposit | Import and export deposit for packages |
| refundPending | The total amount of money generated by voided label waiting to be reviewed. |
| holdPsFee | Performance-based Guaranty. |
Get user's current postage Sample
GET : https://ezeeship.com/api/ezeeship-openapi/postage
Response :
{
"result": "OK",
"message": "",
"data": {
"currentPostage": 205.51,
"allPostage": 460.09,
"holdPostage": 214.48,
"frozenBalance": 12.02,
"importDeposit": 13.03,
"refundPending": 17.07,
"holdPsFee": 15.05
}
}
Get user's funding flow
Fund Flow request parameters
| Parameters | Definitions | optional | default |
|---|---|---|---|
| curPageNo | pagination number | false | 1 |
| pageSize | maxSize: 100 | false | 10 |
| beforeTime | starting time | true | |
| afterTime | ending time | true | |
| type | 1: billed, 2: add refunds | false | |
| chargeType | Array of charge type: 1.paypal 2.alipay 3.Bank Transfer 4.Credit Card 5.Admin Adjust 6.System Adjust | false |
FundFlow Response Object
| Attributes | Definitions |
|---|---|
| balance | User's balance. |
| chargeType | User's charge type |
| type | Funding type: 1. deduction 2. recharge |
| frozenBalance | User's frozen balance for specific operations |
| amount | billed amount or recharged amount. |
| description | description. |
| createTime | the date when funding event happened. |
| billHistoryList | list of billHistory Object See the BillHistory Object |
Get user's fund flow Sample
GET : https://ezeeship.com/api/ezeeship-openapi/postage/queryFundingHistory?beforeTime=2021-06-18+19:58:56&afterTime=2021-07-20+19:58:56&curPageNo=1&pageSize=2
Response :
{
"result": "OK",
"errorCode": null,
"message": "",
"zhMessage": null,
"errorType": null,
"data": {
"defaultPageNo": 1,
"pageSize": 2,
"pageNo": 1,
"totalCount": "47",
"totalPage": 24,
"datas": [
{
"billHistoryList": [
{
"id": 1584221,
"fundFlowId": 1303017,
"baseRate": null,
"fuelRate": null,
"weight": "0.25lb",
"dimension": "9x 7x 2 in",
"withdrewFlag": null,
"otherRateDetail": "{\"baseRate\":3.28,\"Signture\":0.0}",
"otherRate": null,
"deductionTime": "2021-06-28 14:48:05",
"orderNumber": null,
"orderUrl": null,
"trackingNumber": "9214490221582731810270",
"trackingUrl": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=9214490221582731810270",
"carrierId": null,
"carrierServiceId": null,
"billedTime": "2021-06-28 06:48:05",
"amount": 3.28,
"zone": null,
"orderId": "1759790",
"type": null,
"billedZone": null,
"billedDim": null,
"feesTransactionId": 1253206
},
{
"id": 1584221,
"fundFlowId": 1303017,
"baseRate": null,
"fuelRate": null,
"weight": "0.25lb",
"dimension": "9x 7x 2 in",
"withdrewFlag": null,
"otherRateDetail": "{\"baseRate\":3.28,\"Signture\":0.0}",
"otherRate": null,
"deductionTime": "2021-06-28 14:48:05",
"orderNumber": null,
"orderUrl": null,
"trackingNumber": "395633591141",
"trackingUrl": "https://www.fedex.com/apps/fedextrack/?action=track&cntry_code=us&trackingnumber=395633591141",
"carrierId": null,
"carrierServiceId": null,
"billedTime": "2021-06-28 06:48:05",
"amount": 3.28,
"zone": null,
"orderId": "1759790",
"type": null,
"billedZone": null,
"billedDim": null,
"feesTransactionId": 1253206
}
],
"id": 1303017,
"balance": 10791.41,
"chargeType": null,
"type": 1,
"amount": 3.28,
"description": "9214490221582731810270",
"createTime": "2021-06-28 14:48:05",
"billHistory": null
},
{
"billHistoryList": [
{
"id": 1584220,
"fundFlowId": 1303016,
"baseRate": null,
"fuelRate": null,
"weight": "0.25lb",
"dimension": "9x 7x 2 in",
"withdrewFlag": null,
"otherRateDetail": "{\"baseRate\":2.82,\"Signture\":0.0}",
"otherRate": null,
"deductionTime": "2021-06-28 14:31:39",
"orderNumber": null,
"orderUrl": null,
"trackingNumber": "9214490221582731810270",
"trackingUrl": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=9214490221582731810270",
"carrierId": null,
"carrierServiceId": null,
"billedTime": "2021-06-28 06:31:39",
"amount": 2.82,
"zone": null,
"orderId": "1759787",
"type": null,
"billedZone": null,
"billedDim": null,
"feesTransactionId": 1253205
}
],
"id": 1303016,
"balance": 10794.69,
"chargeType": null,
"type": 1,
"amount": 2.82,
"description": "9214490221582731810270",
"createTime": "2021-06-28 14:31:39",
"billHistory": null
}
],
"dataObject": null,
"pageUrl": null
}
}
Get user's transaction detail
TransactionDetail request parameters
| Parameters | Definitions | optional | default |
|---|---|---|---|
| curPageNo | pagination number | false | 1 |
| pageSize | maxSize: 100 | false | 10 |
| beforeTime | transaction's starting time | true | |
| afterTime | transaction's ending time | true | |
| billedTimeBefore | the starting time of of billed | false | |
| billedTimeAfter | the end time of billed | false | |
| serviceCode | Code for carrier services.See the ServiceCodes for all available values | false | |
| billStatus | 1.not billed 2.partBilled 3.fullBilled 4.cancel | false | |
| includeBond | including holding bond rate or not | false | false |
| includePsRate | including holding ps rate or note | false | false |
| searchItem | trackingNo or orderNo | false |
TransactionDetail Object
| Attributes | Definitions |
|---|---|
| orderNumber | the orderNumber of the label transaction |
| trackingNumber | the label's trackingNumber |
| carrierId | the id of carrier |
| carrierServiceId | the id of carrierService |
| createdTime | the date when label created |
| billedTime | the last time when billing the label |
| estimateRate | Carrier's estimated postage with your package you filled in. |
| estimatedRate2 | Carrier's estimated postage with your package actual information. |
| holdAmount | current hold amount for this shipment. |
| billedAmount | the shipping rate has been billed for this shipment. |
| totalBond | Import/Export Frozen Deposit. |
| psHoldRate | Performance-based Guarantee. |
| billStatus | 1.not billed 2.partBilled 3.fullBilled 4.cancel |
| billHistoryList | list of billHistory Object See the BillHistory Object |
Get user's current postage Sample
GET : https://ezeeship.com/api/ezeeship-openapi/postage/queryTransactionDetail?beforeTime=2021-07-18+19:58:56&afterTime=2021-07-20+19:58:56&curPageNo=1&pageSize=2
{
"result": "OK",
"errorCode": null,
"message": "",
"zhMessage": null,
"errorType": null,
"data": {
"defaultPageNo": 1,
"pageSize": 2,
"pageNo": 1,
"totalCount": "47",
"totalPage": 24,
"datas": [
{
"billHistoryList": [
{
"id": 1584221,
"fundFlowId": 1303017,
"baseRate": null,
"fuelRate": null,
"weight": "0.25lb",
"dimension": "9x 7x 2 in",
"withdrewFlag": null,
"otherRateDetail": "{\"baseRate\":3.28,\"Signture\":0.0}",
"otherRate": null,
"deductionTime": "2021-06-28 14:48:05",
"orderNumber": null,
"orderUrl": null,
"trackingNumber": "9214490221582731810270",
"trackingUrl": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=9214490221582731810270",
"carrierId": null,
"carrierServiceId": null,
"billedTime": "2021-06-28 06:48:05",
"amount": 3.28,
"zone": null,
"orderId": "1759790",
"type": null,
"billedZone": null,
"billedDim": null,
"feesTransactionId": 1253206
},
{
"id": 1584221,
"fundFlowId": 1303017,
"baseRate": null,
"fuelRate": null,
"weight": "0.25lb",
"dimension": "9x 7x 2 in",
"withdrewFlag": null,
"otherRateDetail": "{\"baseRate\":3.28,\"Signture\":0.0}",
"otherRate": null,
"deductionTime": "2021-06-28 14:48:05",
"orderNumber": null,
"orderUrl": null,
"trackingNumber": "395633591141",
"trackingUrl": "https://www.fedex.com/apps/fedextrack/?action=track&cntry_code=us&trackingnumber=395633591141",
"carrierId": null,
"carrierServiceId": null,
"billedTime": "2021-06-28 06:48:05",
"amount": 3.28,
"zone": null,
"orderId": "1759790",
"type": null,
"billedZone": null,
"billedDim": null,
"feesTransactionId": 1253206
}
],
"id": 1253206,
"orderNumber": "Order-2021-06-28-015",
"orderId": "1759790",
"trackingNumber": [
"395633591141"
],
"trackingUrl": [
"https://www.fedex.com/apps/fedextrack/?action=track&cntry_code=us&trackingnumber=395633591141"
],
"carrierServiceId": 1,
"carrierId": 1,
"billStatus": 3,
"estimatedRate": 3.28,
"holdAmount": null,
"billedAmount": 3.28,
"createdTime": "2021-06-28 06:48:05",
"estimatedRateDetail": "{\"Residential\":2.00,\"DeliveryArea\":5.40,\"Fuel\":0.89,\"baseRate\":8.05}",
"billedTime": "2021-06-28 14:48:05",
"originEstimateRate": 3.28,
"estimatedRate2": null,
"totalBound": null,
"psHoldRate": 0
},
{
"billHistoryList": [
{
"id": 1584221,
"fundFlowId": 1303017,
"baseRate": null,
"fuelRate": null,
"weight": "0.25lb",
"dimension": "9x 7x 2 in",
"withdrewFlag": null,
"otherRateDetail": "{\"baseRate\":3.28,\"Signture\":0.0}",
"otherRate": null,
"deductionTime": "2021-06-28 14:48:05",
"orderNumber": null,
"orderUrl": null,
"trackingNumber": "9214490221582731810270",
"trackingUrl": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=9214490221582731810270",
"carrierId": null,
"carrierServiceId": null,
"billedTime": "2021-06-28 06:48:05",
"amount": 3.28,
"zone": null,
"orderId": "1759790",
"type": null,
"billedZone": null,
"billedDim": null,
"feesTransactionId": 1253206
},
{
"id": 1584221,
"fundFlowId": 1303017,
"baseRate": null,
"fuelRate": null,
"weight": "0.25lb",
"dimension": "9x 7x 2 in",
"withdrewFlag": null,
"otherRateDetail": "{\"baseRate\":3.28,\"Signture\":0.0}",
"otherRate": null,
"deductionTime": "2021-06-28 14:48:05",
"orderNumber": null,
"orderUrl": null,
"trackingNumber": "395633591141",
"trackingUrl": "https://www.fedex.com/apps/fedextrack/?action=track&cntry_code=us&trackingnumber=395633591141",
"carrierId": null,
"carrierServiceId": null,
"billedTime": "2021-06-28 06:48:05",
"amount": 3.28,
"zone": null,
"orderId": "1759790",
"type": null,
"billedZone": null,
"billedDim": null,
"feesTransactionId": 1253206
}
],
"id": 1253206,
"orderNumber": "Order-2021-06-28-015",
"orderId": "1759790",
"trackingNumber": [
"9214490221582731810270"
],
"trackingUrl": [
"https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=9214490221582731810270"
],
"carrierServiceId": 1,
"carrierId": 1,
"billStatus": 3,
"estimatedRate": 3.28,
"holdAmount": null,
"billedAmount": 3.28,
"createdTime": "2021-06-28 06:48:05",
"estimatedRateDetail": "{\"baseRate\":3.28,\"Signture\":0.0}",
"billedTime": "2021-06-28 14:48:05",
"originEstimateRate": 3.28,
"estimatedRate2": null,
"totalBound": null,
"psHoldRate": 0
}
],
"dataObject": null,
"pageUrl": null
}
}
BillHistory Object
| Attributes | Definitions |
|---|---|
| billedTime | the date when billed |
| deductionTime | the date when deducted |
| amount | billed amount |
| trackingNumber | tracking number |
| weight | weight(lb) |
| dimension | dimension |