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

# Purchase Order - Get By Status

> Retrieve purchase orders filtered by their current status.



## OpenAPI

````yaml get /purchase_order/get_by_status
openapi: 3.0.3
info:
  title: SKULabs API
  description: >-
    Most API keys have "platformGeneric" and "platformApi" scopes included.
    Contact us to convert more routes from "platformUser" (only available to
    users) to "platformGeneric" (available to users and api keys) upon request.
  version: 4.5.0
servers:
  - url: https://api.skulabs.com
  - url: https://app.skulabs.com/s
security: []
tags:
  - name: batch
  - name: customer
    description: Manage customers, tags, and notes
  - name: cycle_count
  - name: distributor
  - name: inventory
    description: Query and modify inventory levels across locations
  - name: inventory_table
  - name: item
    description: Manage items, barcodes, serial numbers, and tags
  - name: kit
    description: Manage kits and their component items
  - name: listing
  - name: location
  - name: oauth
  - name: order
    description: Manage orders, shipments, tags, and statuses
  - name: purchase_order
    description: Manage purchase orders and receiving
  - name: run
  - name: shipments
  - name: shipping
  - name: store
  - name: tag
    description: Create, update, and remove tags
  - name: transfer_order
  - name: warehouse
    description: Manage warehouses and view statistics
  - name: webhook
    description: Manage webhook handlers
paths:
  /purchase_order/get_by_status:
    get:
      tags:
        - purchase_order
      summary: Purchase Order - Get By Status
      description: Retrieve purchase orders filtered by their current status.
      operationId: get_purchase_order_get_by_status
      parameters:
        - name: status
          in: query
          required: true
          schema:
            type: string
            enum:
              - closed
              - created
              - receiving
              - acknowledged
              - sent
              - edited
              - transit
              - accepting
            description: PO status to filter by
      responses:
        '200':
          description: Purchase orders by status
          content:
            application/json:
              schema:
                type: object
                properties:
                  purchase_orders:
                    type: array
                    items:
                      $ref: '#/components/schemas/PurchaseOrder'
                    description: Array of purchase orders
                required:
                  - purchase_orders
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                        description: Detailed error message
                      code:
                        type: string
                        description: Machine-readable error code
                      overview:
                        type: string
                        description: Short human-friendly description
                      statusCode:
                        type: number
                        description: HTTP status code
                      origin:
                        type: string
                        description: Error source
                      skulabsTraceId:
                        type: string
                        description: Trace ID for support
                      type:
                        type: string
                        enum:
                          - error
                          - notice
                          - success
                        description: Error severity for UI handling
                      user_error:
                        type: boolean
                        description: Whether the error was caused by user input
                      display:
                        type: string
                        enum:
                          - notification
                          - panel
                        description: Suggested UI display mode for the error
                    required:
                      - message
                      - statusCode
                required:
                  - error
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                        description: Detailed error message
                      code:
                        type: string
                        description: Machine-readable error code
                      overview:
                        type: string
                        description: Short human-friendly description
                      statusCode:
                        type: number
                        description: HTTP status code
                      origin:
                        type: string
                        description: Error source
                      skulabsTraceId:
                        type: string
                        description: Trace ID for support
                      type:
                        type: string
                        enum:
                          - error
                          - notice
                          - success
                        description: Error severity for UI handling
                      user_error:
                        type: boolean
                        description: Whether the error was caused by user input
                      display:
                        type: string
                        enum:
                          - notification
                          - panel
                        description: Suggested UI display mode for the error
                    required:
                      - message
                      - statusCode
                required:
                  - error
        '403':
          description: Forbidden. Insufficient permissions.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                        description: Detailed error message
                      code:
                        type: string
                        description: Machine-readable error code
                      overview:
                        type: string
                        description: Short human-friendly description
                      statusCode:
                        type: number
                        description: HTTP status code
                      origin:
                        type: string
                        description: Error source
                      skulabsTraceId:
                        type: string
                        description: Trace ID for support
                      type:
                        type: string
                        enum:
                          - error
                          - notice
                          - success
                        description: Error severity for UI handling
                      user_error:
                        type: boolean
                        description: Whether the error was caused by user input
                      display:
                        type: string
                        enum:
                          - notification
                          - panel
                        description: Suggested UI display mode for the error
                    required:
                      - message
                      - statusCode
                required:
                  - error
        '429':
          description: Too many requests. Rate limit exceeded.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                        description: Detailed error message
                      code:
                        type: string
                        description: Machine-readable error code
                      overview:
                        type: string
                        description: Short human-friendly description
                      statusCode:
                        type: number
                        description: HTTP status code
                      origin:
                        type: string
                        description: Error source
                      skulabsTraceId:
                        type: string
                        description: Trace ID for support
                      type:
                        type: string
                        enum:
                          - error
                          - notice
                          - success
                        description: Error severity for UI handling
                      user_error:
                        type: boolean
                        description: Whether the error was caused by user input
                      display:
                        type: string
                        enum:
                          - notification
                          - panel
                        description: Suggested UI display mode for the error
                    required:
                      - message
                      - statusCode
                required:
                  - error
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                        description: Detailed error message
                      code:
                        type: string
                        description: Machine-readable error code
                      overview:
                        type: string
                        description: Short human-friendly description
                      statusCode:
                        type: number
                        description: HTTP status code
                      origin:
                        type: string
                        description: Error source
                      skulabsTraceId:
                        type: string
                        description: Trace ID for support
                      type:
                        type: string
                        enum:
                          - error
                          - notice
                          - success
                        description: Error severity for UI handling
                      user_error:
                        type: boolean
                        description: Whether the error was caused by user input
                      display:
                        type: string
                        enum:
                          - notification
                          - panel
                        description: Suggested UI display mode for the error
                    required:
                      - message
                      - statusCode
                required:
                  - error
      security:
        - SKULabsToken: []
      servers:
        - url: https://api.skulabs.com
components:
  schemas:
    PurchaseOrder:
      type: object
      properties:
        _id:
          type: string
          description: Unique purchase order identifier
          example: 507f1f77bcf86cd799439011
        account_id:
          type: string
          description: Account ID
        number:
          type: string
          description: PO number
        distributor_id:
          type: string
          description: Distributor/vendor ID
        log:
          type: array
          items:
            $ref: '#/components/schemas/PurchaseOrderLogEntry'
          description: Activity log entries
        status:
          type: string
          enum:
            - closed
            - created
            - receiving
            - acknowledged
            - sent
            - edited
            - transit
            - accepting
          description: PO status
        items:
          type: array
          items:
            $ref: '#/components/schemas/PurchaseOrderItem'
          description: Line items
        custom_items:
          type: array
          items:
            type: object
            properties: {}
          description: Custom line items
        custom_adjustments:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                description: Adjustment type name
              amount:
                type: number
                description: Adjustment amount
            required:
              - name
              - amount
          description: Custom adjustments (fees, duties, etc.)
        tracking:
          type: array
          items:
            type: object
            properties: {}
          description: Tracking information
        subtotal:
          type: number
          description: Subtotal amount
        total:
          type: number
          description: Total amount
        tax:
          type: number
          description: Tax amount
        tax_per:
          type: number
          description: Tax percentage
        shipping:
          type: number
          description: Shipping cost
        discount:
          type: number
          description: Discount amount
        due_date:
          type: string
          nullable: true
          format: date
          description: Due date
          example: '2025-01-15'
        arrival_date:
          type: string
          nullable: true
          description: Expected arrival date
          example: '2025-01-15'
        closed_date:
          type: string
          nullable: true
          description: Date the PO was closed
          example: '2025-01-15'
        metadata:
          type: object
          properties: {}
          description: Additional metadata
        discount_per:
          type: number
          description: Discount percentage
        tags:
          type: array
          items:
            type: string
          description: Array of tag IDs (ObjectId strings referencing the tag collection)
          example:
            - 507f1f77bcf86cd799439011
            - 507f1f77bcf86cd799439012
        store_id:
          type: string
          description: Associated store ID
          example: 507f1f77bcf86cd799439011
        warehouse_id:
          type: string
          description: Destination warehouse ID
        memo:
          type: string
          nullable: true
          description: PO memo
        currency:
          type: string
          description: Currency code
        terms:
          type: string
          nullable: true
          description: Payment terms
        method:
          type: string
          nullable: true
          description: Payment method
        order_number:
          type: string
          description: Associated order number
        dropship_address:
          type: object
          properties: {}
          description: Dropship address
        dropshipped:
          type: boolean
          description: Whether this PO is dropshipped
        bol_pro_numbers:
          type: array
          items:
            type: string
          description: BOL/PRO numbers
      required:
        - _id
        - number
        - status
    PurchaseOrderLogEntry:
      type: object
      properties:
        user_id:
          type: string
          nullable: true
          description: User ID who performed the action
          example: 507f1f77bcf86cd799439011
        action:
          type: string
          description: >-
            Action type (created, edited, accepted, added tag, removed tag,
            etc.)
        details:
          type: object
          properties: {}
          description: Additional details about the action
        time:
          type: string
          description: ISO 8601 timestamp of the action
          example: '2025-01-15T12:00:00.000Z'
    PurchaseOrderItem:
      type: object
      properties:
        item_id:
          type: string
          description: Item ID
        kit_id:
          type: string
          description: Kit ID (when the PO line is a kit)
        sku:
          type: string
          description: Item SKU
        name:
          type: string
          description: Item name
        quantity:
          type: number
          description: Ordered quantity
        received:
          type: number
          description: Received quantity
        cost:
          type: number
          description: Unit cost
        rate:
          type: number
          description: Unit rate
        type:
          type: string
          enum:
            - item
            - kit
          description: Line item type
        serial_numbers:
          type: array
          items:
            type: string
          description: Serial/lot numbers received
        description:
          type: string
          description: Item description/notes
        unit:
          type: string
          description: Unit of measure
  securitySchemes:
    SKULabsToken:
      type: http
      scheme: bearer
      bearerFormat: JWT

````