---
title: "GET /v1/pvt/Order/{orderId}"
method: GET
path: "/v1/pvt/Order/{orderId}"
tags: ["Order"]
---

# GET /v1/pvt/Order/{orderId}

`GET /v1/pvt/Order/{orderId}`

## Request

- Base URL: `https://api.bonifiq.com.br`
- URL: `https://api.bonifiq.com.br/v1/pvt/Order/{orderId}`
- Auth: HTTP basic

## Path parameters

- `orderId` string, required

## Response `200`

- OrderGetResponse: This class represents a request with an external Id (such as OrderId) in a third-party system
  - `Id` integer
  - `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, nullable: Date the order reached the completed state (usually it's invoiced or delivered).
  - `OrderCancelledDate` string, date-time, nullable: 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: Can be used at Loyalty Programs. Important: these values should not include Shipping costs.
  - `Customer` ApiCustomer: This class represents a request with an external Id (such as OrderId) in a third-party system
    - `Id` integer
    - `OriginalId` string: This is the Id in the third party system.
    - `Name` string
    - `Email` string
    - `Locale` string, nullable
    - `Phone` string
    - `BirthdayDate` string, date-time, nullable
    - `SignupDate` string, date-time
    - `Document` string
    - `IsEnrolled` boolean
    - `PointsBalance` integer
    - `BalanceOfPoints` integer
    - `Cashback` number, nullable
    - `BirthdayUpdateDate` string, date-time, nullable
    - `FirstName` string
    - `PublicId` string, guid, nullable
    - `SecondaryId` string, nullable
    - `OrderCount` integer, nullable
    - `ReasonEnrolled` string, nullable
    - `AdminId` integer, nullable
    - `EmailAdmin` string, nullable
    - `EnrolledDate` string, date-time, nullable
    - `TierName` string
    - `Origin` 0 | 1 | 2 | 3 | 4 | 5: 0 = Platform 1 = PDV 2 = API 3 = OfflinePlatform 4 = Admin 5 = Affiliate
    - `RfmGroup` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11: 0 = CantMiss 1 = ConstantBuyers 2 = Vips 3 = AtRisk 4 = NeedAttention 5 = Promising 6 = Disconnected 7 = Hibernating 8 = Sleepy 9 = OnTheRise 10 = NewCustomers 11 = Unclassified
    - `RfmGroupName` string, nullable
    - `SegmentTags` string[], nullable: Tags dos segmentos ativos. Só vem preenchido quando a listagem pede IncludeSegments; fora disso vem vazio.
    - `Affiliate` ApiAffiliate
      - `Id` integer
      - `CustomerId` integer
      - `IsActive` boolean
      - `AffiliateCoupon` string, nullable
      - `LastUpdated` string, date-time, nullable
      - `CouponHistories` object[]
        - `Id` integer
        - `AffiliateId` integer
        - `Coupon` string
        - `AssociatedDate` string, date-time
    - `AffiliateCode` string, nullable
    - `AffiliateCodeAssignedAt` string, date-time, nullable
  - `Products` object[], nullable: Products listed on the order.
    - `OriginalId` string: Id from the client store
    - `Title` string: Product Title/Name
    - `Url` string, nullable: Url from the client store from the product.
    - `ImageUrl` string, nullable: Url from where the Product image is hosted.
    - `IsActive` boolean: If true the product is active.
    - `ProductPrice` number, nullable
  - `UpdatedDate` string, date-time: the date from the last update on this order.
  - `Coupon` string, nullable: Coupon code used on this order.
  - `State` 0 | 1 | 2 | 3 | 4: 0 = Initial 1 = Pending 2 = Completed 3 = Cancelled 4 = Ignored
  - `Origin` 0 | 1 | 2 | 3 | 4: 0 = Integration 1 = API 2 = Import 3 = PDV 4 = OfflineIntegration
  - `Branch` ApiBranch: This class represents a request with an external Id (such as OrderId) in a third-party system
    - `Id` integer
    - `OriginalId` string: This is the Id in the third party system.
    - `Name` string
  - `TenantSalesman` ApiTenantSalesman: This class represents a request with an external Id (such as OrderId) in a third-party system
    - `Id` integer
    - `OriginalId` string: This is the Id in the third party system.
    - `Name` string
    - `Store` string
    - `Branch` ApiBranch: This class represents a request with an external Id (such as OrderId) in a third-party system
      - `Id` integer
      - `OriginalId` string: This is the Id in the third party system.
      - `Name` string
    - `BranchId` integer, nullable
  - `Metadatas` object[], nullable
    - `Id` integer
    - `OrderId` integer
    - `Name` string
    - `Value` string
  - `ExternalCoupon` string, nullable: This is the "official" field for coupons from the ecomm platform - normally used for affiliate Coupon
  - `RedeemedReward` CustomerRedeemedHistoryItem
    - `Id` integer: Unique ID for this redeem
    - `ExternalCode` string: Unique external code for this redeem. Could be used for integrating with third-party systems
    - `CashValue` number, nullable: If it is a Cashback or Value rewards represents the amount in cash (R$) given for the customer
    - `IsCanceled` boolean: If true means this reward was cancelled and the points was given back to the customer
    - `RedeemDate` string, date-time: Date the reward was redeemed
    - `Points` RewardRedeemedReponsePoints
      - `Id` integer: Unique ID of the generated point
      - `Points` integer: How many points was used
      - `Type` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19: 0 = Purchase 1 = Signup 2 = Birthday 3 = Ordinary 4 = Reward 5 = Review 6 = Refund 7 = Expire 8 = Referral 9 = SocialMediaFollowFacebook 10 = SocialMediaFollowInstagram 11 = PartialOrderRefund 12 = Quiz 13 = CustomObjective 14 = ReferralAffiliate 15 = SocialMediaFollowLinkedin 16 = SocialMediaFollowTikTok 17 = Campaign 18 = Participation 19 = Fitness
      - `EventKey` string: Unique key for this record. Used to preventing duplication
    - `Coupon` CreateCouponResponse: Create Coupon Response Model
      - `CouponCode` string: Coupon Code
      - `CreatedDate` string, date-time: Create Date
      - `IsUsed` boolean, nullable: if true the coupon was already bein use or inactivated.
      - `CouponValue` number: Discount value for the coupon
      - `CustomerId` integer: the customer that the coupon is being given.
      - `ValidDateStart` string, date-time, nullable: Date the coupon is start to being enable for rewards
      - `ValidDateEnd` string, date-time, nullable: Date the coupon will not be able for rewards anymore.
      - `CouponType` 0 | 1 | 2 | 3 | 4: 0 = FixedValue 1 = Percent 2 = FreeShipping 3 = DiscountShipping 4 = Others

## Changes

- **2026-10-29** `58b5cd54c79b`: 1 warning
  - added the new `11.00` enum value to the `allOf[#/components/schemas/OrderCreateResponse]/allOf[subschema #2]/Customer/oneOf[#/components/schemas/ApiCustomer]/allOf[subschema #2]/RfmGroup/oneOf[#/components/schemas/MatrizRFMItem]/` response property for the response status `200`
- **2026-09-22** `92d04295402d`: 1 info
  - added the optional property `allOf[#/components/schemas/OrderCreateResponse]/allOf[subschema #2]/Customer/oneOf[#/components/schemas/ApiCustomer]/allOf[subschema #2]/SegmentTags` to the response with the `200` status
- **2026-09-18** `c5e8aa0a8d9b`: 1 info
  - added the optional property `allOf[#/components/schemas/OrderCreateResponse]/allOf[subschema #2]/Customer/oneOf[#/components/schemas/ApiCustomer]/allOf[subschema #2]/Locale` to the response with the `200` status

[Operation history](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/changes/v1/pvt/Order/:orderId/get.md)

---

[API](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis.md) - [All operations](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/revisions/bac0977b23d5?raw)