Skip to main content
GET
/
v1
/
pvt
/
Order
/
{orderId}
cURL
curl --request GET \
  --url https://api.bonifiq.com.br/v1/pvt/Order/{orderId} \
  --header 'Authorization: Basic <encoded-value>'
{
  "Id": 123,
  "OriginalId": "<string>",
  "OrderPlacementDate": "2023-11-07T05:31:56Z",
  "OrderCompletedDate": "2023-11-07T05:31:56Z",
  "OrderCancelledDate": "2023-11-07T05:31:56Z",
  "OrderStatus": "<string>",
  "IsCancelledOrReturned": true,
  "IsCompleted": true,
  "OrderTotal": 123,
  "Customer": {
    "Id": 123,
    "OriginalId": "<string>",
    "Name": "<string>",
    "Email": "<string>",
    "Phone": "<string>",
    "BirthdayDate": "2023-11-07T05:31:56Z",
    "SignupDate": "2023-11-07T05:31:56Z",
    "Document": "<string>",
    "IsEnrolled": true,
    "PointsBalance": 123,
    "BalanceOfPoints": 123,
    "Cashback": 123,
    "BirthdayUpdateDate": "2023-11-07T05:31:56Z",
    "FirstName": "<string>",
    "PublicId": "<string>",
    "SecondaryId": "<string>",
    "OrderCount": 123,
    "ReasonEnrolled": "<string>",
    "AdminId": 123,
    "EmailAdmin": "<string>",
    "EnrolledDate": "2023-11-07T05:31:56Z",
    "TierName": "<string>",
    "Origin": 0,
    "RfmGroup": 0,
    "RfmGroupName": "<string>",
    "Affiliate": {
      "Id": 123,
      "CustomerId": 123,
      "IsActive": true,
      "AffiliateCoupon": "<string>",
      "LastUpdated": "2023-11-07T05:31:56Z",
      "CouponHistories": [
        {
          "Id": 123,
          "AffiliateId": 123,
          "Coupon": "<string>",
          "AssociatedDate": "2023-11-07T05:31:56Z"
        }
      ]
    }
  },
  "Products": [
    {
      "OriginalId": "<string>",
      "Title": "<string>",
      "Url": "<string>",
      "ImageUrl": "<string>",
      "IsActive": true,
      "ProductPrice": 123
    }
  ],
  "UpdatedDate": "2023-11-07T05:31:56Z",
  "Coupon": "<string>",
  "State": 0,
  "Origin": 0,
  "Metadatas": [
    {
      "Id": 123,
      "OrderId": 123,
      "Name": "<string>",
      "Value": "<string>"
    }
  ],
  "RedeemedReward": {
    "Id": 123,
    "ExternalCode": "<string>",
    "CashValue": 123,
    "IsCanceled": true,
    "RedeemDate": "2023-11-07T05:31:56Z",
    "Points": {
      "Id": 123,
      "Points": 123,
      "Type": 0,
      "EventKey": "<string>"
    },
    "Coupon": {
      "CouponCode": "<string>",
      "CreatedDate": "2023-11-07T05:31:56Z",
      "IsUsed": true,
      "CouponValue": 123,
      "CustomerId": 123,
      "ValidDateStart": "2023-11-07T05:31:56Z",
      "ValidDateEnd": "2023-11-07T05:31:56Z",
      "CouponType": 0
    }
  }
}

Authorizations

​
Authorization
string
header
required

Use API Basic Auth Keys

Path Parameters

​
orderId
string
required

Response

200 - application/json

This class represents a request with an external Id (such as OrderId) in a third-party system

​
Id
integer<int32>
​
OriginalId
string

This is the Id in the third party system.

​
OrderPlacementDate
string<date-time>

Date of the customer's purchase.

​
OrderCompletedDate
string<date-time> | null

Date the order reached the completed state (usually it's invoiced or delivered).

​
OrderCancelledDate
string<date-time> | null

if the order is cancelled, contains the date.

​
OrderStatus
string

Status at the client's order system.

​
IsCancelledOrReturned
boolean

if true the order was cancelled or returned.

​
IsCompleted
boolean

If true it means the order has reached its final status and points can be awarded to the consumer.

​
OrderTotal
number<decimal>

Can be used at Loyalty Programs. Important: these values should not include Shipping costs.

​
Customer
object

Buyer registration.

​
Products
object[] | null

Products listed on the order.

​
UpdatedDate
string<date-time>

the date from the last update on this order.

​
Coupon
string | null

Coupon code used on this order.

​
State
enum<integer>

Order State: 0=Inicial, 1= Pendente, 2=Completo, 3=Cancelado, 4=Ignorado

Available options:
0,
1,
2,
3,
4
​
Origin
enum<integer>

How this order was integrated into BonifiQ 0 = Order Integration with ecommerce platform 1 = External API 2 = File import

Available options:
0,
1,
2,
3,
4
​
Metadatas
object[] | null
​
RedeemedReward
object

Reward used in this order (if any)