EFC Open API Overview
This document provides an overview of the APIs offered by EFC Open API, covering the two interfaces available to our customers: GraphQL and REST.
API Matrix
1. Air Import
| Function |
GraphQL |
REST API |
| Query master |
aimMasterByMawbNo / aimMasterById / aimMasters |
— |
| Create master |
createAimMaster / createAimMasterWithDetails |
POST /api/aim / POST /api/aim/with-details |
| Delete master |
deleteAimMaster |
— |
| Query house |
aihHouseByHouseNo / aihHouseById / aihHouses |
— |
| Create house |
createAihHouse |
POST /api/aih |
| Delete house |
deleteAihHouse |
— |
| Charge / cost |
createAimMasterChargeCosts / createAihHouseChargeCosts |
POST /api/charge-cost/air-import |
2. Air Export
| Function |
GraphQL |
REST API |
| Query master |
aemMasterByMawbNo / aemMasterById / aemMasters |
— |
| Create master |
createAemMaster / createAemMasterWithDetails |
— |
| Delete master |
deleteAemMaster |
— |
| Query house |
aehHouseByHouseNo / aehHouseById / aehHouses |
— |
| Create house |
createAehHouse |
— |
| Delete house |
deleteAehHouse |
— |
| Charge / cost |
createAemMasterChargeCosts / createAehHouseChargeCosts |
POST /api/charge-cost/air-export |
3. Ocean Import
| Function |
GraphQL |
REST API |
| Query master |
oimMasterByMasterBlNo / oimMasterById / oimMasters |
— |
| Create master |
createOimMaster / createOimMasterWithDetails |
POST /api/oim / POST /api/oim/with-details |
| Delete master |
deleteOimMaster |
— |
| Query container |
oimContainerByContainerNo |
— |
| Create container |
createOimContainer |
POST /api/oim/container |
| Query house |
oihHouseByHouseNo / oihHouseById / oihHouses |
— |
| Create house |
createOihHouse |
POST /api/oih / POST /api/oih/with-master |
| Delete house |
deleteOihHouse |
— |
| Charge / cost |
createOimMasterChargeCosts / createOihHouseChargeCosts |
POST /api/charge-cost/ocean-import |
4. Ocean Export
| Function |
GraphQL |
REST API |
| Query master |
oemMasterByMasterBlNo / oemMasterById / oemMasters |
— |
| Create master |
createOemMaster / createOemMasterWithDetails |
— |
| Delete master |
deleteOemMaster |
— |
| Create container |
createOemContainer |
— |
| Query house |
oehHouseByHouseNo / oehHouseById / oehHouses |
— |
| Create house |
createOehHouse |
— |
| Delete house |
deleteOehHouse |
— |
| Charge / cost |
createOemMasterChargeCosts / createOehHouseChargeCosts |
POST /api/charge-cost/ocean-export |
5. Domestic
| Function |
GraphQL |
REST API |
| Query master |
domMasterById / domMasterByHblNo / domMasterByDocCode / domMasters |
— |
| Create / update master |
createDomMaster |
POST /api/dom |
| Delete master |
deleteDomMaster |
— |
6. Booking (Air / Ocean Export)
| Function |
GraphQL |
REST API |
| Air export shipper booking (AEB) |
aebBookingByDocCode / aebBookingById / aebBookings |
— |
| Air export carrier booking (AEC) |
aecBookingByDocCode / aecBookingById / aecBookings |
— |
| Ocean export shipper booking (OEB) |
oebBookingByDocCode / oebBookingById / oebBookings |
— |
| Ocean export carrier booking (OEC) |
oecBookingByDocCode / oecBookingById / oecBookings |
— |
7. Customer Master Data (CVM)
| Function |
GraphQL |
REST API |
| Query by key |
cvmAddressById / cvmAddressByCompanyName / cvmAddressBySearchCode |
— |
| Search by name |
searchCvmAddressesByName (with country / city / postal code filters) |
GET /api/cvm/search |
| Paged list |
cvmAddresses |
— |
| Create address |
createCvmAddress |
POST /api/cvm |
| Delete address |
deleteCvmAddress |
— |
8. Base Data
| Function |
GraphQL |
REST API |
| Charge / cost item catalog |
plmChargeCostItemById / plmChargeCostItems |
— |
9. Accounts Payable (AP) Invoice
| Function |
GraphQL |
REST API |
| Query invoice |
apiCostInvoiceById / apiCostInvoiceByDocCode / apiCostInvoiceByVendorInvoiceNo / apiCostInvoices |
— |
10. Accounts Receivable (AR) Invoice
| Function |
GraphQL |
REST API |
| Query invoice |
armInvoiceById / armInvoiceByDocCode / armInvoiceByInvoiceNo / armInvoices |
— |
11. Other Services
| Module |
Function |
GraphQL |
REST API |
| Document |
Upload / push document |
— |
POST /api/document/upload / POST /api/document/push |
| Note |
Upload note |
— |
POST /api/note/upload |
Notes
API Entry Points
| Interface |
Endpoint |
Description |
| GraphQL |
/graphql |
GraphQL endpoint for queries and mutations |
| REST |
/api/* |
REST endpoints for data exchange (import / integration) |
| API Explorer |
/swagger, /redoc, /scalar |
Interactive documentation and testing tools for REST |
Authentication
All API requests must be authenticated with valid credentials issued by E-Freight. Please contact E-Freight to obtain your credentials before integration.
List Queries
All list queries (e.g. aimMasters, domMasters, armInvoices) return a paged result and support filtering, sorting, and pagination (cursor-based first/after/last/before or offset-based skip/take).