Light Mode

Shipping Rule Details

GET/shipping/rules/{rule_id}

Last modified: 2 months ago

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

`shipping.read`- Shipping Read Only

Request

Authorization: OAuth 2.0

Add the parameter

Authorization

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

Example

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Path Params

rule_id

integer

required

Shipping Rule ID

Request samples

Responses

Success(200)

Error Validation(404)

HTTP Code: 200

Content Type : JSONapplication/json

status

integer

optional

Status Code of the Shipping Rule

success

boolean

optional

Success of the Shipping Rule

data

object

optional

number

optional

ID of the Shipping Rule

title

string

optional

Title of the Shipping Rule

status

string

optional

Status of the Shipping Rule

shipping_companies_ids

array[number]

optional

You can get a list of Shipment Companies by querying this endpoint: https://api.salla.dev/admin/v2/shipping/companies

restrictions

array [object {3}]

optional

Restrictions Associated with the Shipping Rule

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

Last modified: 2 months ago