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.
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
Use this request to check the health of the ePAL application and your connection to it.

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.
    - Get welcome message
      Use this request to test your connection to theePAL API by returning the welcome message.
    - Health check
      Use this request to check the health of the ePAL application and your connection to it.
  - 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.
  - HS Code Endpoint
    Use the requests in this endpoint to seach HS codes.rest_api/epal_api_srch_hs_desc_rqst.html

Health check

Use this request to check the health of the ePAL application and your connection to it.

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

{epal_url}/health

For example:

https://api.epalglobal.com//health

Details

The following table lists some details about this request:

Table 1. Request Details
Detail	Value
Operation	GET
Endpoint	`/health`
Field	Response

Response Parameters

The response to a successful request contains the following fields:

Table 2. Response Parameters
Response Parameter	Details	Description
`environment`	Type: String	The name of the environment.
`status`	Type: String	The status of the environment.
`timestamp`	Type: String	The time and date when the health check was performed.
`uptime`	Type: Number	The period duting which the environment is up and running.

Example Response

The following is an example response:

{
  "status": "ok",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "uptime": 3600.123,
  "environment": "development"
}