Byelabel Api
    Byelabel Api
    • ByeLabel API (v1) Document
    • Me
      GET
    • Login
      POST
    • Refresh Token
      POST
    • Balance
      GET
    • Carrier List
      GET
    • Country List
      GET
    • State/Province List
      GET
    • State & City From Postal Code
      POST
    • Get Carrier Rates
      POST
    • Create Shipment (Label)
      POST
    • Shipment List
      GET
    • Schemas
      • Fail Result Schema
      • Success Result Schema
      • HTTP Error Schema
      • Tax Identifiers Schema
      • Weight Schema
      • Dimensions Schema
      • Sender Schema
      • Recipient Schema
      • Package Schema
      • Package Line Items Schema
      • Product Options Schema
      • Invoice Schema
      • Printing Options Schema
      • Order Schema
      • Carrier Rate Result Schema
      • Created Shipment Result Schema
      • Document To Print
      • Country Schema
      • State / Province Schema
      • Carrier Schema
      • Shipment Activity Schema

    ByeLabel API (v1) Document

    Purpose#

    This document aims to obtain affordable shipping rates and shipping labels through UPS, FedEx, Asendia, and USPS accounts defined in the system using the ByeLabel API. In doing so, it prioritizes both security and performance.

    Security#

    Before sending requests to the relevant endpoints via the API, authentication is performed using the “Client Id” and “Client Secret” along with the “Workspace Id,” after which a time-limited key (token) is used. When the key (token) expires, it is renewed using the “refresh token” endpoint and continues to be used. Instead of creating a new session with the client id and secret for each request, the refresh token (which changes with each renewal) obtained in the first request can be stored and used in your system.

    Response Structure#

    When requests sent to the system are processed successfully, they return as a JSON package with status code 200 OK. The package contains a success parameter that is boolean (true/false). If success is true, the second parameter is payload; if success is false, the second parameter is error. While payload varies depending on the endpoint, the error parameter returns three sub-parameters: code, message, and args. Finally, the transaction id of the relevant request and the response time are included for informational purposes.
    Modified at 2026-02-08 04:52:43
    Next
    Me
    Built with