Find By Request Ids
GET {{baseUrl}}/sales/requestIds?requestIds=123&requestIds=456&userId=789
Description
This endpoint retrieves sales information based on the provided request IDs and user ID.
Request
- Headers:
- (Required)
tenantId Accept: *
- (Required)
Response
- Status: OK (200)
- Headers:
Accept: *
HEADERS
-
tenantId:- Type: string
- Required: Yes
-
Accept:- Type: string
- Description: Specifies the response format.
- Default Value: *
PARAMS
-
requestIds:- Type: string
- Description: IDs of the requests to retrieve sales information.
- Required: Yes
-
userId:- Type: string
- Description: ID of the user associated with the sales.
- Required: Yes
Sample Request
curl --location -g '{{baseUrl}}/sales/requestIds?requestIds=123&userId=789' \
--header 'tenantId: <your_tenant_id>' \
--header 'Accept: */*'
Sample Response
{
"message": "<string>",
"data": [
{
"id": "<string>",
"createdAt": "<dateTime>",
"updatedAt": "<dateTime>",
"tenantId": "<string>",
"agentId": "<string>",
"merchantId": "<string>",
"businessId": "<string>",
"customerId": "<string>",
"requestId": "<string>",
"transactionReference": "<string>",
"paymentReference": "<string>",
"countryCode": "<string>",
"deliveryNote": "<string>",
"orderNumber": "<string>",
"globalOrderNumber": "<string>",
"totalQuantity": "<integer>",
"isPartialParent": "<boolean>",
"isPartial": "<boolean>",
"isUpdated": "<boolean>",
"shippingFee": "<double>",
"orderAmount": "<double>",
"totalAmount": "<double>",
"discount": "<double>",
"totalPromotionDiscount": "<double>",
"discountType": "FIXED",
"amountPaid": "<double>",
"paymentMethod": "WALLET_TRANSFER",
"saleDetails": [
{
"id": "<long>",
"uuid": "<string>",
"createdAt": "<dateTime>",
"updatedAt": "<dateTime>",
"tenantId": "<string>",
"merchantId": "<string>",
"businessId": "<string>",
"countryCode": "<string>",
"sale": {
"value": "<Circular reference to #/components/schemas/Sale detected>"
},
"product": {
"id": "<long>",
"uuid": "<string>",
"createdAt": "<dateTime>",
"updatedAt": "<dateTime>",
"tenantId": "<string>",
"merchantId": "<string>",
"businessId": "<string>",
"name": "<string>",
"description": "<string>",
"sku": "<string>",
"category": "<string>",
"subCategories": "<string>",
"brand": "<string>",
"countryCode": "<string>",
"productPublicId": "<string>",
"minimumOrderQuantity": "<integer>",
"costPrice": {
"price": "<double>",
"unitQuantity": "<integer>",
"unitPrice": "<double>"
},
"sellingPrice": {
"price": "<double>",
"unitQuantity": "<integer>",
"unitPrice": "<double>"
},
"promotion": {
"id": "<long>",
"uuid": "<string>",
"createdAt": "<dateTime>",
"updatedAt": "<dateTime>",
"tenantId": "<string>",
"merchantId": "<string>",
"name": "<string>",
"description": "<string>",
"discountType": "FIXED",
"amount": "<double>",
"percentage": "<integer>",
"endDate": "<dateTime>",
"isActive": "<boolean>"
},
"quantityOnHand": "<integer>",
"reorderLevel": "<integer>",
"stockLevel": "HIGH",
"unit": "<string>",
"weight": "<double>",
"visibility": "<boolean>",
"images": [
"<string>",
"<string>"
],
"clusters": [
"<long>",
"<long>"
]
},
"quantity": "<integer>",
"unitPrice": "<double>",
"amount": "<double>",
"promotionDiscount": "<double>",
"costPrice": "<double>",
"totalCostPrice": "<double>",
"profit": "<double>",
"sellingPrice": {
"price": "<double>",
"unitQuantity": "<integer>",
"unitPrice": "<double>"
},
"quantityRemaining": "<integer>",
"parentSale": {
"value": "<Circular reference to #/components/schemas/Sale detected>"
}
},
{
"id": "<long>",
"uuid": "<string>",
"createdAt": "<dateTime>",
"updatedAt": "<dateTime>",
"tenantId": "<string>",
"merchantId": "<string>",
"businessId": "<string>",
"countryCode": "<string>",
"sale": {
"value": "<Circular reference to #/components/schemas/Sale detected>"
},
"product": {
"id": "<long>",
"uuid": "<string>",
"createdAt": "<dateTime>",
"updatedAt": "<dateTime>",
"tenantId": "<string>",
"merchantId": "<string>",
"businessId": "<string>",
"name": "<string>",
"description": "<string>",
"sku": "<string>",
"category": "<string>",
"subCategories": "<string>",
"brand": "<string>",
"countryCode": "<string>",
"productPublicId": "<string>",
"minimumOrderQuantity": "<integer>",
"costPrice": {
"price": "<double>",
"unitQuantity": "<integer>",
"unitPrice": "<double>"
},
"sellingPrice": {
"price": "<double>",
"unitQuantity": "<integer>",
"unitPrice": "<double>"
},
"promotion": {
"id": "<long>",
"uuid": "<string>",
"createdAt": "<dateTime>",
"updatedAt": "<dateTime>",
"tenantId": "<string>",
"merchantId": "<string>",
"name": "<string>",
"description": "<string>",
"discountType": "FIXED",
"amount": "<double>",
"percentage": "<integer>",
"endDate": "<dateTime>",
"isActive": "<boolean>"
},
"quantityOnHand": "<integer>",
"reorderLevel": "<integer>",
"stockLevel": "HIGH",
"unit": "<string>",
"weight": "<double>",
"visibility": "<boolean>",
"images": [
"<string>",
"<string>"
],
"clusters": [
"<long>",
"<long>"
]
},
"quantity": "<integer>",
"unitPrice": "<double>",
"amount": "<double>",
"promotionDiscount": "<double>",
"costPrice": "<double>",
"totalCostPrice": "<double>",
"profit": "<double>",
"sellingPrice": {
"price": "<double>",
"unitQuantity": "<integer>",
"unitPrice": "<double>"
},
"quantityRemaining": "<integer>",
"parentSale": {
"value": "<Circular reference to #/components/schemas/Sale detected>"
}
}
],
"deliveryStatus": "RETURNED",
"deliveryMode": "PICK_UP",
"paymentMode": "IN_STORE",
"deliveryAddress": "<string>",
"paymentStatus": "FAILED",
"saleTransaction": {
"id": "<string>",
"createdAt": "<dateTime>",
"updatedAt": "<dateTime>",
"amount": "<double>",
"totalShippingFee": "<double>",
"totalOrderAmount": "<double>",
"sales": [
{
"value": "<Circular reference to #/components/schemas/Sale detected>"
},
{
"value": "<Circular reference to #/components/schemas/Sale detected>"
}
],
"tenantId": "<string>",
"countryCode": "<string>",
"paymentStatus": "SUCCESSFUL",
"paymentMethod": "CASH",
"paymentMode": "POSTPAID",
"transactionReference": "<string>",
"globalOrderNumber": "<string>"
},
"parentSale": {
"value": "<Circular reference to #/components/schemas/Sale detected>"
},
"salesTracking": [
{
"id": "<long>",
"uuid": "<string>",
"createdAt": "<dateTime>",
"updatedAt": "<dateTime>",
"deliveryStatus": "CANCELLED",
"sale": {
"value": "<Circular reference to #/components/schemas/Sale detected>"
},
"isDelayed": "<boolean>",
"merchantId": "<string>",
"businessId": "<string>",
"tenantId": "<string>"
},
{
"id": "<long>",
"uuid": "<string>",
"createdAt": "<dateTime>",
"updatedAt": "<dateTime>",
"deliveryStatus": "ACCEPTED",
"sale": {
"value": "<Circular reference to #/components/schemas/Sale detected>"
},
"isDelayed": "<boolean>",
"merchantId": "<string>",
"businessId": "<string>",
"tenantId": "<string>"
}
]
},
{
"id": "<string>",
"createdAt": "<dateTime>",
"updatedAt": "<dateTime>",
"tenantId": "<string>",
"agentId": "<string>",
"merchantId": "<string>",
"businessId": "<string>",
"customerId": "<string>",
"requestId": "<string>",
"transactionReference": "<string>",
"paymentReference": "<string>",
"countryCode": "<string>",
"deliveryNote": "<string>",
"orderNumber": "<string>",
"globalOrderNumber": "<string>",
"totalQuantity": "<integer>",
"isPartialParent": "<boolean>",
"isPartial": "<boolean>",
"isUpdated": "<boolean>",
"shippingFee": "<double>",
"orderAmount": "<double>",
"totalAmount": "<double>",
"discount": "<double>",
"totalPromotionDiscount": "<double>",
"discountType": "FIXED",
"amountPaid": "<double>",
"paymentMethod": "QR",
"saleDetails": [
{
"id": "<long>",
"uuid": "<string>",
"createdAt": "<dateTime>",
"updatedAt": "<dateTime>",
"tenantId": "<string>",
"merchantId": "<string>",
"businessId": "<string>",
"countryCode": "<string>",
"sale": {
"value": "<Circular reference to #/components/schemas/Sale detected>"
},
"product": {
"id": "<long>",
"uuid": "<string>",
"createdAt": "<dateTime>",
"updatedAt": "<dateTime>",
"tenantId": "<string>",
"merchantId": "<string>",
"businessId": "<string>",
"name": "<string>",
"description": "<string>",
"sku": "<string>",
"category": "<string>",
"subCategories": "<string>",
"brand": "<string>",
"countryCode": "<string>",
"productPublicId": "<string>",
"minimumOrderQuantity": "<integer>",
"costPrice": {
"price": "<double>",
"unitQuantity": "<integer>",
"unitPrice": "<double>"
},
"sellingPrice": {
"price": "<double>",
"unitQuantity": "<integer>",
"unitPrice": "<double>"
},
"promotion": {
"id": "<long>",
"uuid": "<string>",
"createdAt": "<dateTime>",
"updatedAt": "<dateTime>",
"tenantId": "<string>",
"merchantId": "<string>",
"name": "<string>",
"description": "<string>",
"discountType": "PERCENTAGE",
"amount": "<double>",
"percentage": "<integer>",
"endDate": "<dateTime>",
"isActive": "<boolean>"
},
"quantityOnHand": "<integer>",
"reorderLevel": "<integer>",
"stockLevel": "OUT_OF_STOCK",
"unit": "<string>",
"weight": "<double>",
"visibility": "<boolean>",
"images": [
"<string>",
"<string>"
],
"clusters": [
"<long>",
"<long>"
]
},
"quantity": "<integer>",
"unitPrice": "<double>",
"amount": "<double>",
"promotionDiscount": "<double>",
"costPrice": "<double>",
"totalCostPrice": "<double>",
"profit": "<double>",
"sellingPrice": {
"price": "<double>",
"unitQuantity": "<integer>",
"unitPrice": "<double>"
},
"quantityRemaining": "<integer>",
"parentSale": {
"value": "<Circular reference to #/components/schemas/Sale detected>"
}
},
{
"id": "<long>",
"uuid": "<string>",
"createdAt": "<dateTime>",
"updatedAt": "<dateTime>",
"tenantId": "<string>",
"merchantId": "<string>",
"businessId": "<string>",
"countryCode": "<string>",
"sale": {
"value": "<Circular reference to #/components/schemas/Sale detected>"
},
"product": {
"id": "<long>",
"uuid": "<string>",
"createdAt": "<dateTime>",
"updatedAt": "<dateTime>",
"tenantId": "<string>",
"merchantId": "<string>",
"businessId": "<string>",
"name": "<string>",
"description": "<string>",
"sku": "<string>",
"category": "<string>",
"subCategories": "<string>",
"brand": "<string>",
"countryCode": "<string>",
"productPublicId": "<string>",
"minimumOrderQuantity": "<integer>",
"costPrice": {
"price": "<double>",
"unitQuantity": "<integer>",
"unitPrice": "<double>"
},
"sellingPrice": {
"price": "<double>",
"unitQuantity": "<integer>",
"unitPrice": "<double>"
},
"promotion": {
"id": "<long>",
"uuid": "<string>",
"createdAt": "<dateTime>",
"updatedAt": "<dateTime>",
"tenantId": "<string>",
"merchantId": "<string>",
"name": "<string>",
"description": "<string>",
"discountType": "PERCENTAGE",
"amount": "<double>",
"percentage": "<integer>",
"endDate": "<dateTime>",
"isActive": "<boolean>"
},
"quantityOnHand": "<integer>",
"reorderLevel": "<integer>",
"stockLevel": "OUT_OF_STOCK",
"unit": "<string>",
"weight": "<double>",
"visibility": "<boolean>",
"images": [
"<string>",
"<string>"
],
"clusters": [
"<long>",
"<long>"
]
},
"quantity": "<integer>",
"unitPrice": "<double>",
"amount": "<double>",
"promotionDiscount": "<double>",
"costPrice": "<double>",
"totalCostPrice": "<double>",
"profit": "<double>",
"sellingPrice": {
"price": "<double>",
"unitQuantity": "<integer>",
"unitPrice": "<double>"
},
"quantityRemaining": "<integer>",
"parentSale": {
"value": "<Circular reference to #/components/schemas/Sale detected>"
}
}
],
"deliveryStatus": "DELIVERED",
"deliveryMode": "DISPATCH",
"paymentMode": "POSTPAID",
"deliveryAddress": "<string>",
"paymentStatus": "FAILED",
"saleTransaction": {
"id": "<string>",
"createdAt": "<dateTime>",
"updatedAt": "<dateTime>",
"amount": "<double>",
"totalShippingFee": "<double>",
"totalOrderAmount": "<double>",
"sales": [
{
"value": "<Circular reference to #/components/schemas/Sale detected>"
},
{
"value": "<Circular reference to #/components/schemas/Sale detected>"
}
],
"tenantId": "<string>",
"countryCode": "<string>",
"paymentStatus": "REFUNDED",
"paymentMethod": "BANK_TRANSFER",
"paymentMode": "PREPAID",
"transactionReference": "<string>",
"globalOrderNumber": "<string>"
},
"parentSale": {
"value": "<Circular reference to #/components/schemas/Sale detected>"
},
"salesTracking": [
{
"id": "<long>",
"uuid": "<string>",
"createdAt": "<dateTime>",
"updatedAt": "<dateTime>",
"deliveryStatus": "RETURN_CONFIRMED",
"sale": {
"value": "<Circular reference to #/components/schemas/Sale detected>"
},
"isDelayed": "<boolean>",
"merchantId": "<string>",
"businessId": "<string>",
"tenantId": "<string>"
},
{
"id": "<long>",
"uuid": "<string>",
"createdAt": "<dateTime>",
"updatedAt": "<dateTime>",
"deliveryStatus": "RETURNED",
"sale": {
"value": "<Circular reference to #/components/schemas/Sale detected>"
},
"isDelayed": "<boolean>",
"merchantId": "<string>",
"businessId": "<string>",
"tenantId": "<string>"
}
]
}
],
"meta": {
"currentPage": "<long>",
"from": "<long>",
"to": "<long>",
"perPage": "<long>",
"total": "<long>",
"lastPage": "<long>"
}
}
LANGUAGE
CURL REQUEST
curl --request GET \
--url /sales/requestIds?requestIds=123&requestIds=456&userId=789 \
--header 'accept: application/json' \
--header 'content-type: application/json'
RESPONSE
Click Try It! to start a request and see the response here!