List Shipping Methods

Retrieves a list of all available shipping methods.

HTTP Request

GET/api/shop/shipping/methods

Authorization

Authorization

• Required: No
• Permission: Public (read-only)
• Authentication: None

Query Parameters

Parameter	Type	Default	Description
limit	integer	10	Number of results per page
offset	integer	0	Number of results to skip
search	string	—	Search term to filter results by `id`, `name` and `description`
ordering	string	—	Order results by field (`id`, `name`)

Example Requests

🐍 Python

1import requests
2response = requests.get('http://www.example.com/api/shop/shipping/methods', params={
3  'limit': 5,
4  'ordering': 'name',
5  'search': 'express'
6})
7print(response.json())

🌐 Curl

1curl "http://www.example.com/api/shop/shipping/methods?limit=5&ordering=name&search=express"

Status Codes

Code	Description
200	Shipping methods retrieved successfully
400	Bad request — invalid parameters
500	Internal server error

Response Fields

Field	Type	Description
id	integer	Unique ID of the shipping method
name	string	Name of the shipping method
image_data	object	Image data associated with the shipping method (id, type, name, size, human_readable_size, f, width, height, mode)
description	string	Description of the shipping method

Image Data Object Fields:

Field	Type	Description
id	Integer	Unique ID of the image
type	String	File type (read-only, auto-detected)
name	String	Original filename
size	Integer	File size in bytes (read-only)
human_readable_size	String	Human-readable file size (e.g., "2.5 MB")
f	String	File URL/path
width	Integer	Image width in pixels (images only, read-only)
height	Integer	Image height in pixels (images only, read-only)
mode	String	Image color mode (images only, read-only)