Cadastrar um Seller - API Boxlink

Request

Header Params

Authorization

string

required

Header para token JWT (utilize o prefixo Bearer ao inserir o token)

Body Params application/json

JSON para informar os dados do Seller no TMS Boxlink

ativo

boolean

required

Indica se o Seller está ativo ou não

Example:

true

documento

string

required

Número do documento do Seller CPF ou CNPJ

Example:

460.254.270-03

email

string

required

E-mail do Seller

Example:

francisco@buarque.com

endereco

object (EnderecoApiRequest)

required

JSON para informar os dados do Endereço no TMS Boxlink

bairro

string

required

Bairro do Seller

Example:

Centro

cep

string

required

CEP do Seller

Example:

63800-959

cidade

string

required

Cidade do Seller

Example:

Quixeramobim

complemento

string

optional

Complemento do endereço do Seller

Example:

Casa Verde

coordenadas

string

optional

Coordenadas GPS do Seller

Example:

12.12345, 95.12345

logradouro

string

required

Logradouro do Seller

Example:

Rua do Anjo

numero

string

required

Número do Seller

Example:

S/N

pontoReferencia

string

optional

Ponto de referência do endereço do Seller

Example:

Rua sem saída

uf

string

required

UF do Seller

Example:

CE

nomeFantasia

string

required

Nome Fantasia do Seller

Example:

Francisco Buarque

razaoSocial

string

required

Razão Social do Seller

Example:

Francisco Buarque

telefone

string

optional

Número do telefone do Seller

Example:

(85) 1234-5678

urlAvatar

string

optional

URL da imagem do avatar do Seller

Example:

https://example.com/url_logo.jpg

urlLogo

string

optional

URL da imagem do logo do Seller

Example:

https://example.com/url_logo.jpg

Example

{
    "ativo": true,
    "documento": "460.254.270-03",
    "email": "francisco@buarque.com",
    "endereco": {
        "bairro": "Centro",
        "cep": "63800-959",
        "cidade": "Quixeramobim",
        "complemento": "Casa Verde",
        "coordenadas": "12.12345, 95.12345",
        "logradouro": "Rua do Anjo",
        "numero": "S/N",
        "pontoReferencia": "Rua sem saída",
        "uf": "CE"
    },
    "nomeFantasia": "Francisco Buarque",
    "razaoSocial": "Francisco Buarque",
    "telefone": "(85) 1234-5678",
    "urlAvatar": "https://example.com/url_logo.jpg",
    "urlLogo": "https://example.com/url_logo.jpg"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.boxlink.com.br/v2/seller' \
--header 'Authorization;' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ativo": true,
    "documento": "460.254.270-03",
    "email": "francisco@buarque.com",
    "endereco": {
        "bairro": "Centro",
        "cep": "63800-959",
        "cidade": "Quixeramobim",
        "complemento": "Casa Verde",
        "coordenadas": "12.12345, 95.12345",
        "logradouro": "Rua do Anjo",
        "numero": "S/N",
        "pontoReferencia": "Rua sem saída",
        "uf": "CE"
    },
    "nomeFantasia": "Francisco Buarque",
    "razaoSocial": "Francisco Buarque",
    "telefone": "(85) 1234-5678",
    "urlAvatar": "https://example.com/url_logo.jpg",
    "urlLogo": "https://example.com/url_logo.jpg"
}'

Responses

🟢200OK

application/json

Body

JSON de retorno com dados básicos do Seller

ativo

boolean

optional

Indica se o Seller está ativo ou não

documento

string

optional

Número do documento do Seller

email

string

optional

E-mail do Seller

endereco

object (EnderecoApiResponse)

optional

bairro

string

optional

Bairro do Seller

cep

string

optional

CEP do Seller

cidade

string

optional

Cidade do Seller

complemento

string

optional

Complemento do endereço do Seller

coordenadas

string

optional

Coordenadas GPS do Seller

logradouro

string

optional

Logradouro do Seller

numero

string

optional

Número do Seller

pontoReferencia

string

optional

Ponto de referência do endereço do Seller

uf

string

optional

UF do Seller

id

integer <int64>

optional

ID do Seller

nomeFantasia

string

optional

Nome Fantasia do Seller

razaoSocial

string

optional

Razão Social do Seller

telefone

string

optional

Número do telefone do Seller

urlAvatar

string

optional

URL da imagem do avatar do Seller

urlLogo

string

optional

URL da imagem do logo do Seller

Example

{
    "ativo": true,
    "documento": "string",
    "email": "string",
    "endereco": {
        "bairro": "string",
        "cep": "string",
        "cidade": "string",
        "complemento": "string",
        "coordenadas": "string",
        "logradouro": "string",
        "numero": "string",
        "pontoReferencia": "string",
        "uf": "string"
    },
    "id": 0,
    "nomeFantasia": "string",
    "razaoSocial": "string",
    "telefone": "string",
    "urlAvatar": "string",
    "urlLogo": "string"
}

🟢201Seller cadastrado

🟠401Você não tem permissão para acessar este recurso

🔴500Exceção não esperada