> ## Documentation Index
> Fetch the complete documentation index at: https://knowledge.bitbybit.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# List shipping providers

> Return all shipping providers the bitbybit platform integrates with, including whether your company has each one connected and the capability set each provider supports. Use this to render a provider picker in your UI.



## OpenAPI

````yaml GET /shipping/providers
openapi: 3.1.0
info:
  title: bitbybit Open API — Shipping
  description: >-
    Programmatic access to bitbybit shipping: store locations, provider
    discovery, coverage lookup, fee quoting, and the full shipment lifecycle
    (create, book, update, cancel, track) across GoSend, KiriminAja, and
    RideBlitz.
  version: 1.0.0
  contact:
    name: bitbybit Support
    url: https://bitbybit.studio
servers:
  - url: https://api.bitbybit.studio/customer/api/open/v1
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Store Locations
    description: >-
      Manage warehouse / pickup origin addresses. Couriers pick up from these
      locations when a shipment is booked.
  - name: Providers
    description: Discover connected carriers and the services each carrier offers.
  - name: Coverage
    description: >-
      Look up the courier-specific province / city / district / sub-district
      dictionaries needed to populate addresses and quote fees.
  - name: Fee Calculation
    description: Quote shipping fees across carriers using one unified request shape.
  - name: Shipments
    description: >-
      Create, update, cancel, and track shipments. A shipment is always attached
      to an Order.
paths:
  /shipping/providers:
    get:
      tags:
        - Providers
      summary: List connected providers
      description: >-
        Return all shipping providers the bitbybit platform integrates with,
        including whether your company has each one connected and the capability
        set each provider supports. Use this to render a provider picker in your
        UI.
      operationId: listShippingProviders
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProviderInfo'
              example:
                data:
                  - code: gosend
                    name: GoSend
                    connected: true
                    capabilities:
                      - calculate_fee
                      - cancel_booking
                    description: >-
                      Gojek instant motorcycle/car delivery within select
                      Indonesian cities. Best for same-day intra-city shipments.
                  - code: kirimin_aja
                    name: KiriminAja
                    connected: true
                    capabilities:
                      - calculate_fee
                      - coverage_lookup
                      - create_booking
                      - cancel_booking
                      - tracking
                    description: >-
                      Aggregator that exposes 12+ Indonesian couriers (JNE, J&T,
                      SiCepat, …) plus on-demand instant via GoSend, Grab
                      Express, Borzo.
                  - code: ride_blitz
                    name: RideBlitz
                    connected: false
                    capabilities:
                      - calculate_fee
                      - create_booking
                      - cancel_booking
                      - tracking
                    description: >-
                      Bali- & Java-focused electric-fleet instant courier with
                      hourly SLAs.
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    ProviderInfo:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ShippingProvider'
        name:
          type: string
        connected:
          type: boolean
          description: >-
            `true` when the merchant has connected this provider in Settings >
            Integrations.
        capabilities:
          type: array
          items:
            type: string
            enum:
              - calculate_fee
              - coverage_lookup
              - create_booking
              - cancel_booking
              - tracking
        description:
          type: string
    ShippingProvider:
      type: string
      enum:
        - gosend
        - kirimin_aja
        - ride_blitz
        - jne
        - custom
      description: >-
        Provider/courier code. `gosend`, `kirimin_aja`, and `ride_blitz` are
        externally integrated; `jne` is a passthrough placeholder; `custom` is
        for merchant-defined methods.
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: >-
                Machine-readable code, e.g. `VALIDATION_ERROR`, `NOT_FOUND`,
                `INTEGRATION_NOT_CONNECTED`, `PROVIDER_ERROR`, `BOOKING_FAILED`.
            message:
              type: string
              description: Human-readable error message.
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Invalid API key
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key for authentication. Create one in Settings > Developer. The key
        must have the `BITCRM` product scope and an `orders` resource scope;
        required action depends on the endpoint (`READ`, `WRITE`, or `DELETE`).

````