1. Exemplo do formato usado.

{
  "Content-Type": "Application/json",
  "Accept": "Application/json"
}

400 Usuário ausente

[
  {
    "code": 400,
    "message": "Usuário é requerido"
  }
]

400 Senha ausente

[
  {
    "code": 400,
    "message": "Senha é requerida"
  }
]

400 Auth header ausente

[
  {
    "code": 400,
    "message": "Auth header é requerido"
  }
]

401 Não tem acesso

[
  {
    "code": 401,
    "message": "Não tem acesso"
  }
]

500 Erro interno no servidor

[
  {
    "code": 500,
    "message": "Erro interno no servidor"
  }
]

2. Exemplo Usuário não autorizado.

{
  "code": 401,
  "message": "Não tem acesso"
}

REQUISIÇÃO

Rota

3. Exemplos

const resp = await fetch(`https://staging.api.myboxit.com.br/api/v1/standard/verificacao/credenciais`,
  {
    method: 'GET',
    headers: {
      Authorization: 'Basic ' + btoa('<username>:<password>')
    }
  }
);
const data = await resp.text();
console.log(data);

RESPOSTAS

200 Usuário é reconhecido e se envía para ele um mensagem de autenticação bem sucedida

[
  {
    "code": 200,
    "message": "Autenticação bem sucedida"
  }
]

401 Credenciais inválidas

[
  {
    "code": 401,
    "message": "Usuário ou senha inválida"
  }
]

REQUISIÇÃO

Rota

5. Exemplos

const resp = await fetch(
  `https://staging.api.myboxit.com.br/v1/standard/cotacao_locker`,
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Basic ' + btoa('<username>:<password>')
    },
    body: JSON.stringify({
      remetente: {
        cnpj: "",
        cep: ""
      },
      destinatario: {
        cnpj_cpf: "",
        cep: ""
      },
      carga: {
        valor_total: 0,
        cubagem: 0,
        peso_real: 0,
        total_volumes: 2
      },
      volumes: [{
        altura: 0,
        largura: 0,
        comprimento: 0,
        quantidade: 1,
        peso_real: 0,
        valor: 0
      }]
    })
  }
);
const data = await resp.json();
console.log(data);

RESPOSTAS

200 Cotação foi criada com sucesso

[
  {
    "code": 200,
    "message": "Sucesso",
    "cotacao": [
      {
        "codcotacao": 104,
        "preco": 17.7,
        "prazo_entrega": 4,
        "servico": "Entrega em locker",
        "armario_nome": "Boxit Teste 001",
        "armario_endereco": "Rua Benjamin Constant, 02 - Assis - SP - 19806130",
        "armario_cep": "19806130",
        "validade_cotacao": "2022/01/01"
      }
    ]
  }
]

203 O pedido excede o peso

[
  {
    "code": 203,
    "message": " O pedido excede o limite de peso"
  }
]

203 O pedido é muito grande

[
  {
    "code": 203,
    "message": "O pedido é muito grande para o armário"
  }
]

203 Não há armários

[
  {
    "code": 203,
    "message": "Não há armários perto desta localização"
  }
]

REQUISIÇÃO

Rota

4. Exemplos

const resp = await fetch(
  `https://staging.api.myboxit.com.br/api/v1/standard/registrar_pacote_locker`,
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Basic ' + btoa('<username>:<password>')
    },
    body: JSON.stringify({
      codcotacao: "100",
      numero_pedido: "1234",
      tipo_pedido: 2,
      data_pedido: "",
      data_coleta: "",
      remetente: {
        cnpj: "",
        razao_social: "",
        endereco: {
          cep: "",
          rua: "",
          numero: "",
          bairro: "",
          complemento: "",
          cidade: "",
          estado: ""
        }
      },
      destinatario: {
        cnpj_cpf: "",
        nome: "",
        email: "",
        telefone: ""
      }
    })
  }
);
const data = await resp.json();
console.log(data);

RESPOSTAS

200 O pacote foi criado com sucesso

[
  {
    "code": 200,
    "message": "Pacote 1234 criado com sucesso",
    "id_pedido": "100"
  }
]

203 Nenhuma cotação encontrada

[
  {
    "code": 203,
    "message": "Nenhuma cotação encontrada com esse código"
  }
]

203 Já existe um pacote

[
  {
    "code": 203,
    "message": "Já existe um pacote criado com esse código de cotação"
  }
]

REQUISIÇÃO

Rota

6. Exemplos

const resp = await fetch(
`https://staging.api.myboxit.com.br/api/v1/standard/cancelamento`,
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Basic ' + btoa('<username>:<password>')
    },
    body: JSON.stringify({
      numero_pacote: '2020101412483700200000'
    })
  }
);
const data = await resp.json();
console.log(data);

RESPOSTAS

200 O cancelamento foi feito com sucesso

[
  {
    "code": 200,
    "message": "Cancelamento do pacote: 2020101412483700200000 foi feito com sucesso"
  }
]

400 Não foi possível cancelar o pacote

[
  {
    "code": 400,
    "message": "Não foi possível cancelar o pacote"
  }
]

400 O pacote não está cadastrado no sistema

[
  {
    "code": 400,
    "message": "Não foi possível cancelar o numero do pacote: 2020101412483700200000 não está cadastrado no sistema"
  }
]

REQUISIÇÃO

Rota

3. Exemplos

const resp = await fetch(`https://staging.api.myboxit.com.br/api/v1/standard/consultar/pacotes`,
  {
    method: 'GET',
    headers: {
      Authorization: 'Basic ' + btoa('<username>:<password>')
    }
  }
);
const data = await resp.text();
console.log(data);

RESPOSTAS

200 Usuário é reconhecido e se envía para ele um mensagem de autenticação bem sucedida

[
  {
    "code": 200,
    "message": "Autenticação bem sucedida"
  }
]

401 Credenciais inválidas

[
  {
    "code": 401,
    "message": "Usuário ou senha inválida"
  }
]

REQUISIÇÃO

Rota

4. Exemplos

var settings = {
"url": "https://dev.api.myboxit.com.br/v2/companies/signin",
"method": "POST",
"timeout": 0,
"headers": {
  "Authorization": "Basic <username>:<password>"
},
};

$.ajax(settings).done(function (response) {
console.log(response);
});

RESPOSTAS

200 Autenticação com sucesso

[
  {
    "code": 200,
    "message": "SIGNIN_SUCCESS",
    "payload": {
        "clientId": 123,
        "companyId": 10,
        "companyName": "MYBOXIT"
    },
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
  }
]

400 Nome de usuário ou senha inválidos

[
  {
    "code": 400,
    "message": "USER_OR_PASSWORD_INVALID"
  }
]

404 Usuário não existe

[
  {
    "code": 404,
    "message": "USER_NOT_FOUND"
  }
]

REQUISIÇÃO

Rota

4. Exemplos

var settings = {
"url": "https://dev.api.myboxit.com.br/v2/packages/basic",
"method": "POST",
"timeout": 0,
"headers": {
  "Authorization": "Bearer <TOKEN> ",
  "Content-Type": "application/json"
},
"data": JSON.stringify({
  "trackingNumber": "package-ml-0006",
  "description": "test package basic integration brazil",
  "locationId": 15,
  "weight": 1,
  "size": "S",
  "email": "exemplo@gmail.com"
}),
};

$.ajax(settings).done(function (response) {
console.log(response);
});

RESPOSTAS

200 A reserva foi criada com sucesso

[
  {
    "code": 200,
    "message": "PACKAGE_CREATED",
    "boxitReservationId": "001540717"
  }
]

400 O pacote não pôde ser criado

[
  {
    "code": 400,
    "Mensaje": "PACKAGE_CANT_BE_CREATED",
  }
]

REQUISIÇÃO

Rota

4. Exemplos

var settings = {
"url": "https://dev.api.myboxit.com.br/v2/packages/reservation/{:boxitReservationId}",
"method": "POST",
"timeout": 0,
"headers": {
  "Authorization": "Bearer <TOKEN>"
},
};

$.ajax(settings).done(function (response) {
console.log(response);
});

RESPOSTAS

200 A porta foi atribuída com sucesso

[
  {
    "code": 200,
    "message": "DOOR_ASSIGNED",
    "doorNumber": "7"
  }
]

201 Pacote não encontrado

[
  {
    "code": 404,
    "message": "PACKAGE_NOT_FOUND"
  }
]

REQUISIÇÃO

Rota

4. Exemplos

var settings = {
"url": "https://dev.api.myboxit.com.br/v2/packages/{:boxitReservationId}",
"method": "POST",
"timeout": 0,
"headers": {
  "Authorization": "Bearer <TOKEN>"
},
};

$.ajax(settings).done(function (response) {
console.log(response);
});

RESPOSTAS

200 Pacote encontrado

[
  {
      "code": 200,
      "message": "RESERVATION_FOUND",
      "payload": [
          {
              "locationId": 15,
              "lockerName": "Boxit Entrega Já - Showroom",
              "doorNumber": null,
              "trackingNumber": "boxit-ml-000",
              "boxitReservationId": "00154071800",
              "email": "email@myboxit.com",
              "size": "S",
              "password": "123456",
              "createdAt": "2023-01-31T16:24:39.290Z",
              "packageType": 2,
              "status": "NEW"
          }
      ]
  }
]

201 Pacote não encontrado

[
  {
      "code": 404,
      "message": "NO_RESERVATIONS_FOUND"
  }
]

REQUISIÇÃO

Rota

4. Exemplos

var settings = {
"url": "https://dev.api.myboxit.com.br/v2/packages/{:boxitReservationId}",
"method": "PATCH",
"timeout": 0,
"headers": {
  "Authorization": "Bearer <TOKEN>",
  "Content-Type": "application/json"
},
"data": JSON.stringify({
  "size": "S",
  "email": "email@myboxit.com"
}),
};

$.ajax(settings).done(function (response) {
console.log(response);
});

RESPOSTAS

200 Pacote encontrado

[
  {
      "code": 200,
      "message": "RESERVATION_FOUND",
      "payload": [
          {
              "locationId": 15,
              "lockerName": "Boxit Entrega Já - Showroom",
              "doorNumber": null,
              "trackingNumber": "boxit-ml-000",
              "boxitReservationId": "00154071800",
              "email": "email@myboxit.com",
              "size": "S",
              "password": "123456",
              "createdAt": "2023-01-31T16:24:39.290Z",
              "packageType": 2,
              "status": "NEW"
          }
      ]
  }
]

201 Pacote não encontrado

[
  {
      "code": 404,
      "message": "NO_RESERVATIONS_FOUND"
  }
]

REQUISIÇÃO

Rota

4. Exemplos

var settings = {
"url": "https://dev.api.myboxit.com.br/v2/packages/{:boxitReservationId}",
"method": "DELETE",
"timeout": 0,
"headers": {
  "Authorization": "Bearer TOKEN"
},
};

$.ajax(settings).done(function (response) {
console.log(response);
});

RESPOSTAS

200 Pacote Cancelado

[
  {
      "code": 200,
      "message": "RESERVATION_CANCELED"
  }
]

201 Pacote não encontrado

[
  {
      "code": 404,
      "message": "PACKAGE_NOT_FOUND"
  }
]

REQUISIÇÃO

Rota

10. Exemplos

var settings = {
"url": "https://dev.api.myboxit.com.br/v2/platforms",
"method": "GET",
"timeout": 0,
"headers": {
  "Authorization": "Bearer <TOKEN>"
},
};

$.ajax(settings).done(function (response) {
console.log(response);
});

RESPOSTAS

200 Consolta feita com sucesso

[
  {
    "code": 200,
    "message": "LOCKERS_FOUND",
    "payload": [
      {
          "locationId": 1,
          "locationName": "Boxit A01",
          "locationStatus": "ONLINE",
          "address": "Rua Votuporanga Brasil",
          "cep": "00000-000",
          "coordinates": "-23.663300,-46.53100",
          "link": "https://www.google.com/maps",
          "doors": [
              {
                  "size": "L",
                  "availability": 8,
                  "width": 48,
                  "height": 50,
                  "deep": 50
              },
              {
                  "size": "M",
                  "availability": 10,
                  "width": 48,
                  "height": 33,
                  "deep": 50
              },
              {
                  "size": "S",
                  "availability": 9,
                  "width": 48,
                  "height": 16,
                  "deep": 50
              }
          ]
      },
      {
          "locationId": 2,
          "locationName": "Boxit A02",
          "locationStatus": "ONLINE",
          "address": "CL SANCA ITAPEVI, Itapevi",
          "cep": "00000-000",
          "coordinates": "-23.64145902,-46.7244494",
          "link": "https://www.google.com",
          "doors": [
              {
                  "size": "L",
                  "availability": 2,
                  "width": 48,
                  "height": 50,
                  "deep": 50
              },
              {
                  "size": "M",
                  "availability": 2,
                  "width": 48,
                  "height": 33,
                  "deep": 50
              },
              {
                  "size": "S",
                  "availability": 3,
                  "width": 48,
                  "height": 16,
                  "deep": 50
              }
          ]
      }
    ]
  }
]

404 Nenhuma plataforma emcontrada

[
  {
    "code": 404,
    "message": "Nenhuma plataforma emcontrada"
  }
]

REQUISIÇÃO

Rota

Exemplos

var settings = {
"url": "https://dev.api.myboxit.com.br/v2/companies/webhook",
"method": "POST",
"timeout": 0,
"headers": {
  "Authorization": "Bearer <TOKEN>",
  "Content-Type": "application/json"
},
"data": JSON.stringify({
  "notificationType": 1,
  "url": "https://example.com/platforms/status",
  "apiKey": "123",
  "method": "POST"
}),
};

$.ajax(settings).done(function (response) {
console.log(response);
});

RESPOSTAS

200 O pacote foi atualizado com sucesso

[
  {
    "code": 200,
    "message": "NOTIFICATION_CREATED"
  }
]

400 Todos os parâmetros são obrigatórios

[
  {
    "code": 400,
    "message": "MISSING_URL_FIELD"
  }
]

REQUISIÇÃO

Rota

Exemplos

  var settings = {
    "url": "https://dev.api.myboxit.com.br/v2/companies/webhook",
    "method": "GET",
    "timeout": 0,
    "headers": {
      "Authorization": "Bearer <TOKEN>"
    },
  };

  $.ajax(settings).done(function (response) {
    console.log(response);
  });

RESPOSTAS

200 O pacote foi atualizado com sucesso

{
    "code": 200,
    "message": "COMPANY_FOUND",
    "payload": [
        {
            "url": "https://dev.myboxit.com:2053/gl/platforms/status",
            "method": "POST",
            "apiKey": "123",
            "notificationType": 1
        }
    ]
}

REQUISIÇÃO

Rota

Exemplos

  var settings = {
    "url": "https://dev.api.myboxit.com.br/v2/companies/webhook/1",
    "method": "PATCH",
    "timeout": 0,
    "headers": {
      "Authorization": "Bearer <TOKEN>",
      "Content-Type": "application/json"
    },
    "data": JSON.stringify({
      "notificationType": 1,
      "url": "https://dev.myboxit.com:2053/gl/platforms/status2",
      "method": "",
      "apiKey": "1232"
    }),
  };

  $.ajax(settings).done(function (response) {
    console.log(response);
  });

RESPOSTAS

200 Dados atualizado com sucesso

[
  {
  "code": 200,
  "message": "NOTIFICATION_UPDATED"
  }
]

REQUISIÇÃO

Rota

Exemplos

  var settings = {
    "url": "https://dev.api.myboxit.com.br/v2/companies/webhook/1",
    "method": "DELETE",
    "timeout": 0,
    "headers": {
      "Authorization": "Bearer <TOKEN>"
    },
  };

  $.ajax(settings).done(function (response) {
    console.log(response);
  });

RESPOSTAS

200 Dados atualizado com sucesso

[
  {
    "code": 200,
    "message": "NOTIFICATION_DELETED"
  }
]