Byelabel Api
    Byelabel Api
    • 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
    • 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

      Balance

      GET
      /balance
      Available carrier list with its' services and packages

      Request

      Authorization
      Provide your bearer token in the
      Authorization
      header when making requests to protected resources.
      Example:
      Authorization: Bearer ********************
      Header Params

      Responses

      🟢200Success
      application/json
      Body

      🟠401Unauthorized Response
      🔴500Server Error Response
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location --request GET 'https://api.byelabel.com/v1/balance' \
      --header 'X-Workspace-Id: ' \
      --header 'Authorization: Bearer <token>'
      Response Response Example
      200 - Example 1
      {
          "success": true,
          "payload": 0,
          "transaction": {
              "id": "string",
              "response_time": 0
          }
      }
      Modified at 2026-02-08 01:37:07
      Previous
      Refresh Token
      Next
      Carrier List
      Built with