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

# Get label rates for an order

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



## OpenAPI

````yaml /api-reference/openapi.json post /orders/{orderId}/label-rates
openapi: 3.1.0
info:
  title: Replo Public API
  version: '2026-11-17'
servers:
  - url: https://api.replo.app/v1
security: []
paths:
  /orders/{orderId}/label-rates:
    post:
      tags:
        - Shipping-labels
      summary: Get label rates for an order
      description: '**Beta** — this endpoint may change before general availability.'
      operationId: shippingLabels.rates
      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: Order to quote a label for.
          required: true
          description: Order to quote a label for.
          name: orderId
          in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                items:
                  type:
                    - array
                    - 'null'
                  items:
                    type: object
                    properties:
                      orderItemId:
                        type: string
                        format: uuid
                        description: ID of the order item.
                      quantity:
                        type: integer
                        exclusiveMinimum: 0
                        description: How many to ship. Omit for all that remain.
                    required:
                      - orderItemId
                  minItems: 1
                  description: Items in this package. Omit for everything not yet shipped.
                shippingPackageId:
                  type:
                    - string
                    - 'null'
                  format: uuid
                  description: Box to ship in. Omit for the store's default box.
                weightGrams:
                  type:
                    - integer
                    - 'null'
                  exclusiveMinimum: 0
                  maximum: 70000
                  description: Package weight. Omit to add up the item and box weights.
                options:
                  type: object
                  properties:
                    signature:
                      type: string
                      enum:
                        - none
                        - standard
                        - adult
                      default: none
                      description: Signature the carrier collects on delivery.
                    insuranceAmount:
                      type:
                        - integer
                        - 'null'
                      exclusiveMinimum: 0
                      default: null
                      description: >-
                        Declared value to insure, in minor units of the store
                        currency. Null for no insurance.
                    saturdayDelivery:
                      type: boolean
                      default: false
                      description: Ask the carrier to deliver on Saturday, where it can.
                  default:
                    signature: none
                    insuranceAmount: null
                    saturdayDelivery: false
                  description: Signature, insurance and Saturday delivery.
              additionalProperties: false
      responses:
        '200':
          description: Get label rates for an order
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    enum:
                      - label_rates
                  shipmentId:
                    type: string
                    description: The carrier quote these rates belong to; send it to buy.
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/LabelRate'
                  messages:
                    type: array
                    items:
                      type: string
                    description: Carrier notes, e.g. a service that won't take this box.
                  needsCustoms:
                    type: boolean
                    description: The package leaves the store's country and needs customs.
                required:
                  - object
                  - shipmentId
                  - data
                  - messages
                  - needsCustoms
        '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:
    LabelRate:
      type: object
      properties:
        id:
          type: string
          description: Rate id; buy it with the shipment id.
        carrier:
          type: string
        service:
          type: string
          description: Carrier service code, e.g. "FEDEX_GROUND".
        name:
          type: string
          description: What merchants call it, e.g. "FedEx Ground".
        amount:
          type: integer
          description: Postage, in minor units.
        currencyCode:
          type: string
        deliveryDays:
          type:
            - integer
            - 'null'
        estimatedDeliveryAt:
          type:
            - string
            - 'null'
        isBuyerChoice:
          type: boolean
          description: The service the buyer paid for at checkout.
      required:
        - id
        - carrier
        - service
        - name
        - amount
        - currencyCode
        - deliveryDays
        - estimatedDeliveryAt
        - isBuyerChoice
    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.