---
title: "List sales orders"
method: GET
path: "/sales_orders"
tags: ["Sales Orders"]
---

# List sales orders

`GET /sales_orders`

**Plan: Paid API.**

## Query parameters

- `page` integer
- `per_page` integer

## Response `200`

OK

- object
  - `stats` PaginationStats — Pagination metadata attached as `stats` (or `meta` on assets) to index responses. The **quotes** list uses a different block - see `QuoteListStats`.
    - `totalCount` integer
    - `page` integer
    - `perPage` integer
    - `totalPages` integer
    - `prevPage` integer, nullable
    - `nextPage` integer, nullable
    - `outOfRange` boolean
  - `salesOrders` SalesOrderListItem[]
    - `id` string, uuid
    - `name` string
    - `title` string
    - `txnNumber` string
    - `txnDate` string, date, nullable
    - `dueDate` string, date, nullable
    - `shippingDate` string, date, nullable
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
    - `invoiced` number, nullable — Invoiced ratio (0..1).
    - `lastInvoicedOn` string, date, nullable
    - `shippingTracking` string, nullable
    - `shippingAddressName` string, nullable
    - `shippingAddressStreet` string, nullable
    - `shippingAddressStreet1` string, nullable
    - `shippingAddressCity` string, nullable
    - `shippingAddressState` string, nullable
    - `shippingAddressZip` string, nullable
    - `shippingAddressCountry` string, nullable
    - `billingAddressName` string, nullable
    - `billingAddressStreet` string, nullable
    - `billingAddressStreet1` string, nullable
    - `billingAddressCity` string, nullable
    - `billingAddressState` string, nullable
    - `billingAddressZip` string, nullable
    - `billingAddressCountry` string, nullable
    - `workflowState` string, nullable
    - `totalPriceWithTaxInDollars` number, nullable — US dollars.
    - `totalPaymentsInDollars` number, nullable — US dollars.
    - `balanceInDollars` number, nullable — US dollars.
    - `setupChargesInDollars` number, nullable — US dollars.
    - `setupChargesTaxInDollars` number, nullable — US dollars.
    - `setupChargesTaxable` boolean, nullable
    - `miscChargesInDollars` number, nullable — US dollars.
    - `miscChargesTaxInDollars` number, nullable — US dollars.
    - `miscChargesTaxable` boolean, nullable
    - `miscChargesLabel` string, nullable
    - `shippingChargesInDollars` number, nullable — US dollars.
    - `shippingChargesTaxInDollars` number, nullable — US dollars.
    - `shippingChargesTaxable` boolean, nullable
    - `financeChargesInDollars` number, nullable — US dollars.
    - `financeChargesTaxInDollars` number, nullable — US dollars.
    - `financeChargesTaxable` boolean, nullable
    - `lineItemsCount` integer
    - `lineItemsJobsCount` integer
    - `customerPoNumber` string, nullable
    - `customerPoDate` string, date, nullable
    - `lastNote` string, nullable
    - `lastEmailedDate` string, nullable
    - `pm` Party — A person reference (sales rep, PM, designer) with initials.
      - `id` string, uuid
      - `name` string, nullable
      - `initials` string, nullable
    - `projectManager` Party — A person reference (sales rep, PM, designer) with initials.
      - `id` string, uuid
      - `name` string, nullable
      - `initials` string, nullable
    - `designer` Party — A person reference (sales rep, PM, designer) with initials.
      - `id` string, uuid
      - `name` string, nullable
      - `initials` string, nullable
    - `primaryContact` ContactRef — Contact reference returned by some transactions (name, phone, id - no initials).
      - `id` string, uuid
      - `name` string, nullable
      - `phoneWithExt` string, nullable
    - `primarySalesRep` Party — A person reference (sales rep, PM, designer) with initials.
      - `id` string, uuid
      - `name` string, nullable
      - `initials` string, nullable
    - `company` NamedRef — Lightweight reference to a related record.
      - `id` string, uuid
      - `name` string
    - `project` NamedRef — Lightweight reference to a related record.
      - `id` string, uuid
      - `name` string

## Other responses

- `401` — Missing/expired credentials, an index request without a required filter, or the plan does not include this endpoint.

---

[API](https://skmtc.net/shopvox/apis/shopvox-public-api.md) · [All operations](https://skmtc.net/shopvox/apis/shopvox-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shopvox/shopvox-public-api/revisions/7ac1ff5d444a/schema)