{"swagger":"2.0","info":{"version":"1.0.0","title":"6MKT API","description":"Essa API utiliza OAuth2 para controlar o acesso aos seus endpoints e possibilitar a integração com o sistema do Market Place de forma segura e isolada para cada parceiro de forma individual.\n Ela oferece recursos de gestão dos dados do fornecedor/parceiro/afiliado, seus prdutos, a performance dos mesmos no market place e outrasw ferramentas, como a gestão reviews, etc;"},"securityDefinitions":{"access_token":{"type":"oauth2","authorizationUrl":"http://api.6mkt.com/oauth/token","flow":"implicit","scopes":{"write":"allows modifying resources","read":"allows reading resources"}},"access_code":{"type":"apiKey","in":"header","name":"access_code"}},"security":[{"access_token":["read","write"]}],"paths":{"/suppliers":{"get":{"tags":["suppliers"],"summary":"Obtém os dados do fornecedor/parceiro/afiliado","description":"Utilizando a informação do elemento conectado ao sistema, busca e retorna as informações do fornecedor/parceiro/afiliado que é representado por esse login","parameters":[{"in":"header","name":"Authorization","description":"Bearer token gerado pela autenticação do usuário","type":"string","required":true},{"in":"query","name":"uid","type":"string","description":"uid do fornecedor/parceiro/afiliado realizando a consulta","required":true}],"responses":{"200":{"description":"Sucesso","schema":{"$ref":"#/definitions/SupplierViewModel"}},"400":{"description":"Formato inválido de requisição"},"401":{"description":"Acesso não autorizado com token inválido"},"500":{"description":"Falha geral no processamento da requisição"},"501":{"description":"Sistema indisponível"},"502":{"description":"Subsistema indisponível"}}},"post":{"tags":["suppliers"],"summary":"Realiza o cadastro de um fornecedor/parceiro/afiliado","description":"Realiza a gravação dos dados de um fornecedor no sistema\n Para impedir que essa requisição seja feita por qualquer um, uma chave\n deve ser passada no header da reqisição utilizando um hash criado a partir\n de um código de usuário e uma chave secreta do sistema combinada com\n o fornecedor","security":[{"access_code":[]}],"parameters":[{"in":"header","name":"access_code","description":"Hash gerado utilizando HMAC256 composto pela combinação\n da identificação de cliente fornecida para o uso da API e da chave\n utilizada para esta versão e associada unicamente à empresa realizando\n o cadastro. Em um primeiro momento, apenas o MarketPlace 6mkt possui\n esse acesso.","type":"string","required":true},{"in":"body","name":"supplier","description":"Informações do fornecedor/parceiro/afiliado a serem\n inseridas no sistema","schema":{"$ref":"#/definitions/SupplierViewModel"},"required":true}],"responses":{"200":{"description":"Sucesso","schema":{"$ref":"#/definitions/SupplierViewModel"}},"400":{"description":"Formato inválido do request, "},"401":{"description":"Acesso não autorizado com token inválido"},"500":{"description":"Falha geral no processamento da requisição"},"501":{"description":"Sistema indisponível"},"502":{"description":"Subsistema indisponível"}}}},"/suppliers/{uid}/activations":{"post":{"tags":["suppliers"],"summary":"Realiza a ativação de um fornecedor/parceiro/afiliado","description":"Realiza a ativação de um fornecedor no sistema\n No entanto, nesse momento, ainda que um fornecedor jah exista no sistema\n ele ainda não consegue proceder com a sua autentiação de geração de um\n token, de forma que o registro precisa ser liberado.","security":[{"access_code":[]}],"parameters":[{"in":"header","name":"access_code","description":"Hash gerado utilizando HMAC256 composto pela combinação\n da identificação de cliente fornecida para o uso da API e da chave\n utilizada para esta versão e associada unicamente à empresa realizando\n o cadastro. Em um primeiro momento, apenas o MarketPlace 6mkt possui\n esse acesso.","type":"string","required":true},{"in":"path","name":"uid","description":"UID do supplier a ter seus dados atualizados","type":"string","required":true}],"responses":{"200":{"description":"Sucesso","schema":{"$ref":"#/definitions/SupplierViewModel"}},"400":{"description":"Formato inválido do request, "},"401":{"description":"Acesso não autorizado com token inválido"},"500":{"description":"Falha geral no processamento da requisição"},"501":{"description":"Sistema indisponível"},"502":{"description":"Subsistema indisponível"}}}},"/suppliers/security":{"post":{"tags":["suppliers"],"summary":"Realiza a atuaização dos dados de login de um fornecedor/parceiro/afiliado","description":"Realiza a atualização dos dados de um fornecedor no sistema\n Note que o usuário atualizando os dados deve estar autenticado no mesmo","security":[{"access_token":[]}],"parameters":[{"in":"header","name":"Authorization","description":"Bearer token gerado pela autenticação do usuário","type":"string","required":true},{"in":"body","name":"supplier","description":"Informações de acesso do fornecdor","schema":{"$ref":"#/definitions/SupplierSecurityViewModel"},"required":true}],"responses":{"200":{"description":"Sucesso","schema":{"$ref":"#/definitions/SupplierViewModel"}},"400":{"description":"Formato inválido do request"},"401":{"description":"Acesso não autorizado com token inválido"},"500":{"description":"Falha geral no processamento da requisição"},"501":{"description":"Sistema indisponível"},"502":{"description":"Subsistema indisponível"}}}},"/suppliers/{uid}":{"patch":{"tags":["suppliers"],"summary":"Realiza a atualização de um fornecedor/parceiro/afiliado","description":"Realiza a gravação dos dados de um fornecedor no sistema\n No entanto, nesse momento considera-se que um cadastro base já foi\n relizado e o fornecedor/parceiro/afiliado já pode se autenticar no sistema\n de forma que o token desta autenticação será usado como validador do request","security":[{"access_token":[]}],"parameters":[{"in":"header","name":"Authorization","description":"Bearer token gerado pela autenticação do usuário","type":"string","required":true},{"in":"path","name":"uid","description":"UID do supplier a ter seus dados atualizados","type":"string","required":true},{"in":"body","name":"supplier","description":"Informações do fornecedor/parceiro/afiliado a serem\n atualizadas no sistema. Dessa forma, pode-se considerar que apenas\n os campos com valores a serem atualizados estarão presentes no corpo\n desta requisição.","schema":{"$ref":"#/definitions/SupplierViewModel"},"required":true}],"responses":{"200":{"description":"Sucesso","schema":{"$ref":"#/definitions/SupplierViewModel"}},"400":{"description":"Formato inválido do request"},"401":{"description":"Acesso não autorizado com token inválido"},"500":{"description":"Falha geral no processamento da requisição"},"501":{"description":"Sistema indisponível"},"502":{"description":"Subsistema indisponível"}}},"delete":{"tags":["suppliers"],"summary":"Realiza o cancelamento de fornecedor/parceiro/afiliado","description":"Realiza o cancelamento do registro de um fornecedor/parceiro/afiliado\n alterando o seu status para SUSPENSO.","security":[{"access_code":[]}],"parameters":[{"in":"header","name":"access_code","description":"Hash gerado utilizando HMAC256 composto pela combinação\n da identificação de cliente fornecida para o uso da API e da chave\n utilizada para esta versão e associada unicamente à empresa realizando\n o cadastro. Em um primeiro momento, apenas o MarketPlace 6mkt possui\n esse acesso.","type":"string","required":true},{"in":"path","name":"uid","description":"UID do supplier a ter seus dados atualizados","type":"string","required":true}],"responses":{"200":{"description":"Sucesso"},"400":{"description":"Formato inválido do request, "},"401":{"description":"Acesso não autorizado com token inválido"},"500":{"description":"Falha geral no processamento da requisição"},"501":{"description":"Sistema indisponível"},"502":{"description":"Subsistema indisponível"}}}},"/products":{"get":{"tags":["supplier products"],"summary":"Obtém os dados dos produtos do fornecedor logado no sistema","description":"Utilizando a informação do elemento conectado ao sistema,\n busca e retorna as informações do produto sendo buscado, ou de todos os\n produtos do mesmo, caso nenhuma informação de busca seja adicionada","parameters":[{"in":"header","name":"Authorization","description":"Bearer token gerado pela autenticação do usuário","type":"string","required":true},{"in":"query","name":"uid_produto","type":"string","description":"uid do produto sendo buscado","required":false},{"in":"query","name":"name","type":"string","description":"Nome completo ou parcial dos produtos sendo buscados","required":false},{"in":"query","name":"supplier_sku","type":"string","description":"SKU completo ou parcial dos produtos sendo buscados","required":false},{"in":"query","name":"supplier_serial","type":"string","description":"Serial completo ou parcial dos produtos sendo buscados","required":false},{"in":"query","name":"base_price","type":"number","format":"double","description":"valor base do preço a ser considerado","required":false},{"in":"query","name":"delta_price","type":"number","format":"double","description":"valor utilizado em conjunto com o parâmetro base_price\n para buscar produtos em uma faixa (delta_price) de valores a partir\n do valor definido em base_price, dessa forma o retorno trará produtos\n com o valor em price atendendo a segiunte combinação:\n (base_price - detal_price) <= price <= (base_price + price)","required":false},{"in":"query","name":"offset","type":"number","description":"índice dos elementos retornados a partir do qual o conjunto final de \n informações será montado","required":false},{"in":"query","name":"size","type":"number","description":"quantidade de elementos que deverá compor a lista retornada","required":false}],"responses":{"200":{"description":"Sucesso","schema":{"$ref":"#/definitions/ArrayOfProductViewModel"}},"400":{"description":"Formato inválido de requisição"},"401":{"description":"Acesso não autorizado com token inválido"},"500":{"description":"Falha geral no processamento da requisição"},"501":{"description":"Sistema indisponível"},"502":{"description":"Subsistema indisponível"}}},"post":{"tags":["supplier products"],"summary":"Realiza o cadastro de um produto","description":"Realiza a gravação dos dados de um produto no sistema","parameters":[{"in":"header","name":"Authorization","description":"Bearer token gerado pela autenticação do usuário","type":"string","required":true},{"in":"body","name":"product","description":"Informações do produto a ser inserido no sistema","schema":{"$ref":"#/definitions/ProductViewModel"},"required":true}],"responses":{"200":{"description":"Sucesso","schema":{"$ref":"#/definitions/ProductViewModel"}},"400":{"description":"Formato inválido do request, verifique os dados fornecidos\n do produto atendando para as informações fornecida em Product"},"401":{"description":"Acesso não autorizado com token inválido"},"500":{"description":"Falha geral no processamento da requisição"},"501":{"description":"Sistema indisponível"},"502":{"description":"Subsistema indisponível"}}}},"/products/{uid}":{"patch":{"tags":["supplier products"],"summary":"Realiza a atualização de um produto","description":"Realiza a alteração dos dados de um produto no sistema.","security":[{"access_token":[]}],"parameters":[{"in":"header","name":"Authorization","description":"Bearer token gerado pela autenticação do usuário","type":"string","required":true},{"in":"path","name":"uid","description":"UID do produto a ter seus dados atualizados","type":"string","required":true},{"in":"body","name":"product","description":"Informações do produto a ser atualizadas no sistema.\n Dessa forma, pode-se considerar que apenas os campos com valores a\n serem atualizados estarão presentes no corpo desta requisição.","schema":{"$ref":"#/definitions/ProductViewModel"},"required":true}],"responses":{"200":{"description":"Sucesso","schema":{"$ref":"#/definitions/ProductViewModel"}},"400":{"description":"Formato inválido do request"},"401":{"description":"Acesso não autorizado com token inválido"},"500":{"description":"Falha geral no processamento da requisição"},"501":{"description":"Sistema indisponível"},"502":{"description":"Subsistema indisponível"}}},"delete":{"tags":["supplier products"],"summary":"Realiza o cancelamento de fornecedor/parceiro/afiliado","description":"Realiza o cancelamento do registro de um fornecedor/parceiro/afiliado\n alterando o seu status para SUSPENSO.","security":[{"access_code":[]}],"parameters":[{"in":"header","name":"access_code","description":"Hash gerado utilizando HMAC256 composto pela combinação\n da identificação de cliente fornecida para o uso da API e da chave\n utilizada para esta versão e associada unicamente à empresa realizando\n o cadastro. Em um primeiro momento, apenas o MarketPlace 6mkt possui\n esse acesso.","type":"string","required":true},{"in":"path","name":"uid","description":"UID do supplier a ter seus dados atualizados","type":"string","required":true}],"responses":{"200":{"description":"Sucesso","schema":{"$ref":"#/definitions/SupplierViewModel"}},"400":{"description":"Formato inválido do request, "},"401":{"description":"Acesso não autorizado com token inválido"},"500":{"description":"Falha geral no processamento da requisição"},"501":{"description":"Sistema indisponível"},"502":{"description":"Subsistema indisponível"}}}},"/payments":{"get":{"tags":["supplier payments"],"summary":"Obtém os pagamentos realizadaos para o fornecedor/parceiro/afiliado\n que está realizando o request","description":"Utilizando a informação do elemento conectado ao sistema,\n busca e retorna as informações dos pagamentos realizados para este\n fornecedor/parceiro/afiliado. Também considera um eventual conjunto de\n filtros opcionais","parameters":[{"in":"header","name":"Authorization","description":"Bearer token gerado pela autenticação do usuário","type":"string","required":true},{"in":"query","name":"uid_payment","type":"number","description":"uid do pagamento a ser consultados","required":false},{"in":"query","name":"uid_order","type":"number","description":"uid do pedido para este fornecedor/parceiro/afiliado","required":false},{"in":"query","name":"base_date_request","type":"number","description":"milisegundos da data no formato UTC considerada para a\n criação do pagamento","required":false},{"in":"query","name":"delta_date_request","type":"number","description":"número de dias a ser considerado para definir um intervalo\n de tempo considerando a base_date_request informada","required":false},{"in":"query","name":"base_date_accomplished","type":"number","description":"milisegundos da data no formato UTC considerada para a\n efetivação do pagamento","required":false},{"in":"query","name":"delta_date_accomplished","type":"number","description":"número de dias a ser considerado para definir um intervalo\n de tempo considerando a base_date_accomplished informada","required":false},{"in":"query","name":"payment_mode","type":"string","description":"modo de pagamento","required":false},{"in":"query","name":"offset","type":"number","description":"índice dos elementos retornados a partir do qual o conjunto final de \n informações será montado","required":false},{"in":"query","name":"size","type":"number","description":"quantidade de elementos que deverá compor a lista retornada","required":false}],"responses":{"200":{"description":"Sucesso","schema":{"$ref":"#/definitions/ArrayOfPaymentViewModel"}},"400":{"description":"Formato inválido de requisição"},"401":{"description":"Acesso não autorizado com token inválido"},"500":{"description":"Falha geral no processamento da requisição"},"501":{"description":"Sistema indisponível"},"502":{"description":"Subsistema indisponível"}}}},"/payments/{uid_supplier}/notifications/{uid_payment}":{"post":{"tags":["supplier payments"],"summary":"Inscreve o fornecedor/parceiro/afiliado autenticado no sistema\n na lista de notificações a serem enviadas relacionadas a eventos do pagamento\n informado como parametro","description":"Insere o fornece/parceiro/afiliado informado no parâsmetro\n uid_suplier em uma lista de notificação de eventos relacionados ao\n pagamento informado em uid_payment","parameters":[{"in":"header","name":"Authorization","description":"Bearer token gerado pela autenticação do usuário","type":"string","required":true},{"in":"path","name":"uid_supplier","description":"uid do fornecedor/parceiro/afiliado autenticado no\n sistema","type":"string","required":true},{"in":"path","name":"uid_payment","description":"uid do pagamento relacionado ao fornecedor/parceiro/afiliado\n autenticado no sistema","type":"string","required":true}],"responses":{"200":{"description":"Sucesso"},"400":{"description":"Formato inválido de requisição, fornecedor ou pagamento\n não identificados ou relacionados"},"401":{"description":"Acesso não autorizado com token inválido"},"500":{"description":"Falha geral no processamento da requisição"},"501":{"description":"Sistema indisponível"},"502":{"description":"Subsistema indisponível"}}},"delete":{"tags":["supplier payments"],"summary":"Remove a inscrição o fornecedor/parceiro/afiliado autenticado no sistema\n para receber eventos relacionados ao pagamento solicitado.","description":"Remove o fornece/parceiro/afiliado informado no parâsmetro\n uid_suplier de uma lista de notificação de eventos relacionados ao\n pagamento informado em uid_payment","parameters":[{"in":"header","name":"Authorization","description":"Bearer token gerado pela autenticação do usuário","type":"string","required":true},{"in":"path","name":"uid_supplier","description":"uid do fornecedor/parceiro/afiliado autenticado no\n sistema","type":"string","required":true},{"in":"path","name":"uid_payment","description":"uid do pagamento relacionado ao fornecedor/parceiro/afiliado\n autenticado no sistema","type":"string","required":true}],"responses":{"200":{"description":"Sucesso"},"400":{"description":"Formato inválido de requisição, fornecedor ou pagamento\n não identificados ou relacionados"},"401":{"description":"Acesso não autorizado com token inválido"},"500":{"description":"Falha geral no processamento da requisição"},"501":{"description":"Sistema indisponível"},"502":{"description":"Subsistema indisponível"}}}},"/orders":{"get":{"tags":["supplier orders"],"summary":"Obtem lista de pedidos no qual o fornecedor possui produtos","description":"Retorna a lista de pedidos nas quais o fornecedor possiu\n algum produto a ser envido ao cliente que realizou a solicitação","parameters":[{"in":"header","name":"Authorization","description":"Bearer token gerado pela autenticação do usuário","type":"string","required":true},{"in":"query","name":"uid_order","type":"integer","format":"int64","description":"uid do pedido a ser consultados","required":false},{"in":"query","name":"uid_client","type":"string","format":"uuid","description":"uid do cliente realizando o pedido","required":false},{"in":"query","name":"base_date_request","type":"number","description":"milisegundos da data no formato UTC considerada para a\n criação do pedido","required":false},{"in":"query","name":"delta_date_request","type":"number","description":"número de dias a ser considerado para definir um intervalo\n de tempo considerando a base_date_request informada","required":false},{"in":"query","name":"status","type":"string","description":"status do pedido","required":false},{"in":"query","name":"offset","type":"number","description":"índice dos elementos retornados a partir do qual o conjunto final de \n informações será montado","required":false},{"in":"query","name":"size","type":"number","description":"quantidade de elementos que deverá compor a lista retornada","required":false}],"responses":{"200":{"description":"Sucesso","schema":{"$ref":"#/definitions/ArrayOfOrderViewModel"}},"400":{"description":"Formato inválido de requisição"},"401":{"description":"Acesso não autorizado com token inválido"},"500":{"description":"Falha geral no processamento da requisição"},"501":{"description":"Sistema indisponível"},"502":{"description":"Subsistema indisponível"}}}},"/reviews":{"get":{"tags":["supplier reviews"],"summary":"Obtem lista reviews que possuem alguma associação com o\n fornecedor/parceiro/afiliado conectado no sistema","description":"Retorna a lista de reviews que de alguma forma se relacionam\n com o fornecedor/parceiro/afiliado conectado. A Relação entre este e os\n reviews presentes no sistema considera a utilização no comentário do uid_supplier utilizando a API, de produtos com uid_product que estão\n na lista de produtos do usuário atual e também de uid_orders na qual o fornecedor/parceiro/afiliado tenha alguma participação","parameters":[{"in":"header","name":"Authorization","description":"Bearer token gerado pela autenticação do usuário","type":"string","required":true},{"in":"query","name":"uid_order","type":"integer","format":"int64","description":"uid do pedido a ser consultados","required":false},{"in":"query","name":"uid_client","type":"string","format":"uuid","description":"uid do cliente realizando o pedido","required":false},{"in":"query","name":"base_date_request","type":"number","description":"milisegundos da data no formato UTC considerada para a\n criação do review","required":false},{"in":"query","name":"delta_date_request","type":"number","description":"número de dias a ser considerado para definir um intervalo\n de tempo considerando a base_date_request informada","required":false},{"in":"query","name":"offset","type":"number","description":"índice dos elementos retornados a partir do qual o conjunto final de \n informações será montado","required":false},{"in":"query","name":"size","type":"number","description":"quantidade de elementos que deverá compor a lista retornada","required":false}],"responses":{"200":{"description":"Sucesso","schema":{"$ref":"#/definitions/ArrayOfReviewViewModel"}},"400":{"description":"Formato inválido de requisição"},"401":{"description":"Acesso não autorizado com token inválido"},"500":{"description":"Falha geral no processamento da requisição"},"501":{"description":"Sistema indisponível"},"502":{"description":"Subsistema indisponível"}}}},"/reviews/{uid_supplier}/messages/{uid}":{"post":{"tags":["supplier products"],"summary":"Insere uma mensagem no review identificado pelo parâmetro uid","description":"Insere uma nova mensagem na lista de mensagens do review\n informado no parâmetro","parameters":[{"in":"header","name":"Authorization","description":"Bearer token gerado pela autenticação do usuário","type":"string","required":true},{"in":"path","name":"uid_supplier","type":"integer","format":"int64","description":"uid do fornecedor/parceiro/afiliado realizando a chamada","required":true},{"in":"path","name":"uid","type":"integer","format":"int64","description":"uid do review para o qual a mensagem será direcionada","required":true},{"in":"body","name":"message_item","schema":{"$ref":"#/definitions/ReviewItemViewModel"}}],"responses":{"200":{"description":"Sucesso","schema":{"$ref":"#/definitions/ReviewViewModel"}},"400":{"description":"Formato inválido de requisição"},"401":{"description":"Acesso não autorizado com token inválido"},"500":{"description":"Falha geral no processamento da requisição"},"501":{"description":"Sistema indisponível"},"502":{"description":"Subsistema indisponível"}}}},"/stats/sales/category":{"get":{"tags":["stats category"],"summary":"Obtem os produtos mais vendidos por categoria","operationId":"searchCategory","description":"Obtem uma colecao de produtos mais vendidos por categoria em um determinado periodo","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"query","name":"fromDate","type":"string","format":"date","description":"Filtra data inicial das vendas","required":true},{"in":"query","name":"toDate","type":"string","format":"date","description":"Filtra data final das vendas","required":true},{"in":"query","name":"category","type":"string","description":"Filtra produtos mais vendidos por categoria","required":true},{"in":"query","name":"limit","type":"integer","format":"int32","description":"Quantidade de itens que serão retornados","required":false},{"in":"query","name":"offset","type":"integer","format":"int32","description":"Registro inicial para retorno dos itens","required":false}],"responses":{"200":{"description":"Sucesso","schema":{"type":"array","items":{"$ref":"#/definitions/CategoryViewModel"}}},"400":{"description":"Parametro inválido"},"401":{"description":"Acesso não autorizado"},"403":{"description":"Acesso negado"},"500":{"description":"Erro interno do sistema"}}}},"/stats/sales/region":{"get":{"tags":["stats region"],"summary":"Obtem vendas por regiao","description":"Obtem uma colecao de produtos mais vendidos em uma determinada regiao","operationId":"searchRegion","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"query","name":"state","type":"string","description":"Estado","required":true},{"in":"query","name":"city","type":"string","description":"Cidade","required":false},{"in":"query","name":"fromDate","type":"string","format":"date","description":"Data inicial das vendas","required":true},{"in":"query","name":"toDate","type":"string","format":"date","description":"Data final das vendas","required":true},{"in":"query","name":"limit","type":"integer","format":"int32","description":"Quantidade de itens que serão retornados","required":false},{"in":"query","name":"offset","type":"integer","format":"int32","description":"Registro inicial para retorno dos itens","required":false}],"responses":{"200":{"description":"Sucesso","schema":{"type":"array","items":{"$ref":"#/definitions/RegionViewModel"}}},"400":{"description":"Parametro inválido"},"401":{"description":"Acesso não autorizado"},"403":{"description":"Acesso negado"},"500":{"description":"Erro interno do sistema"}}}},"/stats/sales/related":{"get":{"tags":["stats related"],"summary":"Obtem vendas relacionadas para um determinado produto","description":"Obtem uma colecao de produtos que foram comprados junto com outros produtos","operationId":"searchRelated","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"query","name":"product","type":"string","description":"Código do produto","required":true},{"in":"query","name":"category","type":"string","description":"Categoria do produto","required":false},{"in":"query","name":"limit","type":"integer","format":"int32","description":"Quantidade de itens que serão retornados","required":false},{"in":"query","name":"offset","type":"integer","format":"int32","description":"Registro inicial para retorno dos itens"}],"responses":{"200":{"description":"Sucesso","schema":{"type":"array","items":{"$ref":"#/definitions/RelatedViewModel"}}},"400":{"description":"Parametro inválido"},"401":{"description":"Acesso não autorizado"},"403":{"description":"Acesso negado"},"500":{"description":"Erro interno do sistema"}}}},"/stats/sales/payment":{"get":{"tags":["stats payment"],"summary":"Obtem quantidade dos tipos de pagamentos mais utilizados em um determinado periodo","description":"Obtem uma colecao com a quantidade dos tipos de pagamentos mais utilizados em um determinado periodo","operationId":"searchPayment","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"query","name":"fromDate","type":"string","format":"date","description":"Data inicial","required":true},{"in":"query","name":"toDate","type":"string","format":"date","description":"Data final","required":true}],"responses":{"200":{"description":"Sucesso","schema":{"type":"array","items":{"$ref":"#/definitions/ArrayOfPaymentReportViewModel"}}},"400":{"description":"Parametro inválido"},"401":{"description":"Acesso não autorizado"},"403":{"description":"Acesso negado"},"500":{"description":"Erro interno do sistema"}}}},"/gift":{"get":{"tags":["gift"],"summary":"obter uma lista de presentes","parameters":[{"in":"query","name":"coupleName","type":"string","description":"nome do casal","required":true}],"responses":{"200":{"description":"Sucesso.","schema":{"$ref":"#/definitions/ListaPresenteViewModel"}},"401":{"description":"Não autorizado."},"403":{"description":"Proibido."},"500":{"description":"Erro Interno."}}},"post":{"tags":["gift"],"summary":"adicionar uma lista de presentes","parameters":[{"in":"body","name":"Gift","description":"adicionar uma lista de presentes do casal","required":true,"schema":{"$ref":"#/definitions/GiftAddViewModel"}}],"responses":{"200":{"description":"Sucesso.","schema":{"$ref":"#/definitions/OkViewModel"}},"401":{"description":"Não autorizado."},"403":{"description":"Proibido."},"500":{"description":"Erro Interno."}}},"put":{"tags":["gift"],"summary":"atualizar produto escolhido para presente","parameters":[{"in":"body","name":"Gift","description":"lista de produtos selecionados","required":true,"schema":{"$ref":"#/definitions/GiftUpdateViewModel"}}],"responses":{"200":{"description":"Sucesso.","schema":{"$ref":"#/definitions/OkViewModel"}},"401":{"description":"Não autorizado."},"403":{"description":"Proibido."},"500":{"description":"Erro Interno."}}},"delete":{"tags":["gift"],"summary":"deletar uma lista de presentes","parameters":[{"in":"query","name":"idList","type":"number","description":"id da lista de presentes","required":true}],"responses":{"200":{"description":"Sucesso."},"400":{"description":"Erro ao excluír lista de presentes. Possivelmente alguém já efetuou o pagamento de algum produto"},"401":{"description":"Não autorizado."},"403":{"description":"Proibido."},"500":{"description":"Erro Interno."}}}},"/notification":{"post":{"tags":["notification"],"summary":"adicionar um alerta","parameters":[{"in":"body","name":"Alert","description":"lista de produtos selecionados","required":true,"schema":{"$ref":"#/definitions/AlertAddViewModel"}}],"responses":{"200":{"description":"Sucesso.","schema":{"$ref":"#/definitions/OkViewModel"}},"401":{"description":"Não autorizado."},"403":{"description":"Proibido."},"500":{"description":"Erro Interno."}}},"get":{"tags":["notification"],"summary":"obter meus alertas inscritos","responses":{"200":{"description":"Sucesso.","schema":{"$ref":"#/definitions/AlertViewModel"}},"401":{"description":"Não autorizado."},"403":{"description":"Proibido."},"500":{"description":"Erro Interno."}}},"put":{"tags":["notification"],"summary":"desinscrever-se de um alerta","parameters":[{"in":"query","name":"idAlert","type":"number","description":"id do alerta","required":true}],"responses":{"200":{"description":"Sucesso.","schema":{"$ref":"#/definitions/AlertViewModel"}},"401":{"description":"Não autorizado."},"403":{"description":"Proibido."},"500":{"description":"Erro Interno."}}}},"/notification/subscribe":{"post":{"tags":["notification"],"summary":"inscrever-se em alertas por categoria e fornecedor","parameters":[{"in":"body","name":"Alert","description":"inscrever em alertas por categoria e fornecedor","required":true,"schema":{"$ref":"#/definitions/AlertSubscribeViewModel"}}],"responses":{"200":{"description":"Sucesso.","schema":{"$ref":"#/definitions/OkViewModel"}},"401":{"description":"Não autorizado."},"403":{"description":"Proibido."},"500":{"description":"Erro Interno."}}}},"/comparation":{"get":{"tags":["price comparator"],"summary":"Recuperar uma comparação","operationId":"retrieveComparation","description":"Recuperar uma comparação com o seu ID","produces":["application/json"],"parameters":[{"in":"query","required":false,"name":"id","description":"ID da comparação gerado no momento de sua criação","type":"string","format":"uuid"},{"in":"query","name":"offset","type":"number","description":"índice dos elementos retornados a partir do qual o conjunto final de \n informações será montado","required":false},{"in":"query","name":"size","type":"number","description":"quantidade de elementos que deverá compor a lista retornada","required":false},{"in":"header","name":"Authorization","description":"Bearer token gerado pela autenticação do usuário","type":"string","required":true}],"responses":{"200":{"description":"Sucesso","schema":{"$ref":"#/definitions/ComparationViewModel"}},"400":{"description":"Formato inválido do request, verifique os dados fornecidos\n do produto atendando para as informações fornecida em Product"},"401":{"description":"Acesso não autorizado com token inválido"},"500":{"description":"Falha geral no processamento da requisição"},"501":{"description":"Sistema indisponível"},"502":{"description":"Subsistema indisponível"}}},"post":{"tags":["price comparator"],"summary":"Cadastrar uma nova comparação","operationId":"addComparation","description":"Cadastrar uma nova comparação para consulta posterior","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"header","name":"Authorization","description":"Bearer token gerado pela autenticação do usuário","type":"string","required":true},{"in":"body","name":"comparation","description":"Comparation to be added","schema":{"$ref":"#/definitions/ComparationViewModel"}}],"responses":{"200":{"description":"Sucesso","schema":{"$ref":"#/definitions/ComparationViewModel"}},"400":{"description":"Formato inválido do request, verifique os dados fornecidos\n do produto atendando para as informações fornecida em Product"},"401":{"description":"Acesso não autorizado com token inválido"},"500":{"description":"Falha geral no processamento da requisição"},"501":{"description":"Sistema indisponível"},"502":{"description":"Subsistema indisponível"}}}},"/comparation/{id}":{"put":{"tags":["price comparator"],"summary":"Atualizar comparação","operationId":"updateComparation","description":"Atualizar uma comparação com base em seu ID, deve passar o novo conteúdo","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"path","required":true,"name":"id","description":"O ID gerado para a comparação quando a mesma foi criada","type":"string","format":"uuid"},{"in":"header","name":"Authorization","description":"Bearer token gerado pela autenticação do usuário","type":"string","required":true},{"in":"body","name":"comparation","description":"O novo conteúdo da comparação","schema":{"$ref":"#/definitions/ComparationViewModel"}}],"responses":{"200":{"description":"Sucesso","schema":{"$ref":"#/definitions/ComparationViewModel"}},"400":{"description":"Formato inválido do request, verifique os dados fornecidos\n do produto atendando para as informações fornecida em Product"},"401":{"description":"Acesso não autorizado com token inválido"},"500":{"description":"Falha geral no processamento da requisição"},"501":{"description":"Sistema indisponível"},"502":{"description":"Subsistema indisponível"}}},"delete":{"tags":["price comparator"],"summary":"Excluir uma comparação","operationId":"deleteComparation","description":"Excluir uma comparação utilizando seu id","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"path","required":true,"name":"id","description":"O ID gerado para a comparação quando a mesma foi criada","type":"string","format":"uuid"},{"in":"header","name":"Authorization","description":"Bearer token gerado pela autenticação do usuário","type":"string","required":true}],"responses":{"200":{"description":"Sucesso","schema":{"$ref":"#/definitions/ComparationViewModel"}},"400":{"description":"Formato inválido do request, verifique os dados fornecidos\n do produto atendando para as informações fornecida em Product"},"401":{"description":"Acesso não autorizado com token inválido"},"500":{"description":"Falha geral no processamento da requisição"},"501":{"description":"Sistema indisponível"},"502":{"description":"Subsistema indisponível"}}}}},"schemes":["https"],"definitions":{"CategoryViewModel":{"type":"object","properties":{"fromDate":{"type":"string","format":"date","description":"Data inicial das vendas"},"toDate":{"type":"string","format":"date","description":"Data final das vendas"},"categoria":{"type":"string","description":"Categoria do produto"},"limit":{"type":"integer","description":"Quantidade de itens que serão retornados"},"offset":{"type":"integer","description":"Registro inicial para retorno dos itens"}}},"RegionViewModel":{"type":"object","properties":{"estado":{"type":"string","description":"Estado"},"cidade":{"type":"string","description":"Cidade"},"fromDate":{"type":"string","format":"date","description":"Data inicial das vendas"},"toDate":{"type":"string","format":"date","description":"Data final das vendas"},"limit":{"type":"integer","description":"Quantidade de itens que serão retornados"},"offset":{"type":"integer","description":"Registro inicial para retorno dos itens"}}},"RelatedViewModel":{"type":"object","properties":{"produto":{"type":"string","description":"Código do produto"},"categoria":{"type":"string","description":"Categoria do produto"},"limit":{"type":"integer","description":"Quantidade de itens que serão retornados"},"offset":{"type":"integer","description":"Registro inicial para retorno dos itens"}}},"PaymentReportViewModel":{"type":"object","properties":{"payment_mode":{"description":"Forma de pagamento com a qual o pedido será pago. Esta\n informação depende fortemente da integração com o sistema de pagamento\n e considera a lista provida por este, no entanto, para fins de busca\n e interfaces internas o seguinte conjunto será considerado","type":"array","items":{"type":"string","enum":["boleto","cartão de débito","cartão de crédito","débito automático","transferência","dinheiro"]}},"qtde":{"type":"number","format":"int64"},"fromDate":{"type":"string","format":"date","description":"Data inicial"},"toDate":{"type":"string","format":"date","description":"Data final"}}},"ArrayOfPaymentReportViewModel":{"description":"Lista de produtos","type":"object","properties":{"lista":{"type":"array","items":{"type":"object","$ref":"#/definitions/PaymentReportViewModel"}}}},"SupplierViewModel":{"type":"object","description":"Modelo com informações dos fornecedores parceiros no sistema","properties":{"uid":{"description":"Identificador único fornecedor/parceiro/afiliado","type":"string","format":"uuid"},"name":{"type":"string"},"document_number":{"description":"Número de documento, podendo ser este um número de passaport,\n RG, CPF ou CNPJ","type":"string"},"document_type":{"description":"Indicação do tipo de documento ao qual o número do item\n [document_number] se refere","type":"array","items":{"type":"string","enum":["passaporte","rg","cpf","cnpj"]}},"address":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"phoneNumberList":{"description":"Lista de telefones que podem ser usados para contactar\n o fornecedor/parceiro/afiliado","type":"array","items":{"type":"object","$ref":"#/definitions/PhoneNumberItem"}},"status":{"description":"Indica a situação de um fornecedor/parceiro/afiliado dentro\n do sistema","type":"array","items":{"description":"Situação do fornecedor/parceiro/afiliado:\n 1. CRIADO: usuário adicionado ao sistema, mas ainda pendente de análise\n para sua completa ativação\n 2. ATIVADO: usuário ativado e apto à utilização das demais APIS.\n 3. SUSPENSO: usuário temporariamente suspenso do sistema","type":"string","enum":["CRIADO","ATIVADO","SUSPENSO"]}},"default_password":{"description":"Informação utilizada pelo sistema na resposta à ativação\n do fornecedor/parceiro/afiliado para indicar uma senha padrão a ser usada para\n a utilização das demais APIS, como a de alteração da senha."}}},"SupplierSecurityViewModel":{"type":"object","description":"Modelo utilizado para a atualização dos dados de login do sistema","properties":{"uid":{"description":"Identificador único fornecedor/parceiro/afiliado","type":"string","format":"uuid"},"password":{"description":"Chave a ser usada para realização do acesso do fornecedor ao sistema","type":"string"}}},"ProductViewModel":{"type":"object","properties":{"code":{"type":"string","description":"código do produto"},"title":{"type":"string","description":"Título do produto"},"description":{"type":"string","description":"Descrição e detalhes do produto"},"images":{"type":"array","items":{"type":"string"},"description":"Imagens do produto"},"cost":{"type":"number","description":"Preço do produto"},"uid_supplier":{"description":"Identificador único do fornecedor ao qual esse produto\n pertence. Caso não fornecida, o UID do supplier identificado pelo token\n utilizado na conexão será usado","type":"string","format":"uuid"},"supplier_sku":{"description":"Identificador utilizado pelo fornecedor/parceiro/afiliado\n para identificar o modelo do produto","type":"string"},"supplier_serial":{"description":"Identificador utilizado pelo fornecedor/parceiro/afiliado\n para identificar de forma única o produto em seu sistema"}}},"ArrayOfProductViewModel":{"description":"Lista de produtos","type":"object","properties":{"lista":{"type":"array","items":{"type":"object","$ref":"#/definitions/ProductViewModel"}}}},"PaymentViewModel":{"description":"Modelo utilizado para identificar um pagamento realizado\n para um determinado pedido. O Pagamento depende de um sistema externo\n e este modelo concetra as informações utilizadas para documentar e realizar\n esta comunicação","type":"object","properties":{"uid":{"description":"Identificador único para um pagamento realizado em função\n de um determinado pedido. Este elemento é gerado pelo sistema e está\n atrelado ao momento da requisição","type":"number","format":"int64"},"uid_order":{"description":"Identificador do pedido ao qual o pagamento se refere","type":"number","format":"int64"},"date_request":{"description":"Momento da solicitação do pagamento","type":"integer","format":"int64"},"date_accomplished":{"description":"Momento no qual a solicitação do pagamento foi aceita e informada ao sistema","type":"integer","format":"int64"},"payment_mode":{"description":"Forma de pagamento com a qual o pedido será pago. Esta\n informação depende fortemente da integração com o sistema de pagamento\n e considera a lista provida por este, no entanto, para fins de busca\n e interfaces internas o seguinte conjunto será considerado","type":"array","items":{"type":"string","enum":["boleto","cartão de débito","cartão de crédito","débito automático","transferência","dinheiro"]}},"transaction_identifier":{"description":"Identificador único gerado pelo sistema gestor de pagamentos\n com as informações referentes à realização do mesmo"},"historico_requisicoes":{"description":"Histórico de requisições realizadas ao sistema de pagamentos parceiro","type":"array","items":{"description":"Lista de requisições e suas resposas","type":"object","$ref":"#/definitions/PaymentHistoryItem"}},"status":{"description":"Indicação do estado do pagamento no sistema.\n 1. aberto: pagamento solicitado\n 2. em_andamento: requisição feita ao sistema de pagamentos parceiro\n 3. realizado: pagamento autorizado e recebido\n 4. cancelado: pagamento cancelado pelo market place\n 5. com_erro: pagamento incompleto com problemas informados pelo parceiro\n de pagamento","type":"array","items":{"type":"string","enum":["aberto","em_andamento","realizado","cancelado","com erro"]}}}},"ArrayOfPaymentViewModel":{"description":"Lista de pagamentos","type":"object","properties":{"lista":{"type":"array","items":{"type":"object","$ref":"#/definitions/PaymentViewModel"}}}},"OrderViewModel":{"type":"object","description":"Modelo com os dados de pedidos realizados no sistema","properties":{"uid":{"description":"Identificador único de um pedido gerado pelo sistema no\n momento de sua inicialização. Seu valor está relacionado ao momento\n de sua criação e considera os milisegundos desde de 01.01.1970 00:00:000","type":"integer","format":"int64"},"uid_client":{"description":"Identificador do cliente deste pedido","type":"string","format":"uuid"},"uid_product_list":{"description":"List de produtos que fazem parte do pedido","type":"array","items":{"type":"object","$ref":"#/definitions/ProductViewModel"}},"date_request":{"type":"integer","format":"int64"},"status":{"description":"Indicação do estado do pedido:\n 1. aberto: contrução do carrinho de compras em andamento\n 2. em_andamento: pedido fechado e em processo de pagameto\n 3. pagamento_realizado: comprovação do pagamento recebido\n 4. partiu_entrega: produtos que compõem o pedido em processo de entrega\n 5. finalizado: todos os produtos do pedido foram entregues\n 6. cancelado: processo de compra cancelada","type":"array","items":{"type":"string","enum":["aberto","em_andamento","pagamento_realizado","partiu_entrega","finalizado","cancelado"]}}}},"ArrayOfOrderViewModel":{"description":"Lista de pedidos","type":"object","properties":{"lista":{"type":"array","items":{"type":"object","$ref":"#/definitions/OrderViewModel"}}}},"ReviewItemViewModel":{"description":"Modelo com os dados de uma revisão adicionada ao sistema para um mesmo tópico","type":"object","properties":{"uid_message_item":{"description":"Identificador único da mensagem. É preenchido pelo sistema\n na criação de um registro e seu conteúdo representa a data no formato\n UTC com os nanosegundos desde 01.01.1970 00:00:000","type":"integer","format":"int64"},"uid_owner":{"description":"identificador do ID do provedor da mensagem","type":"string","format":"uuid"},"uid_owner_type":{"description":"Identificador do tipo do provedor que adicionou a mensagem.","type":"array","items":{"type":"string","enum":["client","supplier","admin"]}}}},"ReviewViewModel":{"description":"Modelo com as revisões adicionadas por usuários relativas a um pedido, produto e/ou supplier","type":"object","properties":{"uid":{"description":"Identificação única do comentário, gerada pelo sistema quando\n o mesmo é criado.","type":"string","format":"uuid"},"uid_client":{"description":"identificador do cliente que está adicionando o comentário.","type":"string","format":"uuid"},"uid_order":{"description":"Identificador do pedido ao qual o comentário adicionado\n se refere. Está não é uma informação obrigatória do sistema, mas um comentário\n sempre deverá estar associado a uma order, supplier ou product","type":"string","format":"uuid"},"uid_product":{"description":"Identificador único do produto ao qual o comentário se refere\n caso exista essa informação","type":"string","format":"uuid"},"uid_supplier":{"description":"Identificador único do fornecedor (parceiro) ao qual o comentário\n se refere, caso exista essa informação","type":"string","format":"uuid"},"date_created":{"description":"Data inicial da criacao do reveiw em milisegundos no padrão UTC","type":"integer","format":"int64"},"message_list":{"description":"Lista de mensagens atreladas à esta revisão","type":"array","items":{"$ref":"#/definitions/ReviewItemViewModel"}}}},"ArrayOfReviewViewModel":{"description":"Lista de pedidos","type":"object","properties":{"lista":{"type":"array","items":{"type":"object","$ref":"#/definitions/ReviewViewModel"}}}},"PhoneNumberItem":{"description":"Representação de uma informação de número de telefone","properties":{"country_code":{"type":"number"},"number":{"type":"number"},"contact_name":{"type":"string"}}},"PaymentHistoryItem":{"description":"Representação de uma requisição feita ao sistema de pagamento","properties":{"uid":{"description":"Identificador único da requisição, criado pelo sistema\n e baseado no momento da sua chamada","type":"number","format":"int64"},"request":{"description":"Corpo da requisição gerada para o sistema de pagamento\n parceiro","type":"string"},"response":{"description":"Resposta completa fornecida pelo sistema","type":"string"}}},"ListaPresenteViewModel":{"type":"object","properties":{"id":{"type":"number","description":"Id da lista"},"coupleName":{"type":"string","description":"nome do casal"},"weddingDate":{"type":"string","format":"date","description":"data do casamento"},"products":{"type":"array","items":{"$ref":"#/definitions/ProductViewModel"}}}},"GiftAddViewModel":{"type":"object","properties":{"coupleName":{"type":"string","description":"nome do casal"},"weddingDate":{"type":"string","format":"date","description":"data do casamento"},"products":{"type":"array","items":{"$ref":"#/definitions/ProductViewModel"}},"address":{"$ref":"#/definitions/AddressViewModel"}}},"OkViewModel":{"type":"object","properties":{"result":{"type":"string","description":"resultado da requisição"}}},"GiftUpdateViewModel":{"type":"object","properties":{"idList":{"type":"number","description":"número do id da lista de presentes"},"products":{"type":"array","items":{"$ref":"#/definitions/ProductUpdateViewModel"}}}},"ProductUpdateViewModel":{"type":"object","properties":{"id":{"type":"number","description":"id do produto selecionado"},"idPayment":{"type":"number","description":"id do pagamento do produto"}}},"AlertAddViewModel":{"type":"object","properties":{"product":{"$ref":"#/definitions/ProductViewModel"},"percentOff":{"type":"number","description":"porcentagem de desconto"},"startDate":{"type":"string","format":"date","description":"início da promoção"},"endDate":{"type":"string","format":"date","description":"fim da promoção"}}},"AlertViewModel":{"type":"object","properties":{"id":{"type":"number","description":"id do alerta"},"title":{"type":"string","description":"título do produto"},"description":{"type":"string","description":"descrição do produto"},"percentOff":{"type":"number","description":"porcentagem de desconto"},"endDate":{"type":"string","format":"date","description":"data fim da promoção"}}},"AlertSubscribeViewModel":{"type":"object","properties":{"idCategory":{"type":"number","description":"id da categoria"},"idProvider":{"type":"number","description":"id do fornecedor"}}},"AddressViewModel":{"type":"object","properties":{"street":{"type":"string","description":"logradouro"},"zipCode":{"type":"string","description":"CEP"},"neighborhood":{"type":"string","description":"Bairro"},"city":{"type":"string","description":"Cidade"}}},"ComparationViewModel":{"required":["products","creationDate"],"properties":{"id":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851"},"products":{"type":"array","items":{"$ref":"#/definitions/ProductViewModel"}},"creationDate":{"type":"string","format":"date-time","example":"2016-08-29T09:12:33.001Z"}}}},"host":"virtserver.swaggerhub.com","basePath":"/mvpiaia/6mkt/1.0.0"}