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

# List shipping labels

> **Beta** — this endpoint may change before general availability.



## OpenAPI

````yaml /api-reference/openapi.json get /shipping/labels
openapi: 3.1.0
info:
  title: Replo Public API
  version: '2026-11-17'
servers:
  - url: https://api.replo.app/v1
security: []
paths:
  /shipping/labels:
    get:
      tags:
        - Shipping-labels
      summary: List shipping labels
      description: '**Beta** — this endpoint may change before general availability.'
      operationId: shippingLabels.list
      parameters:
        - name: Replo-Api-Version
          in: header
          required: true
          schema:
            type: string
            enum:
              - '2026-11-17'
          description: The public API version to use for this request.
        - schema:
            type: string
            format: uuid
            description: Project whose labels to list.
          required: true
          description: Project whose labels to list.
          name: projectId
          in: query
        - schema:
            type: string
            format: uuid
            description: Only labels for this order.
          required: false
          description: Only labels for this order.
          name: orderId
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 200
            description: '`next_cursor` from the previous page.'
          required: false
          description: '`next_cursor` from the previous page.'
          name: cursor
          in: query
        - schema:
            type: integer
            exclusiveMinimum: 0
            maximum: 100
            description: Labels per page, newest first. Defaults to 50.
          required: false
          description: Labels per page, newest first. Defaults to 50.
          name: limit
          in: query
      responses:
        '200':
          description: List shipping labels
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    enum:
                      - list
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ShippingLabel'
                  has_more:
                    type: boolean
                  next_cursor:
                    type:
                      - string
                      - 'null'
                required:
                  - object
                  - data
                  - has_more
                  - next_cursor
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/InvalidCredentials'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '413':
          $ref: '#/components/responses/PayloadTooLarge'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
        - bearerAuth: []
components:
  schemas:
    ShippingLabel:
      type: object
      properties:
        object:
          type: string
          enum:
            - shipping_label
        id:
          type: string
          format: uuid
        orderId:
          type: string
          format: uuid
        fulfillmentId:
          type:
            - string
            - 'null'
          format: uuid
          description: The package this label ships; null for a return label.
        direction:
          type: string
          enum:
            - outbound
            - return
        carrier:
          type: string
        service:
          type: string
        amount:
          type: integer
          description: Postage paid, in minor units.
        currencyCode:
          type: string
        trackingNumber:
          type:
            - string
            - 'null'
        status:
          type: string
          enum:
            - purchased
            - voidRequested
            - voided
            - voidRejected
        labelUrl:
          type:
            - string
            - 'null'
          description: A short-lived signed link to the label PDF.
        createdAt:
          type: string
      required:
        - object
        - id
        - orderId
        - fulfillmentId
        - direction
        - carrier
        - service
        - amount
        - currencyCode
        - trackingNumber
        - status
        - labelUrl
        - createdAt
    PublicApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            doc_url:
              type: string
            issues:
              type: array
              items:
                type: object
                properties:
                  param:
                    type:
                      - string
                      - 'null'
                    description: >-
                      Dotted path to the failing field within the request body,
                      query or path, e.g. "name" or "variants.0.available"; null
                      when the rule covers the whole input.
                  message:
                    type: string
                    description: Why the field was rejected.
                required:
                  - param
                  - message
              description: >-
                Present on an invalid_request whose input failed validation:
                each failing field and why, at most 10.
          required:
            - code
            - message
            - doc_url
      required:
        - error
  responses:
    InvalidRequest:
      description: Invalid request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiError'
    InvalidCredentials:
      description: >-
        Missing or invalid Replo Public API token. Send an active key as
        `Authorization: Bearer replo_sk_...`; if it was revoked, create a new
        key in Replo Settings.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiError'
    Forbidden:
      description: >-
        You are not authorized to access this resource. Ask a workspace owner to
        perform this action or to grant the key's creator access.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiError'
    NotFound:
      description: >-
        Not Found. The resource may not exist, this key may lack the required
        scope, or the key's creator may have lost access. Check the key's scopes
        in Replo Settings and the creator's project or workspace access; a
        workspace owner can grant access.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiError'
    Conflict:
      description: The resource is in a conflicting state.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiError'
    PayloadTooLarge:
      description: File content exceeds the 10 MiB limit.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiError'
    RateLimitExceeded:
      description: >-
        Too many requests. Please retry after the time indicated by the
        Retry-After header.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiError'
    InternalError:
      description: An internal error occurred.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiError'
    ServiceUnavailable:
      description: Service temporarily unavailable.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.