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

# Get shipment statistics summary

> Get shipment statistics summary. Requires the READ_SHIPPING scope.

Returns aggregate counts of the store's shipments grouped into a small summary: total shipments, pending (pending or in transit), delivered, and canceled (failed or returned). Requires the `READ_SHIPPING` scope.


## OpenAPI

````yaml GET /shipping/stats
openapi: 3.1.0
info:
  title: Salesive Apps API — Shipping & Fulfillment
  version: 1.0.0
  description: >-
    Manage shipping options, live courier rates, shipments and labels, and the
    ShipDay delivery integration from an installed third-party app. Every
    endpoint authenticates with an installed-app access token (prefix `app_`)
    and requires a specific OAuth scope. The target store is bound to the token
    server-side from the installation — never send a shop id.
servers:
  - url: https://api.salesive.com/api/v1
    description: Production
security:
  - AppToken: []
paths:
  /shipping/stats:
    get:
      tags:
        - Shipping
      summary: Get shipment statistics summary
      description: >-
        Returns aggregate counts of the store's shipments grouped into a small
        summary: total shipments, pending (pending or in transit), delivered,
        and canceled (failed or returned). Requires the `READ_SHIPPING` scope.
      operationId: getShipmentStats
      responses:
        '200':
          description: Get shipment statistics summary.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/EnvelopeBase'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/ShipmentStats'
              example:
                status: 200
                success: true
                message: Get shipment statistics summary
                data:
                  total: 42
                  pending: 12
                  delivered: 27
                  canceled: 3
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    EnvelopeBase:
      type: object
      description: >-
        Standard Salesive response envelope. The operation-specific payload is
        carried in `data`.
      required:
        - status
        - success
        - message
      properties:
        status:
          type: integer
          description: HTTP status code, echoed in the body.
        success:
          type: boolean
          description: Whether the request succeeded.
        message:
          type: string
          description: Human-readable result message.
    ShipmentStats:
      type: object
      description: Aggregate shipment counts for the store.
      properties:
        total:
          type: integer
          description: Total shipments.
        pending:
          type: integer
          description: Pending or in-transit shipments.
        delivered:
          type: integer
          description: Delivered shipments.
        canceled:
          type: integer
          description: Failed or returned shipments.
    Envelope:
      allOf:
        - $ref: '#/components/schemas/EnvelopeBase'
        - type: object
          properties:
            data:
              description: Operation-specific payload (object, array, or null).
  responses:
    Unauthorized:
      description: Missing or invalid app access token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Envelope'
          example:
            status: 401
            success: false
            message: Authentication required
            data: null
    Forbidden:
      description: The app token is missing the OAuth scope required for this operation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Envelope'
          example:
            status: 403
            success: false
            message: Insufficient scope
            data: null
  securitySchemes:
    AppToken:
      type: http
      scheme: bearer
      description: >-
        Installed-app access token (prefix app_), issued by the OAuth install
        flow. The store is bound to the token server-side — never send a shop
        id.

````