Admin api orders
List orders
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Query Parameters
minCreatedAt?string
Format
date-timemaxCreatedAt?string
Format
date-timeminUpdatedAt?string
Format
date-timemaxUpdatedAt?string
Format
date-timepage?integer
Default
0pageSize?integer
Default
50Range
value <= 200orderBy?string
Default
"id"Value in
"id" | "storeId" | "totalPrice" | "draftCreatedAt"direction?string
Direction of sorting
Value in
"asc" | "desc"id?integer
status?array<>
externalStatus?array<>
customerRole?array<>
sessionId?array<>
Id of a session, which resulted in an order
externalId?array<>
Client defined order identifiers
startTime?string
Format
date-timeendTime?string
Format
date-timestoreId?integer
Range
1 <= valuecustomerId?integer
paymentTransactionId?string
includeContest?boolean
Default
falseincludeProducts?boolean
Default
falsecustomerPaymentInstrumentBin?string
First 6-8 digits of a card number. Exact match.
Length
6 <= length <= 8customerPaymentInstrumentLast4?string
Card last 4 digits, required when customerPaymentInstrumentExpDate is provided
Match
^\d{4}$customerPaymentInstrumentExpDate?string
Card expire date in MM/YY format
minTotalPrice?string
Format
floatmaxTotalPrice?string
Format
floatminTotalProductQuantity?integer
maxTotalProductQuantity?integer
minDraftCreatedAt?string
Format
date-timemaxDraftCreatedAt?string
Format
date-timeResponse Body
application/json
application/json
curl -X GET "https://oasis-api.public.sandbox.oasis.aifi.com/api/admin/v2/orders?minCreatedAt=2024-09-22T00%3A00%3A00.000Z&maxCreatedAt=2024-09-29T00%3A00%3A00.000Z&minUpdatedAt=2024-09-23T00%3A00%3A00.000Z&maxUpdatedAt=2024-09-30T00%3A00%3A00.000Z&customerPaymentInstrumentLast4=1111&customerPaymentInstrumentExpDate=03%2F28&minTotalPrice=2.50&maxTotalPrice=2.50&minTotalProductQuantity=1&maxTotalProductQuantity=5&minDraftCreatedAt=2024-09-22T00%3A00%3A00.000Z&maxDraftCreatedAt=2024-09-29T00%3A00%3A00.000Z"{
"data": [
{
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"id": 0,
"version": 0,
"isLatest": 0,
"customerId": "11",
"storeId": 1,
"status": "draft",
"transactionId": 0,
"customerShoppingSessionId": 0,
"externalId": "string",
"externalStatus": "ok",
"subtotalPrice": "1.80",
"totalPrice": "2.15",
"totalTax": "0.35",
"paidAt": "2019-08-24T14:15:22Z",
"notificationSentAt": "2019-08-24T14:15:22Z",
"extraText": "",
"completedAt": "2019-08-24T14:15:22Z",
"draftCreatedAt": "2019-08-24T14:15:22Z",
"contest": {
"id": 0,
"orderId": "string",
"orderVersion": 0,
"fromOperator": true,
"status": "contested",
"contestedTotalPrice": "120.00",
"originalTotalPrice": "123.45",
"customerMessage": "string"
},
"products": [
{
"name": "string",
"price": "string",
"barcode": "string",
"category": "string",
"thumbnail": "string",
"weight": 0,
"sku": "string",
"externalId": "string",
"taxCode": "string",
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"productId": "string",
"isExternallyAdded": true,
"orderProductExternalId": "string",
"orderProductSnapshotId": 0,
"quantity": 0,
"subtotalPrice": "1.80",
"totalPrice": "2.15",
"totalTax": "0.35"
}
]
}
],
"pagination": {
"previous": {
"offset": 0,
"count": 0
},
"next": {
"offset": 0,
"count": 0
}
}
}Empty
{
"message": "Invalid request body",
"type": "E_INVALID_BODY",
"errors": [
{
"error": "\"email\" is required",
"rule": "any.required",
"field": "\"email\""
}
]
}How is this guide?