Order List - CAT KISS FISH

Request

Header Params

access-token

string

required

Default:

dnKoMgUlXd3t0vvGpV7M5L6ttWo2lbcRCkpHcHxHRLTDwSKK57OEUeRJ90wU

Body Params application/json

pageNum

integer | null

required

Page Number

Default:

1

pageSize

integer | null

required

Page Size

Default:

5

id

string | null

optional

Order ID

platformOrderId

string | null

optional

Platform order ID

storeOrderId

string | null

optional

Store order ID

state

integer | null

optional

Order State(1:Unpaid 2:Awaiting Production 3:In production 4:Shipped 5:Finished 6:Cancelled 7:In Packing 8:Apply for refund 9:Refund success)

startDate

string | null

optional

Created Date Start(Format: yyyy-MM-dd HH:mm:ss)

endDate

string | null

optional

Created Date End(Format: yyyy-MM-dd HH:mm:ss)

Example

{
     "id": "49",
    "pageNum": 1,
    "pageSize": 10,
    "platformOrderId": "32",
    "storeOrderId": "83",
    "state": 89,
    "startDate": "2025-07-10 00:00:00",
    "endDate": "2025-07-17 23:59:59"
   
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://www.catkissfish.com/website/open/api/order/list' \
--header 'access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
     "id": "49",
    "pageNum": 1,
    "pageSize": 10,
    "platformOrderId": "32",
    "storeOrderId": "83",
    "state": 89,
    "startDate": "2025-07-10 00:00:00",
    "endDate": "2025-07-17 23:59:59"
   
}'

Responses

🟢200Success

application/json

Body

code

integer | null

optional

code 0:success

message

string | null

optional

data

object (CustomPage«OrderVo»)

optional

total

integer | null

optional

total records

current

integer | null

optional

current page number

size

integer | null

optional

page size

records

array[object (OrderVo) {24}] | null

optional

records data

Example

{
  "code": 0,
  "message": "",
  "data": {
    "total": 0,
    "current": 0,
    "size": 0,
    "records": [
      {
        "id": "",
        "shopOrderId": "",
        "pyShopOrderId": "",
        "state": 0,
        "payType": 0,
        "amount": 0,
        "payAmount": 0,
        "productDiscountAmount": 0,
        "discountAmount": 0,
        "designPriceDiscountAmount": 0,
        "logisticsPrice": 0,
        "logisticsDiscountAmount": 0,
        "reduceRegistrationFee": 0,
        "clearanceFee": 0,
        "userRemark": "",
        "payDate": "",
        "startProductionDate": "",
        "entryDate": "",
        "deliverDate": "",
        "cancelDate": "",
        "finishDate": "",
        "userMessage": "",
        "items": [
          {
            "productName": "",
            "styleCode": "",
            "sku": "",
            "customerSku": "",
            "size": "",
            "sizeName": "",
            "color": "",
            "colorName": "",
            "quantity": 0,
            "material": "",
            "mockupList": [
              ""
            ],
            "designList": [
              ""
            ]
          }
        ],
        "shippingAddress": {
          "userName": "",
          "country": "",
          "countryAbbreviation": "",
          "province": "",
          "city": "",
          "postalCode": "",
          "email": "",
          "countryCode": "",
          "phone": "",
          "detailAddress": ""
        }
      }
    ]
  }
}