Shipping Rule Details

This endpoint allows you to show details in regards to a specific new shipping rule, by passing the rule_id as a path parameter.

Scopes

shipping.read- Shipping Read Only

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Path Params

rule_id

integer

required

Unique identification number assigned to a Shipping Rule. Get a list of shipping rule IDs here.

Responses

🟢200Success

application/json

Body

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

object (ShippingRules)

optional

number

required

The unique identifier assigned to the shipping rule. List of shipping rules can be found here

title

string

required

Title of the shipping rule

status

string

required

Status of the shipping rule

shipping_companies_ids

array[number]

required

A unique identifier for the company. Get a list of Shipment Companies by querying this endpoint: https://api.salla.dev/admin/v2/shipping/companies

restrictions

array [object {3}]

required

Restrictions Associated with the Shipping Rule

Example

{
    "status": 200,
    "success": true,
    "data": {
        "title": "CPSAVIP",
        "status": "active",
        "shipping_companies_ids": [
            322729604
        ],
        "restrictions": [
            {
                "type": "cart-price",
                "condition": "==",
                "value": 100
            },
            {
                "type": "category",
                "condition": "!=",
                "value": "Dress"
            },
            {
                "type": "customer-group",
                "condition": ">",
                "value": "VIP"
            }
        ]
    }
}

🟠404Error Validation

🟠401Unauthorized

Request

Request samples

Responses