Skip to main content
GET
/
v1
/
customers
/
{customerId}
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "status": "DRAFT",
  "code": {},
  "cpfcnpj": "<string>",
  "isPJ": true,
  "commercialName": "<string>",
  "companyName": "<string>",
  "addresses": [
    {
      "id": "<string>",
      "principal": true,
      "address": {
        "id": "<string>",
        "zipCode": "<string>",
        "streetDescription": "<string>",
        "streetNumber": "<string>",
        "complement": "<string>",
        "reference": "<string>",
        "neighborhood": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>",
        "municipality": {
          "id": "<string>",
          "name": "<string>",
          "code": "<string>",
          "uf": "<string>"
        },
        "code": "<string>",
        "type": "DELIVERY"
      }
    }
  ],
  "email": "<string>",
  "salesRepresentatives": [
    {
      "id": "<string>",
      "principal": true,
      "name": "<string>",
      "code": "<string>",
      "description": "<string>",
      "active": true
    }
  ],
  "customerGroupName": {},
  "phone": "<string>",
  "creditLimit": 123,
  "availableBalance": 123,
  "synchronized": "SUCCESS",
  "classifications": [
    {
      "name": "<string>",
      "code": "<string>",
      "classificationType": {
        "name": "<string>",
        "code": "<string>"
      }
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "stateInscription": "<string>",
  "observation": "<string>",
  "suframaCode": {},
  "customFields": [
    "<string>"
  ],
  "contacts": [
    {
      "id": "<string>",
      "name": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

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
object
required
cpfcnpj
string
required
isPJ
boolean
required
commercialName
string
required
companyName
string
required
addresses
object[]
required
email
string
required
salesRepresentatives
object[]
required
customerGroupName
object
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
object
required
customFields
string[]
required
contacts
object[]
required