> ## 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 checkout shipping options

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



## OpenAPI

````yaml /api-reference/openapi.json get /shipping/options
openapi: 3.1.0
info:
  title: Replo Public API
  version: '2026-11-17'
servers:
  - url: https://api.replo.app/v1
security: []
paths:
  /shipping/options:
    get:
      tags:
        - Shipping-options
      summary: List checkout shipping options
      description: '**Beta** — this endpoint may change before general availability.'
      operationId: shippingOptions.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 checkout shipping options to list.
          required: true
          description: Project whose checkout shipping options to list.
          name: projectId
          in: query
      responses:
        '200':
          description: List checkout shipping options
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    enum:
                      - list
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ShippingOption'
                  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:
    ShippingOption:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
          minLength: 1
        amount:
          type: integer
          minimum: 0
          description: >-
            Integer amount in the currency's minor units (Stripe convention):
            1999 = $19.99 USD, 1999 = ¥1999 JPY, 1999 = 1.999 KWD
        currencyCode:
          type: string
        rules:
          type: array
          items:
            oneOf:
              - type: object
                properties:
                  attribute:
                    type: string
                    enum:
                      - cartSubtotal
                  operator:
                    type: string
                    enum:
                      - gte
                      - lt
                  value:
                    type: integer
                    minimum: 0
                    description: >-
                      Integer amount in the currency's minor units (Stripe
                      convention): 1999 = $19.99 USD, 1999 = ¥1999 JPY, 1999 =
                      1.999 KWD
                required:
                  - attribute
                  - operator
                  - value
              - type: object
                properties:
                  attribute:
                    type: string
                    enum:
                      - cartWeightGrams
                  operator:
                    type: string
                    enum:
                      - gte
                      - lt
                  value:
                    type: integer
                    minimum: 0
                required:
                  - attribute
                  - operator
                  - value
              - type: object
                properties:
                  attribute:
                    type: string
                    enum:
                      - destination
                  countries:
                    type: array
                    items:
                      type: string
                      pattern: ^[A-Z]{2}$
                    minItems: 1
                  regions:
                    type: array
                    items:
                      type: string
                      pattern: ^[A-Z]{2}-[A-Z0-9]{1,3}$
                  name:
                    type: string
                    minLength: 1
                    maxLength: 80
                required:
                  - attribute
                  - countries
        sortOrder:
          type: integer
        speedTier:
          type: string
          enum:
            - standard
            - express
        minDeliveryDays:
          type:
            - integer
            - 'null'
          exclusiveMinimum: 0
        maxDeliveryDays:
          type:
            - integer
            - 'null'
          exclusiveMinimum: 0
        type:
          type: string
          enum:
            - flat
            - carrierCalculated
            - pickup
        carrierServices:
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 50
        handlingAmount:
          type: integer
          minimum: 0
          description: >-
            Integer amount in the currency's minor units (Stripe convention):
            1999 = $19.99 USD, 1999 = ¥1999 JPY, 1999 = 1.999 KWD
        shippingProfileId:
          type:
            - string
            - 'null'
          format: uuid
        pickupAddressId:
          type:
            - string
            - 'null'
          format: uuid
        pickupInstructions:
          type:
            - string
            - 'null'
          maxLength: 1000
        object:
          type: string
          enum:
            - shipping_option
      required:
        - id
        - name
        - amount
        - currencyCode
        - rules
        - sortOrder
        - speedTier
        - minDeliveryDays
        - maxDeliveryDays
        - type
        - carrierServices
        - handlingAmount
        - shippingProfileId
        - pickupAddressId
        - pickupInstructions
        - object
    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.