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 lookup results by`id`, `name` and `description`
ordering	string	order, -created_at	Order results by field (`id`, `name`, `order`, `created_at`, `updated_at` )

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"

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 Structure

Field	Type	Description
id	Integer	Unique ID of the image
type	String	File type (e.g., image/jpeg)
name	String	Original file name
size	Integer	File size in bytes
human_readable_size	String	Human readable file size (e.g., 2.5 MB)
f	String	URL to access the image file
width	Integer	Image width in pixels
height	Integer	Image height in pixels
mode	String	Color mode (e.g., RGB, CMYK)
thumbnails	List of thumbnail objects	Imgae thumbnails

Thumbnail Data Structure

Field	Type	Description
id	Integer	Unique ID of the thumbnail (unique)
f	String	URL to access the thumbnail file
size	Integer	File size in bytes (nullable)

Example Respones

{
    "count": 3,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 3,
            "name": "ChaparExpress",
            "image": {
                "id": 4,
                "type": "image",
                "name": "rams",
                "size": 118805,
                "human_readable_size": "116.02 KB",
                "f": "http://127.0.0.1:8000/media/core_media/2025/11/29/RAMFeatured.jpg",
                "width": 1280,
                "height": 720,
                "mode": "RGB",
                "thumbnails": [
                    {
                        "id": 213,
                        "f": "http://127.0.0.1:8000/media/core_media/2026/02/02/thumbnails/test2_ecH0zVV_thumbnail_64x64.jpg",
                        "size": 64
                    },
                    {
                        "id": 214,
                        "f": "http://127.0.0.1:8000/media/core_media/2026/02/02/thumbnails/test2_ecH0zVV_thumbnail_128x128.jpg",
                        "size": 128
                    },
                    {
                        "id": 215,
                        "f": "http://127.0.0.1:8000/media/core_media/2026/02/02/thumbnails/test2_ecH0zVV_thumbnail_512x512.jpg",
                        "size": 512
                    },
                    {
                        "id": 216,
                        "f": "http://127.0.0.1:8000/media/core_media/2026/02/02/thumbnails/test2_ecH0zVV_thumbnail_1080x1080.jpg",
                        "size": 1080
                    }
                ]
            },
            "description": "Nihil aut non quis placeat officiis."
        },
        {
            "id": 1,
            "name": "پیک موتور",
            "image": {
                "id": 8,
                "type": "image",
                "name": "پیک موتوری",
                "size": 808754,
                "human_readable_size": "789.80 KB",
                "f": "http://127.0.0.1:8000/media/core_media/2025/12/20/Fantasticheskie_kartinki_dlja_monitora_68_63.jpg",
                "width": 1920,
                "height": 1080,
                "mode": "RGB",
                "thumbnails": [
                    {
                        "id": 213,
                        "f": "http://127.0.0.1:8000/media/core_media/2026/02/02/thumbnails/test2_ecH0zVV_thumbnail_64x64.jpg",
                        "size": 64
                    },
                    {
                        "id": 214,
                        "f": "http://127.0.0.1:8000/media/core_media/2026/02/02/thumbnails/test2_ecH0zVV_thumbnail_128x128.jpg",
                        "size": 128
                    },
                    {
                        "id": 215,
                        "f": "http://127.0.0.1:8000/media/core_media/2026/02/02/thumbnails/test2_ecH0zVV_thumbnail_512x512.jpg",
                        "size": 512
                    },
                    {
                        "id": 216,
                        "f": "http://127.0.0.1:8000/media/core_media/2026/02/02/thumbnails/test2_ecH0zVV_thumbnail_1080x1080.jpg",
                        "size": 1080
                    }
                ]
            },
            "description": "پیک موتوری سراسر شهر"
        },
        {
            "id": 2,
            "name": "پیک وانت",
            "image": null,
            "description": "ارسال با وانت"
        }
    ]
}