nuvemshop v1.0.3

Funções úteis para facilitar a chamada de métodos de requisição HTTP para API da plataforma NuvemShop

Como usar ?

npm i nuvemshop

Setando um cliente a partir de um objeto.

const nuvemshop = require("nuvemshop");
//
nuvemshop.config({
        store_id: "Id da loja",
        access_token: "Token de acesso",
        user_agent: "Usuário de acesso"
    });

Funções:

• getStore(): Essa função retorna um vetor(array) com todas as informações cadastrais referentes a loja/empresa.

• listCustomers(): Essa função retorna um vetor(array) com todos os clientes para uma determinada loja.

• getCustomer(customer_id): Essa função retorna um único objeto de um cliente contendo todas as sus informações cadastrais, passando-se o seu "id".

• listCategories(): Essa função retorna um vetor(array) com todas as categorias cadastradas na loja.

• getCategory(category_id): Essa função retorna um único objeto de uma categoria contendo sus informações cadastrais, passando-se o seu "id".

• listProducts(): Essa função retorna um vetor(array) com todos os produtos cadastrados na loja.

• getProduct(product_id): Essa função retorna um único objeto de um produto cadastrado na loja, passando-se o seu "id".

• getProductVariants(product_id): Essa função retorna um vetor(array) de todas as variantes de um determinado produto, por meio do "id" do produto.

• getProductVariantsById(product_id, variant_id): Essa função seleciona uma única variação para um determinado produto.

• getProductImages(product_id): Essa função retorna um vetor(array) com todas as imagens correspondentes a um determinado produto.

• listOrders: Essa função retorna um vetor(array) com todas as ordens de pedidos realizados para uma determinada loja.

• getOrder: Essa função retorna um único objeto de uma order contendo sus informações cadastrais, passando-se o seu "id".

Filtros:

Lista com parâmetros de filtro para as funções de listagem de entidade:

listStore

listCustomers

listCategories

listProducts

getProductVariants

getProductImages

listOrders

Exemplos:

getStore

const nuvemshop = require("nuvemshop");
//
const app = async () => {
    nuvemshop.config({
        store_id: "Id da loja",
        access_token: "Token de acesso",
        user_agent: "Usuário de acesso"
    });
    //
    const loja = await nuvemshop.getStore();
    //Example passing filter on parameter
    const loja = await nuvemshop.getStore("fields=id,name");
    console.log(loja);
}
//
app();

listCustomers

const nuvemshop = require("nuvemshop");
//
const app = async () => {
    nuvemshop.config({
        store_id: "Id da loja",
        access_token: "Token de acesso",
        user_agent: "Usuário de acesso"
    });
    //
    const clientes = await nuvemshop.listCustomers();
    //Example passing filter on parameter
    const clientes = await nuvemshop.listCustomers("since_id=1000&fields=id,name");
    console.log(clientes);
}
//
app();

getCustomer

const nuvemshop = require("nuvemshop");
//
const app = async () => {
    nuvemshop.config({
        store_id: "Id da loja",
        access_token: "Token de acesso",
        user_agent: "Usuário de acesso"
    });
    //
    const id = "xxxxx";
    const cliente = await nuvemshop.getCostumer(id);
    console.log(cliente);
}
//
app();

listCategories

const nuvemshop = require("nuvemshop");
//
const app = async () => {
    nuvemshop.config({
        store_id: "Id da loja",
        access_token: "Token de acesso",
        user_agent: "Usuário de acesso"
    });
    //
    const categorias = await nuvemshop.listCategories();
    //Example passing filter on parameter
    const categorias = await nuvemshop.listCategories("since_id=1000&fields=id,name");
    console.log(categorias);
}
//
app();

getCategory

const nuvemshop = require("nuvemshop");
//
const app = async () => {
    nuvemshop.config({
        store_id: "Id da loja",
        access_token: "Token de acesso",
        user_agent: "Usuário de acesso"
    });
    //
    const id = "xxxxx";
    const categoria = await nuvemshop.getCategory(id);
    console.log(categoria);
}
//
app();

listProducts

const nuvemshop = require("nuvemshop");
//
const app = async () => {
    nuvemshop.config({
        store_id: "Id da loja",
        access_token: "Token de acesso",
        user_agent: "Usuário de acesso"
    });
    //
    const produtos = await nuvemshop.listProducts();
    //Example passing filter on parameter
    const produtos = await nuvemshop.listProducts("since_id=1000&fields=id,name");
    console.log(produtos);
}
//
app();

getProduct

const nuvemshop = require("nuvemshop");
//
const app = async () => {
    nuvemshop.config({
        store_id: "Id da loja",
        access_token: "Token de acesso",
        user_agent: "Usuário de acesso"
    });
    //
    const id = "xxxxx";
    const produto = await nuvemshop.getProduct(id);
    console.log(produto);
}
//
app();

getProductVariants

const nuvemshop = require("nuvemshop");
//
const app = async () => {
    nuvemshop.config({
        store_id: "Id da loja",
        access_token: "Token de acesso",
        user_agent: "Usuário de acesso"
    });
    //
    const id = "xxxxx";
    const variantes_produto = await nuvemshop.getProductVariants(id);
    //Example passing filter on parameter
    const variantes_produto = await nuvemshop.getProductVariants(id, "since_id=1000&fields=id,name");
    console.log(variantes_produto);
}
//
app();

getProductVariantsById

const nuvemshop = require("nuvemshop");
//
const app = async () => {
    nuvemshop.config({
        store_id: "Id da loja",
        access_token: "Token de acesso",
        user_agent: "Usuário de acesso"
    });
    //
    const produto_id = "xxxxx";
    const variante_id = "xxxxx";
    const variante_produto = await nuvemshop.getProductVariantsById(produto_id, variante_id);
    console.log(variante_produto);
}
//
app();

getProductImages

const nuvemshop = require("nuvemshop");
//
const app = async () => {
    nuvemshop.config({
        store_id: "Id da loja",
        access_token: "Token de acesso",
        user_agent: "Usuário de acesso"
    });
    //
    const id = "xxxxx";
    const produto_imagens = await nuvemshop.getProductImages(id);
    //Example passing filter on parameter
    const produto_imagens = await nuvemshop.getProductImages(id, "since_id=1000&fields=id,name");
    console.log(produto_imagens);
}
//
app();

listOrders

const nuvemshop = require("nuvemshop");
//
const app = async () => {
    nuvemshop.config({
        store_id: "Id da loja",
        access_token: "Token de acesso",
        user_agent: "Usuário de acesso"
    });
    //
    const pedidos = await nuvemshop.listOrders();
    //Example passing filter on parameter
    const pedidos = await nuvemshop.listOrders("since_id=1000&fields=id,name");
    console.log(pedidos);
}
//
app();

getOrder

const nuvemshop = require("nuvemshop");
//
const app = async () => {
    nuvemshop.config({
        store_id: "Id da loja",
        access_token: "Token de acesso",
        user_agent: "Usuário de acesso"
    });
    //
    const id = "xxxxx";
    const pedido = await nuvemshop.getOrder(id);
    console.log(pedido);
}
//
app();