Skip to main content
POST
/
v1
/
customers
Error
A valid request URL is required to generate request examples
{
  "commercialName": "<string>",
  "status": "DRAFT",
  "isPJ": true,
  "companyName": "<string>",
  "code": "<string>",
  "location": "AD",
  "documentType": "CNPJ",
  "cpfcnpj": "<string>",
  "stateInscription": "<string>",
  "countryCode": "<string>",
  "phone": "<string>",
  "email": "<string>",
  "observation": "<string>",
  "priceTableCode": "<string>",
  "creditLimit": 123,
  "availableBalance": 123,
  "customerParentCode": "<string>",
  "addresses": [
    {
      "zipCode": "<string>",
      "streetDescription": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "<string>",
      "type": "DELIVERY",
      "streetNumber": "<string>",
      "complement": "<string>",
      "reference": "<string>",
      "neighborhood": "<string>",
      "code": "<string>",
      "principal": false
    }
  ],
  "salesRepresentatives": [
    {
      "code": "<string>",
      "principal": false
    }
  ],
  "classifications": [
    {
      "code": "<string>",
      "name": "<string>",
      "classificationType": {
        "code": "<string>",
        "name": "<string>",
        "origin": "INTEGRATION",
        "useAsFilter": false,
        "useAsTag": false
      },
      "description": "<string>"
    }
  ],
  "suframaCode": "<string>",
  "customFields": [
    {
      "name": "<string>",
      "value": {}
    }
  ],
  "origin": "INTEGRATION",
  "contacts": [
    {
      "name": "string",
      "surname": "string",
      "email": "example@email.com",
      "phone": "string",
      "countryCode": "55",
      "position": "BUYER"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

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

Body

application/json
​
commercialName
string
required

commercial name of the customer

​
status
enum<string>
required

customer status

Available options:
DRAFT,
PENDING,
APPROVED,
BLOCKED,
INACTIVE
​
isPJ
boolean

determines if this customer is a company or not. only required when location is Brazil

​
companyName
string

company name of the customer, if it's a company. only required when location is Brazil

​
code
string

code of the customer. it must be unique

​
location
enum<string>

two letter country code defined by ISO 3166-1 Alpha-2 that defines where the customer is located

Available options:
AD,
AE,
AF,
AG,
AI,
AL,
AM,
AO,
AQ,
AR,
AS,
AT,
AU,
AW,
AX,
AZ,
BA,
BB,
BD,
BE,
BF,
BG,
BH,
BI,
BJ,
BL,
BM,
BN,
BO,
BR,
BS,
BT,
BV,
BW,
BY,
BZ,
CA,
CC,
CD,
CF,
CG,
CH,
CI,
CK,
CL,
CM,
CN,
CO,
CR,
CU,
CV,
CW,
CX,
CY,
CZ,
DE,
DJ,
DK,
DM,
DO,
DZ,
EC,
EE,
EG,
EH,
ER,
ES,
ET,
FI,
FJ,
FK,
FM,
FO,
FR,
GA,
GB,
GD,
GE,
GF,
GG,
GH,
GI,
GL,
GM,
GN,
GP,
GQ,
GR,
GS,
GT,
GU,
GW,
GY,
HK,
HM,
HN,
HR,
HT,
HU,
ID,
IE,
IL,
IM,
IN,
IO,
IQ,
IR,
IS,
IT,
JE,
JM,
JO,
JP,
KE,
KG,
KH,
KI,
KM,
KN,
KP,
KR,
KW,
KY,
KZ,
LA,
LB,
LC,
LI,
LK,
LR,
LS,
LT,
LU,
LV,
LY,
MA,
MC,
MD,
ME,
MF,
MG,
MH,
MK,
ML,
MM,
MN,
MO,
MP,
MQ,
MR,
MS,
MT,
MU,
MV,
MW,
MX,
MY,
MZ,
NA,
NC,
NE,
NF,
NG,
NI,
NL,
NO,
NP,
NR,
NU,
NZ,
OM,
PA,
PE,
PF,
PG,
PH,
PK,
PL,
PM,
PN,
PR,
PS,
PT,
PW,
PY,
QA,
RE,
RO,
RS,
RU,
RW,
SA,
SB,
SC,
SD,
SE,
SG,
SH,
SI,
SJ,
SK,
SL,
SM,
SN,
SO,
SR,
SS,
ST,
SV,
SX,
SY,
SZ,
TC,
TD,
TF,
TG,
TH,
TJ,
TK,
TL,
TM,
TN,
TO,
TR,
TT,
TV,
TW,
TZ,
UA,
UG,
US,
UY,
UZ,
VA,
VC,
VE,
VG,
VI,
VN,
VU,
WF,
WS,
XK,
YE,
YT,
ZA,
ZM,
ZW
​
documentType
enum<string>

type of document that the customer will be using to register itself.

Available options:
CNPJ,
CPF,
TAX_ID,
NIF,
PASSPORT,
OTHER
​
cpfcnpj
string

document that the customer will be using to register itself.

​
stateInscription
string

customer's state inscription

​
countryCode
string

countryCode refers to the international dialing code (DDI) of the country where the customer is located.

​
phone
string

phone number of the customer

​
email
string

customer email is required if location is set to Brazil

​
observation
string

observations about the customer

​
priceTableCode
string

if the customer has a price table, then the code of the price table must be provided

​
creditLimit
number

customer credit limit

​
availableBalance
number

customer available balance

​
customerParentCode
string

if the customer has a parent, then one existing customer parent code must be provided

​
addresses
object[]

customer address to be created after the customer. one of them must be the principal

​
salesRepresentatives
object[]

list of sales representatives to be related to the customer. should be used a code of an existent sales representative

​
classifications
object[]

customer classifications to be created and binded or binded, if they already exists

​
suframaCode
string

SUFRAMA code of the customer, if applicable

​
customFields
object[]

custom fields to be set to the customer

​
origin
enum<string>

customer origin

Available options:
INTEGRATION,
EXTERNAL_FORM
​
contacts
object[]

customer contacts to be created. Each contact must have a name and at least email or phone. Duplicate emails or phones are not allowed

Response

200 - application/json

creates a new customer

​
commercialName
string
required

commercial name of the customer

​
status
enum<string>
required

customer status

Available options:
DRAFT,
PENDING,
APPROVED,
BLOCKED,
INACTIVE
​
isPJ
boolean

determines if this customer is a company or not. only required when location is Brazil

​
companyName
string

company name of the customer, if it's a company. only required when location is Brazil

​
code
string

code of the customer. it must be unique

​
location
enum<string>

two letter country code defined by ISO 3166-1 Alpha-2 that defines where the customer is located

Available options:
AD,
AE,
AF,
AG,
AI,
AL,
AM,
AO,
AQ,
AR,
AS,
AT,
AU,
AW,
AX,
AZ,
BA,
BB,
BD,
BE,
BF,
BG,
BH,
BI,
BJ,
BL,
BM,
BN,
BO,
BR,
BS,
BT,
BV,
BW,
BY,
BZ,
CA,
CC,
CD,
CF,
CG,
CH,
CI,
CK,
CL,
CM,
CN,
CO,
CR,
CU,
CV,
CW,
CX,
CY,
CZ,
DE,
DJ,
DK,
DM,
DO,
DZ,
EC,
EE,
EG,
EH,
ER,
ES,
ET,
FI,
FJ,
FK,
FM,
FO,
FR,
GA,
GB,
GD,
GE,
GF,
GG,
GH,
GI,
GL,
GM,
GN,
GP,
GQ,
GR,
GS,
GT,
GU,
GW,
GY,
HK,
HM,
HN,
HR,
HT,
HU,
ID,
IE,
IL,
IM,
IN,
IO,
IQ,
IR,
IS,
IT,
JE,
JM,
JO,
JP,
KE,
KG,
KH,
KI,
KM,
KN,
KP,
KR,
KW,
KY,
KZ,
LA,
LB,
LC,
LI,
LK,
LR,
LS,
LT,
LU,
LV,
LY,
MA,
MC,
MD,
ME,
MF,
MG,
MH,
MK,
ML,
MM,
MN,
MO,
MP,
MQ,
MR,
MS,
MT,
MU,
MV,
MW,
MX,
MY,
MZ,
NA,
NC,
NE,
NF,
NG,
NI,
NL,
NO,
NP,
NR,
NU,
NZ,
OM,
PA,
PE,
PF,
PG,
PH,
PK,
PL,
PM,
PN,
PR,
PS,
PT,
PW,
PY,
QA,
RE,
RO,
RS,
RU,
RW,
SA,
SB,
SC,
SD,
SE,
SG,
SH,
SI,
SJ,
SK,
SL,
SM,
SN,
SO,
SR,
SS,
ST,
SV,
SX,
SY,
SZ,
TC,
TD,
TF,
TG,
TH,
TJ,
TK,
TL,
TM,
TN,
TO,
TR,
TT,
TV,
TW,
TZ,
UA,
UG,
US,
UY,
UZ,
VA,
VC,
VE,
VG,
VI,
VN,
VU,
WF,
WS,
XK,
YE,
YT,
ZA,
ZM,
ZW
​
documentType
enum<string>

type of document that the customer will be using to register itself.

Available options:
CNPJ,
CPF,
TAX_ID,
NIF,
PASSPORT,
OTHER
​
cpfcnpj
string

document that the customer will be using to register itself.

​
stateInscription
string

customer's state inscription

​
countryCode
string

countryCode refers to the international dialing code (DDI) of the country where the customer is located.

​
phone
string

phone number of the customer

​
email
string

customer email is required if location is set to Brazil

​
observation
string

observations about the customer

​
priceTableCode
string

if the customer has a price table, then the code of the price table must be provided

​
creditLimit
number

customer credit limit

​
availableBalance
number

customer available balance

​
customerParentCode
string

if the customer has a parent, then one existing customer parent code must be provided

​
addresses
object[]

customer address to be created after the customer. one of them must be the principal

​
salesRepresentatives
object[]

list of sales representatives to be related to the customer. should be used a code of an existent sales representative

​
classifications
object[]

customer classifications to be created and binded or binded, if they already exists

​
suframaCode
string

SUFRAMA code of the customer, if applicable

​
customFields
object[]

custom fields to be set to the customer

​
origin
enum<string>

customer origin

Available options:
INTEGRATION,
EXTERNAL_FORM
​
contacts
object[]

customer contacts to be created. Each contact must have a name and at least email or phone. Duplicate emails or phones are not allowed