Report sales orders by issue date

POST/v1/api/store/{team_slug}/report/sales_order

v1Operation ID v1_public_report_sales_order

Returns every sales order issued in the period, in full (v1 order shape), for your own reporting. Drafts and unsaved orders are left out.

Amounts are in thousandths, an older encoding (339750 is 339.75). An order's calc_* fields (calc_subtotal, calc_tax, calc_discount, calc_total) measure only what has been invoiced so far, and remain 0 until an invoice is created for the order. deposit_total is the deposit percentage ×1000, not an amount. See Money and quantities.

Permission

Needs the View Reports permission. Otherwise 403 with a bare { "message": "Insufficient Permission" } (no success or error envelope).

Business rules

• An order is in the period when its issue date is between start_date and end_date, inclusive.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team

Request body

application/json, required.

• end_datestring (date-time)required

  End of the period (ISO 8601), inclusive: send 23:59:59 to include the whole last day. In UTC, like start_date (an offset is dropped, not applied).

• start_datestring (date-time)required

  Start of the period (ISO 8601), inclusive, to the second: send the start of the day. Send it in UTC (Z): the date and time are compared with UTC as written and any offset is dropped, so 2026-10-01T00:00:00-05:00 means midnight UTC.

Response

200Successful response.

• dataarray of objectsrequired
  Fields of each item (36)

  • approval_statusstring | null

    requested, need-changes, approved, or null.

  • assigned_usersarray of objects

    People on the order.

    Fields of each item (3)

    • avatar_urlstring | null
    • idstring

      The user.

    • namestring
  • calc_deposit_totalinteger | number | string | null

    Deposit amount. Thousandths, an older encoding: 12500 is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities.

  • calc_discountinteger | number | string | null

    Invoiced discount; 0 until invoiced. Thousandths, an older encoding: 12500 is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities.

  • calc_subtotalinteger | number | string | null

    Invoiced line and shipping subtotal; 0 until the order is invoiced. Thousandths, an older encoding: 12500 is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities.

  • calc_taxinteger | number | string | null

    Invoiced tax; 0 until invoiced. Thousandths, an older encoding: 12500 is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities.

  • calc_totalinteger | number | string | null

    Invoiced total; 0 until the order is invoiced. Thousandths, an older encoding: 12500 is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities.

  • created_atstring (date-time) | null

    Created. ISO 8601 with offset, or null.

  • created_bystring | null

    Who created it.

  • cust_due_datestring (date-time) | null

    Customer due date. ISO 8601 with offset, or null.

  • customerobject | null

    The customer, as in Get a customer.

    Child fields (2)

    • idstring

      The customer.

    • namestring | null
  • customer_idstring | null

    The customer.

  • customer_po_numberstring | null
  • customer_portal_order_linkstring | null

    Customer portal link. It carries the customer's portal access: don't publish it.

  • customer_portal_payment_linkstring | null

    Customer portal payment page link, with the same access.

  • deposit_duestring (date-time) | null

    Deposit due. ISO 8601 with offset, or null.

  • deposit_requiredboolean
  • deposit_totalinteger | number | string | null

    The deposit percentage ×1000: 50000 is 50%. Not an amount.

  • due_datestring (date-time) | null

    Production due date. ISO 8601 with offset, or null.

  • full_amount_duestring (date-time) | null

    Full amount due. ISO 8601 with offset, or null.

  • idstring

    The order.

  • is_quoteboolean
  • is_rushboolean
  • issue_datestring (date-time) | null

    Issue date. ISO 8601 with offset, or null.

  • namestring | null
  • object_typestring | null

    sales_order or quote.

  • paid_amountinteger | number | string | null

    Paid so far. Thousandths, an older encoding: 12500 is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities.

  • payment_term_idstring | null

    Payment term.

  • scoped_idstring | null

    The order number.

  • ship_due_datestring (date-time) | null

    Ship-by date. ISO 8601 with offset, or null.

  • start_datestring (date-time) | null

    Production start. ISO 8601 with offset, or null.

  • statusobject

    A status: label, kind and place in the list.

    Child fields (9)

    • colorstring | null

      Hex color.

    • customer_labelstring
    • idstring

      The status.

    • labelstring
    • pipeline_idstring

      Only on the statuses of a task preset (role pipeline): the task preset. Absent on other statuses.

    • positioninteger

      Its place in the team's list: sort by it to find the next status.

    • rolestring

      Which list it belongs to: job for job statuses, pipeline for the statuses of a task preset.

      • One of: "order", "quote", "job", "purchase_order", "shipment", "customer_message", "pipeline"
    • trashedboolean

      The status was deleted.

    • typestring

      The kind of status: start (Pending), pre_production and in_progress (In Progress), end (Completed).

      • One of: "start", "pre_production", "in_progress", "end"
  • status_idstring | null

    The order status.

  • tagsarray of objects

    The order's tags.

    Fields of each item (3)

    • color_hexstring | null
    • idstring

      The tag.

    • namestring
  • unique_keystring | null
  • warehouse_idstring | null

    Warehouse.

• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

  When

  Your role lacks View Reports.

  Fix

  Ask the team owner to turn on View Reports for your permission group.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

• 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

  When

  start_date or end_date is missing or not ISO 8601.

  Fix

  Send both as ISO 8601 date-times.

Notes

• There is no paging: the whole period comes back in one response. Ask for a month or less at a time.

Related

• POSTReport quotes by issue date/v1/api/store/{team_slug}/report/quote
• POSTReport payments and refunds/v1/api/store/{team_slug}/report/payment
• POSTReport invoices of orders paid in full/v1/api/store/{team_slug}/report/tax

Example request

curl

curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/report/sales_order' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "end_date": "2026-11-30T23:59:59Z",    "start_date": "2026-11-01T00:00:00Z"  }'

Example response 200

Response

{
  "data": [
    {
      "approval_status": null,
      "assigned_users": [
        {
          "avatar_url": null,
          "id": "4mdDkMg3dgQOa3",
          "name": "Alex Rivera"
        }
      ],
      "calc_deposit_total": 169880,
      "calc_discount": 0,
      "calc_subtotal": 315000,
      "calc_tax": 24750,
      "calc_total": 339750,
      "created_at": "2026-11-02T15:00:00+00:00",
      "created_by": "4mdDkMg3dgQOa3",
      "cust_due_date": "2026-11-10T00:00:00+00:00",
      "customer": {
        "id": "ifAHmADekGZ6id",
        "name": "Northwind Apparel"
      },
      "customer_id": "ifAHmADekGZ6id",
      "customer_po_number": null,
      "customer_portal_order_link": "https://example.com/portal/order",
      "customer_portal_payment_link": "https://example.com/portal/pay",
      "deposit_due": "2026-11-05T00:00:00+00:00",
      "deposit_required": true,
      "deposit_total": 50000,
      "due_date": "2026-11-06T17:00:00+00:00",
      "full_amount_due": "2026-11-20T00:00:00+00:00",
      "id": "sFbALVSYD55eXe",
      "is_quote": false,
      "is_rush": false,
      "issue_date": "2026-11-02T00:00:00+00:00",
      "name": "Team shirts",
      "object_type": "sales_order",
      "paid_amount": 100000,
      "payment_term_id": null,
      "scoped_id": "SO1001",
      "ship_due_date": "2026-11-08T00:00:00+00:00",
      "start_date": "2026-11-04T09:00:00+00:00",
      "status": {
        "color": "#2196f3",
        "customer_label": "In Progress",
        "id": "wgbOT87gGZvhgy",
        "label": "In production",
        "position": 2,
        "role": "order",
        "trashed": false,
        "type": "in_progress"
      },
      "status_id": "wgbOT87gGZvhgy",
      "tags": [],
      "unique_key": "ord_EXAMPLEuniqueKey",
      "warehouse_id": null
    }
  ],
  "status": 200,
  "success": true
}