Get Sales
Get Sales
GET /sales
Query Parameters
| Name | Description | Type |
|---|---|---|
| userId | string (query) | string |
| saleId | string (query) | string |
| parentPartialSaleId | integer ($int64) (query) | integer |
| tenantId | string (query) | string |
| paymentReference | string (query) | string |
| requestId | string (query) | string |
| countryCode | string (query) | string |
| customerBusinessId | string (query) | string |
| customerId | string (query) | string |
| businessId | string (query) | string |
| agentId | string (query) | string |
| paymentStatus | string (query) Available values: PENDING, SUCCESSFUL, REFUNDED, FAILED, REVERSED | string |
| displayPaymentMode | string (query) Available values: ALL, PREPAID_SUCCESS_AND_POSTPAID, PREPAID_FAILED_AND_POSTPAID, PREPAID_PROCESSING_ONLY, PREPAID_PROCESSING_FAILED_ONLY, PREPAID_FAILED_ONLY | string |
| deliveryStatus | string (query) Available values: PENDING, REJECTED, CANCELLED, ACCEPTED, SHIPPED, DELIVERED, CONFIRMED, RETURNED, RETURN_CONFIRMED, READY_TO_SHIP, READY_FOR_PICKUP, PICKING, PACKED | string |
| deliveryMode | string (query) Available values: PICK_UP, DISPATCH | string |
| paymentMode | string (query) Available values: IN_STORE, PREPAID, POSTPAID | string |
| totalAmount | number ($double) (query) | number |
| fromAmount | number ($double) (query) | number |
| orderNumber | string (query) | string |
| globalOrderNumber | string (query) | string |
| paymentMethod | string (query) Available values: QR, USSD, PAYMENT_LINK, WALLET_TRANSFER, BANK_TRANSFER, CASH, EFT, CARD | string |
| partialMode | string (query) Available values: PARENT_SALE, PARTIAL_SALE, ALL_SALE | string |
| paymentReferences | array[string] (query) | array[string] |
| deliveryStatuses | array[string] (query) Available values: PENDING, REJECTED, CANCELLED, ACCEPTED, SHIPPED, DELIVERED, CONFIRMED, RETURNED, RETURN_CONFIRMED, READY_TO_SHIP, READY_FOR_PICKUP, PICKING, PACKED | array[string] |
| toAmount | number ($double) (query) | number |
| customerIds | array[string] (query) | array[string] |
| search | string (query) | string |
| inStore | boolean (query) | boolean |
| from | string (query) | string |
| to | string (query) | string |
| locale.baseLocale.language | string (query) | string |
| locale.baseLocale.script | string (query) | string |
| locale.baseLocale.region | string (query) | string |
| locale.baseLocale.variant | string (query) | string |
| page | integer (query) One-based page index (1..N) Default value: 1 | integer |
| size | integer (query) The size of the page to be returned Default value: 20 | integer |
| sort | array[string] (query) Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | array[string] |
Responses
200 OK
Description: Successful operation
Example Value:
{
{
"message": "string",
"data": [
{
"id": "string",
"nativeId": 0,
"tenantId": "string",
"countryCode": "string",
"merchantId": "string",
"businessId": "string",
"customerBusinessId": "string",
"agentId": "string",
"customerId": "string",
"transactionReference": "string",
"paymentReference": "string",
"eftReceipt": "string",
"totalAmount": 0,
"orderAmount": 0,
"shippingFee": 0,
"shippingFeeDetail": {
"shippingFee": 0,
"distanceCovered": 0,
"requestId": "string",
"dropOffUserId": "string"
},
"logisticsProvider": "string",
"baseFare": 0,
"unitPricePerDistance": 0,
"totalVat": 0,
"totalVatRatio": 0,
"discount": 0,
"amountPaid": 0,
"orderNumber": "string",
"globalOrderNumber": "string",
"totalQuantity": 0,
"paymentMethod": "string",
"paymentStatus": "string",
"deliveryAddress": "string",
"deliveryAddressDto": {
"id": "string",
"state": "string",
"city": "string",
"address": "string",
"latitude": 0,
"longitude": 0,
"customerId": "string",
"tenantId": "string",
"postalCode": "string",
"deliveryMode": "PICK_UP",
"customerPhoneNumber": "string"
},
"paymentMode": "string",
"deliveryMode": "string",
"deliveryStatus": "string",
"deliveryNote": "string",
"orders": [
{
"productImage": [
"string"
],
"name": "string",
"id": "string",
"brand": "string",
"quantity": 0,
"quantityRemaining": 0,
"amount": 0,
"promotionDiscount": 0,
"sellingPrice": 0,
"costPrice": 0,
"totalCostPrice": 0,
"profit": 0,
"vat": 0,
"vatRatio": 0
}
],
"extraPayloads": {
"ussdString": "string",
"bankCode": "string",
"accountNumber": "string",
"paymentLink": "string",
"navigatingUrl": "string",
"qrCode": "string"
},
"salesTracking": [
{
"id": "string",
"deliveryStatus": "PENDING",
"saleId": "string",
"isDelayed": true,
"merchantId": "string",
"bussinessId": "string",
"tenantId": "string",
"createdAt": "2024-07-17T15:35:49.118Z",
"updatedAt": "2024-07-17T15:35:49.118Z"
}
],
"isPartial": true,
"isPartialParent": true,
"createdAt": "2024-07-17T15:35:49.118Z",
"updatedAt": "2024-07-17T15:35:49.118Z",
"deliveryData": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"business": {
"get_id": "string",
"name": "string",
"email": "string",
"photo": "string",
"wallet": {
"userId": "string",
"virtualBankCode": "string",
"floatAccountId": "string",
"floatAccountUuid": "string",
"floatAccountNumber": "string",
"commissionAccountId": "string"
},
"address": {
"country": "string",
"latitude": 0,
"lga": "string",
"name": "string",
"state": "string",
"longitude": 0
},
"location": {
"coordinates": [
0
],
"type": "string"
},
"user": "string",
"owner": {
"profileTenant": "string",
"city": {
"code": "string",
"name": "string"
},
"country": {
"code": "string",
"name": "string",
"currency": "string"
},
"firstName": "string",
"lastName": "string",
"phone": "string",
"photo": "string",
"state": {
"code": "string",
"name": "string"
},
"username": "string",
"wallet": {
"userId": "string",
"virtualBankCode": "string",
"floatAccountId": "string",
"floatAccountUuid": "string",
"floatAccountNumber": "string",
"commissionAccountId": "string"
},
"id": "string",
"fullName": "string"
},
"businessHandle": "string",
"shippingFee": 0,
"phone": "string",
"category": "string",
"active": true,
"acceptingOrder": true,
"isDistributor": true,
"isManufacturer": true,
"isHead": true,
"extraLocationPrice": 0,
"distance": 0,
"kycDetails": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"pickUpAddresses": [
{
"country": "string",
"latitude": 0,
"lga": "string",
"name": "string",
"state": "string",
"longitude": 0,
"location": {
"coordinates": [
0
],
"type": "string"
}
}
],
"priceMargin": {
"type": "FIXED",
"source": "BUSINESS",
"value": 0,
"enabled": true
}
},
"customer": {
"country": {
"code": "string",
"name": "string",
"currency": "string"
},
"firstName": "string",
"lastName": "string",
"wallet": {
"userId": "string",
"virtualBankCode": "string",
"floatAccountId": "string",
"floatAccountUuid": "string",
"floatAccountNumber": "string",
"commissionAccountId": "string"
},
"city": {
"code": "string",
"name": "string"
},
"phone": "string",
"profileTenant": "string",
"photo": "string",
"get_id": "string",
"state": {
"code": "string",
"name": "string"
},
"username": "string",
"status": "string",
"profileOwners": [
"string"
],
"businesses": [
{
"get_id": "string",
"name": "string",
"email": "string",
"photo": "string",
"wallet": {
"userId": "string",
"virtualBankCode": "string",
"floatAccountId": "string",
"floatAccountUuid": "string",
"floatAccountNumber": "string",
"commissionAccountId": "string"
},
"address": {
"country": "string",
"latitude": 0,
"lga": "string",
"name": "string",
"state": "string",
"longitude": 0
},
"location": {
"coordinates": [
0
],
"type": "string"
},
"user": "string",
"owner": {
"profileTenant": "string",
"city": {
"code": "string",
"name": "string"
},
"country": {
"code": "string",
"name": "string",
"currency": "string"
},
"firstName": "string",
"lastName": "string",
"phone": "string",
"photo": "string",
"state": {
"code": "string",
"name": "string"
},
"username": "string",
"wallet": {
"userId": "string",
"virtualBankCode": "string",
"floatAccountId": "string",
"floatAccountUuid": "string",
"floatAccountNumber": "string",
"commissionAccountId": "string"
},
"id": "string",
"fullName": "string"
},
"businessHandle": "string",
"shippingFee": 0,
"phone": "string",
"category": "string",
"active": true,
"acceptingOrder": true,
"isDistributor": true,
"isManufacturer": true,
"isHead": true,
"extraLocationPrice": 0,
"distance": 0,
"kycDetails": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"pickUpAddresses": [
{
"country": "string",
"latitude": 0,
"lga": "string",
"name": "string",
"state": "string",
"longitude": 0,
"location": {
"coordinates": [
0
],
"type": "string"
}
}
],
"priceMargin": {
"type": "FIXED",
"source": "BUSINESS",
"value": 0,
"enabled": true
}
}
],
"address": "string",
"fullName": "string"
},
"agent": {
"country": {
"code": "string",
"name": "string",
"currency": "string"
},
"firstName": "string",
"lastName": "string",
"wallet": {
"userId": "string",
"virtualBankCode": "string",
"floatAccountId": "string",
"floatAccountUuid": "string",
"floatAccountNumber": "string",
"commissionAccountId": "string"
},
"city": {
"code": "string",
"name": "string"
},
"phone": "string",
"profileTenant": "string",
"photo": "string",
"get_id": "string",
"state": {
"code": "string",
"name": "string"
},
"username": "string",
"status": "string",
"profileOwners": [
"string"
],
"businesses": [
{
"get_id": "string",
"name": "string",
"email": "string",
"photo": "string",
"wallet": {
"userId": "string",
"virtualBankCode": "string",
"floatAccountId": "string",
"floatAccountUuid": "string",
"floatAccountNumber": "string",
"commissionAccountId": "string"
},
"address": {
"country": "string",
"latitude": 0,
"lga": "string",
"name": "string",
"state": "string",
"longitude": 0
},
"location": {
"coordinates": [
0
],
"type": "string"
},
"user": "string",
"owner": {
"profileTenant": "string",
"city": {
"code": "string",
"name": "string"
},
"country": {
"code": "string",
"name": "string",
"currency": "string"
},
"firstName": "string",
"lastName": "string",
"phone": "string",
"photo": "string",
"state": {
"code": "string",
"name": "string"
},
"username": "string",
"wallet": {
"userId": "string",
"virtualBankCode": "string",
"floatAccountId": "string",
"floatAccountUuid": "string",
"floatAccountNumber": "string",
"commissionAccountId": "string"
},
"id": "string",
"fullName": "string"
},
"businessHandle": "string",
"shippingFee": 0,
"phone": "string",
"category": "string",
"active": true,
"acceptingOrder": true,
"isDistributor": true,
"isManufacturer": true,
"isHead": true,
"extraLocationPrice": 0,
"distance": 0,
"kycDetails": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"pickUpAddresses": [
{
"country": "string",
"latitude": 0,
"lga": "string",
"name": "string",
"state": "string",
"longitude": 0,
"location": {
"coordinates": [
0
],
"type": "string"
}
}
],
"priceMargin": {
"type": "FIXED",
"source": "BUSINESS",
"value": 0,
"enabled": true
}
}
],
"address": "string",
"fullName": "string"
},
"customerBusiness": {
"get_id": "string",
"name": "string",
"email": "string",
"photo": "string",
"wallet": {
"userId": "string",
"virtualBankCode": "string",
"floatAccountId": "string",
"floatAccountUuid": "string",
"floatAccountNumber": "string",
"commissionAccountId": "string"
},
"address": {
"country": "string",
"latitude": 0,
"lga": "string",
"name": "string",
"state": "string",
"longitude": 0
},
"location": {
"coordinates": [
0
],
"type": "string"
},
"user": "string",
"owner": {
"profileTenant": "string",
"city": {
"code": "string",
"name": "string"
},
"country": {
"code": "string",
"name": "string",
"currency": "string"
},
"firstName": "string",
"lastName": "string",
"phone": "string",
"photo": "string",
"state": {
"code": "string",
"name": "string"
},
"username": "string",
"wallet": {
"userId": "string",
"virtualBankCode": "string",
"floatAccountId": "string",
"floatAccountUuid": "string",
"floatAccountNumber": "string",
"commissionAccountId": "string"
},
"id": "string",
"fullName": "string"
},
"businessHandle": "string",
"shippingFee": 0,
"phone": "string",
"category": "string",
"active": true,
"acceptingOrder": true,
"isDistributor": true,
"isManufacturer": true,
"isHead": true,
"extraLocationPrice": 0,
"distance": 0,
"kycDetails": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"pickUpAddresses": [
{
"country": "string",
"latitude": 0,
"lga": "string",
"name": "string",
"state": "string",
"longitude": 0,
"location": {
"coordinates": [
0
],
"type": "string"
}
}
],
"priceMargin": {
"type": "FIXED",
"source": "BUSINESS",
"value": 0,
"enabled": true
}
},
"inStore": true
}
],
"meta": {
"currentPage": 0,
"from": 0,
"to": 0,
"perPage": 0,
"total": 0,
"lastPage": 0
}
}
}