> ## 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 shipping options

> Retrieve available shipping options for a specific address and order.

## Request

```http theme={null}
GET /shipping/options?shippingAddressId=6938e4f0019a97bc42775b59&orderId=6a27d632289b87893fcbde35
Authorization: Bearer {{token}}
x-shop-id: {{shopId}}
```

## Headers

| Header          | Type   | Description                                              |
| --------------- | ------ | -------------------------------------------------------- |
| `Authorization` | string | Provide the customer token in the format `Bearer <jwt>`. |
| `x-shop-id`     | string | Identify the shop that owns the order.                   |

## Query parameters

| Parameter           | Type   | Required | Description                                                |
| ------------------- | ------ | -------- | ---------------------------------------------------------- |
| `shippingAddressId` | string | Yes      | The shipping address ID to calculate shipping options for. |
| `orderId`           | string | Yes      | The order ID to calculate shipping costs against.          |

## Successful response

```json theme={null}
{
    "status": 200,
    "success": true,
    "message": "Available shipping options retrieved",
    "data": [
        {
            "_id": "69f8f047f5d9d8178331ec8a",
            "name": "Standard Delivery",
            "description": "Delivered within 3-5 business days.",
            "type": "manual",
            "price": 5000,
            "couriers": [],
            "enabled": true,
            "deleted": false,
            "deletedAt": null,
            "shop": "68b8f52575da81b332af29f1",
            "pickupAddress": null,
            "validatedAddress": null,
            "createdAt": "2026-05-04T19:15:19.313Z",
            "updatedAt": "2026-05-04T19:15:19.313Z",
            "__v": 0
        }
    ]
}
```

## Error response

```json theme={null}
{
    "status": 400,
    "success": false,
    "message": "\"shippingAddressId\" is required",
    "data": {}
}
```


## OpenAPI

````yaml GET /shipping/options
openapi: 3.1.0
info:
  title: Salesive Store API
  description: >-
    REST interface for querying products, categories, and merchandising banners
    exposed by Salesive storefronts.
  version: 1.0.0
servers:
  - description: Production
    url: https://store.salesive.com/api/v1
security:
  - BearerAuth: []
    ShopIdHeader: []
paths:
  /shipping/options:
    get:
      summary: Get shipping options
      description: Retrieve available shipping options for a specific address and order.
      parameters:
        - $ref: '#/components/parameters/XShopIdHeader'
        - name: shippingAddressId
          in: query
          required: true
          description: The shipping address ID to calculate shipping options for.
          schema:
            type: string
        - name: orderId
          in: query
          required: true
          description: The order ID to calculate shipping costs for.
          schema:
            type: string
      responses:
        '200':
          description: Shipping options retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingOptionsResponse'
        '401':
          description: Unauthorized.
        '404':
          description: Shipping address or order not found.
components:
  parameters:
    XShopIdHeader:
      name: x-shop-id
      in: header
      description: >-
        Optional identifier that scopes responses to a specific storefront when
        the referer cannot be inferred.
      required: false
      schema:
        type: string
  schemas:
    ShippingOptionsResponse:
      type: object
      required:
        - status
        - success
        - message
        - data
      properties:
        status:
          type: integer
        success:
          type: boolean
        message:
          type: string
        data:
          type: array
          items:
            $ref: '#/components/schemas/ShippingOption'
    ShippingOption:
      type: object
      required:
        - _id
        - name
        - carrier
        - estimatedDays
        - price
      properties:
        _id:
          type: string
          description: Shipping option identifier.
        name:
          type: string
          description: Name of the shipping option.
        carrier:
          type: string
          description: Carrier name (e.g., USPS, FedEx, DHL).
        estimatedDays:
          type: string
          description: Estimated delivery time.
        price:
          type: number
          description: Shipping cost.
        formattedPrice:
          type: string
          description: Formatted price string.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT issued by the Salesive Store API for authenticated shoppers.
    ShopIdHeader:
      type: apiKey
      in: header
      name: x-shop-id
      description: >-
        Optional storefront identifier sent as a header to scope responses to a
        specific shop. Try It requests remember this value once provided.

````