List purchase orders

Retrieve a list of purchase orders with pagination and filtering options. Results are filtered to purchase orders the authenticated user has access to.

Query Parameters

limitinteger

Maximum number of items to return per page

Default: 10Minimum: 1Maximum: 100

pageinteger

Page number for pagination

Default: 1Minimum: 1

searchstring

Search term to filter purchase orders by name, supplier name, tracking number, reference number, or product details

cursorstring

Cursor for pagination (alternative to page-based pagination)

sortBystring

Field to sort by (e.g., createdAt, updatedAt, name, status, expectedDate, supplier.name, warehouse.name)

sortOrderstring

Order to sort by

Default: "desc"Value in: "asc" | "desc"

statusstring

Filter purchase orders by status

supplierIdstring

Filter purchase orders by supplier ID

Format: "uuid"

warehouseIdstring

Filter purchase orders by warehouse ID

Format: "uuid"

childOrdersboolean

Whether to include purchase orders from child organizations

Default: false

includeArchivedboolean

Whether to include archived purchase orders

Default: false

fromstring

Start date for filtering purchase orders by creation date

Format: "date"

tostring

End date for filtering purchase orders by creation date

Format: "date"

curl -X GET "https://www.shipsidekick.com/api/v1/purchase-orders?limit=10&page=1&search=string&cursor=string&sortBy=string&sortOrder=asc&status=draft&supplierId=497f6eca-6276-4993-bfeb-53cbbbba6f08&warehouseId=497f6eca-6276-4993-bfeb-53cbbbba6f08&from=2019-08-24&to=2019-08-24"

Successful operation

{
  "object": "list",
  "data": [
    {
      "id": "po-1234-5678-9abc-def0-123456789012",
      "organizationId": "org-5678-1234-abcd-efgh-987654321000",
      "name": "#PO-12345",
      "status": "confirmed",
      "supplierId": "supplier-1234-5678-9abc-def012345678",
      "subtotal": 1500,
      "totalTax": 150,
      "grandTotal": 1650,
      "currency": "usd",
      "trackingNumber": "1Z999AA1234567890",
      "referenceNumber": "REF-12345",
      "shippingCarrier": "UPS",
      "expectedDate": "2024-02-15T10:00:00Z",
      "createdAt": "2024-01-15T10:00:00Z",
      "updatedAt": "2024-01-16T14:30:00Z",
      "cancelledAt": null,
      "supplier": {
        "id": "supplier-1234-5678-9abc-def012345678",
        "name": "ACME Corp"
      },
      "warehouse": {
        "id": "warehouse-1234-5678-9abc-def012345678",
        "name": "Main Warehouse"
      },
      "lineItems": [
        {
          "id": "line-item-1234-5678-9abc-def012345678",
          "productVariantId": "variant-1234-5678-9abc-def012345678",
          "requestedQuantity": 10,
          "unitPrice": 150,
          "subtotal": 1500,
          "productVariant": {
            "title": "Widget Pro",
            "sku": "WIDGET-PRO-001"
          }
        }
      ],
      "tags": [],
      "notes": []
    }
  ],
  "hasMore": false,
  "totalCount": 1,
  "limit": 10
}

List purchase orders

Query Parameters

Example response with multiple purchase orders

TypeScript