BObonifiq
Customer

Get a customer information from its ID

Changed on

The response includes segments: the active customer segments the customer belongs to, with name and tag (the segment's public identifier). Inactive segments are omitted and the list is empty when the customer is not in any active segment.

get/v1/pvt/Customer/{id}

Request

  • Base URL
    https://api.bonifiq.com.br
  • Auth
    HTTP basic

Path parameters

idstring required

Id from the client`s store, usually email address

Response

ErrorMessagestring nullable

Error message returned when the request fails validation or processing. For warnings and successful responses, consumers should usually inspect Result, Code and Severity first.

ErrorCodeinteger nullable

Legacy numeric error code derived from internal API errors when available. This field is relevant only for error flows that use ApiResponseErrorDescription.

Codestring nullable

Endpoint-specific business code formatted as a two-digit string, such as 03 or 07. This field is available for success, warning and error outcomes.

CodeNamestring nullable

Symbolic enum name associated with Code, such as CheckoutNotFound.

Severity0 | 1 | 2

0 = Success 1 = Warning 2 = Error

HasWarningboolean

Convenience flag that is true when Severity is Warning. Warnings are valid 200 OK business outcomes and should not be handled as transport or validation errors.

HasErrorboolean

Indicates whether the request failed and should be handled as an error response. This flag is reserved for real API errors; warnings must keep this property as false.

Changes

  • ab5bc0ffd114Revision changes
    • info

      added the optional property ///// to the response with the status