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

# List Transactions

> Get your transaction logs — transaction API calls with their action, request/response, and timing. Results are sorted by most recent first by default, and can be reordered with `order_by` / `order_direction`.



## OpenAPI

````yaml /openapi.json get /api/transactions
openapi: 3.0.0
info:
  title: Authentication API
  description: API for user authentication and token generation
  version: 1.0.0
servers:
  - url: https://api.retailreadyai.com
    description: Production server
  - url: https://stg.retailreadyai.com
    description: Staging server
security: []
paths:
  /api/transactions:
    get:
      tags:
        - Transactions
      summary: List Transactions
      description: >-
        Get your transaction logs — transaction API calls with their action,
        request/response, and timing. Results are sorted by most recent first by
        default, and can be reordered with `order_by` / `order_direction`.
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          description: Page number (1-indexed). Defaults to 1.
        - name: page_size
          in: query
          schema:
            type: integer
            default: 50
            maximum: 100
          description: Number of items per page. Defaults to 50, capped at 100.
        - name: transaction_id
          in: query
          schema:
            type: string
            format: uuid
          description: Filter to a single transaction by its UUID.
        - name: order_id
          in: query
          schema:
            type: string
            format: uuid
          description: Filter to transactions associated with this order UUID.
        - name: po_number
          in: query
          schema:
            type: string
          description: Filter to transactions associated with this purchase order number.
        - name: execution_status
          in: query
          schema:
            type: string
            enum:
              - SUCCESS
              - FAILURE
              - RETRY
              - PENDING
              - SKIP
          description: Filter by execution status. An invalid value returns 400.
        - name: action_type
          in: query
          schema:
            type: string
            enum:
              - POST_ORDER_TO
              - CREATE_ORDERS_FROM
              - INGEST_PURCHASE_ORDER
              - INGEST_PURCHASE_ORDER_CHANGE
              - FETCH_ORDER_UPDATES
              - SEND_SHIPMENT_CONFIRMATION
              - SEND_TRACKING
              - SEND_PO_ACK
              - SEND_ASN
              - SEND_INVOICE
              - PO_ACK_STATUS_CHECK
              - ASN_STATUS_CHECK
              - INVOICE_STATUS_CHECK
              - INGEST_ORDER_PUT
          description: Filter by action type. An invalid value returns 400.
        - name: retailer_ids
          in: query
          schema:
            type: string
          description: >-
            Comma-separated retailer UUIDs (e.g. `a,b,c`). Matches transactions
            scoped to any of the listed retailers.
        - name: brand_ids
          in: query
          schema:
            type: string
          description: >-
            Comma-separated brand UUIDs. Matches transactions scoped to any of
            the listed brands.
        - name: facility_ids
          in: query
          schema:
            type: string
          description: >-
            Comma-separated facility UUIDs. Matches transactions scoped to any
            of the listed facilities.
        - name: has_error
          in: query
          schema:
            type: boolean
          description: >-
            When `true`, returns only transactions with a non-null error
            message; when `false`, only those without. Case-insensitive.
            Independent of `execution_status`. Any value other than true/false
            returns 400.
        - name: created_at_from
          in: query
          schema:
            type: string
            format: date
          description: >-
            Return transactions created on or after this date. Accepts a date or
            datetime; compared by calendar date, so the whole day is included.
        - name: created_at_to
          in: query
          schema:
            type: string
            format: date
          description: >-
            Return transactions created on or before this date. Accepts a date
            or datetime; compared by calendar date, so the whole day is
            included.
        - name: search
          in: query
          schema:
            type: string
          description: >-
            Free-text search. Matches (case-insensitive, partial) against
            transaction_id, order_id, correlation_id, error_message, and
            request_url.
        - name: order_by
          in: query
          schema:
            type: string
            enum:
              - created_at
              - updated_at
              - execution_status
              - action_type
            default: created_at
          description: >-
            Field to sort by. Defaults to created_at. Unknown values fall back
            to the default (no error).
        - name: order_direction
          in: query
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
          description: >-
            Sort direction. Defaults to desc. Unknown values fall back to the
            default (no error).
      responses:
        '200':
          description: Transactions retrieved successfully
          content:
            application/json:
              schema:
                type: object
                description: Paginated list response.
                properties:
                  data:
                    type: object
                    properties:
                      transactions:
                        type: array
                        items:
                          $ref: '#/components/schemas/Transaction'
                      total_count:
                        type: integer
                        description: >-
                          Total number of transactions matching the filters
                          (across all pages)
                        example: 22
                      page:
                        type: integer
                        example: 1
                      page_size:
                        type: integer
                        example: 50
              example:
                data:
                  page: 1
                  page_size: 50
                  total_count: 22
                  transactions:
                    - action_type: Purchase order received
                      action_type_label: Purchase Order Received
                      brand_id: 79b7fcfa-4a0b-45e9-a30c-3c1620af81e6
                      carton_id: null
                      duration_ms: 257
                      error_message: null
                      execution_status: SUCCESS
                      facility_id: c7bebef5-1d9f-4973-b03f-9fb2f02dfabb
                      load_id: null
                      order_id: null
                      request_method: GET
                      request_payload: null
                      request_url: https://api.retailreadyai.com/api/transactions
                      response_body: {}
                      response_status: 200
                      retailer_id: a7ef7e81-8da3-4b82-8f0b-ee06998c9171
                      transaction_id: 57713ed9-57c5-4e80-9663-a487b5c5fe6d
                      created_at: '2026-05-09T22:58:44.000Z'
                      updated_at: '2026-05-14T00:15:24.000Z'
        '400':
          description: Invalid query parameter (e.g. malformed UUID or unknown filter)
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  error:
                    type: object
                    properties:
                      code:
                        type: string
              example:
                message: 'Invalid query parameter: transaction_id must be a UUID'
                error:
                  code: INVALID_REQUEST
        '401':
          description: >-
            Authentication failed or user lacks access to the requested
            retailer's transactions
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  error:
                    type: object
                    properties:
                      code:
                        type: string
              example:
                message: User is not authorized to access this resource
                error:
                  code: UNAUTHORIZED
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  error:
                    type: object
                    properties:
                      code:
                        type: string
              example:
                message: Error fetching transactions
                error:
                  code: INTERNAL_SERVER_ERROR
      security:
        - bearerAuth: []
components:
  schemas:
    Transaction:
      type: object
      description: >-
        A single transaction-log entry. Captures one external API call: which
        action ran, what was sent, what came back, how long it took, and which
        order/load/carton (if any) it relates to.
      properties:
        transaction_id:
          type: string
          format: uuid
          description: UUID of this transaction record.
          example: 57713ed9-57c5-4e80-9663-a487b5c5fe6d
        action_type:
          type: string
          description: >-
            Human-readable label describing what this transaction did (e.g.
            `Purchase order received`, `Shipment confirmation sent`).
          example: Purchase order received
        action_type_label:
          type: string
          description: >-
            Human-readable label for the action_type (e.g. `Purchase Order
            Received`).
          example: Purchase Order Received
        execution_status:
          type: string
          description: Outcome of the action (e.g. SUCCESS, FAILURE).
          example: SUCCESS
        error_message:
          type: string
          nullable: true
          description: Error string when execution_status is not SUCCESS; null on success.
          example: null
        duration_ms:
          type: integer
          description: How long the action took, in milliseconds.
          example: 257
        brand_id:
          type: string
          format: uuid
          nullable: true
          description: UUID of the brand this transaction is scoped to.
        retailer_id:
          type: string
          format: uuid
          nullable: true
          description: UUID of the retailer this transaction is scoped to.
        facility_id:
          type: string
          format: uuid
          nullable: true
          description: UUID of the facility this transaction is scoped to, when applicable.
        order_id:
          type: string
          format: uuid
          nullable: true
          description: UUID of the order this transaction relates to, when applicable.
        load_id:
          type: string
          format: uuid
          nullable: true
          description: UUID of the load this transaction relates to, when applicable.
        carton_id:
          type: string
          format: uuid
          nullable: true
          description: UUID of the carton this transaction relates to, when applicable.
        request_method:
          type: string
          description: HTTP method of the inbound request that created this transaction.
          example: GET
        request_url:
          type: string
          description: >-
            URL of the inbound request that created this transaction — your
            API's `/transactions` endpoint.
          example: https://api.retailreadyai.com/api/transactions
        request_payload:
          type: object
          additionalProperties: true
          nullable: true
          description: >-
            Body of the inbound POST that created this transaction. Shape varies
            by action_type. Null when the request had no body.
        response_status:
          type: integer
          description: HTTP status code returned by the upstream service.
          example: 200
        response_body:
          type: object
          additionalProperties: true
          nullable: true
          description: >-
            Body returned by the upstream service. Shape varies by action_type
            and upstream service. Null when no body was returned.
        created_at:
          type: string
          format: date-time
          nullable: true
          description: ISO 8601 timestamp of when the transaction record was created.
          example: '2026-05-09T22:58:44.000Z'
        updated_at:
          type: string
          format: date-time
          nullable: true
          description: ISO 8601 timestamp of when the transaction record was last updated.
          example: '2026-05-14T00:15:24.000Z'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````