Shipping (Separate Service)
POST /openapi/{version}/shipping/available-carrier-connections/
Retrieves carrier connections that are eligible to ship an order, based on order details, pickup location, and shipment type.
Request
- Base URLhttps://base_url
- Authnone declared
Path parameters
versionstring required
Request body
height_cmnumber double required
width_cmnumber double required
length_cmnumber double required
weight_grnumber double required
is_codboolean required
package_pricenumber double required
package_currency'ALL' | 'AFN' | 'ARS' | 'AWG' | 'AUD' | 'AZN' | 'BSD' | 'BBD' | 'BYN' | 'BZD' | 'BMD' | 'BOB' | 'BAM' | 'BWP' | 'BGN' | 'BRL' | 'BND' | 'KHR' | 'CAD' | 'KYD' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'HRK' | 'CUP' | 'CZK' | 'DKK' | 'DOP' | 'XCD' | 'EGP' | 'SVC' | 'EUR' | 'FKP' | 'FJD' | 'GHS' | 'GIP' | 'GTQ' | 'GGP' | 'GYD' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'IRR' | 'IMP' | 'ILS' | 'JMD' | 'JPY' | 'JEP' | 'KZT' | 'KPW' | 'KRW' | 'KGS' | 'LAK' | 'LBP' | 'LRD' | 'MKD' | 'MYR' | 'MUR' | 'MXN' | 'MNT' | 'MZN' | 'NAD' | 'NPR' | 'ANG' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PKR' | 'PAB' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'SHP' | 'SAR' | 'RSD' | 'SCR' | 'SGD' | 'SBD' | 'SOS' | 'ZAR' | 'LKR' | 'SEK' | 'CHF' | 'SRD' | 'SYP' | 'TWD' | 'THB' | 'TTD' | 'TRY' | 'TVD' | 'UAH' | 'GBP' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'YER' | 'ZWD' | 'DZD' | 'AOA' | 'AMD' | 'AZM' | 'BHD' | 'BDT' | 'BYR' | 'XOF' | 'BTN' | 'BOV' | 'BIF' | 'XAF' | 'CVE' | 'CLF' | 'COU' | 'KMF' | 'CDF' | 'CYP' | 'DJF' | 'ERN' | 'EEK' | 'ETB' | 'XPF' | 'GMD' | 'GEL' | 'GHC' | 'GNF' | 'GWP' | 'HTG' | 'IQD' | 'JOD' | 'KES' | 'KWD' | 'LVL' | 'LSL' | 'LYD' | 'LTL' | 'MOP' | 'MGA' | 'MGF' | 'MWK' | 'MVR' | 'MTL' | 'MRO' | 'MXV' | 'MDL' | 'MAD' | 'MZM' | 'MMK' | 'PGK' | 'ROL' | 'RUR' | 'RWF' | 'WST' | 'STD' | 'CSD' | 'SLL' | 'SKK' | 'SIT' | 'SDD' | 'SZL' | 'TJS' | 'TZS' | 'TOP' | 'TND' | 'TRL' | 'TMM' | 'UGX' | 'AED' | 'USS' | 'USN' | 'VUV' | 'VEB' | 'ZMK' required
- ALL - Albania Lek - Lek
- AFN - Afghanistan Afghani - ؋
- ARS - Argentina Peso - $
- AWG - Aruba Guilder - ƒ
- AUD - Australia Dollar - A$
- AZN - Azerbaijan Manat - ₼
- BSD - Bahamas Dollar - $
- BBD - Barbados Dollar - $
- BYN - Belarus Ruble - Br
- BZD - Belize Dollar - BZ$
- BMD - Bermuda Dollar - $
- BOB - Bolivia Bolíviano - $b
- BAM - Bosnia and Herzegovina Convertible Mark - KM
- BWP - Botswana Pula - P
- BGN - Bulgaria Lev - лв
- BRL - Brazil Real - R$
- BND - Brunei Darussalam Dollar - $
- KHR - Cambodia Riel - ៛
- CAD - Canada Dollar - $
- KYD - Cayman Islands Dollar - $
- CLP - Chile Peso - $
- CNY - China Yuan Renminbi - ¥
- COP - Colombia Peso - $
- CRC - Costa Rica Colon - ₡
- HRK - Croatia Kuna - kn
- CUP - Cuba Peso - ₱
- CZK - Czech Republic Koruna - Kč
- DKK - Denmark Krone - kr
- DOP - Dominican Republic Peso - RD$
- XCD - East Caribbean Dollar - $
- EGP - Egypt Pound - £
- SVC - El Salvador Colon - $
- EUR - Euro Member Countries - €
- FKP - Falkland Islands (Malvinas) Pound - £
- FJD - Fiji Dollar - $
- GHS - Ghana Cedi - ¢
- GIP - Gibraltar Pound - £
- GTQ - Guatemala Quetzal - Q
- GGP - Guernsey Pound - £
- GYD - Guyana Dollar - $
- HNL - Honduras Lempira - L
- HKD - Hong Kong Dollar - $
- HUF - Hungary Forint - Ft
- ISK - Iceland Krona - kr
- INR - India Rupee - INR
- IDR - Indonesia Rupiah - Rp
- IRR - Iran Rial - ﷼
- IMP - Isle of Man Pound - £
- ILS - Israel Shekel - ₪
- JMD - Jamaica Dollar - J$
- JPY - Japan Yen - ¥
- JEP - Jersey Pound - £
- KZT - Kazakhstan Tenge - лв
- KPW - Korea (North) Won - ₩
- KRW - Korea (South) Won - ₩
- KGS - Kyrgyzstan Som - лв
- LAK - Laos Kip - ₭
- LBP - Lebanon Pound - £
- LRD - Liberia Dollar - $
- MKD - Macedonia Denar - ден
- MYR - Malaysia Ringgit - RM
- MUR - Mauritius Rupee - ₨
- MXN - Mexico Peso - $
- MNT - Mongolia Tughrik - ₮
- MZN - Mozambique Metical - MT
- NAD - Namibia Dollar - $
- NPR - Nepal Rupee - ₨
- ANG - Netherlands Antilles Guilder - ƒ
- NZD - New Zealand Dollar - NZ$
- NIO - Nicaragua Cordoba - C$
- NGN - Nigeria Naira - ₦
- NOK - Norway Krone - kr
- OMR - Oman Rial - ﷼
- PKR - Pakistan Rupee - ₨
- PAB - Panama Balboa - B/.
- PYG - Paraguay Guarani - Gs
- PEN - Peru Sol - S/.
- PHP - Philippines Peso - ₱
- PLN - Poland Zloty - zł
- QAR - Qatar Riyal - ﷼
- RON - Romania Leu - lei
- RUB - Russia Ruble - ₽
- SHP - Saint Helena Pound - £
- SAR - Saudi Arabia Riyal - ﷼
- RSD - Serbia Dinar - Дин.
- SCR - Seychelles Rupee - ₨
- SGD - Singapore Dollar - $
- SBD - Solomon Islands Dollar - $
- SOS - Somalia Shilling - S
- ZAR - South Africa Rand - R
- LKR - Sri Lanka Rupee - ₨
- SEK - Sweden Krona - kr
- CHF - Switzerland Franc - CHF
- SRD - Suriname Dollar - $
- SYP - Syria Pound - £
- TWD - Taiwan New Dollar - NT$
- THB - Thailand Baht - ฿
- TTD - Trinidad and Tobago Dollar - TT$
- TRY - Turkey Lira - TRY
- TVD - Tuvalu Dollar - $
- UAH - Ukraine Hryvnia - ₴
- GBP - United Kingdom Pound - £
- USD - US Dollar - $
- UYU - Uruguay Peso - $U
- UZS - Uzbekistan Som - лв
- VEF - Venezuela Bolívar - Bs
- VND - Viet Nam Dong - ₫
- YER - Yemen Rial - ﷼
- ZWD - Zimbabwe Dollar - Z$
- DZD - Algerian Dinar - DZD
- AOA - Kwanza - AOA
- AMD - Armenian Dram - AMD
- AZM - Azerbaijanian Manat - AZM
- BHD - Bahraini Dinar - BHD
- BDT - Taka - BDT
- BYR - Belarussian Ruble - BYR
- XOF - CFA Franc BCEAO - XOF
- BTN - Ngultrum - BTN
- BOV - Mvdol - BOV
- BIF - Burundi Franc - BIF
- XAF - CFA Franc BEAC - XAF
- CVE - Cape Verde Escudo - CVE
- CLF - Unidades de fomento - CLF
- COU - Unidad de Valor Real - COU
- KMF - Comoro Franc - KMF
- CDF - Franc Congolais - CDF
- CYP - Cyprus Pound - CYP
- DJF - Djibouti Franc - DJF
- ERN - Nakfa - ERN
- EEK - Kroon - EEK
- ETB - Ethiopian Birr - ETB
- XPF - CFP Franc - XPF
- GMD - Dalasi - GMD
- GEL - Lari - GEL
- GHC - Cedi - GHC
- GNF - Guinea Franc - GNF
- GWP - Guinea-Bissau Peso - GWP
- HTG - Gourde - HTG
- IQD - Iraqi Dinar - IQD
- JOD - Jordanian Dinar - JOD
- KES - Kenyan Shilling - KES
- KWD - Kuwaiti Dinar - KWD
- LVL - Latvian Lats - LVL
- LSL - Loti - LSL
- LYD - Lybian Dinar - LYD
- LTL - Lithuanian Litas - LTL
- MOP - Pataca - MOP
- MGA - Ariary - MGA
- MGF - Malagasy Franc - MGF
- MWK - Kwacha - MWK
- MVR - Rufiyaa - MVR
- MTL - Maltese Lira - MTL
- MRO - Ouguiya - MRO
- MXV - Mexican Unidad de Inversion (UDI) - MXV
- MDL - Moldovan Leu - MDL
- MAD - Moroccan Dirham - MAD
- MZM - Metical - MZM
- MMK - Kyat - MMK
- PGK - Kina - PGK
- ROL - Leu - ROL
- RUR - Russian Ruble - RUR
- RWF - Rwanda Franc - RWF
- WST - Tala - WST
- STD - Dobra - STD
- CSD - Serbian Dinar - CSD
- SLL - Leone - SLL
- SKK - Slovak Koruna - SKK
- SIT - Tolar - SIT
- SDD - Sudanese Dinar - SDD
- SZL - Lilangeni - SZL
- TJS - Somoni - TJS
- TZS - Tanzanian Shilling - TZS
- TOP - Pa�anga - TOP
- TND - Tunisian Dinar - TND
- TRL - Turkish Lira - TRL
- TMM - Manat - TMM
- UGX - Uganda Shilling - UGX
- AED - UAE Dirham - AED
- USS - US Dollar (Same day) - USS
- USN - US Dollar (Next day) - USN
- VUV - Vatu - VUV
- VEB - Bolivar - VEB
- ZMK - Kwacha - ZMK
order_type'FWD' | 'RTN' required
- FWD - FWD
- RTN - RTN
pickup_location_idinteger required
shipment_type'Standard' | 'Express' | 'SameDay' | 'NextDay' | 'Scheduled' | 'ReturnDropoff' | 'ReturnStandard' | 'ReturnExpress' required
- Standard - Standard
- Express - Express
- SameDay - SameDay
- NextDay - NextDay
- Scheduled - Scheduled
- ReturnDropoff - ReturnDropoff
- ReturnStandard - ReturnStandard
- ReturnExpress - ReturnExpress
Response
Successfully retrieved the available carrier connections
successboolean
messagestring required
Changes
No recorded changes to this operation across all 1 revision of this API.