Update Shipping Method

Update an existing shipping method.

HTTP Request

PATCH/api/shipping/methods/:id

Authorization

Authorization

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

Path Parameters

Parameter	Type	Required	Description
id	Integer	Yes	Unique ID of the shipping method to update

Request Body

Field	Type	Required	Description
active	Boolean	No	Whether the shipping method is active
order	Integer	No	Display order priority
name	String	No	Name of the shipping method
image	String	No	URL to the shipping method image
description	String	No	Detailed description of the shipping method
formula	String	No	Formula for calculating shipping cost

Example Requests

🐍 Python

1import requests
2
3# Update shipping method name and status
4response = requests.patch('http://www.example.com/api/shipping/methods/1', 
5  json={
6      'name': 'Express Shipping',
7      'active': True,
8      'order': 1
9  },
10  headers={'Authorization': 'Token <your_api_key>'}
11)
12print(response.json())
13
14# Update formula and description
15response = requests.patch('http://www.example.com/api/shipping/methods/1', 
16  json={
17      'formula': 'weight * 2.5 + 5',
18      'description': 'Fast delivery within 24 hours'
19  },
20  headers={'Authorization': 'Token <your_api_key>'}
21)
22print(response.json())

🌐 Curl

1# Update shipping method name and status
2curl -X PATCH "http://www.example.com/api/shipping/methods/1" -H "Authorization: Token <your_api_key>" -H "Content-Type: application/json" -d '{
3  "name": "Express Shipping",
4  "active": true,
5  "order": 1
6}'
7
8# Update formula and description
9curl -X PATCH "http://www.example.com/api/shipping/methods/1" -H "Authorization: Token <your_api_key>" -H "Content-Type: application/json" -d '{
10  "formula": "weight * 2.5 + 5",
11  "description": "Fast delivery within 24 hours"
12}'

Response Fields

Field	Type	Description
id	integer	Unique ID of the shipping method
active	boolean	Whether the shipping method is active
order	integer	The order in which the shipping method appears
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
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": "ChaparExpress",
    "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": "Nihil aut non quis placeat officiis.",
    "formula": "1000",
    "created_at": "2025-12-20T17:24:23.808373Z",
    "updated_at": "2025-12-20T17:30:18.972208Z"
}