Skip to content

Query Orders

API Information

  • Request Path: /market/order/page/query
  • Request Method: POST
  • Content-Type: application/json

Request Headers

ParameterTypeRequiredDescription
AuthorizationStringYesUser authentication token
Content-TypeStringYesMust be set to application/json

Request Body Structure

FieldTypeRequiredDescriptionConstraints
orderNoStringNoOrder number-
orderTimeStartLongNoStart time filter-
orderTimeEndLongNoEnd time filter-
statusesList<Integer>NoOrder statuses (1-Pending, 2-Delivered, 3-Completed, 4-Analyzing, 5-Pending Image, 6-Failed)-
typeIntegerNoOrder type (1-Normal, 2-Programming)-
creatorStringNoCreator IDInjected by token usually
pageNumberintYesPage number-
pageSizeintYesPage size-
sortStringNoSort field-
orderStringNoSort order (asc/desc)-

Request Body Example

json
{
  "pageNumber": 1,
  "pageSize": 10,
  "statuses": [1, 2],
  "type": 1
}

Response Body Structure

CommonResponse Object

FieldTypeDescription
codeIntegerResponse status code
messageStringResponse message
dataOrderQueryRespResponse data

OrderQueryResp Object

FieldTypeDescription
totalLongTotal count
contentList<MarketOrder>Order list

MarketOrder Object

FieldTypeDescription
idLongOrder ID
orderNoStringOrder Number
totalAmountBigDecimalTotal Amount
discountAmountBigDecimalDiscount Amount
finalAmountBigDecimalFinal Amount
thumbStringThumbnail URL
statusIntegerOrder Status
typeIntegerOrder Type (1-Normal, 2-Programming)
providerStringProvider (changguang/tianyi)
regionStringRegion (Geometry WKT)
timeStartStringStart Time
timeEndStringEnd Time
simulationIdStringSimulation ID
recurringBooleanIs Recurring Order
recurringDayIntegerRecurring Day
recurringUnitIntegerRecurring Unit (1-Day, 2-Week, 3-Month)
maxCloudIntegerMax Cloud Cover (0-100)
resolutionBigDecimalGround Resolution (m)
creatorStringCreator ID
ctimeLongCreate Time
mtimeLongModify Time
deletedIntegerDeleted Flag

Response Examples

Success Response

json
{
  "code": 200,
  "message": "success",
  "data": {
    "total": 50,
    "content": [
      {
        "id": 1,
        "orderNo": "ORDER_001",
        "totalAmount": 1000.0,
        "discountAmount": 100.0,
        "finalAmount": 900.0,
        "thumb": "http://example.com/thumb.jpg",
        "status": 1,
        "type": 1,
        "provider": "tianyi",
        "region": "{\"type\":\"Polygon\",\"coordinates\":[[[102.61282157031928,21.488503948497097],[106.99114976403081,21.488503948497097],[106.99114976403081,18.594746845159506],[102.61282157031928,18.594746845159506],[102.61282157031928,21.488503948497097]]]}",
        "timeStart": "2023-10-27 10:00:00",
        "timeEnd": "2023-10-28 10:00:00",
        "recurring": false,
        "maxCloud": 20,
        "resolution": 0.5,
        "creator": "user_123",
        "ctime": 1698364800000,
        "mtime": 1698364800000,
        "deleted": 0
      }
    ]
  }
}

Failure Response

json
{
  "code": 400,
  "message": "Invalid page number",
  "data": null
}

Error Code Description

Error CodeDescription
200Success
400Request parameter error
401Unauthorized
500Server internal error

Usage Instructions

  1. This API is used to query orders with pagination
  2. User authentication is required
  3. Supports filtering by status, type, and time

Notes

  • Default sort is by create time desc