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

# Summarise order updates

> What order updates delivered for this store — reach, cost and engagement

**Required scope:** `crm.view`


## OpenAPI

````yaml /api-reference/openapi.json get /crm/connections/{id}/order-updates/summary
openapi: 3.0.3
info:
  title: Pineyard API
  version: 1.0.0
  description: >-
    Programmatic access to agents, campaigns, calls, phone numbers, WhatsApp and
    results in your Pineyard workspace.
servers:
  - url: https://api.pineyard.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /crm/connections/{id}/order-updates/summary:
    get:
      summary: Summarise order updates
      description: What order updates delivered for this store — reach, cost and engagement
      parameters:
        - schema:
            type: string
          required: true
          name: id
          in: path
        - schema:
            type: integer
            minimum: 0
            exclusiveMinimum: true
            maximum: 365
          required: false
          name: days
          in: query
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  orders:
                    type: integer
                    minimum: 0
                  ordersWithPhone:
                    type: integer
                    minimum: 0
                  ordersNotified:
                    type: integer
                    minimum: 0
                  attempted:
                    type: integer
                    minimum: 0
                  delivered:
                    type: integer
                    minimum: 0
                  read:
                    type: integer
                    minimum: 0
                  failed:
                    type: integer
                    minimum: 0
                  clicks:
                    type: integer
                    minimum: 0
                  replies:
                    type: integer
                    minimum: 0
                  spend:
                    type: number
                    minimum: 0
                  costPerNotifiedOrder:
                    type: number
                    nullable: true
                    minimum: 0
                  medianMinutesToFirstUpdate:
                    type: number
                    nullable: true
                    minimum: 0
                  optOuts:
                    type: integer
                    minimum: 0
                  shippedNotified:
                    type: integer
                    minimum: 0
                  notifiedValue:
                    type: number
                    minimum: 0
                  totalValue:
                    type: number
                    minimum: 0
                  currencies:
                    type: array
                    items:
                      type: string
                  codOrders:
                    type: integer
                    minimum: 0
                required:
                  - orders
                  - ordersWithPhone
                  - ordersNotified
                  - attempted
                  - delivered
                  - read
                  - failed
                  - clicks
                  - replies
                  - spend
                  - costPerNotifiedOrder
                  - medianMinutesToFirstUpdate
                  - optOuts
                  - shippedNotified
                  - notifiedValue
                  - totalValue
                  - currencies
                  - codOrders
        '400':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.

            - `invalid_body`: The request body (or query) failed validation.
            Details are in `issues` (or `detail`). `422` on `POST
            /v1/campaigns/{campaignId}/leads`.
        '401':
          description: >-
            - `invalid_api_key`: The API key is unknown, revoked or expired, or
            its workspace was deleted.

            - `unauthorized`: No `Authorization: Bearer` header, or an empty
            token.
        '403':
          description: >-
            - `api_key_not_scoped`: A key issued without scopes was used outside
            `/v1`.

            - `api_key_owner_inactive`: The member the key acts for was removed
            or suspended.

            - `forbidden`: The key lacks the permission named in
            `requiredPermission`, or the resource belongs to another workspace.

            - `workspace_pending_approval`: The workspace has not been approved
            yet.

            - `workspace_suspended`: The workspace is suspended.
        '404':
          description: >-
            - `crm_connection_not_found`: CRM connection not found (400 on
            campaign create: missing or not ACTIVE; 404 on CRM routes).

            - `not_found`: The resource does not exist in your workspace, or the
            feature is not enabled for it.
        '413':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '429':
          description: '- `rate_limited`: Too many requests.'
        '500':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '502':
          description: >-
            - `provider_error`: The calling service rejected the request
            (`upstreamStatus` 4xx) or was unavailable (5xx).
        '503':
          description: '- `database_unavailable`: The service is temporarily unavailable.'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. `pk_live_xxxxxxxxxxxxxxxxxxxxxxxx`.

````

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