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.
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
Get label by ID
Use this request to retrieve a specific label using the label's ID.

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
    - Generate shipping labels and documents
      Use this request to generate shipping labels and other associated documents (such as customs declarations, commercial invoices and so on). You can choose which you want to generate.
    - Get label by ID
      Use this request to retrieve a specific label using the label's ID.
    - Get label by tracking number
    - Get all Shippo documents for a transaction
      Use this request to retrieve all the documents and labels for a Shippo Transaction ID.
    - Get Shippo customs declaration by ID
  - 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

Get label by ID

Use this request to retrieve a specific label using the label's ID.

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

{api_url}/generate-labels/{labelId}

where:

{api_url} is the API's URL.
{labelId} is the ID of the label that you want to retrieve.

For example:

https://api.epalglobal.co/generate-labels/{labelId}

Details

Table 1. Request Details
Detail	Value
Operation	`GET`
Endpoint	`/generate-labels/{labelId}`
Fields	Query parameter

Query Parameters

Table 2.
Query Parameter	Details	Description
`labelId`	Type: String Status: Mandatory	Specify the Label ID of the label that you want to retrieve,