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

# 列出 FBA 退件運貨單 （分頁）

<Warning>
  此頁面由 AI 自動翻譯。API 技術規格以英文呈現為標準。如有任何疑問，請參閱[英文版本](/api-reference/fbashipment/list-fba-shipments-with-pagination)。
</Warning>

回傳您的 FBA 運貨單分頁列表，可依倉庫與狀態篩選。用以顯示 FBA 運貨單佇列或與您自己的紀錄對帳。


## OpenAPI

````yaml get /api/Fba/FbaShipment/list
openapi: 3.1.0
info:
  title: Return Helper API
  description: API documentation for Return Helper — covering User and Public endpoints.
  version: 1.0.0
servers:
  - url: https://api.returnshelper.com/uat/user
    description: Sandbox — User API
  - url: https://api.returnshelper.com/uat/public
    description: Sandbox — Public API
  - url: https://api.returnhelpercentre.com/v1/user
    description: Production — User API
  - url: https://api.returnhelpercentre.com/v1/public
    description: Production — Public API
  - url: https://api.returnhelperchina.com/user
    description: Production — User API (China)
security:
  - ApiKey: []
    ApiToken: []
paths:
  /api/Fba/FbaShipment/list:
    get:
      tags:
        - FbaShipment
      summary: List FBA shipments with pagination
      operationId: ReturnUserApi_ListFbaShipment
      parameters:
        - name: pageSize
          in: query
          required: true
          schema:
            type: integer
            maximum: 50
            minimum: 1
          description: Number of records per page (max 50)
        - name: offset
          in: query
          required: true
          schema:
            type: integer
          description: Pagination offset
        - name: createFrom
          in: query
          required: true
          schema:
            type: string
            format: date-time
          description: Filter by creation date from (ISO 8601)
        - name: createTo
          in: query
          required: true
          schema:
            type: string
            format: date-time
          description: Filter by creation date to (ISO 8601)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralList_UserCreateFbaShipmentReply'
        '401':
          description: >-
            Authentication failed. Returned when the `x-rr-apikey` or
            `x-rr-apitoken` header is missing or invalid. The body uses the
            standard `ApiResponse` envelope with `meta.error.message` describing
            the auth failure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      security:
        - ApiKey: []
          ApiToken: []
      servers:
        - url: https://api.returnshelper.com/uat/user
          description: Sandbox — User API
components:
  schemas:
    GeneralList_UserCreateFbaShipmentReply:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/UserCreateFbaShipmentReply'
          description: List of created FBA shipments
    ApiResponse:
      type: object
      description: >-
        Universal response envelope. Successful responses include the business
        payload as additional top-level fields alongside `correlationId` and
        `meta`. Failed responses (auth errors, validation errors) only populate
        `correlationId` and `meta`, with `meta.errorCode` and `meta.error`
        describing the failure.
      properties:
        correlationId:
          type:
            - string
            - 'null'
          description: >-
            Unique correlation ID for tracing the request through Return Helper
            systems.
        meta:
          $ref: '#/components/schemas/ApiResponseMeta'
    UserCreateFbaShipmentReply:
      type: object
      properties:
        fbaShipmentId:
          type: string
          format: uuid
        apiId:
          type: integer
          format: int32
        warehouseId:
          type: integer
          format: int32
        fbaShipmentStatusCode:
          type:
            - string
            - 'null'
        removalOrderId:
          type:
            - string
            - 'null'
        trackingNumber:
          type:
            - string
            - 'null'
        arrivalOn:
          type:
            - string
            - 'null'
          format: date-time
        createOn:
          type: string
          format: date-time
    ApiResponseMeta:
      type: object
      description: >-
        Application-level metadata for every API response. Inspect `status` and
        `errorCode` to detect soft-error responses (validation failures arrive
        as HTTP 200 with `meta.status: 400`).
      properties:
        status:
          type: integer
          description: >-
            Application-level status code. For successful operations this
            mirrors the HTTP status (e.g. 200). For validation failures it
            reports the logical status (e.g. 400) even though the wire HTTP
            status is 200.
        data:
          type: object
          additionalProperties:
            type: string
          description: Reserved free-form metadata key/value pairs. Usually empty.
        errorCode:
          type:
            - string
            - 'null'
          description: >-
            Machine-readable error code (e.g. `VALIDATION_FAILED`). Non-null
            only when the operation failed.
        error:
          type: object
          additionalProperties: true
          description: >-
            Field-level or message-level error detail keyed by request property
            name. Empty object on success.
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-rr-apikey
      description: Your API key
    ApiToken:
      type: apiKey
      in: header
      name: x-rr-apitoken
      description: Your API token — keep this private

````