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

# Get Free Shipping Option

Gets the current Store's Free Shipping option (if exists) whose Seller is associated with the user's bearer token making this API call.

Only works with the currently authenticated store.

[block:code]
{
  "codes": [
    {
      "code": "{\n    \"totalItems\": integer,\n    \"success\": true,\n    \"errors\": [],\n    \"results\": [\n        {\n            \"enabled\": boolean,\n            \"threshold\": integer,\n            \"shippingCategoryId\": integer\n        }\n    ]\n}",
      "language": "json",
      "name": "Response Template"
    },
    {
      "code": "{\n    \"totalItems\": 1,\n    \"success\": true,\n    \"errors\": [],\n    \"results\": [\n        {\n            \"enabled\": false,\n            \"threshold\": null,\n            \"shippingCategoryId\": null\n        }\n    ]\n}",
      "language": "json",
      "name": "Example Response #1"
    }
  ]
}
[/block]

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "v1.39.0",
    "title": "TcgApi"
  },
  "paths": {
    "/stores/{storeKey}/freeshipping/settings": {
      "get": {
        "tags": [
          "Stores"
        ],
        "summary": "Get Free Shipping Option",
        "description": "Gets the current Store's Free Shipping option (if exists) whose Seller is associated with the user's bearer token making this API call.",
        "operationId": "Stores_FreeShippingOptions",
        "parameters": [
          {
            "name": "storeKey",
            "in": "path",
            "description": "Required. A unique key used to identify the caller of the API.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "Used for paging. The number of SellerShippingOptions to skip. Default is 0.",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Used for paging. The maximum number of SellerShippingOptions to return. Default is 10.",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TcgApiModel.Common.PagedApiResult_TcgApiModel.Store.FreeShippingOptions_"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/TcgApiModel.Common.PagedApiResult_TcgApiModel.Store.FreeShippingOptions_"
                }
              }
            }
          },
          "404": {
            "description": "Not Found"
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.tcgplayer.com"
    }
  ],
  "components": {
    "schemas": {
      "TcgApiModel.Store.FreeShippingOptions": {
        "type": "object",
        "properties": {
          "enabled": {
            "type": "boolean"
          },
          "threshold": {
            "format": "double",
            "type": "number"
          },
          "shippingCategoryId": {
            "format": "int32",
            "type": "integer"
          }
        }
      },
      "TcgApiModel.Common.PagedApiResult_TcgApiModel.Store.FreeShippingOptions_": {
        "type": "object",
        "properties": {
          "totalItems": {
            "format": "int32",
            "type": "integer"
          },
          "success": {
            "type": "boolean"
          },
          "errors": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "results": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TcgApiModel.Store.FreeShippingOptions"
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 94,
      "1": 217,
      "2": 152,
      "3": 86,
      "4": 78,
      "5": 118,
      "6": 200,
      "7": 0,
      "8": 17,
      "9": 105,
      "10": 157,
      "11": 192
    }
  }
}
```