List Shipping Rules

This endpoint allows you to fetch a list of shipping rules.

Scopes

shipping.read- Shipping Read Only

Add the parameter

Authorization

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

Example:

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

Responses

🟢200Success

application/json

Body

status

integer

optional

Status Code of the Shipping Rule

Example:

200

success

boolean

optional

Success of the Shipping Rule

Default:

true

data

array[object (ShippingRules) {3}]

optional

number

optional

ID of the Shipping Rule

Example:

2079537577

name

string

optional

Name of the Shipping Rule

Example:

CPSAVIP

status

string

optional

Status of the Shipping Rule

Example:

active

cursor

object

optional

current

integer

optional

Example:

integer | null

optional

Previous Pages Number Value

integer | null

optional

Next Pages Number Value

count

integer

optional

Total Number Value of the Shipping Rules

Example:

Example

{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 2079537577,
      "name": "CPSAVIP",
      "status": "active"
    }
  ],
  "cursor": {
    "current": 1,
    "previous": 0,
    "next": 1,
    "count": 1
  }
}

🟠401Unauthorized

Request

Request samples

Responses