Create Shipping Method

Creates a new shipping method

HTTP Request

POST/api/shipping/methods

Authorization

Authorization

• Required: Yes
• Permission: Staff with ShippingMethodPermission or Admin
• Permission Code: 2601
• Authentication: Token-based (Authorization: Token <your_api_key>)

Request Body

Field	Type	Required	Description
active	Boolean	No	Whether the shipping method is active (default=True)
order	Integer	No	The display row-order of the shipping method
name	String	Yes	Name of the shipping method(unique)
image	Integer	No	ID of the image associated with the shipping method
description	String	No	Description of the shipping method
formula	String	Yes	Formula for calculating shipping costs

Example Requests

🐍 Python

1import requests
2
3response = requests.post('http://www.example.com/api/shipping/methods', json={
4  'active': True,
5  'order': 1,
6  'name': 'Standard Shipping',
7  'image': 123,
8  'description': 'Delivery within 5-7 business days.',
9  'formula': 'base_cost + (weight * rate_per_kg)'
10}, headers={
11  'Authorization': 'Token <your_api_key>'
12})
13print(response.json())

🌐 Curl

1curl -X POST "http://www.example.com/api/shipping/methods" \
2-H "Authorization: Token <your_api_key>" \
3-H "Content-Type: application/json" \
4-d '{
5  "active": true,
6  "order": 1,
7  "name": "Standard Shipping",
8  "image": 123,
9  "description": "Delivery within 5-7 business days.",
10  "formula": "base_cost + (weight * rate_per_kg)"
11}'

Response Fields

Field	Type	Description
id	integer	Unique ID of the shipping method
active	boolean	Whether the shipping method is active
order	integer	The display row order of the shipping method (nullable)
name	string	Name of the shipping method (unique)
image_data	object	Image data associated with the shipping method(nullable)
description	string	Description of the shipping method (nullable)
formula	string	Formula for calculating shipping costs
created_at	string (ISO 8601)	Timestamp when the shipping method was created
updated_at	string (ISO 8601)	Timestamp when the shipping method was last updated

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 Response

{
    "id": 3,
    "active": true,
    "order": 1,
    "name": "Chapar",
    "image_data": {
        "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": "magnam",
    "formula": "1000",
    "created_at": "2025-12-20T17:24:23.808373Z",
    "updated_at": "2025-12-20T17:24:23.808379Z"
}

Notes

• The formula field is used to calculate shipping costs based on various parameters like weight, distance, etc.
• Shipping methods can be ordered using the order field to control display priority