UNPKG

terminal-africa

Version:

## Introduction The Terminal Shipping API (TShip) provides a single interface for integrating shipping carriers within your applications. The API allows anyone to programatically get shipping rates and arrange pickup and delivery.

github.com/danielozeh/node-terminal-africa

danielozeh/node-terminal-africa

58 lines (57 loc) • 2.18 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
export default class Rate { /** * Get Rates for Shipments - This allows you to fetch shipment rates on Terminal Africa * @param {string} queryParams * @param {string=} queryParams.currency * @param {string=} queryParams.delivery_address * @param {string=} queryParams.pickup_address * @param {string=} queryParams.parcel_id * @param {string=} queryParams.shipment_id * @param {boolean=} queryParams.cash_on_delivery * @param {string=} queryParams.carrier_id * @returns object * @method GET */ static getShipmentRates(queryParams: string): Promise<any>; /** * Get Quotes for Shipment - This allows you to fetch quick quotes on Terminal Africa * @param {Object[]} quotesData * @param {object} quotesData.pickup_address * @param {object} quotesData.delivery_address * @param {parcel} quotesData.parcel * @param {string=} quotesData.carrier_id * @param {string=} quotesData.currency * @param {string=} quotesData.cash_on_delivery * @returns object * @method POST */ static getQuotesForShipment(quotesData: object): Promise<any>; /** * Get Rates for Multi-Piece Shipment- This allows you to fetch rates for multi-piece shipments on Terminal Africa * @param {Object[]} rateData * @param {string=} rateData.currency * @param {string=} rateData.delivery_address * @param {array} rateData.parcels * @param {string=} rateData.pickup_address * @param {string=} rateData.shipment_id * @returns object * @method POST */ static getMultiPieceShipmentRates(rateData: object): Promise<any>; /** * Get Rates- This allows you to fetch generated rates on Terminal Africa * @param {string} queryParams * @param {string=} queryParams.page * @param {string=} queryParams.perPage * @returns object * @method GET */ static getRates(queryParams: any): Promise<any>; /** * Get Rate- This allows you to fetch a rate on Terminal Africa * @param {string} rateId * @returns object * @method GET */ static getRate(rateId: string): Promise<any>; }