v1

latestOpenAPI 3.1.02026-07-26477322.4 KB

Criar cliente

post/customers

Request body

namestring

Nome do cliente. Max: 64 caracteres.

emailstring

E-mail do cliente. Max: 64 caracteres

codestring

Código de referência do cliente no sistema da loja. Max: 52 caracteres

documentstring

CPF, CNPJ ou PASSPORT do cliente. Max: 16 caracteres para CPF e CNPJ e Max: 50 caracteres para PASSPORT

document_typestring

Tipo de documento. Valores possíveis: CPF, CNPJ ou PASSPORT.

typestring

Tipo de cliente. Valores possíveis: individual (pessoa física) ou company (pessoa jurídica).<br>Obrigatório, caso o document seja enviado.

genderstring

Sexo do cliente . Valores possíveis: male ou female

birthdatestring date

Data de nascimento do cliente.

metadatastring

Objeto chave/valor utilizado para armazenar informações adicionais sobre o cliente. Saiba mais sobre metadata

Response

200

idstring

namestring

emailstring

codestring

documentstring

document_typestring

typestring

genderstring

delinquentboolean

created_atstring

updated_atstring

birthdatestring

Example response

{
  "id": "cus_QA5V47r9c0Im3dzN",
  "name": "Tony Stark",
  "email": "tonystarkk@avengers.com",
  "code": "MY_CUSTOMER_001",
  "document": "93095135270",
  "document_type": "CPF",
  "type": "individual",
  "gender": "male",
  "address": {
    "id": "addr_KewjagEfrCbY1doZ",
    "line_1": "375, Av. General Justo, Centro",
    "line_2": "8º andar",
    "zip_code": "20021130",
    "city": "Rio de Janeiro",
    "state": "RJ",
    "country": "BR",
    "status": "active",
    "created_at": "2017-09-22T15:36:46Z",
    "updated_at": "2018-04-03T17:46:20Z"
  },
  "created_at": "2017-09-22T15:36:46Z",
  "updated_at": "2018-04-03T17:46:20Z",
  "birthdate": "1984-05-03T00:00:00Z",
  "phones": {
    "home_phone": {
      "country_code": "55",
      "number": "000000000",
      "area_code": "21"
    },
    "mobile_phone": {
      "country_code": "55",
      "number": "000000000",
      "area_code": "21"
    }
  },
  "metadata": {
    "id": "my_customer_id",
    "company": "Avengers"
  }
}

All 47 operations