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

# List a vendor's pending items

> List the unpaid line items and adjustments that make up one vendor's pending payout. Requires the `admin:payouts` permission.



## OpenAPI

````yaml openapi-merchant.json GET /payouts/pending/items/{vendorId}
openapi: 3.0.0
info:
  title: PuppetVendors Merchant API V2
  version: 2.0.0
  description: >-
    The endpoints reachable with a merchant API key (`mk_live_…`), minted from
    Settings → API Access in the PuppetVendors admin. A merchant key administers
    users and vendors, and renews its own token. Everything else in the V2 API,
    including orders, products, payouts, fulfillments and documents, stays on
    the v1 API token and is refused here with a 403. Keys are revealed once at
    creation; rotating one leaves the previous key working for a 24 hour grace
    window.
  contact:
    name: PuppetVendors Support
    url: https://puppetvendors.com
  license:
    name: Proprietary
servers:
  - url: https://production-api.puppetvendors.com
    description: Production
  - url: http://localhost:8082
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Auth
    description: Authentication endpoints for obtaining and refreshing API tokens
  - name: Portal - Auth
    description: Vendor portal authentication endpoints (vendor user login, token refresh)
  - name: Products
    description: Product management and synchronization
  - name: Orders
    description: Order retrieval and management
  - name: Payouts
    description: Vendor payout information
  - name: Fulfillments
    description: Order fulfillment operations
  - name: Reports
    description: Vendor sales reports and analytics
  - name: Vendors
    description: Vendor management operations
  - name: Settings
    description: Settings endpoints for vendor configuration and management
  - name: Users
    description: User account management
  - name: Shop
    description: Shop configuration and settings
  - name: Commissions
    description: Commission rate management
  - name: Integrations
    description: Vendor integration configuration endpoints
  - name: Line Items
    description: Order line item operations
paths:
  /payouts/pending/items/{vendorId}:
    get:
      tags:
        - Payouts
      summary: List a vendor's pending items
      description: >-
        List the unpaid line items and adjustments that make up one vendor's
        pending payout. Requires the `admin:payouts` permission.
      operationId: listPendingPayoutItems
      parameters:
        - in: path
          name: vendorId
          required: true
          schema:
            type: string
          description: The vendor whose pending items to list
          example: 507f1f77bcf86cd799439012
        - in: query
          name: startDate
          required: true
          schema:
            type: string
          description: Window start (YYYY-MM-DD in the shop timezone, or ISO 8601)
        - in: query
          name: endDate
          required: true
          schema:
            type: string
          description: >-
            Window end (YYYY-MM-DD in the shop timezone, or ISO 8601); a future
            date clamps to now; at most 12 months after startDate
        - in: query
          name: first
          schema:
            type: integer
            minimum: 1
            maximum: 100
          description: Number of items to return (orderDate ascending)
        - in: query
          name: after
          schema:
            type: string
          description: Cursor for forward pagination
        - in: query
          name: last
          schema:
            type: integer
            minimum: 1
            maximum: 100
          description: Number of items to return (backward pagination)
        - in: query
          name: before
          schema:
            type: string
          description: Cursor for backward pagination
      responses:
        '200':
          description: Summary header over the full window plus the page of items
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    description: >-
                      The summary node fields (vendorName, vendorId, amount,
                      currency, fromDate, toDate, payoutMethod, itemsCount) plus
                      edges/pageInfo
                    properties:
                      amount:
                        type: number
                      itemsCount:
                        type: number
                      payoutMethod:
                        type: string
                        enum:
                          - stripe
                          - paypal
                          - globalPayouts
                          - manual
                        description: >-
                          Same as the payoutMethod of GET /payouts/pending (a
                          vendor with nothing pending resolves from their vendor
                          record)
                      edges:
                        type: array
                        items:
                          type: object
                          properties:
                            node:
                              type: object
                              properties:
                                _id:
                                  type: string
                                referenceNumber:
                                  type: string
                                  nullable: true
                                  description: Line item orderNumber; custom item customId
                                title:
                                  type: string
                                  nullable: true
                                  description: Line item name; custom item comments
                                amount:
                                  type: number
                                  description: >-
                                    Custom items are signed (deductions
                                    negative)
                                orderDate:
                                  type: string
                                  format: date-time
                                  nullable: true
                                type:
                                  type: string
                                  enum:
                                    - lineItem
                                    - customItem
                            cursor:
                              type: string
                      pageInfo:
                        type: object
        '400':
          description: >-
            Missing startDate or endDate (both required), invalid filters,
            non-hex vendorId, or DATE_RANGE_EXCEEDED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            Forbidden - merchant scope with admin:payouts required, or
            MERCHANT_PAYOUTS_API_NOT_ENABLED (the payouts API is not enabled for
            this store)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Vendor not found in this shop
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          enum:
            - false
          description: Indicates the request failed
        error:
          type: object
          required:
            - message
          properties:
            message:
              type: string
              description: Human-readable error message
              example: Resource not found
            code:
              type: string
              description: >-
                Stable machine-readable error code. The frontend uses this as
                its localisation key (e.g. errors.api.<code>). Server errors
                always report INTERNAL_SERVER_ERROR.
              example: NOT_FOUND
            errorId:
              type: string
              description: >-
                Correlation id for support/log lookup. Present on opaque 5xx
                responses so a user can quote a reference for the underlying
                (server-side logged) error.
              example: err_1783365360839_j281w7b
            details:
              type: object
              description: >-
                Additional client-error context (e.g. field-level validation
                errors). Never populated for server errors.
  securitySchemes:
    bearerAuth:
      type: apiKey
      in: header
      name: x-access-token
      description: >-
        JWT minted from a merchant API key (`mk_live_…`) by POST /authenticate.
        Send the token value directly, with no "Bearer" prefix. Tokens last 14
        days and can be renewed at POST /refresh-token; revoking the key refuses
        the next request made with any token minted from it.

````

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