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

# List orders

> Returns the vendor's orders, newest first. Use `cursor` with the `next_cursor` from the previous response to page through them.



## OpenAPI

````yaml /openapi.json get /api/vendor/v1/orders
openapi: 3.1.0
info:
  title: UrbnBox integration API
  version: 1.0.0
  description: >-
    Create and track delivery orders, send parcels between pickup points, and
    connect Shopify.
servers:
  - url: https://portal.urbnbox.io
    description: UrbnBox production and test-key server
security: []
tags:
  - name: Shipments
    description: Quote, create, and retrieve pickup-point shipments.
  - name: Checkout sessions
    description: Hold lockers for partner checkout sessions.
  - name: Public bookings
    description: Create browser-based locker bookings.
  - name: Store discovery
    description: Find active UrbnBox stores.
  - name: Shopify
    description: Callbacks called by Shopify.
  - name: Vendor API
    description: >-
      Vendor-authenticated endpoints for delivery orders, pickup-point shipments
      and webhooks. All require an X-API-Key header with a vendor key.
paths:
  /api/vendor/v1/orders:
    get:
      tags:
        - Vendor API
      summary: List orders
      description: >-
        Returns the vendor's orders, newest first. Use `cursor` with the
        `next_cursor` from the previous response to page through them.
      parameters:
        - name: page_size
          in: query
          schema:
            type: integer
            enum:
              - 10
              - 25
              - 50
              - 100
            default: 25
          description: Orders per page
        - name: cursor
          in: query
          schema:
            type: string
          description: The `next_cursor` value from the previous response
      responses:
        '200':
          description: Paginated order list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedOrders'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    PaginatedOrders:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/VendorOrder'
        page_size:
          type: integer
        next_cursor:
          type: string
          description: Pass as `cursor` for the next page. Empty on the last page
    VendorOrder:
      type: object
      description: Order fields are returned with capitalised names.
      properties:
        ID:
          type: string
        Status:
          type: string
          enum:
            - draft
            - confirmed
            - assigned
            - packing
            - dispatched
            - delivered
            - cancelled
        FulfillmentType:
          type: string
        ClientName:
          type:
            - string
            - 'null'
        ClientPhone:
          type:
            - string
            - 'null'
        Address:
          type:
            - string
            - 'null'
        ClientLat:
          type:
            - number
            - 'null'
        ClientLng:
          type:
            - number
            - 'null'
        ScheduledAt:
          type:
            - string
            - 'null'
          format: date-time
        TotalKES:
          type: integer
          description: Items plus delivery fee, in whole KES
        DeliveryFeeKES:
          type: integer
          description: Whole KES
        PublicToken:
          type: string
        IsCOD:
          type: boolean
        CODAmountKES:
          type:
            - integer
            - 'null'
        CreatedAt:
          type: string
          format: date-time
        UpdatedAt:
          type: string
          format: date-time
  responses:
    Unauthorized:
      description: The credential is missing, invalid, or inactive.
      content:
        text/plain:
          schema:
            type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Vendor API key. Keys begin with the ubx_ prefix and identify vendor
        accounts.

````

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