Skip to main content
GET
Error

Authorizations

x-api-key
string
header
required

unique identifier access key. each brand has it own unique key.

Path Parameters

customerId
string
required

Response

customer details

id
string
required
status
enum<string>
required
Available options:
DRAFT,
PENDING,
APPROVED,
BLOCKED,
INACTIVE
code
string | null
required
cpfcnpj
string
required
isPJ
boolean
required
commercialName
string
required
companyName
string
required
addresses
object[]
required
email
string
required
salesRepresentatives
object[]
required
customerGroupName
string | null
required
phone
string
required
creditLimit
number
required
availableBalance
number
required
synchronized
enum<string>
required
Available options:
SUCCESS,
ERROR,
NOT_SYNCHRONIZED,
PROCESSING
classifications
object[]
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
stateInscription
string
required
observation
string
required
suframaCode
string | null
required
customFields
string[]
required
contacts
object[]
required