API Boxlink

Cadastrar um Departamento do Seller

Ambiente de Produção

https://api.boxlink.com.br

POST

/v2/seller/departamento/{sellerId}

API do Canal Logístico | Cadastro Seller/departamento

Request

Path Params

sellerId

integer

required

sellerId

Header Params

Authorization

string

required

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

Body Params application/json

ativo

boolean

optional

Indica se o departamento do Seller está ativo ou não

Example:

true

documento

string

optional

Número do documento do departamento do Seller CPF ou CNPJ

Example:

460.254.270-03

string

optional

E-mail do departamento do Seller

Example:

francisco@buarque.com

endereco

object (EnderecoApiRequest)

optional

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

string

required

UF do Seller

Example:

nome

string

required

Nome do departamento do Seller

Example:

Francisco Buarque

telefone

string

optional

Número do telefone do departamento do Seller

Example:

(85) 1234-5678

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"
  },
  "nome": "Francisco Buarque",
  "telefone": "(85) 1234-5678"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.boxlink.com.br/v2/seller/departamento/' \
--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"
    },
    "nome": "Francisco Buarque",
    "telefone": "(85) 1234-5678"
}'

Responses

🟢200OK

application/json

Body

JSON de retorno com dados departamento do Seller

ativo

boolean

optional

Indica se o departamento do Seller está ativo ou não

documento

string

optional

Número do documento do departamento do Seller

string

optional

E-mail do departamento 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

string

optional

UF do Seller

integer <int64>

optional

ID do departamento do Seller

nome

string

optional

Nome do departamento do Seller

telefone

string

optional

Número do telefone do departamento 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,
  "nome": "string",
  "telefone": "string"
}

🟢201Departamento cadastrado

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

🔴500Exceção não esperada

Modified at 2023-03-02 18:42:19

Pesquisar última ocorrência por Período

Alterar um Departamento do Seller