API legada/Referência completa/PDV e terminal de balcão

Nomes alternativos do catálogo

Os endereços wk_pos_get_all_products, wkposgetallproducts, wk_pos_get_all_customers e wkposgetallcustomers, equivalentes a pos_products e pos_customers.

Os terminais antigos pedem os produtos por wk_pos_get_all_products ou wkposgetallproducts e os clientes por wk_pos_get_all_customers ou wkposgetallcustomers. Cada endereço desta página executa o mesmo código de Produtos e clientes do PDV: mesmos parâmetros, mesma resposta, mesmos erros. Em software novo use pos_products e pos_customers.

Todos exigem um usuário administrador. Com /api/v1.0 os ids saem em UUID; com /api saem decimais.

GET/api/v1.0/wk_pos_get_all_productsAdmin

Mesmo que pos_products, ids UUID

Igual a GET /api/v1.0/pos_products.

Parâmetros de consulta

pageintegerpadrão: 1

Página.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250.

searchstring

Busca por palavras no nome, na descrição, no SKU e no código de barras.

GET/api/wk_pos_get_all_productsAdmin

Mesmo que pos_products, ids decimais

Igual a GET /api/pos_products.

Parâmetros de consulta

pageintegerpadrão: 1

Página.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250.

searchstring

Busca por palavras no nome, na descrição, no SKU e no código de barras.

GET/api/v1.0/wkposgetallproductsAdmin

Mesmo que pos_products, ids UUID

Igual a GET /api/v1.0/pos_products.

Parâmetros de consulta

pageintegerpadrão: 1

Página.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250.

searchstring

Busca por palavras no nome, na descrição, no SKU e no código de barras.

GET/api/wkposgetallproductsAdmin

Mesmo que pos_products, ids decimais

Igual a GET /api/pos_products.

Parâmetros de consulta

pageintegerpadrão: 1

Página.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250.

searchstring

Busca por palavras no nome, na descrição, no SKU e no código de barras.

GET/api/v1.0/wk_pos_get_all_customersAdmin

Mesmo que pos_customers, ids UUID

Igual a GET /api/v1.0/pos_customers.

Parâmetros de consulta

pageintegerpadrão: 1

Página.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250.

searchstring

Busca por texto no nome, no sobrenome e no e-mail (e no CPF/CNPJ com 3 ou mais dígitos).

GET/api/wk_pos_get_all_customersAdmin

Mesmo que pos_customers, ids decimais

Igual a GET /api/pos_customers.

Parâmetros de consulta

pageintegerpadrão: 1

Página.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250.

searchstring

Busca por texto no nome, no sobrenome e no e-mail (e no CPF/CNPJ com 3 ou mais dígitos).

GET/api/v1.0/wkposgetallcustomersAdmin

Mesmo que pos_customers, ids UUID

Igual a GET /api/v1.0/pos_customers.

Parâmetros de consulta

pageintegerpadrão: 1

Página.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250.

searchstring

Busca por texto no nome, no sobrenome e no e-mail (e no CPF/CNPJ com 3 ou mais dígitos).

GET/api/wkposgetallcustomersAdmin

Mesmo que pos_customers, ids decimais

Igual a GET /api/pos_customers.

Parâmetros de consulta

pageintegerpadrão: 1

Página.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250.

searchstring

Busca por texto no nome, no sobrenome e no e-mail (e no CPF/CNPJ com 3 ou mais dígitos).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1.0/wk_pos_get_all_products?page=1&items_per_page=250" \
  -u "$ADMIN_EMAIL:$API_KEY"

Resposta

200Produtos (resumo)

json

{
  "status": 200,
  "data": {
    "success": true,
    "message": "",
    "products": [
      { "product_id": "d8a6c5e7-8e44-4055-a0e2-49014f5d17f6", "product": "Notebook Vintage Vermelho 04018", "price": "1678.95", "product_code": "SD-004018-C", "pos_barcode": "SD-004018-C", "image_path": "", "amount": "77", "options": [] }
    ],
    "search": { "page": 1, "items_per_page": 250, "total_items": 4985 }
  }
}

Os campos completos de produtos e de clientes estão em Produtos e clientes do PDV.

Erros

Os mesmos de Produtos e clientes do PDV: 401 sem credencial, 403 Forbidden: admin scope required para quem não é administrador e data.success: false com HTTP 200 se a consulta à base falhar.

Veja também

Nomes alternativos do catálogo

Os endereços wk_pos_get_all_products, wkposgetallproducts, wk_pos_get_all_customers e wkposgetallcustomers, equivalentes a pos_products e pos_customers.

Todos exigem um usuário administrador. Com /api/v1.0 os ids saem em UUID; com /api saem decimais.

GET/api/v1.0/wk_pos_get_all_productsAdmin

Mesmo que pos_products, ids UUID

Igual a GET /api/v1.0/pos_products.

Parâmetros de consulta

pageintegerpadrão: 1

Página.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250.

searchstring

Busca por palavras no nome, na descrição, no SKU e no código de barras.

GET/api/wk_pos_get_all_productsAdmin

Mesmo que pos_products, ids decimais

Igual a GET /api/pos_products.

Parâmetros de consulta

pageintegerpadrão: 1

Página.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250.

searchstring

Busca por palavras no nome, na descrição, no SKU e no código de barras.

GET/api/v1.0/wkposgetallproductsAdmin

Mesmo que pos_products, ids UUID

Igual a GET /api/v1.0/pos_products.

Parâmetros de consulta

pageintegerpadrão: 1

Página.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250.

searchstring

Busca por palavras no nome, na descrição, no SKU e no código de barras.

GET/api/wkposgetallproductsAdmin

Mesmo que pos_products, ids decimais

Igual a GET /api/pos_products.

Parâmetros de consulta

pageintegerpadrão: 1

Página.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250.

searchstring

Busca por palavras no nome, na descrição, no SKU e no código de barras.

GET/api/v1.0/wk_pos_get_all_customersAdmin

Mesmo que pos_customers, ids UUID

Igual a GET /api/v1.0/pos_customers.

Parâmetros de consulta

pageintegerpadrão: 1

Página.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250.

searchstring

Busca por texto no nome, no sobrenome e no e-mail (e no CPF/CNPJ com 3 ou mais dígitos).

GET/api/wk_pos_get_all_customersAdmin

Mesmo que pos_customers, ids decimais

Igual a GET /api/pos_customers.

Parâmetros de consulta

pageintegerpadrão: 1

Página.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250.

searchstring

Busca por texto no nome, no sobrenome e no e-mail (e no CPF/CNPJ com 3 ou mais dígitos).

GET/api/v1.0/wkposgetallcustomersAdmin

Mesmo que pos_customers, ids UUID

Igual a GET /api/v1.0/pos_customers.

Parâmetros de consulta

pageintegerpadrão: 1

Página.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250.

searchstring

Busca por texto no nome, no sobrenome e no e-mail (e no CPF/CNPJ com 3 ou mais dígitos).

GET/api/wkposgetallcustomersAdmin

Mesmo que pos_customers, ids decimais

Igual a GET /api/pos_customers.

Parâmetros de consulta

pageintegerpadrão: 1

Página.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250.

searchstring

Busca por texto no nome, no sobrenome e no e-mail (e no CPF/CNPJ com 3 ou mais dígitos).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1.0/wk_pos_get_all_products?page=1&items_per_page=250" \
  -u "$ADMIN_EMAIL:$API_KEY"

Resposta

200Produtos (resumo)

json

{
  "status": 200,
  "data": {
    "success": true,
    "message": "",
    "products": [
      { "product_id": "d8a6c5e7-8e44-4055-a0e2-49014f5d17f6", "product": "Notebook Vintage Vermelho 04018", "price": "1678.95", "product_code": "SD-004018-C", "pos_barcode": "SD-004018-C", "image_path": "", "amount": "77", "options": [] }
    ],
    "search": { "page": 1, "items_per_page": 250, "total_items": 4985 }
  }
}

Os campos completos de produtos e de clientes estão em Produtos e clientes do PDV.

Erros

Os mesmos de Produtos e clientes do PDV: 401 sem credencial, 403 Forbidden: admin scope required para quem não é administrador e data.success: false com HTTP 200 se a consulta à base falhar.