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 my orders

GET
/v1/orders/my-orders
order
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/orders/my-orders'
Response Response Example
200 - Success
{
    "orders": [
        {
            "id": 1,
            "status": "PAID",
            "quotaQuantity": 10,
            "paymentMethod": "PIX",
            "referral": null,
            "totalValue": "500",
            "paymentProviderName": "pay2m",
            "paidAt": null,
            "createdAt": "2025-02-14T18:54:03.625Z",
            "raffle": {
                "id": 1,
                "raffleCategoryId": 99,
                "userId": 1,
                "title": "Luxury Car Giveaway",
                "subtitle": "News!",
                "description": "Win a luxury car!",
                "slug": "luxury-car-giveaway",
                "statusText": "Open for reservations",
                "privacy": "PUBLIC",
                "reservationType": "AUTO",
                "photoUrl": "https://example.com/photo.jpg",
                "status": "ACTIVE",
                "startsAt": "2025-02-14T18:54:03.613Z",
                "endsAt": "2025-02-21T18:54:03.613Z",
                "reservationFields": [
                    "name",
                    "email",
                    "phone",
                    "cpf"
                ],
                "isHighlighted": false,
                "certificateCode": null,
                "enableNotification": false,
                "showEndsAt": true,
                "quotaPrice": "50",
                "quotaQuantity": 100,
                "quotaQuantityAvailable": 90,
                "freeCampaign": false,
                "affiliate": false,
                "minReservationQuantity": 1,
                "maxReservationQuantity": 100,
                "reservationTimeLimit": 30,
                "maxBuyerQuantity": 100,
                "fastSelectionCards": [],
                "popularSelectionCard": 1,
                "showProgressBar": true,
                "showRank": true,
                "showPrices": true,
                "enableQuotaPrizes": false,
                "automaticQuotaPrizeDistribution": false,
                "enablePromotions": false,
                "cumulative": false,
                "promotionType": "BY_QUOTA_QUANTITY",
                "enableAntiSpam": false,
                "antiSpamMaxQuota": 3,
                "antiSpamTimeout": 60,
                "whatsapp": null,
                "whatsappGroup": null,
                "telegram": null,
                "email": null,
                "createdAt": "2025-02-14T18:54:03.615Z",
                "updatedAt": "2025-02-14T18:55:00.017Z"
            },
            "luckyNumbers": []
        }
    ],
    "count": 1,
    "totalPages": 1
}

Request

Query Params
startDate
string <date>
optional
Example:
2024-01-01
endDate
string <date>
optional
Example:
2025-01-01
status
enum<string> 
optional
Allowed values:
PAIDPENDINGCANCELED
Example:
PAID
page
string 
optional
Example:
1

Responses

🟢200OK
application/json
Body
orders
array [object {10}] 
required
id
integer 
required
status
enum<string> 
required
Allowed values:
PAIDPENDINGCANCELED
quotaQuantity
integer 
required
paymentMethod
enum<string> 
required
Allowed values:
PIXCREDIT_CARDBILLTRANSFERFREE
referral
string  | null 
required
totalValue
string 
required
paymentProviderName
enum<string> 
required
Allowed values:
pay2mpagguefreeCampaign
paidAt
string <date>
required
createdAt
string <date>
required
raffle
object 
required
count
integer 
required
totalPages
integer 
required
🟠401Unauthorized
🟠403Forbidden
Previous
get orders by raffle id
Next
get order details
Built with