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.

{
    "totalItems": integer,
    "success": true,
    "errors": [],
    "results": [
        {
            "enabled": boolean,
            "threshold": integer,
            "shippingCategoryId": integer
        }
    ]
}
{
    "totalItems": 1,
    "success": true,
    "errors": [],
    "results": [
        {
            "enabled": false,
            "threshold": null,
            "shippingCategoryId": null
        }
    ]
}
Path Params
string
required

Required. A unique key used to identify the caller of the API.

Query Params
int32

Used for paging. The number of SellerShippingOptions to skip. Default is 0.

int32

Used for paging. The maximum number of SellerShippingOptions to return. Default is 10.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

404

Not Found

Language
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json