Home
ePAL REST API Overview
Use the information provided here to understand how to use the REST API.
API Reference Guide
This sections describes all the endpoints, requests and fields that you can use for your API integration.
Code Translation Endpoint
Use the requesy in this endpoint to map commodity codes to export, import or transport codes.
Translate export/import/transport codes
Use this request to translate commodify codes into export, import, or transport codes.

ePAL REST API Overview
Use the information provided here to understand how to use the REST API.
- Getting Started with the API
  Use the information here to help you get started with your integration with the ePAL REST API.
- API Reference Guide
  This sections describes all the endpoints, requests and fields that you can use for your API integration.
  - Health Endpoint Overview
    Use the requests available for this endpoint to check on the general health of your connecttion to the ePAL API and ePAL's overall health status.
  - Health Check Endpoint
    Use the request in this endpoint to check the health of various connections and applications.rest_api/epal_api_rqst_chck_all_sts.html
  - Transactions Endpoint
    Use this endpoint to find requests that are related to transactions.
  - Quotes Endpoint
    Use the requests in this endpoint to create and manage quotes.rest_api/epal_api_qte_ssn_rwdt_rqst.html
  - Documents Overview
    Use the requests available for this endpoint to manage documents such as shipping labels, customs declarations, commercial invoices and more.rest_api/epal_api_gt_shppo_cstms_dclrtn_rqst.html
  - Fulfillment Endpoint
    Use the request in this endpont to process fulfillments.
  - IOSS Validation Endpoint
    Use the requests here to check if a transaction qualifies for IOSS.
  - Code Translation Endpoint
    Use the requesy in this endpoint to map commodity codes to export, import or transport codes.
    - Translate export/import/transport codes
      Use this request to translate commodify codes into export, import, or transport codes.
  - HS Code Endpoint
    Use the requests in this endpoint to seach HS codes.rest_api/epal_api_srch_hs_desc_rqst.html

Translate export/import/transport codes

Use this request to translate commodify codes into export, import, or transport codes.

Use a POST operation and the following URL to send this request:

{api_url}/code-translation

where {api_url} is the API's URL.

For example:

https://api.epalglobal.co/code-translation

Details

Table 1. Request Details
Detail	Value
Operation	`POST`
Endpoint	`code-translation`
Fields	Body and response parameters

Body Parameters

Table 2.
Body Paramter	Details	Description
`type`	Type: String Status: Mandatory Required Values: `export`, `import` or `transport`.	Specify the type of code that you want to translate the commodity code into.
`code`	Type: Status: Mandatory Required Values:	Specify the commodity code that you want to translate.

Response Parameters

Table 3.
Response Parameter	Details	Description
`code`	Type: String Status: Mandatory	The export, import or transport code.
`type`	Type: String Status: Mandatory	The type or category to which the code belongs.
`description`	Type: String Status: Mandatory	Text decription.
`conditionalNote`	Type: String Status: Optional	Any conditional notes.
`isConditional`	Type: Boolean Status: Mandatory	Indicates whether the code has conditional requirements or not.

Request Example

The following is an example using an export code:

{
  "type": "export",
  "code": "12345678"
}

The following is an example import code:

{
  "type": "import",
  "code": "*ABC123"
}

The following is an example of a transport code:

{
  "type": "transport",
  "code": "09876543"
}

Response Example

The following is an example response for a successful request:

{
  "code": "01_12345678",
  "type": "GOODS",
  "description": "Electronic goods",
  "conditionalNote": "string",
  "isConditional": false
}