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 order details

GET
/v1/orders/{orderId}
order
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '/v1/orders/{{orderId}}'
Response Response Example
200 - Success
{
    "id": 1,
    "raffleId": 1,
    "userId": 1,
    "status": "PAID",
    "quotaQuantity": 10,
    "priceByQuota": "50",
    "referral": null,
    "paymentMethod": "PIX",
    "paymentProviderName": "pay2m",
    "totalValue": "500",
    "paidAt": null,
    "createdAt": "2025-02-14T18:54:03.625Z",
    "updatedAt": "2025-02-14T18:54:03.625Z",
    "raffle": {
        "id": 1,
        "title": "Luxury Car Giveaway",
        "subtitle": "News!",
        "photoUrl": "https://example.com/photo.jpg",
        "endsAt": "2025-02-21T18:54:03.613Z",
        "reservationTimeLimit": 30
    },
    "luckyNumbers": [],
    "user": {
        "id": 1,
        "phone": "11111111111"
    },
    "orderPixPayment": {
        "qrCodeId": "123456",
        "qrCodeContent": "123456"
    }
}

Request

Path Params
orderId
string 
required
Example:
{{orderId}}

Responses

🟢200OK
application/json
Body
id
integer 
required
raffleId
integer 
required
userId
integer 
required
status
enum<string> 
required
Allowed values:
PAIDPENDINGCANCELED
quotaQuantity
integer 
required
priceByQuota
string 
required
referral
string 
required
paymentMethod
enum<string> 
required
Allowed values:
PIXCREDIT_CARDBILLTRANSFERFREE
paymentProviderName
enum<string> 
required
Allowed values:
pay2mpagguefreeCampaign
totalValue
string 
required
paidAt
string <date>
required
createdAt
string <date>
required
updatedAt
string <date>
required
raffle
object 
required
id
integer 
required
title
string 
required
subtitle
string 
required
photoUrl
string 
required
endsAt
string 
required
reservationTimeLimit
integer 
required
luckyNumbers
array[string]
required
user
object 
required
id
integer 
required
phone
string 
required
orderPixPayment
object 
required
qrCodeId
string 
required
qrCodeContent
string 
required
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
Previous
get my orders
Next
pay order
Built with