API Reference

List Shipping Options

get
https://marketplace-integrations.nelo.co/v1/admin/shipping-options

Retrieve a list of Shipping Options. The shipping options can be filtered by fields such as region_id or is_return. The shipping options can also be sorted or paginated.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Filter by name.

string

Filter by the ID of the region the shipping options belong to.

boolean

Filter by whether the shipping options are return shipping options.

boolean

Filter by whether the shipping options are available for admin users only.

string

Term used to search shipping options' name.

string

A shipping option field to sort-order the retrieved shipping options by.

Filter by shipping option IDs.

ID of the shipping option.

created_at
object

Filter by a creation date range.

updated_at
object

Filter by an update date range.

deleted_at
object

Filter by a deletion date range.

integer
Defaults to 0

The number of users to skip when retrieving the shipping options.

integer
Defaults to 20

Limit the number of shipping options returned.

string

Comma-separated relations that should be expanded in the returned shipping options.

string

Comma-separated fields that should be included in the returned shipping options.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 11 months ago

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

Updated 11 months ago