Rotas sem versão

As rotas /api/users e /api/customers, gêmeas das /api/v1.0, que devolvem ids decimais para clientes escritos para a Venddor 1.0.

Toda rota da API 1.0 existe em duas formas: com o prefixo de versão (/api/v1.0/users) e sem ele (/api/users). As duas usam a mesma lógica, a mesma autenticação (HTTP Basic com e-mail:chave_de_api de um administrador, ou Bearer) e os mesmos campos. Nesta página estão as rotas sem versão de usuários e clientes, cada uma apontando para a página que descreve o comportamento.

A única diferença está nos ids. A Venddor 1.0 usava números inteiros; a plataforma passou a usar UUID. Para que um cliente escrito para a Venddor 1.0 funcione sem mudanças, a forma sem versão:

devolve os ids como números decimais dentro de uma string ("1036002250"), derivados do UUID;
aceita esses decimais na entrada (caminho, consulta e corpo). O UUID também é aceito.

Escolha uma forma por integração e não misture: um id decimal não é aceito pelas rotas /api/v1.0, e um cliente que lê user_id espera sempre o mesmo formato. Na dúvida, use /api/v1.0 com UUID.

GET/api/usersAdmin

Listar usuários (rota sem versão)

Igual a GET /api/v1.0/users: Listar clientes. user_id e profile_id saem em decimal.

POST/api/usersAdmin

Criar um usuário (rota sem versão)

Igual a POST /api/v1.0/users: Criar cliente. A resposta traz o user_id decimal.

GET/api/users/{id}Admin

Consultar um usuário (rota sem versão)

Igual a GET /api/v1.0/users/{id}: Consultar cliente. Em fields[].field_id os ids também saem em decimal.

Parâmetros de caminho

idstringobrigatório

Id do usuário, em decimal (ou UUID).

PUT/api/users/{id}Admin

Atualizar um usuário (rota sem versão)

Igual a PUT /api/v1.0/users/{id}: Alterar cliente.

Parâmetros de caminho

idstringobrigatório

Id do usuário, em decimal (ou UUID).

DELETE/api/users/{id}Admin

Excluir um usuário (rota sem versão)

Igual a DELETE /api/v1.0/users/{id}: Excluir cliente. Responde 204.

Parâmetros de caminho

idstringobrigatório

Id do usuário, em decimal (ou UUID).

GET/api/users/{id}/ordersAdmin

Pedidos de um cliente (rota sem versão)

Igual a GET /api/v1.0/users/{id}/orders: Listar pedidos. Só aceita page e items_per_page.

Parâmetros de caminho

idstringobrigatório

Id do cliente, em decimal (ou UUID).

GET/api/users/{user_id}/addressesAdmin

Endereços de um usuário (rota sem versão)

Igual a GET /api/v1.0/users/{user_id}/addresses: Endereços. Um id decimal que não corresponde a nenhum usuário responde 400 Invalid id.

Parâmetros de caminho

user_idstringobrigatório

Id do usuário, em decimal (ou UUID).

GET/api/users/{user_id}/cartAdmin

Carrinho aberto de um usuário (rota sem versão)

Igual a GET /api/v1.0/users/{user_id}/cart: Pedidos e carrinho. Aceita só UUID: com o id decimal responde 500.

Parâmetros de caminho

user_idstringobrigatório

Id do usuário (UUID).

GET/api/users/{user_id}/profile-fieldsAdmin

Valores dos campos de perfil de um usuário (rota sem versão)

Igual a GET /api/v1.0/users/{user_id}/profile-fields: Campos de perfil.

Parâmetros de caminho

user_idstringobrigatório

Id do usuário, em decimal (ou UUID).

POST/api/customersAdmin

Atualizar clientes em lote por CNPJ (rota sem versão)

Igual a POST /api/v1.0/customers: Sincronização por CNPJ. O corpo identifica os clientes pelo CNPJ, então não há ids para converter.

GET/api/customers/{id}/credit-limitAdmin

Limite de crédito de um cliente (rota sem versão)

Igual a GET /api/v1.0/customers/{id}/credit-limit: Crédito e pagamento.

Parâmetros de caminho

idstringobrigatório

Id do cliente, em decimal (ou UUID).

GET/api/customers/{id}/overdue-titlesAdmin

Títulos vencidos de um cliente (provisória) (rota sem versão)

Igual a GET /api/v1.0/customers/{id}/overdue-titles: Crédito e pagamento. Resposta fixa e vazia.

Parâmetros de caminho

idstringobrigatório

Id do cliente, em decimal (ou UUID).

GET/api/customers/{id}/payment-termAdmin

Prazo de pagamento de um cliente (provisória) (rota sem versão)

Igual a GET /api/v1.0/customers/{id}/payment-term: Crédito e pagamento. Resposta fixa ("À vista").

Parâmetros de caminho

idstringobrigatório

Id do cliente, em decimal (ou UUID).

GET/api/customers/{id}/promotionsAdmin

Promoções ativas vistas por um cliente (rota sem versão)

Igual a GET /api/v1.0/customers/{id}/promotions: Crédito e pagamento.

Parâmetros de caminho

idstringobrigatório

Id do cliente, em decimal (ou UUID).

GET/api/user_profilesAdmin

Listar perfis de entrega (não implementado) (rota sem versão)

Igual a GET /api/v1.0/user_profiles: Campos de perfil. Responde 501.

POST/api/user_profilesAdmin

Criar um perfil de entrega (não implementado) (rota sem versão)

Igual a POST /api/v1.0/user_profiles: Campos de perfil. Responde 501.

PUT/api/user_profiles/{id}Admin

Atualizar um perfil de entrega (não implementado) (rota sem versão)

Igual a PUT /api/v1.0/user_profiles/{id}: Campos de perfil. Responde 501.

Parâmetros de caminho

idstringobrigatório

Id do perfil.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/users?user_type=C&items_per_page=2"
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/users/1036002250/addresses"

Resposta

200Usuários (trecho, ids decimais)

json

{
  "params": { "page": 1, "items_per_page": 2, "total_items": 8043 },
  "users": [
    {
      "user_id": "1036002250",
      "profile_id": "1036002250",
      "email": "contato@paodoce.example.com",
      "firstname": "Padaria Pão Doce Ltda",
      "user_type": "C",
      "status": "A",
      "CNPJ": "11222333000181"
    }
  ]
}

Erros

Status	Quando	Corpo
400	Id decimal que não corresponde a nenhum registro (em `addresses`, `orders`, `profile-fields`)	`{"message":"Invalid id","status":400}`
401	Sem credenciais ou chave inválida	`{"message":"Invalid credentials","status":401}`
403	Usuário que não é administrador	`{"message":"Forbidden: admin scope required","status":403}`

Os demais erros são os da rota /api/v1.0 correspondente.

Veja também

Rotas sem versão

As rotas /api/users e /api/customers, gêmeas das /api/v1.0, que devolvem ids decimais para clientes escritos para a Venddor 1.0.

devolve os ids como números decimais dentro de uma string ("1036002250"), derivados do UUID;
aceita esses decimais na entrada (caminho, consulta e corpo). O UUID também é aceito.

GET/api/usersAdmin

Listar usuários (rota sem versão)

Igual a GET /api/v1.0/users: Listar clientes. user_id e profile_id saem em decimal.

POST/api/usersAdmin

Criar um usuário (rota sem versão)

Igual a POST /api/v1.0/users: Criar cliente. A resposta traz o user_id decimal.

GET/api/users/{id}Admin

Consultar um usuário (rota sem versão)

Igual a GET /api/v1.0/users/{id}: Consultar cliente. Em fields[].field_id os ids também saem em decimal.

Parâmetros de caminho

idstringobrigatório

Id do usuário, em decimal (ou UUID).

PUT/api/users/{id}Admin

Atualizar um usuário (rota sem versão)

Igual a PUT /api/v1.0/users/{id}: Alterar cliente.

Parâmetros de caminho

idstringobrigatório

Id do usuário, em decimal (ou UUID).

DELETE/api/users/{id}Admin

Excluir um usuário (rota sem versão)

Igual a DELETE /api/v1.0/users/{id}: Excluir cliente. Responde 204.

Parâmetros de caminho

idstringobrigatório

Id do usuário, em decimal (ou UUID).

GET/api/users/{id}/ordersAdmin

Pedidos de um cliente (rota sem versão)

Igual a GET /api/v1.0/users/{id}/orders: Listar pedidos. Só aceita page e items_per_page.

Parâmetros de caminho

idstringobrigatório

Id do cliente, em decimal (ou UUID).

GET/api/users/{user_id}/addressesAdmin

Endereços de um usuário (rota sem versão)

Igual a GET /api/v1.0/users/{user_id}/addresses: Endereços. Um id decimal que não corresponde a nenhum usuário responde 400 Invalid id.

Parâmetros de caminho

user_idstringobrigatório

Id do usuário, em decimal (ou UUID).

GET/api/users/{user_id}/cartAdmin

Carrinho aberto de um usuário (rota sem versão)

Igual a GET /api/v1.0/users/{user_id}/cart: Pedidos e carrinho. Aceita só UUID: com o id decimal responde 500.

Parâmetros de caminho

user_idstringobrigatório

Id do usuário (UUID).

GET/api/users/{user_id}/profile-fieldsAdmin

Valores dos campos de perfil de um usuário (rota sem versão)

Igual a GET /api/v1.0/users/{user_id}/profile-fields: Campos de perfil.

Parâmetros de caminho

user_idstringobrigatório

Id do usuário, em decimal (ou UUID).

POST/api/customersAdmin

Atualizar clientes em lote por CNPJ (rota sem versão)

Igual a POST /api/v1.0/customers: Sincronização por CNPJ. O corpo identifica os clientes pelo CNPJ, então não há ids para converter.

GET/api/customers/{id}/credit-limitAdmin

Limite de crédito de um cliente (rota sem versão)

Igual a GET /api/v1.0/customers/{id}/credit-limit: Crédito e pagamento.

Parâmetros de caminho

idstringobrigatório

Id do cliente, em decimal (ou UUID).

GET/api/customers/{id}/overdue-titlesAdmin

Títulos vencidos de um cliente (provisória) (rota sem versão)

Igual a GET /api/v1.0/customers/{id}/overdue-titles: Crédito e pagamento. Resposta fixa e vazia.

Parâmetros de caminho

idstringobrigatório

Id do cliente, em decimal (ou UUID).

GET/api/customers/{id}/payment-termAdmin

Prazo de pagamento de um cliente (provisória) (rota sem versão)

Igual a GET /api/v1.0/customers/{id}/payment-term: Crédito e pagamento. Resposta fixa ("À vista").

Parâmetros de caminho

idstringobrigatório

Id do cliente, em decimal (ou UUID).

GET/api/customers/{id}/promotionsAdmin

Promoções ativas vistas por um cliente (rota sem versão)

Igual a GET /api/v1.0/customers/{id}/promotions: Crédito e pagamento.

Parâmetros de caminho

idstringobrigatório

Id do cliente, em decimal (ou UUID).

GET/api/user_profilesAdmin

Listar perfis de entrega (não implementado) (rota sem versão)

Igual a GET /api/v1.0/user_profiles: Campos de perfil. Responde 501.

POST/api/user_profilesAdmin

Criar um perfil de entrega (não implementado) (rota sem versão)

Igual a POST /api/v1.0/user_profiles: Campos de perfil. Responde 501.

PUT/api/user_profiles/{id}Admin

Atualizar um perfil de entrega (não implementado) (rota sem versão)

Igual a PUT /api/v1.0/user_profiles/{id}: Campos de perfil. Responde 501.

Parâmetros de caminho

idstringobrigatório

Id do perfil.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/users?user_type=C&items_per_page=2"
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/users/1036002250/addresses"

Resposta

200Usuários (trecho, ids decimais)

json

{
  "params": { "page": 1, "items_per_page": 2, "total_items": 8043 },
  "users": [
    {
      "user_id": "1036002250",
      "profile_id": "1036002250",
      "email": "contato@paodoce.example.com",
      "firstname": "Padaria Pão Doce Ltda",
      "user_type": "C",
      "status": "A",
      "CNPJ": "11222333000181"
    }
  ]
}

Erros

Status	Quando	Corpo
400	Id decimal que não corresponde a nenhum registro (em `addresses`, `orders`, `profile-fields`)	`{"message":"Invalid id","status":400}`
401	Sem credenciais ou chave inválida	`{"message":"Invalid credentials","status":401}`
403	Usuário que não é administrador	`{"message":"Forbidden: admin scope required","status":403}`

Os demais erros são os da rota /api/v1.0 correspondente.