Raffle System
  1. order
Raffle System
  • Raffles
    • authentication
      • admin login
      • user login
    • awarded-boxes
      • getAll
      • open awarded box
      • create
      • getAll by raffleId
      • delete
    • awarded-boxes-combo
      • create
      • getAll by raffleId
      • update
      • delete
    • tracking
      • get tracking info
    • pay2m-api
      • access token generation
      • generate billing qr code
      • consult qr code
      • list webhook
      • register/update webhook
      • delete webhook
    • provider-api
      • auth login
      • create pix static
      • get webhooks
      • create webhook
      • get balance
      • get extracts
      • edit webhook
      • delete webhook
      • get webhook details
      • restore webhook
    • winner
      • get quota prize winners
    • general
      • update settings
      • get settings
      • create notifications
      • get notifications
      • get notification by id
      • update notification
      • delete notification
      • create faq
      • get faqs
      • get faq by id
      • update faq
      • delete faq
    • metrics
      • get sales by day for raffle
      • get top buyers by raffle
      • get general metrics
      • get last orders
      • get raffle percentage of sales
      • get orders summary
      • get badges
      • get sell bar
      • get fake sold quotas percentage
      • create fake sold quotas percentage
      • update fake sold quotas percentage
    • payments
      • get payment providers
      • create/update payment provider
      • get payment provider by name
      • get pix payments
      • get my pix payments
      • get pix payment details
    • order
      • create order withou payment method
        POST
      • create order
        POST
      • get orders
        GET
      • get orders by raffle id
        GET
      • get my orders
        GET
      • get order details
        GET
      • pay order
        PATCH
      • cancel order
        PATCH
    • lucky-numbers
      • get lucky numbers by raffleId
      • get lucky numbers by orderId
    • raffle
      • toggle awarded boxes visualization
      • toggle awarded boxes winners visualization
      • toggle acumulative combo
      • update category
      • delete category
      • create raffle category
      • get categories
      • create raffle
      • get raffles
      • get raffle details
      • delete raffle
      • update raffle
      • get winners
      • get winner details
      • get winner info
      • create winner
      • upload file
    • user
      • create user
      • get users
      • update user
      • get user details
      • delete user
      • get user by phone
      • get profile
      • create customer
      • update customer
  1. order

get orders by raffle id

GET
/v1/orders/raffle/{raffleId}
order
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '/v1/orders/raffle/{{raffleId}}'
Response Response Example
200 - Success
{
    "orders": [
        {
            "id": 4,
            "status": "PAID",
            "quotaQuantity": 20,
            "totalValue": "20",
            "paidAt": "2025-01-23T21:39:43.192Z",
            "createdAt": "2025-01-23T14:55:57.019Z",
            "user": {
                "name": "Admin User",
                "phone": "11111111111"
            }
        },
        {
            "id": 3,
            "status": "PENDING",
            "quotaQuantity": 10,
            "totalValue": "10",
            "paidAt": "2025-01-23T21:36:34.324Z",
            "createdAt": "2025-01-23T14:54:54.971Z",
            "user": {
                "name": "Admin User",
                "phone": "11111111111"
            }
        }
    ],
    "count": 2,
    "totalPages": 1
}

Request

Path Params
raffleId
string 
required
Example:
{{raffleId}}
Query Params
startDate
string <date>
optional
Example:
2024-11-01
endDate
string <date>
optional
Example:
2025-01-01
status
enum<string> 
optional
Allowed values:
PAIDPENDINGCANCELED
Example:
PAID
page
string 
optional
Example:
1
orderQuery
string 
optional
Example:
dev

Responses

🟢200OK
application/json
Body
orders
array [object {7}] 
required
id
integer 
required
status
enum<string> 
required
Allowed values:
PAIDPENDINGCANCELED
quotaQuantity
integer 
required
totalValue
string 
required
paidAt
string <date> | null 
required
createdAt
string <date>
required
user
object 
required
count
integer 
required
totalPages
integer 
required
🟠401Unauthorized
🟠403Forbidden
Previous
get orders
Next
get my orders
Built with