> ## 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.

# Order - Get

> Retrieve a paginated list of orders with optional filtering by status, store, tags, and date ranges. Maximum page size: 100 (Standard), 250 (Pro), 500 (Enterprise).



## OpenAPI

````yaml get /order/get
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:
  /order/get:
    get:
      tags:
        - order
      summary: Order - Get
      description: >-
        Retrieve a paginated list of orders with optional filtering by status,
        store, tags, and date ranges. Maximum page size: 100 (Standard), 250
        (Pro), 500 (Enterprise).
      operationId: get_order_get
      parameters:
        - name: selector
          in: query
          required: true
          schema:
            type: object
            properties: {}
            description: Query selector object for filtering results
        - name: limit
          in: query
          required: false
          schema:
            type: number
            description: Max results to return
            example: 50
        - name: skip
          in: query
          required: false
          schema:
            type: number
            description: Number of results to skip
            example: 0
        - name: sort
          in: query
          required: false
          schema:
            type: object
            properties: {}
            description: 'Sort fields object, e.g. { "name": 1 }'
        - name: fields
          in: query
          required: false
          schema:
            type: object
            properties: {}
            description: 'Projection fields object, e.g. { "name": 1 }'
      responses:
        '200':
          description: Array of orders matching the query
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OrderListItem'
        '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:
    OrderListItem:
      type: object
      properties:
        _id:
          type: string
          description: Unique order identifier
          example: 507f1f77bcf86cd799439011
        store_id:
          type: string
          description: Store identifier
          example: 507f1f77bcf86cd799439011
        order_number:
          type: string
          description: Order number
        status:
          type: string
          enum:
            - unstarted
            - in_progress
            - shipped
            - cancelled
            - cleared
            - delayed
            - stopped
            - partially shipped
            - archived
            - awaiting fulfillment
            - pending
            - partially cleared
          description: Order status
        type:
          type: string
          enum:
            - manual
            - combined
            - split
            - combined_child
            - split_parent
          description: Order type
        items:
          type: array
          items:
            type: object
            properties: {}
          description: Cleared/scanned items array
        log:
          type: array
          items:
            $ref: '#/components/schemas/OrderLogEntry'
          description: Order log entries
        scans:
          type: array
          items:
            $ref: '#/components/schemas/OrderScan'
          description: Scan records
        fulfillments:
          type: array
          items:
            $ref: '#/components/schemas/OrderFulfillment'
          description: Fulfillment records
        transactions:
          type: array
          items:
            $ref: '#/components/schemas/OrderTransaction'
          description: Transaction records
        returns:
          type: array
          items:
            $ref: '#/components/schemas/OrderReturn'
          description: Returns
        notes:
          type: array
          items:
            $ref: '#/components/schemas/OrderNote'
          description: Order notes
        tags:
          type: array
          items:
            type: string
          description: Array of tag IDs (ObjectId strings referencing the tag collection)
          example:
            - 507f1f77bcf86cd799439011
            - 507f1f77bcf86cd799439012
        stash:
          $ref: '#/components/schemas/OrderStash'
        location:
          type: string
          description: Assigned location name
        batch_number:
          type: number
          nullable: true
          description: Batch number
        channel_status:
          type: string
          nullable: true
          description: Channel-reported status
    OrderLogEntry:
      type: object
      properties:
        user_id:
          type: string
          nullable: true
          description: User ID who performed the action
          example: 507f1f77bcf86cd799439011
        action:
          type: string
          description: Action performed (e.g. shipped, cancelled, overrode)
        time:
          type: string
          description: ISO timestamp of the action
          example: '2025-01-15T12:00:00.000Z'
        details:
          nullable: true
          description: Additional details about the action
    OrderScan:
      type: object
      properties:
        _id:
          type: string
          description: Scan ID
          example: 507f1f77bcf86cd799439011
        user_id:
          type: string
          description: User who performed the scan
          example: 507f1f77bcf86cd799439011
        barcode_id:
          type: string
          description: Barcode ID scanned
        item_id:
          type: string
          description: Item ID
        variant_id:
          type: string
          description: Variant ID
        time:
          type: string
          description: Scan time
          example: '2025-01-15T12:00:00.000Z'
        skipped:
          type: boolean
          description: Whether the scan was skipped
        out_of_stock:
          type: boolean
          description: Whether item was out of stock
        note:
          type: string
          description: Scan note (e.g. serial number)
        quantity:
          type: number
          description: Quantity scanned
        deducted:
          type: boolean
          description: Whether inventory was deducted
        location_id:
          type: string
          description: Location ID
        line_id:
          type: string
          description: Line item ID
    OrderFulfillment:
      type: object
      properties:
        _id:
          type: string
          description: Fulfillment ID
          example: 507f1f77bcf86cd799439011
        status:
          type: string
          description: Fulfillment status
        tracking_number:
          type: string
          description: Tracking number
        tracking_url:
          type: string
          description: Tracking URL
    OrderTransaction:
      type: object
      properties:
        _id:
          type: string
          description: Transaction ID
          example: 507f1f77bcf86cd799439011
        amount:
          type: number
          description: Transaction amount
        kind:
          type: string
          description: Transaction kind
        status:
          type: string
          description: Transaction status
    OrderReturn:
      type: object
      properties:
        _id:
          type: string
          description: Return ID
          example: 507f1f77bcf86cd799439011
        rma_number:
          type: string
          description: RMA number
        status:
          type: string
          description: Return status
        items:
          type: array
          items:
            type: object
            properties: {}
          description: Returned items
    OrderNote:
      type: object
      properties:
        _id:
          type: string
          description: Note ID
          example: 507f1f77bcf86cd799439011
        user_id:
          type: string
          description: User who created the note
          example: 507f1f77bcf86cd799439011
        time:
          type: string
          description: Note creation time
          example: '2025-01-15T12:00:00.000Z'
        note:
          type: string
          description: Note text
        type:
          type: string
          enum:
            - internal
            - customer_facing
          description: Note type
    OrderStash:
      type: object
      properties:
        store_id:
          type: string
          description: Store ID
          example: 507f1f77bcf86cd799439011
        id:
          type: string
          description: Order ID from the channel
        date:
          type: string
          description: Order date
          example: '2025-01-15'
        items:
          type: array
          items:
            $ref: '#/components/schemas/StashItem'
          description: Line items from the channel
        shipping_information:
          $ref: '#/components/schemas/ShippingInformation'
        total:
          type: number
          description: Order total
        tax:
          type: number
          description: Tax amount
        shipping:
          type: number
          description: Shipping cost
        discount:
          type: number
          description: Discount amount
        notes:
          type: string
          description: Channel notes
        alternate_order_id:
          type: string
          description: Alternate order identifier
        order_id:
          type: string
          description: Raw order ID from channel
        currency:
          type: string
          description: Currency code
      description: Channel data stash
    StashItem:
      type: object
      properties:
        id:
          type: string
          description: Listing item ID
        variant_id:
          type: string
          description: Variant ID
        lineName:
          type: string
          description: Line item name
        quantity:
          type: number
          description: Quantity ordered
        price:
          type: number
          description: Unit price
        sku:
          type: string
          description: SKU of the listing
        line_id:
          type: string
          description: Unique line item ID
        metadata:
          nullable: true
          description: Additional line item metadata
        dropshipped:
          type: boolean
          description: Whether this item is dropshipped
    ShippingInformation:
      type: object
      properties:
        name:
          type: string
          description: Recipient name
        email:
          type: string
          description: Email address
        address:
          type: string
          description: Street address line 1
        street2:
          type: string
          description: Street address line 2
        city:
          type: string
          description: City
        state:
          type: string
          description: State or province
        zip:
          type: string
          description: Postal or ZIP code
        country:
          type: string
          description: Country code
        phone:
          type: string
          description: Phone number
        company:
          type: string
          description: Company name
        method:
          type: string
          description: Shipping method
        is_residential:
          type: boolean
          description: Whether the address is residential
        is_valid:
          type: boolean
          description: Whether the address has been validated
        hash:
          type: string
          description: Address validation hash
        address_type:
          type: string
          nullable: true
          description: Address type classification
        address_validation_data:
          type: object
          properties: {}
          description: Address validation result data
      description: Shipping address and info
  securitySchemes:
    SKULabsToken:
      type: http
      scheme: bearer
      bearerFormat: JWT

````