---
title: "GET /commerce/orders"
method: GET
path: "/commerce/orders"
tags: ["Commerce Orders"]
---

# GET /commerce/orders

`GET /commerce/orders`

Gets a list of orders for a business.

## Query parameters

- `businessName` string, required
- `serviceName` 'shopify' | 'square', required
- `offset` number
- `limit` number
- `orderBy` string
- `id` string
- `fulfillmentStatus` 'fulfilled' | 'partial' | 'unfulfilled' | 'cancelled' | 'unknown'
- `paymentStatus` 'pending' | 'approved' | 'paid' | 'failed' | 'cancelled' | 'refunded' | 'unknown'
- `status` 'open' | 'closed' | 'cancelled' | 'unknown' | 'draft'
- `startDate` string
- `endDate` string

## Response `200`

- GetOrderResponseDto
  - `pagination` PaginationMetaData, required
    - `offset` number, required
    - `limit` number, required
    - `count` number, required
  - `data` GetOrderData[], required
    - `id` string, required
    - `orderNumber` string
    - `fulfillmentRefs` FulfillmentRefs[]
      - `carrier` string
      - `trackingNumber` string
      - `service` string
      - `trackingUrl` string
    - `lines` Lines[]
      - `id` string
      - `balances` Balance[]
        - `amount` string, float
        - `date` string, date-time
      - `accountRef` AccountRef
        - `id` string, required
        - `name` string
      - `customerRef` AccountRef
        - `id` string, required
        - `name` string
      - `trackingCategoryRefs` TrackingCategoryResponse[]
        - `id` string
        - `name` string
        - `type` 'class' | 'department' | 'location' | 'unknown'
    - `refundRefs` RefundRefs[]
      - `id` string, required
      - `totalAmount` number, float, required
    - `transactionSourceRefs` OrderTransactionSourceRefs[]
      - `id` string, required
      - `type` 'failedPayout' | 'payment' | 'paymentFee' | 'paymentFeeRefund' | 'payout' | 'refund' | 'transfer' | 'dispute' | 'order' | 'other' | 'unknown'
      - `totalAmount` number, float, required
    - `shippingAddress` ShippingAddress
      - `line1` string
      - `line2` string
      - `city` string
      - `region` string
      - `country` string
      - `postalCode` string
    - `billingAddress` BillingAddress
      - `line1` string
      - `line2` string
      - `city` string
      - `region` string
      - `country` string
      - `postalCode` string
    - `customerRef` OrderCustomerRef
      - `id` string, required
      - `customerName` string
      - `email` string
    - `currencyRef` CommerceCurrencyRef
      - `id` string
      - `symbol` string, required
      - `name` string, required
    - `totalShippingAmount` number, float
    - `totalGratuityAmount` number, float
    - `totalDiscountAmount` number, float
    - `totalTaxAmount` number, float, required
    - `totalAmount` number, float, required
    - `createdDate` string, date-time, required
    - `sourceModifiedDate` string, date-time, required
    - `status` 'open' | 'closed' | 'cancelled' | 'unknown' | 'draft', required
    - `paymentStatus` 'pending' | 'approved' | 'paid' | 'failed' | 'cancelled' | 'refunded' | 'unknown', required
    - `fulfillmentStatus` 'fulfilled' | 'partial' | 'unfulfilled' | 'cancelled' | 'unknown', required
  - `count` number, required
  - `meta` BasicStartEndDateReportMetaData, required
    - `reportId` string[], required
    - `serviceName` 'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'myob' | 'zohoBooks' | 'byod', required
    - `businessName` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `startDate` string, date-time, required
    - `endDate` string, date-time, required

## Other responses

- `202` — Data in pending state
- `204` — No data available
- `400` — Bad Request Error - Thrown if fields sent via query does not follow specifications
- `401` — Unauthorized - Not logged in or log in expired
- `403` — Forbidden - Not enough permission
- `500` — Server Error

---

[API](https://skmtc.net/railz/apis/fis-accounting-data-as-a-service-api.md) · [All operations](https://skmtc.net/railz/apis/fis-accounting-data-as-a-service-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/railz/fis-accounting-data-as-a-service-api/revisions/5cdfae3fa1fa/schema)