title: Shipping options
domain: store
routes:
  - method: GET
    path: /shipping-options
route: /shipping-options
description: >
  A shipping option represents a delivery method for products and belongs to a region.
endpoints:
  - path: /
    method: GET
    title: List shipping options
    params:
      - name: product_ids
        optional: true
        type: String
        description: String of product ids. Id's needs to be separated by comma.
      - name: region_id
        type: String
        description: Id of region
    description: >
      Retrieves shipping options in a given region. Shipping options for specific products can be retrieved using the `product_ids` query param.

response: |
  {
    "region": {
      "id": "reg_HMnixPlOicAs7aBlXuchAGxd",
      "name": "Denmark",
      "currency_code": "DKK",
      "currency": "DKK",
      "tax_rate": 0.25,
      "tax_code": null,
      "countries": [{
        "id": "1001",
        "iso_2": "DK",
        "iso_3": "DNK",
        "num_code": "208",
        "name": "denmark",
        "display_name": "Denmark"
      }],
      "payment_providers": [{
        "id": "stripe",
        "is_installed": true
      }],
      "fulfillment_providers": [{
        "id": "manual",
        "is_installed": true
      }],
      "created_at": "2020-12-11T17:03:54.458Z",
      "updated_at": "2020-12-11T17:03:54.458Z",
      "metadata": null
    }
  }