Light Mode

Shipping Rule Details

GET/shipping/rules/{rule_id}

Last modified: a month 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

Inherited from project

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

Path Params

rule_id

integer

required

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

Request samples

Responses

Success(200)

Error Validation(404)

Unauthorized(401)

HTTP Code: 200

Content Type : JSONapplication/json

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

#/definitions/1389490

optional

{
  "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"
      }
    ]
  }
}

Last modified: a month ago