Skip to main content
GET
List shipping methods

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1

Page number to return (offset pagination, starting at 1).

Required range: x >= 1
per_page
integer
default:25

Shipping methods per page. Defaults to 25; values above 250 are capped at 250.

Required range: x >= 1
status
string

Only return shipping methods with this status (active, inactive, or draft). Any other value returns 422.

search_query
string

Case-insensitive partial match on the shipping method name.

sort
string
default:priority

Sort order, one of priority, -priority, name, or -name (prefix - for descending). Unrecognized values fall back to priority.

Response

Success

shipping_methods
object[]
meta
object