List shipping rules

Returns a page of shipping rules.

GET /settings/shipping_rules

cURL

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/settings/shipping_rules?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200

{
  "data": [
    {
      "configuration": {
        "rate": "<unknown>",
        "zones": "<array>"
      },
      "created_by": "<unknown>",
      "created_on": "<string>",
      "description": "<string>",
      "href": "<string>",
      "id": "<string>",
      "last_updated_by": "<unknown>",
      "last_updated_on": "<string>",
      "name": "<string>",
      "object": "<string>",
      "shipping_class": "<unknown>",
      "status": "<string>",
      "version": 123
    }
  ],
  "object": "<string>",
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  },
  "url": "<string>"
}

Returns rules under data, each with its name, description, status and configuration. Set the page size with limit and fetch the next page with cursor. Other fields filter as filter_<field>.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization · string · header · required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Query Parameters

limit · integer

How many records to return on one page.

Example:

20

cursor · string

The next_cursor from the previous page, to fetch the page after it.

sort · string

The field to sort by. Prefix it with - to sort descending, as in -created_on.

Example:

"-created_on"

Response

200 - application/json

A page of shipping rules, under data.

data · object[]

Show child attributes

object · string

pagination · object

Show child attributes

url · string