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

# Create Picking List

> ### Authorization

Requires orders:read. API keys resolve organization scope from their credential; session callers include organizationId.

### PDF output

Create a private PDF picking list for 1–500 order UUIDs, trimmed and deduplicated in first-requested order. Missing or inaccessible orders fail the complete selection without creating a partial document. The same grouping, product quantities, SKU/variation and currency-labeled prices as the workspace Orders page are used. timeZone accepts an IANA time zone; omitted API requests use UTC. This does not arrange shipment or change orders.

The result contains structured list data, every orderId, a saved documentId and a signed HTTPS downloadUrl valid until expiresAt (five minutes). Generate a fresh list for a new download URL. Download the PDF and send it to your own printer; the API does not control local printers. PDF rendering may take up to 120 seconds.



## OpenAPI

````yaml /openapi.json post /api/v1/orders/picking-list
openapi: 3.1.0
info:
  title: OmniCommerce API
  version: 1.0.0
  license:
    name: Proprietary
    url: https://omnicommerce.sg/terms
  description: >-
    OmniCommerce API surface for agents and developer integrations. Includes
    public endpoints (merchant discovery, product search, compare, catalog, ACO
    retrieval) and authenticated endpoints (product management via API key
    Bearer tokens).
servers:
  - url: https://omnicommerce.sg
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
tags:
  - name: agentic-checkout
    description: Merchant-fulfilled agentic checkout
    x-group: Agentic Checkout
  - name: agents
    description: agents
    x-group: Agents
  - name: analytics
    description: Sales performance across marketplaces
    x-group: Analytics
  - name: aops
    description: Agent operating procedures
    x-group: AOPs
  - name: branding
    description: branding
    x-group: Branding
  - name: campaigns
    description: Campaign briefs, offer windows, and marketplace runs
    x-group: Campaigns
  - name: commerce
    description: commerce
    x-group: Commerce
  - name: developer-platform
    description: Authenticated developer platform APIs
    x-group: Developer Platform
  - name: documents
    description: Knowledge base document uploads
    x-group: Knowledge Base
  - name: inventory
    description: Inventory quantities, planning signals, and marketplace listing absence
    x-group: Inventory
  - name: looks
    description: AI-styled product looks
    x-group: Looks
  - name: oauth
    description: OAuth token endpoints
    x-group: OAuth
  - name: orders
    description: Workspace and agentic orders
    x-group: Orders
  - name: organizations
    description: Organization management
    x-group: Organizations
  - name: price-books
    description: Marketplace list-price markup rules
    x-group: Price Books
  - name: products
    description: Product CRUD, bulk import, enrichment, publish, and delist
    x-group: Products
  - name: promotions
    description: Central promotions and marketplace sync
    x-group: Promotions
  - name: public-agent
    description: Public agent discovery and catalog APIs
    x-group: Public Agent
  - name: returns
    description: returns
    x-group: Returns
  - name: reviews
    description: Marketplace product reviews and seller replies
    x-group: Reviews
  - name: settlements
    description: settlements
    x-group: Settlements
  - name: ucp
    description: Universal Commerce Protocol
    x-group: UCP
paths:
  /api/v1/orders/picking-list:
    post:
      tags:
        - orders
      summary: Create Picking List
      description: >-
        ### Authorization


        Requires orders:read. API keys resolve organization scope from their
        credential; session callers include organizationId.


        ### PDF output


        Create a private PDF picking list for 1–500 order UUIDs, trimmed and
        deduplicated in first-requested order. Missing or inaccessible orders
        fail the complete selection without creating a partial document. The
        same grouping, product quantities, SKU/variation and currency-labeled
        prices as the workspace Orders page are used. timeZone accepts an IANA
        time zone; omitted API requests use UTC. This does not arrange shipment
        or change orders.


        The result contains structured list data, every orderId, a saved
        documentId and a signed HTTPS downloadUrl valid until expiresAt (five
        minutes). Generate a fresh list for a new download URL. Download the PDF
        and send it to your own printer; the API does not control local
        printers. PDF rendering may take up to 120 seconds.
      operationId: post_v1_orders_picking_list
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                orderIds:
                  minItems: 1
                  maxItems: 500
                  type: array
                  items:
                    type: string
                    format: uuid
                    pattern: >-
                      ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                timeZone:
                  type: string
                  maxLength: 100
                organizationId:
                  description: >-
                    Session callers only. API keys resolve organization scope
                    from the credential.
                  type: string
                  minLength: 1
                  maxLength: 120
              required:
                - orderIds
              additionalProperties: false
      responses:
        '200':
          description: >-
            Request completed. Inspect data.success, per-target results and
            pendingCount for processing progress.
          content:
            application/json:
              schema:
                type: object
                required:
                  - ok
                  - apiVersion
                  - operationId
                  - status
                  - data
                  - links
                  - warnings
                  - recommendations
                properties:
                  ok:
                    type: boolean
                  apiVersion:
                    type: string
                  operationId:
                    type: string
                    format: uuid
                  status:
                    type: string
                    enum:
                      - completed
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                      orderIds:
                        type: array
                        items:
                          type: string
                          format: uuid
                          pattern: >-
                            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                      succeededCount:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      failedCount:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      documentIds:
                        type: array
                        items:
                          type: string
                      documentId:
                        type: string
                      fileName:
                        type: string
                      mimeType:
                        type: string
                        const: application/pdf
                      downloadUrl:
                        type: string
                        format: uri
                      expiresAt:
                        type: string
                        format: date-time
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                      results:
                        type: array
                        items:
                          type: object
                          properties:
                            orderId:
                              type: string
                              format: uuid
                              pattern: >-
                                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                            success:
                              type: boolean
                              const: true
                          required:
                            - orderId
                            - success
                      list:
                        type: object
                        properties:
                          storeLabel:
                            type: string
                          userLabel:
                            type: string
                          printedAtLabel:
                            type: string
                          orderQuantity:
                            type: number
                          productQuantity:
                            type: number
                          itemQuantity:
                            type: number
                          rows:
                            type: array
                            items:
                              type: object
                              properties:
                                productName:
                                  type: string
                                imageUrl:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                sku:
                                  type: string
                                variation:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                priceLabel:
                                  type: string
                                quantity:
                                  type: number
                                orderIds:
                                  type: array
                                  items:
                                    type: string
                              required:
                                - productName
                                - imageUrl
                                - sku
                                - variation
                                - priceLabel
                                - quantity
                                - orderIds
                        required:
                          - storeLabel
                          - userLabel
                          - printedAtLabel
                          - orderQuantity
                          - productQuantity
                          - itemQuantity
                          - rows
                    required:
                      - success
                      - orderIds
                      - succeededCount
                      - failedCount
                      - documentIds
                      - documentId
                      - fileName
                      - mimeType
                      - downloadUrl
                      - expiresAt
                      - results
                      - list
                  links:
                    type: object
                    additionalProperties:
                      type: string
                  warnings:
                    type: array
                    items:
                      type: string
                  recommendations:
                    type: array
                    items:
                      type: string
        '400':
          description: >-
            Invalid request, conflicting operations, singular arguments or a
            batch exceeding the endpoint limit.
        '401':
          description: Missing or invalid credentials.
        '403':
          description: >-
            Missing scope, organization mismatch, or a target outside the
            caller's assigned stores and markets.
        '429':
          description: Rate limit exceeded.
        '503':
          description: >-
            Service unavailable. Retry a submission with the same requestId and
            unchanged operations.
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Bearer API key for server-to-server access. Session auth is also
        supported in first-party UI flows.

````

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