Jump to main content
ePAL Product Documentation
  • Getting Started with ePAL
  • ePAL for WooCommerce
  • ePAL Portal User Guide
  • ePAL REST API Overview
  1. Home
  2. ePAL REST API Overview

    Use the information provided here to understand how to use the REST API.

  3. API Reference Guide

    This sections describes all the endpoints, requests and fields that you can use for your API integration.

  4. 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

  • 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

Documents Overview

Use the requests available for this endpoint to manage documents such as shipping labels, customs declarations, commercial invoices and more.Get Shippo customs declaration by ID

Table 1. Request and Endpoints
Endpoint Requests
Documents (/generate-labels) Generate shipping labels and documents
Get label by ID
Get label by tracking number
Get all Shippo documents for a transaction
Get Shippo customs declaration by ID
Generated by <oXygen/> XML WebHelp