Skip to content

Create New Images Order ​

API Information ​

  • Request Path: /market/order/programming/create
  • Request Method: POST
  • Content-Type: application/json

Request Headers ​

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

Request Body Structure ​

FieldTypeRequiredDescriptionConstraints
sensorTypeIntegerYesSensor type1=SAR, 2=Optical
geometryStringYesGeometry (GeoJSON)-
aoiIdLongNoAOI ID; when provided, server uses AOI geometry-
startDateStringYesStart Timeyyyy-MM-dd HH:mm or yyyy-MM-ddTHH:mm:ss
endDateStringYesEnd Timeyyyy-MM-dd HH:mm or yyyy-MM-ddTHH:mm:ss
recurringBooleanNoIs Recurring-
recurringDayIntegerNoRecurring Day-
recurringUnitIntegerNoRecurring Unit1-Day, 2-Week, 3-Month
maxCloudIntegerNoMax Cloud Cover0-100
resolutionLevelIntegerYesResolution level: 1-Ultra High, 2-High Resolution - Submeter, 3-High Resolution, 4-Medium-Low Resolution1/2/3/4
outputFolderIdLongNoOutput folder ID-
ossOutputIdLongNoExisting object storage output config ID-
ossOutputObjectNoNew object storage output config-

OssOutputPayload Structure (ossOutput) ​

FieldTypeRequiredDescriptionConstraints
nameStringNoConfig name-
endPointStringNoEndpoint-
akStringNoAccess key-
skStringNoSecret key-
accessPathStringNoBase access path-

Request Body Example ​

json
{
  "sensorType": 2,
  "geometry": "{\"type\":\"Polygon\",\"coordinates\":[[[102.61282157031928,21.488503948497097],[106.99114976403081,21.488503948497097],[106.99114976403081,18.594746845159506],[102.61282157031928,18.594746845159506],[102.61282157031928,21.488503948497097]]]}",
  "startDate": "2023-10-27 10:00:00",
  "endDate": "2023-10-28 23:59:59",
  "recurring": false,
  "maxCloud": 20,
  "resolutionLevel": 2
}

Response Body Structure ​

CommonResponse Object ​

FieldTypeDescription
codeIntegerResponse status code
messageStringResponse message
dataOrderCreateRespResponse data

OrderCreateResp Object ​

FieldTypeDescription
orderNoStringCreated order number

Response Examples ​

Success Response ​

json
{
  "code": 200,
  "message": "success",
  "data": {
    "orderNo": "PROG_ORDER_202310270001"
  }
}

Failure Response ​

json
{
  "code": 400,
  "message": "Satellite not available",
  "data": null
}

Error Code Description ​

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

Usage Instructions ​

  1. This API is used to create a satellite programming order
  2. User authentication is required
  3. Specify sensor type, time window and geometry

Notes ​

  • Time window must be valid for the selected sensor type