> ## 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 a shipping option

> Get a shipping option. Requires the READ_SHIPPING scope.

Returns a single shipping option by id. The option must belong to the store bound to the app token. For `auto` options the store-level shipping configuration is merged into the result. Requires the `READ_SHIPPING` scope.


## OpenAPI

````yaml GET /shipping/options/{id}
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/options/{id}:
    get:
      tags:
        - Shipping
      summary: Get a shipping option
      description: >-
        Returns a single shipping option by id. The option must belong to the
        store bound to the app token. For `auto` options the store-level
        shipping configuration is merged into the result. Requires the
        `READ_SHIPPING` scope.
      operationId: getShippingOption
      parameters:
        - name: id
          in: path
          required: true
          description: ObjectId of the shipping option.
          schema:
            type: string
      responses:
        '200':
          description: Get a shipping option.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/EnvelopeBase'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/ShippingOption'
              example:
                status: 200
                success: true
                message: Get a shipping option
                data:
                  _id: 6650a1f2c3d4e5f601020304
                  name: Standard Shipping
                  description: 3-5 business day delivery
                  type: custom
                  price: 1500
                  match: all
                  couriers: []
                  triggers:
                    - type: totalAmount
                      operator: '>='
                      value: 10000
                  enabled: true
                  shop: 6630b2a1d4e5f60102030405
                  deleted: false
                  createdAt: '2026-05-20T10:00:00.000Z'
                  updatedAt: '2026-05-20T10:00:00.000Z'
        '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.
    ShippingOption:
      type: object
      description: >-
        A configured shipping option. For options of type `auto`, the
        store-level shipping configuration is merged into the object.
      additionalProperties: true
      properties:
        _id:
          type: string
          description: ObjectId of the shipping option.
        name:
          type: string
          description: Display name.
        description:
          type: string
          description: Description shown to shoppers.
        type:
          type: string
          description: Option type. One of `auto`, `manual`, or `custom`.
          enum:
            - auto
            - manual
            - custom
        price:
          type: number
          description: Flat shipping price (or live cost estimate for auto options).
        match:
          type: string
          description: How triggers combine.
          enum:
            - all
            - any
        couriers:
          type: array
          items:
            type: string
          description: Courier codes the option is restricted to.
        triggers:
          type: array
          items:
            $ref: '#/components/schemas/ShippingTrigger'
          description: Eligibility rules.
        enabled:
          type: boolean
          description: Whether the option is active.
        shop:
          type: string
          description: The store id (bound server-side).
        deleted:
          type: boolean
          description: Soft-delete flag.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    ShippingTrigger:
      type: object
      description: A single eligibility rule evaluated against the order context.
      additionalProperties: true
      properties:
        type:
          type: string
          description: What the rule tests.
          enum:
            - totalAmount
            - country
            - state
            - city
            - zipCode
            - distance
            - custom
        operator:
          type: string
          description: Comparison operator.
          enum:
            - '='
            - '!='
            - '>'
            - <
            - '>='
            - <=
            - in
            - notIn
            - contains
            - notContains
        value:
          description: >-
            Value to compare against (string, number, or array depending on
            operator).
        unit:
          type: string
          description: Optional unit (e.g. for distance rules).
        source:
          type: string
          description: Optional source field for the comparison.
        coordinates:
          type: object
          additionalProperties: true
          description: Optional coordinates for distance rules.
        metadata:
          type: object
          additionalProperties: true
          description: Optional free-form metadata.
    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.

````