{"swagger":"2.0","info":{"description":"API 4middleware para e-commerce, plataformas e/ou marketplaces <br /> 4MiddleWare é um hub de integrações que consegue conectar vários sistemas. <br /><br /> Para obter as chaves de integração contate através do e-mail integracoes@hub4middleware.com.br <br /><br /> Conheça todas integrações compatíveis acessando https://4middleware.com.br ","version":"V1","title":"4MiddleWare - Passivo","termsOfService":""},"tags":[{"name":"Products","description":"Queues"},{"name":"Price Status Stock","description":"Queues"},{"name":"Order","description":"Order"},{"name":"Order Status","description":"Order status"}],"paths":{"/products/queue/{EndPoint}":{"get":{"tags":["Products"],"summary":"retorna fila de produtos pendentes de sincronização.","operationId":"productsqueue","produces":["application/json"],"parameters":[{"name":"EndPoint","in":"path","description":"Identificação da sua plataforma, solicite ao time 4MW","required":true,"type":"string"},{"name":"4mw-pass","in":"header","description":"password de integração","required":true,"type":"string"},{"name":"4mw-key","in":"header","description":"chave de integração","required":true,"type":"string"}],"responses":{"200":{"description":"Observar o boolean 'Sucess' e msg se erro","schema":{"$ref":"#/definitions/ApiResponseProduct"}},"400":{"description":"Request inválido"}}}},"/products/queue/{EndPoint}/remove/{productidonseller}":{"put":{"tags":["Products"],"summary":"remove um item da fila de produtos.","operationId":"productsqueueremove","produces":["application/json"],"parameters":[{"name":"EndPoint","in":"path","description":"Identificação da sua plataforma, solicite ao time 4MW","required":true,"type":"string"},{"name":"productidonseller","in":"path","description":"Identificação do produto","required":true,"type":"string"},{"name":"4mw-pass","in":"header","description":"password de integração","required":true,"type":"string"},{"name":"4mw-key","in":"header","description":"chave de integração","required":true,"type":"string"}],"responses":{"200":{"description":"Observar o boolean 'Sucess' e msg se erro","schema":{"$ref":"#/definitions/ApiResponseItemNull"}},"400":{"description":"Request inválido"}}}},"/price-stock-status/queue/{EndPoint}":{"get":{"tags":["Price Status Stock"],"summary":"retorna fila de produtos que tiveram alterações em preço, estoque ou status.","operationId":"price-stock-statusqueue","produces":["application/json"],"parameters":[{"name":"EndPoint","in":"path","description":"Identificação da sua plataforma, solicite ao time 4MW","required":true,"type":"string"},{"name":"4mw-pass","in":"header","description":"password de integração","required":true,"type":"string"},{"name":"4mw-key","in":"header","description":"chave de integração","required":true,"type":"string"}],"responses":{"200":{"description":"Observar o boolean 'Sucess' e msg se erro","schema":{"$ref":"#/definitions/ApiResponseStockPriceStatus"}},"400":{"description":"Request inválido"}}}},"/price-stock-status/queue/{EndPoint}/remove/{productidonseller}":{"put":{"tags":["Price Status Stock"],"summary":"remove um item da fila de preço, estoque ou status.","operationId":"price-stock-statusqueueremove","produces":["application/json"],"parameters":[{"name":"EndPoint","in":"path","description":"Identificação da sua plataforma, solicite ao time 4MW","required":true,"type":"string"},{"name":"productidonseller","in":"path","description":"Identificação do produto","required":true,"type":"string"},{"name":"4mw-pass","in":"header","description":"password de integração","required":true,"type":"string"},{"name":"4mw-key","in":"header","description":"chave de integração","required":true,"type":"string"}],"responses":{"200":{"description":"Observar o boolean 'Sucess' e msg se erro","schema":{"$ref":"#/definitions/ApiResponseItemNull"}},"400":{"description":"Request inválido"}}}},"/order/create/{EndPoint}":{"post":{"tags":["Order"],"summary":"cria um pedido no 4mw.","operationId":"ordercreate","produces":["application/json"],"parameters":[{"name":"EndPoint","in":"path","description":"Identificação da sua plataforma, solicite ao time 4MW","required":true,"type":"string"},{"in":"body","name":"body","description":"","required":true,"schema":{"$ref":"#/definitions/Order"}},{"name":"4mw-pass","in":"header","description":"password de integração","required":true,"type":"string"},{"name":"4mw-key","in":"header","description":"chave de integração","required":true,"type":"string"}],"responses":{"200":{"description":"Observar o boolean 'Sucess' e msg se erro","schema":{"$ref":"#/definitions/ApiResponseItemNull"}},"400":{"description":"Request inválido"}}}},"/order/{EndPoint}/{orignOrderId}":{"get":{"tags":["Order"],"summary":"obtém um pedido.","operationId":"orderget","produces":["application/json"],"parameters":[{"name":"EndPoint","in":"path","description":"Identificação da sua plataforma, solicite ao time 4MW","required":true,"type":"string"},{"name":"orignOrderId","in":"path","description":"Código do pedido","required":true,"type":"string"},{"name":"4mw-pass","in":"header","description":"password de integração","required":true,"type":"string"},{"name":"4mw-key","in":"header","description":"chave de integração","required":true,"type":"string"}],"responses":{"200":{"description":"Observar o boolean 'Sucess' e msg se erro","schema":{"$ref":"#/definitions/ApiResponseOrder"}},"400":{"description":"Request inválido"}}}},"/order-status/queue/{EndPoint}/{status}":{"get":{"tags":["Order"],"summary":"obtém fila de atualização de pedidos.","operationId":"order-status-queue","produces":["application/json"],"parameters":[{"name":"EndPoint","in":"path","description":"Identificação da sua plataforma, solicite ao time 4MW","required":true,"type":"string"},{"name":"status","in":"path","description":"approved ou invoiced ou shiped ou delivered ou canceled","required":true,"type":"string"},{"name":"4mw-pass","in":"header","description":"password de integração","required":true,"type":"string"},{"name":"4mw-key","in":"header","description":"chave de integração","required":true,"type":"string"}],"responses":{"200":{"description":"Observar o boolean 'Sucess' e msg se erro","schema":{"$ref":"#/definitions/ApiResponseOrderStatus"}},"400":{"description":"Request inválido"}}}},"/order-status/queue/{EndPoint}/remove/{orignOrderId}":{"put":{"tags":["Order"],"summary":"remove um pedido da fila de status.","operationId":"order-status-queue-remove","produces":["application/json"],"parameters":[{"name":"EndPoint","in":"path","description":"Identificação da sua plataforma, solicite ao time 4MW","required":true,"type":"string"},{"name":"orignOrderId","in":"path","description":"Código do pedido","required":true,"type":"string"},{"name":"4mw-pass","in":"header","description":"password de integração","required":true,"type":"string"},{"name":"4mw-key","in":"header","description":"chave de integração","required":true,"type":"string"}],"responses":{"200":{"description":"Observar o boolean 'Sucess' e msg se erro","schema":{"$ref":"#/definitions/ApiResponseItemNull"}},"400":{"description":"Request inválido"}}}},"/order-status/{EndPoint}/{orignOrderId}/approved":{"put":{"tags":["Order Status"],"summary":"Aprovar pedido.","operationId":"order-approved","produces":["application/json"],"parameters":[{"name":"EndPoint","in":"path","description":"Identificação da sua plataforma, solicite ao time 4MW","required":true,"type":"string"},{"name":"orignOrderId","in":"path","description":"Código do pedido","required":true,"type":"string"},{"name":"4mw-pass","in":"header","description":"password de integração","required":true,"type":"string"},{"name":"4mw-key","in":"header","description":"chave de integração","required":true,"type":"string"}],"responses":{"200":{"description":"Observar o boolean 'Sucess' e msg se erro","schema":{"$ref":"#/definitions/ApiResponseItemNull"}},"400":{"description":"Request inválido"}}}},"/order-status/{EndPoint}/{orignOrderId}/canceled":{"put":{"tags":["Order Status"],"summary":"Cancelar pedido.","operationId":"order-canceled","produces":["application/json"],"parameters":[{"name":"EndPoint","in":"path","description":"Identificação da sua plataforma, solicite ao time 4MW","required":true,"type":"string"},{"name":"orignOrderId","in":"path","description":"Código do pedido","required":true,"type":"string"},{"name":"4mw-pass","in":"header","description":"password de integração","required":true,"type":"string"},{"name":"4mw-key","in":"header","description":"chave de integração","required":true,"type":"string"}],"responses":{"200":{"description":"Observar o boolean 'Sucess' e msg se erro","schema":{"$ref":"#/definitions/ApiResponseItemNull"}},"400":{"description":"Request inválido"}}}}},"definitions":{"Order":{"type":"object","properties":{"DockID":{"type":"string","description":"ID da loja / doca do seller"},"orignOrderId":{"type":"string","description":"ID do pedido na plataforma de origem"},"purchaseDate":{"type":"string","description":"dd-mm-yyyy HH:mm:ss"},"currentStatus":{"type":"string","description":"waitingpayment ou approved"},"DiscountValue":{"type":"number","description":"Valor do desconto"},"AdditionValue":{"type":"number","description":"valor adicional do pedido (ex. juros)"},"orderTotal":{"type":"number","description":"valor total do pedido"},"FulFillment":{"type":"boolean","description":"Define se é um pedido fulfillment"},"items":{"type":"array","description":"itens vendidos","items":{"type":"object","properties":{"productidonseller":{"type":"string","description":"codigo do produto no sistema do seller"},"sku":{"type":"string","description":"sku do produto no sistema do seller, caso seja um produto sem variação envie empty ''"},"quantity":{"type":"integer","description":"quantidade de itens vendidos"},"unitprice":{"type":"number","description":"valor unitário"}}}},"customer":{"type":"object","description":"Dados do comprador","properties":{"email":{"type":"string","description":"E-mail"},"firstName":{"type":"string","description":"Nome - Quando PF"},"lastName":{"type":"string","description":"sobrenome - Quando PF"},"tradeName":{"type":"string","description":"Nome fantasia da empresa - quando PJ"},"stateInscription":{"type":"string","description":"Inscrição Estadual - quando PJ. Quando Isento, será retornada essa informação 'Isento'"},"document":{"type":"string","description":"CPF"},"phones":{"type":"array","description":"array com telefones do comprador","items":{}},"corporateName":{"type":"string","description":"Nome da empresa - quando PJ"},"corporateDocument":{"type":"string","description":"CNPJ"},"isCorporate":{"type":"boolean","description":"true quando PJ e false quando PF"}}},"address":{"type":"object","description":"Endereço de entrega","properties":{"state":{"type":"string","description":"Estado UF"},"country":{"type":"string","description":"País"},"reference":{"type":"string","description":"ponto de referência"},"CustomerName":{"type":"string","description":"Nome do cliente destinatário"},"postalCode":{"type":"string","description":"Cep"},"city":{"type":"string","description":"Cidade"},"street":{"type":"string","description":"Logradouro"},"number":{"type":"integer","description":"número"},"neighborhood":{"type":"string","description":"bairro"},"complement":{"type":"string","description":"complemento do endereço"}}},"logisticsInfo":{"type":"object","description":"informações do serviço de entrega","properties":{"shippingServiceID":{"type":"string","description":"identificador do serviço"},"shippingEstimateDays":{"type":"integer","description":"prazo de entrega em dias"},"price":{"type":"number","description":"valor do frete"}}},"paymentID":{"type":"string","description":"Identificador do pagamento utilizado"},"installment":{"type":"object","description":"Informações do parcelamento","properties":{"numberOfInstallments":{"type":"integer","description":"Número de parcelas"},"price":{"type":"number","description":"Valor da parcela"}}}}},"OrderStatus":{"type":"object","properties":{"currentStatus":{"type":"string","description":"status atual do pedido"},"orignOrderId":{"type":"string","description":"Código do pedido"},"middlewareOrderID":{"type":"string","description":"Código do pedido na base 4mw"},"dataSourceOrderId":{"type":"string","description":"Código do pedido no erp do seller"},"EndPoint":{"type":"string","description":"Canal vendedor"},"invoiceData":{"type":"object","properties":{"key":{"type":"string","description":"chave da nota fiscal"},"number":{"type":"string","description":"número da nota fiscal"},"serie":{"type":"string","description":"série da nota fiscal"},"xml":{"type":"string","description":"xml da nota fiscal"}}},"shippingData":{"type":"object","properties":{"trackinumber":{"type":"string","description":"código de rastreio do pedido junto a transportadora"},"url":{"type":"string","description":"url de rastreio do pedido junto a transportadora"}}}}},"Product":{"type":"object","properties":{"active":{"type":"boolean","description":"define se o produto está ativo"},"productidonseller":{"type":"string","description":"Código do produto","maxLength":50},"name":{"type":"string","description":"nome do produto","maxLength":150},"ean":{"type":"string","description":"EAN do produto - caso tenha variações, deve informar em cada sku e no nível produto empty","maxLength":15},"ncm":{"type":"string","description":"NCM do produto - caso tenha variações, deve informar em cada sku e no nível produto empty","maxLength":50},"isbn":{"type":"string","description":"ISBN do produto - caso tenha variações, deve informar em cada sku e no nível produto empty","maxLength":50},"descriptionfield1":{"type":"string","description":"descrição 1 do produto"},"descriptionfield2":{"type":"string","description":"descrição 2 do produto"},"descriptionfield3":{"type":"string","description":"descrição 3 do produto"},"height":{"type":"number","description":"(Altura)Utilizar sempre a mesma unidade de medida (CM ou Metros) - caso tenha variações, deve informar em cada sku e no nível produto o maior valor"},"lenght":{"type":"number","description":"(Profundidade/Comprimento)Utilizar sempre a mesma unidade de medida (CM ou Metros) - caso tenha variações, deve informar em cada sku e no nível produto o maior valor"},"width":{"type":"number","description":"(Largura)Utilizar sempre a mesma unidade de medida (CM ou Metros) - caso tenha variações, deve informar em cada sku e no nível produto o maior valor"},"weight":{"type":"number","description":"(Peso com embalagem)Utilizar sempre a mesma unidade de medida (Gramas ou Kilos) - caso tenha variações, deve informar em cada sku e no nível produto o maior valor"},"crossdocktime":{"type":"integer","description":"Prazo adicional - caso tenha variações, deve informar em cada sku e no nível produto 0"},"listprice":{"type":"number","description":"Preço De - caso tenha variações, deve informar em cada sku e no nível produto o valor do sku com menor valor"},"sellprice":{"type":"number","description":"Preço Por/Venda - caso tenha variações, deve informar em cada sku e no nível produto o valor do sku com menor valor"},"stock":{"type":"integer","description":"Estoque -  caso tenha variações, deve informar em cada sku e no nível produto 0 - caso o StockByDocks esteja preenchido, este campo se referá ao somatório de todas as lojas - importante atentar-se em implantações MULTIDOCA/Lojas ou não. Sem multidocas - usar: 'stock' -> com multidocas - usar : 'StockByDocks'"},"StockByDocks":{"type":"array","description":"Lista de lojas/docas - estoques","items":{"type":"object","properties":{"DockID":{"type":"string","description":"Código da loja / Doca no sistema ERP do seller"},"DockQty":{"type":"integer","description":"Quantidade disponível na respectiva DOCA / Loja"}}}},"brand":{"type":"object","properties":{"id":{"type":"string","description":"Código da marca","maxLength":50},"name":{"type":"string","description":"Nome da marca","maxLength":100}}},"familycategories":{"type":"array","description":"Lista de familias de categorias. Ex. Familia 1: Masculino >> Roupas >> Bermudas. Para cada grupo de categorias, criar uma familia","items":{"type":"object","description":"Ex. Familia 1: Masculino >> Roupas >> Bermudas. Para cada grupo de categorias, criar uma familia","properties":{"id":{"type":"string","description":"Código da categoria pai","maxLength":50},"name":{"type":"string","description":"Nome da categoria pai","maxLength":100},"subcategories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Código da subcategoria","maxLength":50},"name":{"type":"string","description":"Nome da subcategoria","maxLength":100}}}}}}},"ecURL":{"type":"string","description":"URL do produto na loja virtual - caso não possua informe empty","maxLength":200},"aditionalattributes":{"type":"array","description":"Lista de atributos adicionais do produto - alguns sites chamam de especificações técnicas. ex: Nome: Tipo de TV - Valor: Smart ... Nome: Portas Ubs - Valor: 2","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"filters":{"type":"array","description":"Lista de filtros/atributos do produto - alguns sites chamam de especificações técnicas. ex: Nome: Tipo de TV - Valor: Smart ... Nome: Portas Ubs - Valor: 2","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"images":{"type":"array","description":"Lista de imagens do produto - caso tenha variações, informar em cada sku as suas respectivas imagens e no produto uma lista vazia []","items":{},"example":["string","string"]},"variations":{"type":"array","description":"Caso não possua variações envie essa lista vazia []","items":{"type":"object","properties":{"active":{"type":"boolean","description":"define se o sku está ativo"},"sku":{"type":"string","description":"SKU","maxLength":50},"ean":{"type":"string","description":"EAN do Sku - caso não tenha enviar empty","maxLength":15},"ncm":{"type":"string","description":"NCM do Sku - caso não tenha enviar empty","maxLength":50},"isbn":{"type":"string","description":"ISBN do Sku - caso não tenha enviar empty","maxLength":50},"height":{"type":"number","description":"(Altura)Utilizar sempre a mesma unidade de medida (CM ou Metros)"},"lenght":{"type":"number","description":"(Profundidade/Comprimento)Utilizar sempre a mesma unidade de medida (CM ou Metros)"},"width":{"type":"number","description":"(Largura)Utilizar sempre a mesma unidade de medida (CM ou Metros)"},"weight":{"type":"number","description":"(Peso com embalagem)Utilizar sempre a mesma unidade de medida (Gramas ou Kilos)"},"listprice":{"type":"number","description":"Preço De"},"sellprice":{"type":"number","description":"Preço Por/Venda"},"images":{"type":"array","description":"Lista de imagens do Sku - caso não tenha envie uma lista vazia []","items":{},"example":["string","string"]},"seo":{"type":"object","description":"SEO do produto - caso não tenha preencha todos atributos do SEO com Empty","properties":{"title":{"type":"string"},"description":{"type":"string"},"keywords":{"type":"string"}}},"stock":{"type":"integer","description":"Estoque -  caso tenha variações, deve informar em cada sku e no nível produto 0 - caso o StockByDocks esteja preenchido, este campo se referá ao somatório de todas as lojas - importante atentar-se em implantações MULTIDOCA/Lojas ou não. Sem multidocas - usar: 'stock' -> com multidocas - usar : 'StockByDocks'"},"StockByDocks":{"type":"array","description":"Lista de lojas/docas - estoques","items":{"type":"object","properties":{"DockID":{"type":"string","description":"Código da loja / Doca no sistema ERP do seller"},"DockQty":{"type":"integer","description":"Quantidade disponível na respectiva DOCA / Loja"}}}},"combinations":{"type":"array","description":"Combinações da variações. ex: Nome: Cor - Valor: Azul .... Tamanho - Valor: 40","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"}}}}}}},"seo":{"type":"object","description":"SEO do produto - caso não tenha preencha todos atributos do SEO com Empty","properties":{"title":{"type":"string"},"description":{"type":"string"},"keywords":{"type":"string"}}}},"xml":{"name":"Product"}},"StockPriceStatus":{"type":"object","properties":{"active":{"type":"boolean","description":"define se o produto está ativo"},"productidonseller":{"type":"string","description":"Código do produto","maxLength":50},"sku":{"type":"string","description":"sku do produto","maxLength":50},"name":{"type":"string","description":"nome do produto","maxLength":150},"listprice":{"type":"number","description":"Preço De - caso tenha variações, deve informar em cada sku e no nível produto o valor do sku com menor valor"},"sellprice":{"type":"number","description":"Preço Por/Venda - caso tenha variações, deve informar em cada sku e no nível produto o valor do sku com menor valor"},"stock":{"type":"integer","description":"Estoque -  caso tenha variações, deve informar em cada sku e no nível produto 0"}},"xml":{"name":"Product"}},"ApiResponseProduct":{"type":"object","properties":{"success":{"type":"boolean","format":"boolean","description":"True indica sucesso e false falha"},"msg":{"type":"string","format":":string","description":"se não houve sucesso no request a mensagem deve ser observada"},"item":{"items":{"$ref":"#/definitions/Product"}}}},"ApiResponseStockPriceStatus":{"type":"object","properties":{"success":{"type":"boolean","format":"boolean","description":"True indica sucesso e false falha"},"msg":{"type":"string","format":":string","description":"se não houve sucesso no request a mensagem deve ser observada"},"item":{"items":{"$ref":"#/definitions/StockPriceStatus"}}}},"ApiResponseItemNull":{"type":"object","properties":{"success":{"type":"boolean","format":"boolean","description":"True indica sucesso e false falha"},"msg":{"type":"string","format":":string","description":"se não houve sucesso no request a mensagem deve ser observada"},"item":{"type":"object","example":null}}},"ApiResponseOrder":{"type":"object","properties":{"success":{"type":"boolean","format":"boolean","description":"True indica sucesso e false falha"},"msg":{"type":"string","format":":string","description":"se não houve sucesso no request a mensagem deve ser observada"},"item":{"items":{"$ref":"#/definitions/Order"}}}},"ApiResponseOrderStatus":{"type":"object","properties":{"success":{"type":"boolean","format":"boolean","description":"True indica sucesso e false falha"},"msg":{"type":"string","format":":string","description":"se não houve sucesso no request a mensagem deve ser observada"},"item":{"type":"array","items":{"$ref":"#/definitions/OrderStatus"}}}}},"schemes":["https"],"host":"api.hub4middleware.com.br","basePath":"/v1"}