FoccoSMF - Marketplaces¶
Utilização de Serviços de Envio e Consulta de Dados para Marketplace¶
Para utilização dos serviços do Marketplace é utilizado o padrão REST, utilizando JSON para envio e recebimento das informações.
A URL base para utilização dos serviços é o http://<IP>:<PORTA>/service/<SERVIÇO> do FoccoSMF.
Exemplo: http://172.16.11.109:8878/service/SendPricesMarketplace
1. Envio de Tarefas para o FoccoSMF¶
1.1 - JSON de envio de Tarefas¶
| Atributo | Informação |
|---|---|
| Chave de Acesso | Chave do ambiente do cliente do FoccoERP. |
| Modelo | Modelo de serviço do FoccoSMF, utilizar "MARKETPLACE". |
| CodigoGenerico | Deve ser utilizado o nome do Marketplace que se deseja enviar/receber informações. |
| MarketplaceData | Aqui devem ser enviados os dados que serão enviados ao Marketplace, sendo os dados de Autenticação, a URL base do Marketplace e os Dados (Produto, Preço, Estoque) conforme as estruturas definidas. |
| MarketplaceData.UrlBase | URL base do Marketplace. Exemplo: https://cliente.souhibrido.com.br/ |
| MarketplaceData.Authentication | Dados de autenticação. |
| MarketplaceData.Data | Dados do Marketplace conforme o serviço utilizado, por exemplo, se utilizado o serviço de envio de produto, deve ser enviada a estrutura do produto, caso utilizado o serviço de envio de preço, deve ser enviada a estrutura de preço. |
Exemplo:
{
"ChaveAmbiente": "FB9BD7CF-4DD7-4ECE-955B-464AE41D8988",
"Modelo": "MARKETPLACE",
"CodigoGenerico": "MAGENTO",
"MarketplaceData": {
"UrlBase": "https://cliente.souhibrido.com.br/",
"Authentication": { },
"Data": { }
},
}
1.2 - JSON de envio para consulta de resultado de tarefas¶
URL: <URL base para utilização dos serviços>/service/GetTaskResult
| Atributo | Informação |
|---|---|
| ChaveAmbiente | Chave do ambiente do cliente do FoccoERP. |
| Token | Token/chave da tarefa criada no FoccoSMF, que será utilizada para consulta do resultado da tarefa. |
Exemplo
{
"ChaveAmbiente": "FB9BD7CF-4DD7-4ECE-955B-464AE41D2004",
"Token": "4041A17B-D946-4233-840A-6281DA13BF28"
}
1.3 - JSON de retorno do FoccoSMF¶
Essa estrutura de retorno é tanto para o agendamento de tarefas, quanto para a consulta de situação de tarefas.
| Atributo | Informação |
|---|---|
| Token | Token/chave da tarefa criada no FoccoSMF, que será utilizada para consulta do resultado da tarefa. |
| Status | Status/situação da tarefa no FoccoSMF. Situações possíveis: Pendente, Sucesso e Falha. |
| Modelo | Modelo de serviço do FoccoSMF, será o modelo utilizado no envio, no caso "MARKETPLACE". |
| Acao | Identifica a ação/método executado pela tarefa, será o serviço utilizado. Exemplo:"SendPricesMarketplace" |
| Resultado | Retorna o resultado da execução da tarefa. |
Observação¶
Como os serviços do Marketplace são executados de maneira assíncrona com a chamada do serviço, o retorno do envio da tarefa sempre será "null". Na consulta de resultado da tarefa, quando a mesma for executada, será retornado o JSON de retorno, com o resultado do envio dos dados ao Marketplace.
Exemplo
{
"Token": "F061789A-383A-45CA-9BB9-3425F26345BA",
"Status": "Pendente",
"Modelo": "MARKETPLACE",
"Acao": "SendPricesMarketplace",
"Resultado": null
}
2 - Envio de Produtos para Marketplaces via FoccoSMF¶
2.1. - Serviço de Envio de Produtos¶
URL: <URL base para utilização dos serviços>/SendProductsMarketplace
JSON (Enviados em "Data" dos dados do Marketplace ("MarketplaceData" )
| Atributo | Tipo | Informação | Obrigatório |
|---|---|---|---|
| Products | List\<object> | Lista de produtos. | |
| Products.Cnpj | string | CNPJ do estabelecimento. | |
| Products.Sku | string | Código do Produto - Stock Keeping Unit (SKU). Limite de caracteres: 250. | Sim |
| Products.Name | string | Descrição do item no Marketplace. Limite de caracteres: 250. | Sim |
| Products.Description | string | Informações adicionais do item no Marketplace (Vitrine) envio de estrutura HTML. Limite de caracteres: 1000. | |
| Products.Status | string | Situação do item no Marketplace. Valores possíveis: enabled e disabled. | Sim |
| Products.Type | string | Tipo de item. Valores possíveis: simple e configurable. | Sim |
| Products.Width | double | Largura do produto. | Sim |
| Products.Height | double | Altura do produto. | Sim |
| Products.Length | double | Comprimento/profundidade do produto. | Sim |
| Products.Weight | double | Peso do produto. | Sim |
| Products.Ipi | double | Ipi do produto. | |
| Products.IpiType | string | Tipo de Ipi do produto. Valores possíveis: percentage e value. | |
| Products.Ean | string | Código de barras do produto. | |
| Products.Nbm | string | NBM - Nomenclatura Brasileira de Mercadorias ou NCM - Nomenclatura Comum do Mercosul. | Sim |
| Products.OriginalName | string | Descrição Original do Item no Marketplace, sem informação(ões) de Atributo(s) do mesmo. | |
| Products.Categories | List\<object> | Lista de categorias do produto. | |
| Products.Categories.Code | string | Código da categoria. | |
| Products.Categories.Name | string | Descrição da categoria. | |
| Products.ProductAttributes | List\<object> | Lista de atributos do produto, respostas de atributos para o produto. | |
| Products.ProductAttributes.Id | string | Identificador do atributo. | |
| Products.ProductAttributes.Code | string | Código do atributo. | |
| Products.ProductAttributes.Key | string | Resposta/valor do atributo. É recomendável que a propriedade Products.ProductAttributes.Keys não seja informada, quando esta for informada. | |
| Products.ProductAttributes.Options | List\<object> | Lista de opções do atributo. | |
| Products.ProductAttributes.Options.Id | string | Identificador da opção. | |
| Products.ProductAttributes.Options.Code | string | Código da opção. | |
| Products.ProductAttributes.Options.Value | string | Valor da opção. | |
| Products.ProductAttributes.Keys | List\<string> | Lista de respostas/valores do atributo. É recomendável que a propriedade Products.ProductAttributes.Key não seja informada, quando esta for informada. | |
| Products.Specifications | List\<object> | Lista de especificações do produto. | |
| Products.Specifications.Id | string | Identificador da especificação. | |
| Products.Specifications.Code | string | Código da especificação. | |
| Products.Specifications.Key | string | Resposta/valor da especificação. É recomendável que a propriedade Products.Specifications.Keys não seja informada, quando esta for informada. | |
| Products.Specifications.Options | List\<object> | Lista de opções das especificações do produto. | |
| Products.Specifications.Options.Id | string | Identificador da opção. | |
| Products.Specifications.Options.Code | string | Código da opção. | |
| Products.Specifications.Options.Value | string | Valor da opção. | |
| Products.Specifications.Keys | List\<string> | Lista de respostas/valores da especificação. É recomendável que a propriedade Products.Specifications.Key não seja informada, quando esta for informada. | |
| Products.OptionsAttributes | List\<object> | Lista de atributos de opções de atributos do produto, utilizado quando um item é configurado, para indicar as possíveis variações de cada atributo. | |
| Products.OptionsAttributes.Id | string | Identificador da variação. | |
| Products.OptionsAttributes.Code | string | Código da variação. | |
| Products.OptionsAttributes.Key | string | Resposta/valor da variação. | |
| Products.OptionsAttributes.Options | List\<object> | Lista de opções das variações do produto. | |
| Products.OptionsAttributes.Options.Id | string | Identificador da opção. | |
| Products.OptionsAttributes.Options.Code | string | Código da opção. | |
| Products.OptionsAttributes.Options.Value | string | Valor da opção. | |
| Products.ImagesUrl | object | Lista de imagens em Url. | |
| Products.ImagesUrl.Url | string | Url da imagem. | |
| Products.ImagesUrl.Position | int32 | Posição da imagem no Marketplace. | |
| Products.ImagesUrl.Type | string | Tipo da imagem. Valor padrão: "image/png". | |
| Products.ImagesUrl.FileName | string | Nome do arquivo. | |
| Products.ImagesUrl.Name | string | Nome/descrição da imagem no Marketplace. | |
| Products.ImagesBase64 | object | Lista de imagens em base 64. | |
| Products.ImagesBase64.DataBase64Encoded | string | Dados da imagem codificados em base 64. | |
| Products.ImagesBase64.Position | int32 | Posição da imagem no Marketplace. | |
| Products.ImagesBase64.Type | string | Tipo da imagem. Valores possíveis: | |
| Products.ImagesBase64.FileName | string | Nome do arquivo. | |
| Products.ImagesBase64.Name | string | Nome/descrição da imagem no Marketplace. | |
| Products.ProductChildren | List\<object> | Lista de filhos configuráveis. | |
| Products.Parameters | object | Parâmetros específicos de produto conforme plataforma. | |
| Products.ExternalId | string | Id do produto no terceiro. | |
| Products.BrandId | string | Identificador da Marca do Produto no Terceiro. | |
| Products.Multiplier | double | Múltiplo de Venda do Produto. |
Exemplo
"Data": {
"Products": [
{
"Cnpj": null,
"Sku": "3072019",
"Name": "DESC ITEM FILHO",
"Description": "<html><h1>Teste Description ERP.<h1></html>",
"Status": "enabled",
"Type": "simple",
"Width": 18.6,
"Height": 18.8,
"Length": 18.4,
"Weight": 99.2,
"Ipi": 5.0,
"IpiType": "percentage",
"Ean": "7777889",
"Nbm": "98789999",
"OriginalName": "DESC ITEM FILHO",
"Categories": [
{
"Code": "4",
"Name": "teste1"
},
{
"Code": "6",
"Name": "teste2"
}
],
"ProductAttributes": [
{
"Id": "156",
"Code": "chipset",
"Key": "18",
"Options": null,
"Keys": null
}
],
"Specifications": null,
"OptionsAttributes": null,
"ImagesUrl": [
{
"Url": "https://weblocation.com.br/arquivos/ids/1049972-1000-1000/a.png",
"Position": 0,
"Type": null,
"FileName": "Imagem.url.png",
"Name": "Figura 2"
}
],
"ImagesBase64": [
{
"DataBase64Encoded": "image64encoded",
"Position": 0,
"Type": "image/png",
"FileName": "Furadeira.png",
"Name": "Figura 1"
}
],
"ProductChildren": null,
"Parameters": {
"AttributeSetId": 10.0
},
"ExternalId": "12345",
"BrandId": "Volkswagen",
"Multiplier": 3.0
},
{
"Cnpj": null,
"Sku": "3072019-1",
"Name": "DESC ITEM PAI 1",
"Description": "<html><h1>Teste Description ERP.<h1></html>",
"Status": "enabled",
"Type": "configurable",
"Width": 18.6,
"Height": 18.8,
"Length": 18.4,
"Weight": 99.2,
"Ipi": 5.0,
"IpiType": "percentage",
"Ean": "7777889",
"Nbm": "98789999",
"OriginalName": "DESC ITEM PAI 1",
"Categories": [
{
"Code": "4",
"Name": "teste1"
},
{
"Code": "6",
"Name": "teste2"
}
],
"ProductAttributes": null,
"Specifications": null,
"OptionsAttributes": [
{
"Id": "227",
"Key": "Voltagem",
"Options": [
{
"Id": "8",
"Value": null
},
{
"Id": "9",
"Value": null
}
]
}
],
"ImagesUrl": [
{
"Url": "https://weblocation.com.br/arquivos/ids/1049972-1000-1000/a.png",
"Position": 0,
"Type": null,
"FileName": "Imagem.url.png",
"Name": "Figura 2"
}
],
"ImagesBase64": [
{
"DataBase64Encoded": "image64encoded",
"Position": 0,
"Type": "image/png",
"FileName": "Furadeira.png",
"Name": "Figura 1"
}
],
"ProductChildren": [
{
"Cnpj": null,
"Sku": "3072019",
"Name": "DESC ITEM FILHO - 127V",
"Description": "<html><h1>Teste Description ERP.<h1></html>",
"Status": "enabled",
"Type": "simple",
"Width": 18.6,
"Height": 18.8,
"Length": 18.4,
"Weight": 99.2,
"Ipi": 5.0,
"IpiType": "percentage",
"Ean": "7777889",
"Nbm": "98789999",
"OriginalName": "DESC ITEM FILHO",
"Categories": [
{
"Code": "4",
"Name": "teste1"
},
{
"Code": "6",
"Name": "teste2"
}
],
"ProductAttributes": [
{
"Id": "voltagem",
"Key": null,
"Options": null,
"Keys": [
"127",
"220",
"380"
]
}
],
"Specifications": null,
"OptionsAttributes": null,
"ImagesUrl": [
{
"Url": "https://urlimagem.com/imagem.png",
"Position": 0,
"Type": null,
"FileName": "Imagem.url.png",
"Name": "Figura 2"
}
],
"ProductChildren": null,
"Parameters": {
"AttributeSetId": 10.0
},
"ExternalId": "12345",
"BrandId": "Volkswagen",
"Multiplier": 5.25
}
],
"Parameters": {
"AttributeSetId": 10.0
},
"ExternalId": "12345",
"BrandId": "Volkswagen"
}
]
}
2.2 -Retorno do envio de Produtos, Estoque e Preço¶
JSON (Retornado no "Resultado" na Consulta de tarefas do FoccoSMF - Descrito no Item 1.2)
| Atributo | Tipo | Informação |
|---|---|---|
| ProductResponses | List\<object> | Lista de retornos de produtos. |
| ProductResponses.Cnpj | string | CNPJ do estabelecimento |
| ProductResponses.Marketplace | string | Código do Marketplace do produto enviado. |
| ProductResponses.Sku | string | Código do Produto - Stock Keeping Unit (SKU) do produto enviado. |
| ProductResponses.Warehouse | string | Código do Almoxarifado, quando for envio de estoque. |
| ProductResponses.Quantity | double | Quantidade, quando for envio de estoque. |
| ProductResponses.PriceTable | string | Código da Tabela de Preços, quando for envio de preço. |
| ProductResponses.Value | double | Valor, quando for envio de preço. |
| ProductResponses.Status | string | Status da requisição de envio. Conforme padrão HTTP: (OK, BAD_REQUEST) |
| ProductResponses.Message | string | Mensagem de retorno com detalhes de Sucesso ou Falha. |
| ProductResponses.ExternalId | string | Id do produto no terceiro. |
| ProductResponses.Variations | List\<object> | Lista de variações do produto. |
| ProductResponses.Variations.Sku | string | Código da variação do produto enviado. |
| ProductResponses.Variations.ExternalId | string | Id da variação do produto no terceiro. |
Exemplo
{
"ProductResponses": [
{
"Cnpj": "93200111000122",
"Marketplace": "MAGENTO",
"Sku": "10001-[10001]",
"Warehouse": null,
"Quantity": 0,
"PriceTable": null,
"Value": 0,
"Status": "OK",
"Message": "Produto enviado ao Marketplace com sucesso.",
"ExternalId": "12345",
"Variations": [
{
"Sku": "10001-[10002]",
"ExternalId": "3636"
}
],
}
]
}
3 - Envio de Preços para Marketplaces via FoccoSMF¶
3.1 - Serviço de Envio de Preços¶
URL: <URL base para utilização dos serviços>/SendPricesMarketplace
JSON (Enviados em "Data" dos dados do Marketplace ("MarketplaceData" )
| Atributo | Tipo | Informação | Obrigatório |
|---|---|---|---|
| Prices | List\<object> | Lista de preços de produtos, que serão enviados ao Marketplace. | |
| Prices.Cnpj | string | CNPJ do estabelecimento. | |
| Prices.Sku | string | Código do Produto - Stock Keeping Unit (SKU). | Sim |
| Prices.SkuParent | string | Código do Produto - Stock Keeping Unit (SKU), do produto pai. Quando produto configurado deve ser enviado o código do produto pai, quando não configurado o próprio código do produto. | Sim |
| Prices.PriceTable | string | Tabela de preços. | |
| Prices.Value | double | Valor do produto. | Sim |
| Prices.ExternalId | string | Id da variação no terceiro. | |
| Prices.ExternalIdParent | string | Id do produto no terceiro. |
Exemplo
"Data": {
"Prices": [
{
"Cnpj": null,
"Sku": "3072019",
"SkuParent": "3072019",
"Value": 19.19,
"ExternalId": "12345",
"ExternalIdParent": "3636"
},
{
"Cnpj": null,
"Sku": "2500000000(1099999999)",
"SkuParent": "2500000000",
"Value": 18.18,
"ExternalId": "12346",
"ExternalIdParent": "3637"
}
]
}
3.2 - Retorno de envio de Preços¶
Conforme item 2.2.
4 - Envio de Estoque para Marketplaces via FoccoSMF¶
4.1 - Serviço de Envio de Estoque¶
URL: <URL base para utilização dos serviços>/SendStocksMarketplace
JSON (Enviados em "Data" dos dados do Marketplace ("MarketplaceData" )
| Atributo | Tipo | Informação | Obrigatório |
|---|---|---|---|
| Stocks | List\<object> | Lista de estoque de produtos que serão enviados ao Marketplace. | |
| Stocks.Cnpj | string | CNPJ do estabelecimento. | |
| Stocks.CompanyDescription | string | Razão social da empresa. | |
| Stocks.Sku | string | Código do Produto - Stock Keeping Unit (SKU). | Sim |
| Stocks.SkuParent | string | Código do Produto - Stock Keeping Unit (SKU), do produto pai. Quando produto configurado deve ser enviado o código do produto pai, quando não configurado o próprio código do produto. | Sim |
| Stocks.SubsidiaryCode | string | Código da filial no marketplace de destino. O código é buscado a partir do De-Para "Filial Marketplace" cadastrado nos parâmetros de configuração do Marketplace no FoccoHub. | |
| Stocks.Warehouse | string | Almoxarifado - Local de estoque da quantidade. | |
| Stocks.Quantity | double | Quantidade em estoque. | Sim |
| Stocks.ProductDescription | string | Descrição do produto. | |
| Stocks.ExternalId | string | Id da variação no terceiro. | |
| Stocks.ExternalIdParent | string | Id do produto no terceiro. | |
| Stocks.StocksMultiCompany | List\<object> | Lista de estoque Multiempresa. | |
| ProductResponses.StockMultiCompany.CnpjCompany | string | CNPJ da empresa. | Sim |
| ProductResponses.StockMultiCompany.CompanyDescription | string | Razão social da empresa. | Sim |
| ProductResponses.StockMultiCompany.Quantity | double | Quantidade em estoque. |
Exemplo:
"Data": {
"Stocks": [
{
"Cnpj": null,
"CompanyDescription": "Razão social da empresa.",
"Sku": "3072019",
"SkuParent": "3072019",
"Warehouse": "10",
"Quantity": 14.0,
"ProductDescription": "Novo Produto",
"ExternalId": "12345",
"ExternalIdParent": "3636",
"StocksMultiCompany": [
{
"CnpjCompany": "93200111000122",
"CompanyDescription": "FOCCOERP_ORIG_3_17",
"Quantity": 14.0
},
{
"CnpjCompany": "7267775000177",
"CompanyDescription": "FOCCOERP_ORIG_3_17",
"Quantity": 2.0
}
],
"StockMultiCompany":
},
{
"Cnpj": null,
"CompanyDescription": "Razão social da empresa.",
"Sku": "2500000000(1099999999)",
"SkuParent": "2500000000",
"Warehouse": "10",
"Quantity": 88.0,
"ProductDescription": "Novo Produto",
"ExternalId": "12346",
"ExternalIdParent": "3637",
"StocksMultiCompany": [
{
"CnpjCompany": "93200111000122",
"CompanyDescription": "FOCCOERP_ORIG_3_17",
"Quantity": 88.0
},
{
"CnpjCompany": "7267775000177",
"CompanyDescription": "FOCCOERP_ORIG_3_17",
"Quantity": 0.0
}
],
}
]
}
4.2 - Retorno de envio de Preços¶
Conforme item 2.2.
5 - Envio de Tarefa para Consulta de Pedidos de Marketplaces via FoccoSMF¶
5.1 - Serviço de Envio de Consulta de Pedidos¶
URL: <URL base para utilização dos serviços>/CheckOrdersMarketplace
JSON (Enviados em "Data" dos dados do Marketplace ("MarketplaceData" )
| Atributo | Tipo | Informação |
|---|---|---|
| Cnpj | long | CNPJ da Empresa, para consulta de pedidos. Quando o Marketplace possui divisão por empresa/CNPJ, caso contrário a informação será ignorada. |
Exemplo
"Data": {
"Cnpj": "93200111000122"
}
5.2 - Retorno de Consulta de Pedidos¶
JSON (Retornado no "Resultado" na Consulta de tarefas do FoccoSMF - Descrito no Item 1.2)
| Atributo | Tipo | Informação |
|---|---|---|
| Orders | List<object> | Lista de pedidos retornados do Marketplace. |
| Orders.Cnpj | string | CNPJ da Empresa. |
| Orders.Marketplace | string | Identificador do Marketplace onde o pedido se encontra.Exemplo: MAGENTO, SKYHUB. |
| Orders.Type | string | Tipo do pedido. Valores possíveis: sale - Venda assistance - Assistência Técnica billedassistance - Assistência com Receita bonus - Bonificação fulfillment - Fulfillment |
| Orders.Position | string | Posição do pedido no Marketplace. |
| Orders.Status | string | Status do pedido no Marketplace. Valores possíveis: processed - Processado imported - Importado billed - Faturado canceled - Cancelado |
| Orders.OrderId | string | Identificador do pedido no Marketplace. |
| Orders.OrderNumber | string | Número do pedido no Marketplace. |
| Orders.CreationDate | date | Data de emissão do pedido no Marketplace. |
| Orders.CancelDate | date | Data de cancelamento, informada quando o Status da ordem for Canceled |
| Orders.NetAmount | double | Valor líquido do pedido. |
| Orders.TotalAmount | double | Valor Bruto do pedido. |
| Orders.Comments | string | Observações do pedido. |
| Orders.ShippingAmount | double | Valor de frete. |
| Orders.ShippingDescription | string | Transportadora do pedido no Marketplace. |
| Orders.FreightType | string | Tipo de frete no Marketplace. CIF - FOB - collect. |
| Orders.PriceTable | string | Tabela de preços no Marketplace. |
| Orders.Salesman | string | Vendedor, representante do pedido no Marketplace. |
| Orders.SubsidiaryCompany | string | Centro de distribuição. |
| Orders.Channel | string | Canal de origem do pedido (e-commerce). |
| Orders.DiscountAmount | double | Desconto da capa do pedido. |
| Orders.AdditionalAmount | double | Acréscimo da capa do pedido. |
| Orders.RequestOrderNumber | string | Número da ordem de compra no Marketplace |
| Orders.ResponsiblePaymentType | string | Destino de faturamento do pedido. |
| Orders.BranchIdentifier | string | Identificador da filial. |
| Orders.Customer | List<object> | Estrutura com dados do cliente do pedido. |
| Orders.Customer.Email | string | E-mail do cliente no marketplace. |
| Orders.Customer.Document | string | Documento do cliente. |
| Orders.Customer.Firstname | string | Primeiro nome do cliente no Marketplace. |
| Orders.Customer.Lastname | string | Sobrenome do cliente no Marketplace. |
| Orders.Customer.StateRegistration | string | Inscrição Estadual no Marketplace. |
| Orders.FinalCustomer | object | Estrutura com dados do cliente final do pedido. |
| Orders.FinalCustomer.Name | string | Nome do cliente final no Marketplace. |
| Orders.FinalCustomer.Document | string | Documento do cliente final. |
| Orders.FinalCustomer.StateRegistration | string | Inscrição Estadual do cliente final no Marketplace. |
| Orders.FinalCustomer.PostCode | string | CEP do cliente final no Marketplace. |
| Orders.FinalCustomer.Address | object | Estrutura com dados do endereço do cliente final. |
| Orders.FinalCustomer.Address.Street | string | Logradouro do endereço do cliente final. |
| Orders.FinalCustomer.Address.Number | string | Número do endereço do cliente final. |
| Orders.FinalCustomer.Address.Complement | string | Complemento do endereço do cliente final. |
| Orders.FinalCustomer.Address.Neighborhood | string | Bairro do endereço do cliente final. |
| Orders.FinalCustomer.City | string | Cidade do endereço do cliente final. |
| Orders.FinalCustomer.State | string | Estado/UF do endereço do cliente final. |
| Orders.FinalCustomer.Country | string | País do endereço do cliente final. |
| Orders.FinalCustomer.Comments | string | Observações do cliente final. |
| Orders.FinalCustomer.Emails | List<string> | Lista de emails do cliente final. |
| Orders.FinalCustomer.Phones | List<object> | Lista de telefones do cliente final. |
| Orders.FinalCustomer.Phones.DDI | string | DDI do telefone do cliente final. |
| Orders.FinalCustomer.Phones.DDD | string | DDD do telefone ddo cliente final. |
| Orders.FinalCustomer.Phones.Number | string | Número do telefone do cliente final. |
| Orders.ShippingAddress | List<object> | Estrutura com dados do endereço de entrega. |
| Orders.ShippingAddress.Email | string | E-mail do endereço de endereço de entrega. |
| Orders.ShippingAddress.Firstname | string | Primeiro nome do endereço de entrega. |
| Orders.ShippingAddress.Lastname | string | Sobrenome do endereço de entrega. |
| Orders.ShippingAddress.PostCode | string | CEP do endereço de entrega. |
| Orders.ShippingAddress.Address | List<object> | Estrutura com dados do endereço. |
| Orders.ShippingAddress.Address.Street | string | Logradouro do endereço de entrega. |
| Orders.ShippingAddress.Address.Number | string | Número do endereço de entrega. |
| Orders.ShippingAddress.Address.Complement | string | Complemento do endereço de entrega. |
| Orders.ShippingAddress.Address.Neighborhood | string | Bairro do endereço de entrega. |
| Orders.ShippingAddress.City | string | Cidade do endereço de entrega. |
| Orders.ShippingAddress.CityCode | string | Código da cidade do endereço de entrega. |
| Orders.ShippingAddress.State | string | Estado/UF do endereço de entrega. |
| Orders.ShippingAddress.StateCode | string | Código do estado/UF do endereço de entrega. |
| Orders.ShippingAddress.Country | string | País do endereço de entrega. |
| Orders.ShippingAddress.CountryCode | string | Código do país do endereço de entrega. |
| Orders.ShippingAddress.Telephones | List<object> | Lista de telefones do endereço. |
| Orders.ShippingAddress.Telephones.Type | string | Tipo de telefone do telefone de entrega no Marketplace. |
| Orders.ShippingAddress.Telephones.DDI | string | DDI do telefone de entrega. |
| Orders.ShippingAddress.Telephones.DDD | string | DDD do telefone de entrega. |
| Orders.ShippingAddress.Telephones.Number | string | Número do telefone de entrega. |
| Orders.BillingAddress | List<object> | Estrutura com dados do endereço de faturamento/cobrança. |
| Orders.BillingAddress.Email | string | E-mail do endereço de cobrança. |
| Orders.BillingAddress.Firstname | string | Primeiro nome do endereço de cobrança. |
| Orders.BillingAddress.Lastname | string | Sobrenome |
| Orders.BillingAddress.PostCode | string | CEP do endereço de cobrança. |
| Orders.BillingAddress.Address | List<object> | Estrutura com dados do endereço. |
| Orders.BillingAddress.Address.Street | string | Logradouro do endereço de cobrança. |
| Orders.BillingAddress.Address.Number | string | Número do endereço de cobrança. |
| Orders.BillingAddress.Address.Complement | string | Complemento do endereço de cobrança. |
| Orders.BillingAddress.Address.Neighborhood | string | Bairro do endereço de cobrança. |
| Orders.BillingAddress.City | string | Cidade do endereço do cobrança. |
| Orders.BillingAddress.CityCode | string | Código da cidade do endereço de cobrança. |
| Orders.BillingAddress.State | string | Estado/UF do endereço do cobrança. |
| Orders.BillingAddress.StateCode | string | Código do Estado/UF do endereço do cobrança. |
| Orders.BillingAddress.Country | string | País do endereço de cobrança. |
| Orders.BillingAddress.CountryCode | string | Código do país do endereço de cobrança. |
| Orders.BillingAddress.Telephones | List<object> | Lista de telefones do endereço. |
| Orders.BillingAddress.Telephones.Type | string | Tipo de telefone do telefone de cobrança no Marketplace. |
| Orders.BillingAddress.Telephones.DDI | string | DDI do telefone de cobrança. |
| Orders.BillingAddress.Telephones.DDD | string | DDD do telefone de cobrança. |
| Orders.BillingAddress.Telephones.Number | string | Número do telefone de cobrança. |
| Orders.Items | List<object> | Lista de itens do pedido. |
| Orders.Items.Sequence | double | Sequencia/número do item no pedido. |
| Orders.Items.Sku | string | SKU (Stock Keeping Unit), do item no Marketplace. Utilizado como identificador do item. |
| Orders.Items.Name | string | Descrição do item no Marketplace. |
| Orders.Items.Quantity | double | Quantidade do item. |
| Orders.Items.UnitCode | string | Unidade de medida. |
| Orders.Items.DiscountAmount | double | Desconto em valor. |
| Orders.Items.DiscountPercent | double | Desconto em percentual. |
| Orders.Items.OriginalPrice | double | Preço original do produto. |
| Orders.Items.SalePrice | double | Preço de venda do produto. |
| Orders.Items.PriceTable | string | Tabela de preços. |
| Orders.Items.CFOP | string | CFOP (Código Fiscal de Operações e Prestações) do produto. |
| Orders.Items.CST | string | CST (Código de Situação Tributária) do produto. |
| Orders.Items.Comments | string | Observações do produto. |
| Orders.Items.ExternalProductId | string | Id do produto no terceiro. |
| Orders.Items.ExternalVariationId | string | Id da variação no terceiro. |
| Orders.Items.DeliveryDate | date | Data de entrega no Marketplace. |
| Orders.Items.ProductType | string | Tipo de Produto. Valores Possíveis: normal - Produto normal service - Produto de Serviço |
| Orders.Items.RemittanceType | string | Tipo de Remessa Valores Possíveis: sale - Venda assistance - Assistência Técnica billedassistance - Assistência com Receita bonus - Bonificação |
| Orders.Items.Specifications | List<object> | Lista de especificações do item do pedido. |
| Orders.Items.Specifications.Code | string | Código da especificação. |
| Orders.Items.Specifications.Value | string | Valor referente ao código da especificação |
| Orders.Payments | List<object> | Lista de pagamentos do pedido. |
| Orders.Payments.Type | string | Tipo de pagamento. undefined - Tipo de pagamento indefinido. billet - Boleto. creditcard - Cartão de crédito. debitcard - Cartão de débito. |
| Orders.Payments.Method | string | Método de pagamento.Utilizado para identificar portador do pagamento. |
| Orders.Payments.NumberPayments | double | Número de parcelas do pagamento.Utilizado para identificar condição de pagamento. |
| Orders.Payments.TotalAmount | double | Valor total do pagamento. |
| Orders.Payments.AuthorizationNumber | string | Número de autorização de operações com cartão. |
| Orders.Payments.NSU | string | NSU (Número Sequencial Único) de operações com cartão. |
| Orders.Payments.CardBrand | string | Bandeira do cartão. |
| Orders.DeliveryInvoice | List<object> | Lista de notas fiscais de entrega. |
| Orders.DeliveryInvoice.Number | string | Número da nota fiscal de remessa. |
| Orders.DeliveryInvoice.Series | string | Série da nota fiscal de remessa. |
| Orders.DeliveryInvoice.Date | date | Data de emissão da nota fiscal de remessa. |
| Orders.DeliveryInvoice.Key | string | Chave da nota fiscal de remessa. |
| Orders.SalesInvoice | List<object> | Lista de notas fiscais de venda. |
| Orders.SalesInvoice.Number | string | Número da nota fiscal de venda. |
| Orders.SalesInvoice.Series | string | Série da nota fiscal de venda. |
| Orders.SalesInvoice.Date | date | Data de emissão da nota fiscal de venda. |
| Orders.SalesInvoice.Key | string | Chave da nota fiscal de venda. |
| Orders.Delivery | List<object> | Lista de itens para entrega. |
| Orders.Delivery.Cnpj | string | Cnpj da empresa que irá entregar o item. |
| Orders.Delivery.ShippingDescription | string | Nome da transportadora de entrega. |
| Orders.Delivery.DeliveryInfo | List<object> | Lista de informações do item para entrega. |
| Orders.Delivery.DeliveryInfo.ItemIndex | int | Número do item. |
| Orders.Delivery.DeliveryInfo.ShippingPrice | double | Valor do frete. |
| Orders.Delivery.DeliveryInfo.Quantity | double | Quantidade do item. |
| Orders.Delivery.DeliveryInfo.DeliveryInfoComponents | List<object> | Lista de informações dos componentes do item para entrega. |
| Orders.Delivery.DeliveryInfo.DeliveryInfoComponents.Id | string | Identificador do componente do item. |
| Orders.Delivery.DeliveryInfo.DeliveryInfoComponents.Quantity | double | Quantidade do componente do item. |
Exemplo:
{
"Orders": [
{
"Cnpj": "93200111000122",
"Marketplace": "MAGENTO",
"Type": "sale",
"Position": "processing",
"Status": "processed",
"OrderId": "3",
"OrderNumber": "000000003",
"CreationDate": "2019-08-26T14:35:20-03:00",
"NetAmount": 5799.4,
"TotalAmount": 5829.4,
"Comments": null,
"Customer": {
"Email": "ederson.copelli@focco.com.br",
"Document": "906.959.690-30",
"Firstname": "Éderson Luis",
"Lastname": "Copelli",
"StateRegistration": "7990304016"
},
"FinalCustomer": {
"Name": "Éderson Luis Copelli",
"Document": "307.240.940-40",
"StateRegistration": null,
"PostCode": "95012-140",
"Address": {
"Street": "Rua dos Cinamomos",
"Number": "517",
"Complement": null,
"Neighborhood": "Cinqüentenário"
},
"City": "Caxias do Sul",
"State": "RS",
"Country": "Brasil",
"Comments": null,
"Emails": [
"promob@promob.com",
"ederson.copelli@focco.com.br"
],
"Phones": [
{
"Type": null,
"DDI": null,
"DDD": "23",
"Number": "423432"
},
{
"Type": null,
"DDI": "55",
"DDD": "54",
"Number": "30254486"
}
]
},
"ShippingAmount": 30,
"ShippingDescription": "Flat Rate - em média 3 dias úteis - Fixed",
"FreightType": "CIF",
"PriceTable": null,
"Salesman": null,
"SubsidiaryCompany": null,
"Channel": "AMERICANAS",
"DiscountAmount": 0,
"AdditionalAmount": 0,
"RequestOrderNumber": "OC123",
"ResponsiblePaymentType": "Company",
"BranchIdentifier": "26011"
"ShippingAddress": {
"Email": "ederson.copelli@focco.com.br",
"Firstname": "Éderson Luis",
"Lastname": "Copelli",
"PostCode": "95034-000",
"Address": {
"Street": "Rua Moreira César",
"Number": "2019",
"Complement": "TESTES - Focco Sistemas de Gestão",
"Neighborhood": "Pio X"
},
"City": "Caxias do Sul",
"CityCode": null,
"State": "Rio Grande do Sul",
"StateCode": "RS",
"Country": null,
"CountryCode": "BR",
"Telephones": [
{
"Type": null,
"DDI": null,
"DDD": "54",
"Number": "992126449"
}
]
},
"BillingAddress": {
"Email": "ederson.copelli@focco.com.br",
"Firstname": "Éderson Luis",
"Lastname": "Copelli",
"PostCode": "95034-000",
"Address": {
"Street": "Rua Moreira César",
"Number": "2019",
"Complement": "TESTES - Focco Sistemas de Gestão",
"Neighborhood": "Pio X"
},
"City": "Caxias do Sul",
"CityCode": null,
"State": "Rio Grande do Sul",
"StateCode": "RS",
"Country": null,
"CountryCode": "BR",
"Telephones": [
{
"Type": null,
"DDI": null,
"DDD": "54",
"Number": "992126449"
}
]
},
"Items": [
{
"Sequence": 1,
"Sku": "10001-[10001]",
"Name": "MOTOSSERRA MS 650 2 Tempos",
"Quantity": 2,
"UnitCode": null,
"DiscountAmount": 0,
"DiscountPercent": 0,
"OriginalPrice": 1899.7,
"SalePrice": 1899.7,
"PriceTable": null,
"CFOP": null,
"CST": null,
"Comments": null,
"ExternalProductId": "12345",
"ExternalVariationId": "25",
"DeliveryDate": "2019-08-26T14:35:20-03:00",
"Specifications": [
{
"Code": "CODE",
"Value": "BARR0004"
},
{
"Code": "CONF_LARG",
"Value": "1200"
},
{
"Code": "CONF_ALT",
"Value": "770"
},
{
"Code": "CONF_PROF",
"Value": "800"
},
{
"Code": "COR",
"Value": "CERULEO"
}
]
},
{
"Sequence": 2,
"Sku": "123456",
"Name": "Produto Teste Teste",
"Quantity": 4,
"UnitCode": null,
"DiscountAmount": 0,
"DiscountPercent": 0,
"OriginalPrice": 500,
"SalePrice": 500,
"PriceTable": null,
"CFOP": null,
"CST": null,
"Comments": null,
"ExternalProductId": "12346",
"ExternalVariationId": "26",
"Specifications": [
{
"Code": "CODE",
"Value": "CAB339"
},
{
"Code": "COR",
"Value": "MOGNO"
}
]
}
],
"Payments": [
{
"Type": "creditcard",
"Method": "mundipagg_creditcard",
"NumberPayments": 0,
"TotalAmount": 5829.4,
"AuthorizationNumber": null,
"NSU": null,
"CardBrand": "visa"
}
],
"DeliveryInvoice": null,
"SalesInvoice": null,
"Delivery": [
{
"Cnpj": "93200111000122",
"ShippingDescription":"Transportadora X",
"DeliveryInfo":[
{
"ItemIndex": 1,
"ShippingPrice": 28.77,
"Quantity": 1,
"DeliveryInfoComponents": null
}
]
},
{
"Cnpj": "92786680000139",
"ShippingDescription":"Transportadora Y",
"DeliveryInfo":[
{
"ItemIndex": 0,
"ShippingPrice": 12.49,
"Quantity": 1,
"DeliveryInfoComponents": null
}
]
}
]
},
{
"Cnpj": "93200111000122",
"Marketplace": "MAGENTO",
"Type": "sale",
"Position": "processing",
"Status": "processed",
"OrderId": "4",
"OrderNumber": "000000004",
"CreationDate": "2019-09-02T12:36:38-03:00",
"NetAmount": 2801.37,
"TotalAmount": 2826.37,
"Comments": null,
"Customer": {
"Email": "ederson.copelli@focco.com.br",
"Document": "906.959.690-30",
"Firstname": "Éderson Luis",
"Lastname": "Copelli"
},
"ShippingAmount": 25,
"ShippingDescription": "Flat Rate - em média 3 dias úteis - Fixed",
"FreightType": "CIF",
"PriceTable": null,
"Salesman": null,
"ShippingAddress": {
"Email": "ederson.copelli@focco.com.br",
"Firstname": "Éderson Luis",
"Lastname": "Copelli",
"PostCode": "95034-000",
"Address": {
"Street": "Rua Marcos Moreschi",
"Number": "437",
"Complement": "DO LADO",
"Neighborhood": "Pio X"
},
"City": "Caxias do Sul",
"CityCode": null,
"State": "Rio Grande do Sul",
"StateCode": "RS",
"Country": null,
"CountryCode": "BR",
"Telephones": [
{
"Type": null,
"DDI": null,
"DDD": "54",
"Number": "992126449"
}
]
},
"BillingAddress": {
"Email": "ederson.copelli@focco.com.br",
"Firstname": "Éderson Luis",
"Lastname": "Copelli",
"PostCode": "95034-000",
"Address": {
"Street": "Rua Moreira César",
"Number": "2019",
"Complement": "TESTES - Focco Sistemas de Gestão",
"Neighborhood": "Pio X"
},
"City": "Caxias do Sul",
"CityCode": null,
"State": "Rio Grande do Sul",
"StateCode": "RS",
"Country": null,
"CountryCode": "BR",
"Telephones": [
{
"Type": null,
"DDI": null,
"DDD": "54",
"Number": "992126449"
}
]
},
"Items": [
{
"Sequence": 1,
"Sku": "10001-[10001]",
"Name": "MOTOSSERRA MS 650 2 Tempos",
"Quantity": 2,
"UnitCode": null,
"DiscountAmount": 0,
"DiscountPercent": 0,
"OriginalPrice": 899.7,
"SalePrice": 899.7,
"PriceTable": null,
"CFOP": null,
"CST": null,
"Comments": null,
"ExternalProductId": "12345",
"ExternalVariationId": "25",
},
{
"Sequence": 2,
"Sku": "KIT9999-[KIT9999]",
"Name": "EMBALAGEM FERRAGENS",
"Quantity": 3,
"UnitCode": null,
"DiscountAmount": 0,
"DiscountPercent": 0,
"OriginalPrice": 333.99,
"SalePrice": 333.99,
"PriceTable": null,
"CFOP": null,
"CST": null,
"Comments": null,
"ExternalProductId": "12347",
"ExternalVariationId": "27",
}
],
"Payments": [
{
"Type": "creditcard",
"Method": "mundipagg_creditcard",
"NumberPayments": 0,
"TotalAmount": 2826.37,
"AuthorizationNumber": null,
"NSU": null,
"CardBrand": "visa"
}
],
"DeliveryInvoice": null,
"SalesInvoice": null,
"Delivery": [
{
"Cnpj": "93200111000122",
"ShippingDescription":"Transportadora X",
"DeliveryInfo":[
{
"ItemIndex": 1,
"ShippingPrice": 28.77,
"Quantity": 1,
"DeliveryInfoComponents": null
}
]
},
{
"Cnpj": "92786680000139",
"ShippingDescription":"Transportadora Y",
"DeliveryInfo":[
{
"ItemIndex": 0,
"ShippingPrice": 12.49,
"Quantity": 1,
"DeliveryInfoComponents": null
}
]
}
]
}
]
}
6 - Envio de Status de Pedidos para Marketplaces via FoccoSMF¶
6.1 - Serviço de Envio de Status de Pedidos¶
URL: <URL base para utilização dos serviços>/SendOrderStatusMarketplace
JSON (Enviados em "Data" dos dados do Marketplace ("MarketplaceData")
| Atributo | Tipo | Informação | Obrigatório |
|---|---|---|---|
| OrdersStatus | List\<object> | Lista de Status de Pedidos que serão enviados ao Marketplace. | |
| OrdersStatus.Cnpj | string | CNPJ da Empresa. | |
| OrdersStatus.OrderId | string | Identificador do pedido no Marketplace. | Sim |
| OrdersStatus.OrderNumber | string | Número do pedido no Marketplace. | Sim |
| OrdersStatus.Status | string | Status que será enviado para o Marketplace. Valores possíveis: processed - Processado imported - Importado billed - Faturado | Sim |
| OrdersStatus.ERPOrderCode | long | Número do pedido no ERP. | |
| OrdersStatus.DeliveryDate | date | Data de Entrega do pedido para o cliente final. | |
| OrdersStatus.Parameters | object | Parâmetros de configuração da plataforma. | |
| OrdersStatus.TrackingUrl | string | URL para rastreio do pedido. | |
| OrdersStatus.TotalValue | double | Valor total do pedido no ERP. | |
| OrdersStatus.BranchIdentifier | string | Identificador da filial. | |
| OrdersStatus.Invoices | List\<object> | Lista de Status de Notas Fiscais. | |
| OrdersStatus.Invoices.Number | string | Número da nota fiscal. | |
| OrdersStatus.Invoices.Series | string | Série da nota fiscal. | |
| OrdersStatus.Invoices.Date | date | Data de emissão da nota fiscal. | |
| OrdersStatus.Invoices.Key | string | Chave da nota fiscal. | |
| OrdersStatus.Invoices.TotalValue | double | Total da nota fiscal. | |
| OrdersStatus.Invoices.GrossValue | double | Valor bruto da nota fiscal. | |
| OrdersStatus.Invoices.ShippingCompany | string | Transportadora da nota fiscal. | |
| OrdersStatus.Invoices.ShippingCompanyIdentifier | string | CNPJ da transportadora da nota fiscal. | |
| OrdersStatus.Invoices.EstimatedDeliveryDate | date | Data de Entrega estimada da nota fiscal. | |
| OrdersStatus.Invoices.Xml | string | XML da nota fiscal. | |
| OrdersStatus.Invoices.VolumeQuantity | long | Quantidade de volumes da nota fiscal. | |
| OrdersStatus.Invoices.Items | List\<object> | Lista de Itens da Nota Fiscal. | |
| OrdersStatus.Invoices.Items.ExternalId | string | Id do produto no terceiro. | |
| OrdersStatus.Invoices.Items.ExternalVariationId | string | Id da variação no terceiro. | |
| OrdersStatus.Invoices.Items.Cfop | string | CFOP do item na nota fiscal. | |
| OrdersStatus.Sku | string | SKU (Stock Keeping Unit), do item no Marketplace. | |
| OrdersStatus.Quantity | double | Quantidade do item. |
*Exemplo:
"Data": {
"OrdersStatus": [
{
"Cnpj": "93200111000122",
"OrderId": "15",
"OrderNumber": "000000015",
"Status": "imported",
"Invoices": [],
"ERPOrderCode": "15",
"DeliveryDate": "2019-09-09T00:00:00-03:00",
"TrackingUrl": "http://www.rastreio.com.br",
"TotalValue": 100.1,
"BranchIdentifier": "26011"
},
{
"Cnpj": "93200111000122",
"OrderId": "15",
"OrderNumber": "000000015",
"Status": "billed",
"Invoices": [
{
"Number": "17327010",
"Series": "142",
"Date": "2019-09-09T00:00:00-03:00",
"Key": "43190993200111000122551420173270101000570811",
"TotalValue": 100.1,
"ShippingCompany": "Transportadora XYZ",
"ShippingCompanyIdentifier": "93200111000122",
"EstimatedDeliveryDate": "2019-09-09T00:00:00-03:00",
"Xml": "<procEventoNFe versao="1.00" xmlns=...",
"VolumeQuantity": 5,
"Items": [
{
"ExternalId": "12345",
"ExternalVariationId": "25",
"Cfop": "5101",
"Sku": "KIT9999-[KIT9999]",
"Quantity": 3
}
],
}
],
"ERPOrderCode": "15",
"DeliveryDate": "2019-09-09T00:00:00-03:00"
}
]
}
6.2 - JSON (Retornado no "Resultado" na Consulta de tarefas do FoccoSMF)¶
JSON (Retornado no "Resultado" na Consulta de tarefas do FoccoSMF - Descrito no Item 1.2)
| Atributo | Tipo | Informação |
|---|---|---|
| OrderStatusResponses | List\<object> | Lista de Respostas de Envio de Status para Marketplaces |
| OrderStatusResponses.Cnpj | string | CNPJ da Empresa. |
| OrderStatusResponses.Marketplace | string | Marketplace que foi enviado o Status. |
| OrderStatusResponses.OrderId | string | Identificador do pedido no Marketplace. |
| OrderStatusResponses.OrderNumber | string | Número do pedido no Marketplace. |
| OrderStatusResponses.Status | string | Status que foi enviado para os Marketplaces. |
| OrderStatusResponses.RequestStatus | string | Status da requisição. |
| OrderStatusResponses.Message | string | Mensagem retornada da requisição. |
Exemplo
{
"OrderStatusResponses": [
{
"Cnpj": "93200111000122",
"Marketplace": "MAGENTO",
"OrderId": "15",
"OrderNumber": "000000015",
"Status": "processed",
"RequestStatus": "OK",
"Message": "Status do pedido enviado com sucesso."
},
{
"Cnpj": "93200111000122",
"Marketplace": "MAGENTO",
"OrderId": "15",
"OrderNumber": "000000015",
"Status": "imported",
"RequestStatus": "OK",
"Message": "Status do pedido enviado com sucesso."
}
]
}
7 - Ordens de Compra do processo de Dropshipping¶
7.1 - Serviço de consulta de novas Ordens de Compra¶
URL: <URL base para utilização dos serviços>/CheckOrdersMarketplace
JSON (Enviado em "Data" para busca de ordens ("MarketplaceData" )
| Atributo | Tipo | Informação | Obrigatório |
|---|---|---|---|
| Cnpj | string | CNPJ do estabelecimento. | |
| Status | string | CNPJ do estabelecimento. |
"Data": {
"Cnpj": "0415878963258",
"Status": "NEW"
}
7.2 -Retorno da consulta de Ordens¶
JSON (Retornado no "Resultado" na Consulta de tarefas do FoccoSMF - Descrito no Item 1.2)
| Atributo | Tipo | Informação |
|---|---|---|
| Key | string | Identificador do registro enviado |
| Cnpj | string | Cnpj da integração |
| Succeeded | bool | Sucesso ou falha da requisição |
| ErrorMessage | string | Identificador do registro enviado |
| Value | List |
Ordens retornadas |
7.2.1 Estrutura da ordem retornada (OrderResponse)¶
| Atributo | Tipo | O que significa | Obrigatório |
|---|---|---|---|
| OrderIdentifier | string | Identificador da Ordem de Compra. | Sim |
| SalesOrder | string | Número do Pedido de Venda (E-Commerce). | Sim |
| Status | string | Código do Status (Ver Tabela). | Sim |
| CreationDate | date | Data de Emissão (E-commerce). | Sim |
| ApprovalDate | date | Data de Aprovação / Aceite. | |
| BillingAuthorizationDate | date | Data de Autorização do Faturamento. | |
| InvoiceDate | date | Data de Retorno da Nota Fiscal (E-Commerce). | |
| DeliveryDate | date | Data Estimada de Entrega. | |
| BillingDeadline | date | Prazo para Faturamento. | Sim |
| Type | string | Tipo de Ordem de Compra (Ver Tabela). | Sim |
| Comments | string | Observações. | |
| ProviderCompanyIdentifier | string | CNPJ do Fornecedor. | Sim |
| EcommerceProviderIdentifier | string | Identificador do Fornecedor. | |
| OrderShippingType | string | Tipo de Frete (Ver Tabela). | Sim |
| ShippingPrice | double | Valor do Frete. | Sim |
| Products | List\<object> | Lista de produtos. | |
| Products.Sequence | int | Número do Item. | Sim |
| Products.Sku | string | Identificador do Item (no ERP(Fornecedor)). | Sim |
| Products.Ean | string | Código EAN do Item (Código de Barras). | Sim |
| Products.Name | string | Descrição do Item. | Sim |
| Products.Quantity | double | Quantidade do Item. | Sim |
| Products.MeasureUnit | string | Unidade de Medida do Item. | Sim |
| Products.OriginalPrice | double | Preço Original do Item. | |
| Products.SalePrice | double | Preço de Venda do Item. | Sim |
| Products.TotalOriginalPrice | double | Total do Preço Original do Item. | |
| Products.TotalSalePrice | double | Total do Preço de Venda do Item. | Sim |
| Products.Cst | string | CST (Código de Situação Tributária) do Item. | |
| Products.Cfop | string | CFOP (Código Fiscal de Operações e Prestações) do Item. | |
| Products.VolumeQuantity | double | Quantidade de Volumes. | |
| Ecommerce | object | ||
| Ecommerce.EcommerceCustomerIdentifier | string | Identificador da Empresa/Filial compradora. | Sim |
| Ecommerce.Description | string | Descrição da Empresa/Filial compradora. | Sim |
| Ecommerce.CompanyIdentifier | string | CNPJ da Empresa/Filial compradora. | Sim |
| Ecommerce.RegionRegistration | string | Inscrição Estadual da Empresa/Filial compradora. | Sim |
| Ecommerce.Address | object | ||
| Ecommerce.Address.PostCode | string | Código de Endereçamento Postal (CEP). | Sim |
| Ecommerce.Address.Street | string | Logradouro do Endereço. | Sim |
| Ecommerce.Address.AddressNumber | string | Número do Endereço. | |
| Ecommerce.Address.AddressComplement | string | Complemento do Endereço. | |
| Ecommerce.Address.Neighborhood | string | Bairro do Endereço. | Sim |
| Ecommerce.Address.CityName | string | Cidade do Endereço. | Sim |
| Ecommerce.Address.CityCode | string | Código IBGE(completo) da Cidade do Endereço. | Sim |
| Ecommerce.Address.RegionName | string | Estado/UF do Endereço. | Sim |
| Ecommerce.Address.RegionCode | string | Código do Estado/UF do Endereço. | Sim |
| Ecommerce.Address.CountryName | string | País do Endereço. | Sim |
| Ecommerce.Address.CountryCode | string | Código do País do Endereço. | Sim |
| Ecommerce.Address.Phones | List\<object> | Lista de telefones. | |
| Ecommerce.Address.Phones.Type | string | Tipo de Telefone (Ver Tabela). | Sim |
| Ecommerce.Address.Phones.DDI | long | DDI do Telefone. | |
| Ecommerce.Address.Phones.DDD | long | DDD do Telefone. | |
| Ecommerce.Address.Phones.PhoneNumber | long | Número do Telefone. | Sim |
| ShippingCompany | object | ||
| ShippingCompany.CompanyIdentifier | string | CNPJ da Transportadora. | Sim |
| ShippingCompany.Description | string | Descrição da Transportadora. | Sim |
| ShippingCompany.RegionRegistration | string | Inscrição Estadual da Transportadora. | Sim |
| ShippingCompany.Address | object | ||
| ShippingCompany.Address.PostCode | string | Código de Endereçamento Postal (CEP). | Sim |
| ShippingCompany.Address.Street | string | Logradouro do Endereço. | Sim |
| ShippingCompany.Address.AddressNumber | string | Número do Endereço. | |
| ShippingCompany.Address.AddressComplement | string | Complemento do Endereço. | |
| ShippingCompany.Address.Neighborhood | string | Bairro do Endereço. | Sim |
| ShippingCompany.Address.CityName | string | Cidade do Endereço. | Sim |
| ShippingCompany.Address.CityCode | string | Código IBGE(completo) da Cidade do Endereço. | Sim |
| ShippingCompany.Address.RegionName | string | Estado/UF do Endereço. | Sim |
| ShippingCompany.Address.RegionCode | string | Código do Estado/UF do Endereço. | Sim |
| ShippingCompany.Address.CountryName | string | País do Endereço. | Sim |
| ShippingCompany.Address.CountryCode | string | Código do País do Endereço. | Sim |
| ShippingCompany.Address.Phones | List\<object> | Lista de telefones. | |
| ShippingCompany.Address.Phones.Type | string | Tipo de Telefone (Ver Tabela). | Sim |
| ShippingCompany.Address.Phones.DDI | long | DDI do Telefone. | |
| ShippingCompany.Address.Phones.DDD | long | DDD do Telefone. | |
| ShippingCompany.Address.Phones.PhoneNumber | long | Número do Telefone. | Sim |
| Customer | object | ||
| Customer.CustomerIdentifier | string | CPF/CNPJ do Cliente. | Sim |
| Customer.RegionRegistration | string | Inscrição Estadual do Cliente. | Sim |
| Customer.Type | string | Tipo de Cliente (Ver Tabela). | Sim |
| Customer.TaxPayerType | bool | Tipo de Contribuinte. | Sim |
| Customer.Email | string | E-mail do Cliente. | Sim |
| Customer.Name | string | Nome e Sobrenome do Cliente. | Sim |
| Customer.BillingEmail | string | E-mail do Cliente de Cobrança. | Sim |
| Customer.BillingName | string | Nome e Sobrenome do Cliente de Cobrança. | Sim |
| Customer.DeliveryEmail | string | E-mail do Cliente de Entrega. | Sim |
| Customer.DeliveryName | string | Nome e Sobrenome do Cliente de Entrega. | Sim |
| BillingAddress.Address | object | ||
| BillingAddress.Address.PostCode | string | Código de Endereçamento Postal (CEP). | Sim |
| BillingAddress.Address.Street | string | Logradouro do Endereço. | Sim |
| BillingAddress.Address.AddressNumber | string | Número do Endereço. | |
| BillingAddress.Address.AddressComplement | string | Complemento do Endereço. | |
| BillingAddress.Address.Neighborhood | string | Bairro do Endereço. | Sim |
| BillingAddress.Address.CityName | string | Cidade do Endereço. | Sim |
| BillingAddress.Address.CityCode | string | Código IBGE(completo) da Cidade do Endereço. | Sim |
| BillingAddress.Address.RegionName | string | Estado/UF do Endereço. | Sim |
| BillingAddress.Address.RegionCode | string | Código do Estado/UF do Endereço. | Sim |
| BillingAddress.Address.CountryName | string | País do Endereço. | Sim |
| BillingAddress.Address.CountryCode | string | Código do País do Endereço. | Sim |
| BillingAddress.Address.Phones | List\<object> | Lista de telefones. | |
| BillingAddress.Address.Phones.Type | string | Tipo de Telefone (Ver Tabela). | Sim |
| BillingAddress.Address.Phones.DDI | long | DDI do Telefone. | |
| BillingAddress.Address.Phones.DDD | long | DDD do Telefone. | |
| BillingAddress.Address.Phones.PhoneNumber | long | Número do Telefone. | Sim |
| DeliveryAddress.Address | object | ||
| DeliveryAddress.Address.PostCode | string | Código de Endereçamento Postal (CEP). | Sim |
| DeliveryAddress.Address.Street | string | Logradouro do Endereço. | Sim |
| DeliveryAddress.Address.AddressNumber | string | Número do Endereço. | |
| DeliveryAddress.Address.AddressComplement | string | Complemento do Endereço. | |
| DeliveryAddress.Address.Neighborhood | string | Bairro do Endereço. | Sim |
| DeliveryAddress.Address.CityName | string | Cidade do Endereço. | Sim |
| DeliveryAddress.Address.CityCode | string | Código IBGE(completo) da Cidade do Endereço. | Sim |
| DeliveryAddress.Address.RegionName | string | Estado/UF do Endereço. | Sim |
| DeliveryAddress.Address.RegionCode | string | Código do Estado/UF do Endereço. | Sim |
| DeliveryAddress.Address.CountryName | string | País do Endereço. | Sim |
| DeliveryAddress.Address.CountryCode | string | Código do País do Endereço. | Sim |
| DeliveryAddress.Address.Phones | List\<object> | Lista de telefones. | |
| DeliveryAddress.Address.Phones.Type | string | Tipo de Telefone (Ver Tabela). | Sim |
| DeliveryAddress.Address.Phones.DDI | long | DDI do Telefone. | |
| DeliveryAddress.Address.Phones.DDD | long | DDD do Telefone. | |
| DeliveryAddress.Address.Phones.PhoneNumber | long | Número do Telefone. | Sim |
Exemplo
{
"Key": "1",
"Cnpj": "0256897589658",
"succeeded": true,
"errorMessage": null,
"value": [
{
"OrderIdentifier": "OrderIdentifier123",
"SalesOrder":"123",
"Status":"NEW",
"CreationDate":"2020-01-20T13:30:00-03:00",
"ApprovalDate":"2020-01-20T13:30:00-03:00",
"BillingAuthorizationDate":"2020-01-20T13:30:00-03:00",
"InvoiceDate":"2020-01-20T13:30:00-03:00",
"DeliveryDate":"2020-01-20T13:30:00-03:00",
"BillingDeadline":"2020-01-20T13:30:00-03:00",
"Type":"SALE",
"Comments":"Comentários da ordem",
"ProviderCompanyIdentifier":"52992847000101",
"EcommerceProviderIdentifier":"fornecedornoecommerce",
"OrderShippingType": "CIF",
"ShippingPrice": 50,
"Products": [
{
"Sequence":1,
"Sku":"Product sku",
"Ean":"Product Ean",
"Name":"Product Name",
"Quantity":10,
"MeasureUnit":"UN",
"OriginalPrice":10.5,
"SalePrice":16.7,
"TotalOriginalPrice":105,
"TotalSalePrice":167,
"Cst":"01",
"Cfop":"5101",
"VolumeQuantity": 1
}
],
"Ecommerce": {
"EcommerceCustomerIdentifier":"idenfiticadorecommerce",
"Description":"Description Ecommerce",
"CompanyIdentifier":"21046987000155",
"RegionRegistration":"ISENTO",
"Address": {
"PostCode":"95034000",
"Street":"Rua Moreira Cesar",
"AddressNumber":"2019",
"AddressComplement":"Focco",
"Neighborhood":"Pio X",
"CityName":"Caxias do Sul",
"CityCode":"4305108",
"RegionName":"Rio Grande do Sul",
"RegionCode":"RS",
"CountryName":"Brazil",
"CountryCode":"BR",
"Phones": [
{
"Type": "CELLPHONE",
"DDI": 55,
"DDD": 22,
"PhoneNumber": 24587569
}
]
}
},
"ShippingCompany": {
"CompanyIdentifier":"41295002000132",
"Description":"Description ShippingCompany",
"RegionRegistration":"ISENTO",
"Address": {
"PostCode":"95034000",
"Street":"Rua Moreira Cesar",
"AddressNumber":"2019",
"AddressComplement":"Focco",
"Neighborhood":"Pio X",
"CityName":"Caxias do Sul",
"CityCode":"4305108",
"RegionName":"Rio Grande do Sul",
"RegionCode":"RS",
"CountryName":"Brazil",
"CountryCode":"BR",
"Phones": [
{
"Type": "CELLPHONE",
"DDI": 55,
"DDD": 22,
"PhoneNumber": 24587569
}
]
}
},
"Customer": {
"CustomerIdentifier":"69552774000121",
"RegionRegistration":"ISENTO",
"Type":"LEGAL_ENTITY",
"TaxPayerType":true,
"Email":"customer@email.com",
"Name":"Customer Name",
"BillingEmail":"billing@email.com",
"BillingName":"Customer BillingName",
"DeliveryEmail":"delivery@email.com",
"DeliveryName":"Customer DeliveryName",
"BillingAddress": {
"PostCode":"95034000",
"Street":"Rua Moreira Cesar",
"AddressNumber":"2019",
"AddressComplement":"Focco",
"Neighborhood":"Pio X",
"CityName":"Caxias do Sul",
"CityCode":"4305108",
"RegionName":"Rio Grande do Sul",
"RegionCode":"RS",
"CountryName":"Brazil",
"CountryCode":"BR",
"Phones": [
{
"Type": "CELLPHONE",
"DDI": 55,
"DDD": 22,
"PhoneNumber": 24587569
}
]
},
"DeliveryAddress": {
"PostCode":"95034000",
"Street":"Rua Moreira Cesar",
"AddressNumber":"2019",
"AddressComplement":"Focco",
"Neighborhood":"Pio X",
"CityName":"Caxias do Sul",
"CityCode":"4305108",
"RegionName":"Rio Grande do Sul",
"RegionCode":"RS",
"CountryName":"Brazil",
"CountryCode":"BR",
"Phones": [
{
"Type": "CELLPHONE",
"DDI": 55,
"DDD": 22,
"PhoneNumber": 24587569
}
]
}
},
"orderHistories": [
{
"status": "NEW - New order",
"statusDate": "2020-06-05T17:29:09-03:00",
"comments": null
},
{
"status": "WAIT_BILLING_PROVIDER - Awaiting provider billing",
"statusDate": "2020-06-25T14:47:48-03:00",
"comments": null
},
{
"status": "WAIT_PROV - Awaiting provider acceptance",
"statusDate": "2020-06-25T10:33:16-03:00",
"comments": null
}
]
}
]
}
7.3 - Serviço de consulta do status atual de uma ou mais Ordens de Compra¶
URL: <URL base para utilização dos serviços>/GetStatusPurchaseOrdersMarketplace
JSON (Enviado em "Data" para busca de ordens ("MarketplaceData" )
| Atributo | Tipo | Informação | Obrigatório |
|---|---|---|---|
| Orders | List\<object> | Lista de Ordens buscadas. | |
| Orders.Cnpj | string | CNPJ do estabelecimento. | |
| Orders.OrderIdentifier | string | Identificador da ordem buscada. |
"Data": {
"Orders": [
{
"Cnpj": "0415878963258",
"OrderIdentifier": "1"
}
]
}
7.4 -Retorno da consulta de status atual das Ordens¶
JSON (Retornado no "Resultado" na Consulta de tarefas do FoccoSMF - Descrito no Item 1.2)
| Atributo | Tipo | Informação |
|---|---|---|
| List | List\<Status\<OrderResponse>> | Lista de status |
| Status.Key | string | Identificador do registro enviado |
| Status.Cnpj | string | Cnpj da integração |
| Status.Succeeded | bool | Sucesso ou falha da requisição |
| Status.ErrorMessage | string | Identificador do registro enviado |
| Value | OrderResponse | Ordem retornada |
Objeto OrderResponse conforme estrutura descrita no item 7.2.1 Porém no campo "value" retornará apenas uma única Ordem ao invés de uma lista de ordens.
7.5 - Serviço de atualização de status de uma ou mais Ordens de Compra¶
URL: <URL base para utilização dos serviços>/SendOrderStatusMarketplace
JSON (Enviado em "Data" para busca de ordens ("MarketplaceData" )
| Atributo | Tipo | Informação | Obrigatório |
|---|---|---|---|
| OrderStatus | List\<object> | Lista de Ordens que terão o seu status atualizado. | |
| OrderStatus.Cnpj | string | CNPJ do estabelecimento. | |
| OrderStatus.OrderIdentifier | string | Identificador da ordem buscada. | |
| OrderStatus.Status | string | Novo status da ordem. | |
| OrderStatus.StatusDate | string | Data da atualização do status da ordem. | |
| OrderStatus.Comments | string | Observações. |
"Data": {
"OrderStatus": [
{
"Cnpj": "0415878963258",
"OrderIdentifier": "1",
"Status": "AUTH_BILLING",
"StatusDate": "29/04/2020 10:26:30",
"Comments": "Teste."
}
]
}
7.6 -Retorno da atualização de status da Ordem¶
JSON (Retornado no "Resultado" na Consulta de tarefas do FoccoSMF - Descrito no Item 1.2)
Conforme estrutura retornada no item 7.4
7.7 - Serviço de Envio de Fornecedores¶
URL: <URL base para utilização dos serviços>/SendProviderMarketplace
JSON (Enviado em "Data" para busca de ordens ("MarketplaceData" )
| Atributo | Tipo | Informação | Obrigatório |
|---|---|---|---|
| CompanyName | String | Razão Social da Empresa | Sim |
| TradingName | String | Nome Fantasia da Empresa | Sim |
| CompanyIdentifier | String | CNPJ da Empresa | Sim |
| RegionRegistration | String | Inscrição Estadual da Empresa | Sim |
| PostCode | String | CEP da Empresa | Sim |
| Street | String | Rua do Endereço da Empresa | Sim |
| AddressNumber | String | Número do Endereço da Empresa | Não |
| AddressComplement | String | Complemento do Endereço da Empresa | Não |
| Neighborhood | String | Bairro do Endereço da Empresa | Não |
| CityName | String | Nome da Cidade da Empresa | Sim |
| CityCode | String | Codigo IBGE da Cidade da Empresa | Sim |
| RegionName | String | Nome da UF da Empresa | Sim |
| RegionCode | String | Código da UF da Empresa | Sim |
| CountryName | String | Nome do País da Empresa | Sim |
| CountryCode | String | Código do País da Empresa | Sim |
| String | Email da Empresa | Não | |
| Phones | List\<Object> | Lista de Telefones | |
| Type | String | Tipo do Telefone | Sim |
| DDI | Long? | Código internacional do Telefone | Não |
| DDD | Long? | Código Regional do Telefone | Sim |
| PhoneNumber | Long? | Número do Telefone | Sim |
"Data": {
"CompanyName": "Teste",
"TradingName": "Teste1",
"CompanyIdentifier": "23658798",
"RegionRegistration": "Teste",
"PostCode": "Teste",
"Street": "Teste rua",
"AddressNumber": "11",
"AddressComplement": "complemento",
"Neighborhood": "bairro",
"CityName": "caxias",
"CityCode": "01245215",
"RegionName": "rio grande do sul",
"RegionCode": "rs",
"CountryName": "Brasil",
"CountryCode": "BR",
"Email": "teste@teste.com.br",
"Phones": [
{
"Type": "CELLPHONE",
"DDI": 55,
"DDD": 54,
"PhoneNumber": 36587458
}
]
}
7.8 -Retorno do envio de Fornecedores¶
JSON (Retornado no "Resultado" na Consulta de tarefas do FoccoSMF - Descrito no Item 1.2)
| Atributo | Tipo | Informação |
|---|---|---|
| Key | string | Identificador do registro enviado |
| Cnpj | string | Cnpj da integração |
| Succeeded | bool | Sucesso ou falha da requisição |
| ErrorMessage | string | Identificador do registro enviado |
| Value | Objeto | Fornecedor Inserido |
7.8.1 Estrutura do Fornecedor Retornado¶
|Atributo|Tipo|O que significa| |:--- | :----| :--- | :--- | |CompanyName | String | Razão Social da Empresa | |TradingName | String | Nome Fantasia da Empresa | |CompanyIdentifier | String | CNPJ da Empresa | |RegionRegistration | String | Inscrição Estadual da Empresa| |PostCode| String | CEP da Empresa | |Street | String | Rua do Endereço da Empresa | |AddressNumber|String| Número do Endereço da Empresa | |AddressComplement|String|Complemento do Endereço da Empresa | |Neighborhood|String|Bairro do Endereço da Empresa | |CityName|String|Nome da Cidade da Empresa| |CityCode|String|Código IBGE da Cidade da Empresa | |RegionName |String | Nome da UF da Empresa | |RegionCode |String| Código da UF da Empresa | |CountryName|String|Nome do País da Empresa| |CountryCode|String|Código do País da Empresa | |Email|String|Email da Empresa| |Phones| List\<Object>|Lista de Telefones| |Type| String| Tipo do Telefone | |DDI |Long?| Código internacional do Telefone | |DDD | Long? |Código Regional do Telefone | |PhoneNumber|Long?| Número do Telefone |
"Data": {
"ID": 101,
"CompanyName": "Teste",
"TradingName": "Teste1",
"CompanyIdentifier": "23658798",
"RegionRegistration": "Teste",
"PostCode": "Teste",
"Street": "Teste rua",
"AddressNumber": "11",
"AddressComplement": "complemento",
"Neighborhood": "bairro",
"CityName": "caxias",
"CityCode": "01245215",
"RegionName": "rio grande do sul",
"RegionCode": "rs",
"CountryName": "Brasil",
"CountryCode": "BR",
"Email": "teste@teste.com.br",
"Phones": [
{
"Type": "CELLPHONE",
"DDI": 55,
"DDD": 54,
"PhoneNumber": 36587458
}
]
}
7.9 - Serviço de consulta de Notas Fiscais de Saída de uma ou mais Ordens de Compra¶
URL: <URL base para utilização dos serviços>/CheckOrderInvoiceMarketplace
JSON (Enviado em "Data" para busca de ordens ("MarketplaceData" )
| Atributo | Tipo | Informação | Obrigatório |
|---|---|---|---|
| OrdersInvoice | List\<object> | Lista de Ordens buscadas. | |
| OrderInvoices.Cnpj | string | CNPJ do estabelecimento. | |
| OrderInvoices.OrderIdentifier | string | Identificador da ordem buscada. |
"Data": {
"OrderInvoices": [
{
"Cnpj": "0415878963258",
"OrderIdentifier": "1"
}
]
}
7.10 -Retorno da consulta de Notas Fiscais de Saída das Ordens¶
JSON (Retornado no "Resultado" na Consulta de tarefas do FoccoSMF - Descrito no Item 1.2)
| Atributo | Tipo | Informação |
|---|---|---|
| Key | string | Identificador do registro enviado. |
| Cnpj | string | Cnpj da integração. |
| Succeeded | bool | Sucesso ou falha da requisição. |
| ErrorMessage | string | Identificador do registro enviado. |
| Value | List |
Notas Fiscais retornadas |
7.10.1 Estrutura das Notas Fiscais de Saída Retornadas¶
| Atributo | Tipo | O que significa |
|---|---|---|
| Id | long | Identificador do registro no FoccoHUB. |
| Type | string | Tipo da Nota Fiscal. |
| InvoiceNumber | long | Número da Nota Fiscal. |
| Series | string | Série da Nota Fiscal. |
| CreationDate | date | Data de Emissão da Nota Fiscal. |
| Key | string | Chave de Acesso da Nota Fiscal. |
| Url | string | URL para download do PDF da Nota Fiscal. |
| FileId | string | Identificador do XML armazenado no FoccoHUB. |
{
"Key": "1",
"Cnpj": "0256897589658",
"succeeded": true,
"errorMessage": null,
"value": [
{
"id": 64,
"type": "REMITTANCE",
"invoiceNumber": 1233321,
"series": "55",
"creationDate": "2020-06-22T15:30:00-03:00",
"key": "12345678901234567890123456789012345678901232",
"url": "http://site.com.br/download/as123af1.pdf",
"fileId": "c0586356-bb81-4908-8de6-94b6f37e2c59"
},
{
"id": 65,
"type": "SYMBOLIC",
"invoiceNumber": 3211123,
"series": "55",
"creationDate": "2020-06-12T13:30:00-03:00",
"key": "12345678901234567890123456789012345678901235",
"url": "http://site.com.br/download/3211123.pdf",
"fileId": "8228a465-563f-4c0e-be87-4730690fafc2"
}
]
}
7.11 - Serviço de Envio de informações de nota fiscal de Saída¶
URL: <URL base para utilização dos serviços>/SendOrderInvoiceMarketplace
Para o envio de informações de nota fiscal de saída é necessário construir um MultiPartForm contendo um Json com as informações de "Data" e um form-data contendo o arquivo
FORM-DATA de arquivo XML
| Atributo | Tipo | Informação | Obrigatório |
|---|---|---|---|
| File | form-data | Arquivo XML da Nota Fiscal | Sim |
JSON (Enviado em "Data" para busca de ordens ("MarketplaceData" )
| Atributo | Tipo | Informação | Obrigatório |
|---|---|---|---|
| OrderIdentifier | string | Identificador da Ordem de Compra. | |
| InvoiceNumber | string | Número da Nota Fiscal. | Sim |
| Series | string | Série da Nota Fiscal. | Sim |
| CreationDate | dateTimeOffset | Data de Emissão da Nota Fiscal. | Sim |
| Key | string | Chave de Acesso da Nota Fiscal. | Sim |
| Url | string | URL do PDF da Nota Fiscal para Upload. | Sim |
| InvoiceType | string | Tipo da nota. | Sim |
"Data": {
"OrderIdentifier": "1234587",
"InvoiceNumber":"38548"
"Series":"5"
"CreationDate":"2020-06-22T15:30:00-03:00"
"Key":"12345678901234567890123456789012345678901235",
"Url":"teste.com/arquivo"
"InvoiceType":"symbolic"
}
7.12 - Retorno do Envio de informações de nota fiscal de Saída¶
JSON (Retornado no "Resultado" na Consulta de tarefas do FoccoSMF - Descrito no Item 1.2)
| Atributo | Tipo | Informação |
|---|---|---|
| Key | string | Identificador do registro enviado. |
| Cnpj | string | Cnpj da integração. |
| Succeeded | bool | Sucesso ou falha da requisição. |
| ErrorMessage | string | Identificador do registro enviado. |
| Value | InvoiceResponse | Nota Fiscal retornada |
7.12.1 Estrutura da Nota Fiscal de Saída Retornada¶
| Atributo | Tipo | O que significa |
|---|---|---|
| Id | long | Identificador do registro no FoccoHUB. |
| Type | string | Tipo da Nota Fiscal. |
| InvoiceNumber | long | Número da Nota Fiscal. |
| Series | string | Série da Nota Fiscal. |
| CreationDate | date | Data de Emissão da Nota Fiscal. |
| Key | string | Chave de Acesso da Nota Fiscal. |
| Url | string | URL para download do PDF da Nota Fiscal. |
| FileId | string | Identificador do XML armazenado no FoccoHUB. |
{
"Key": "1",
"Cnpj": "0256897589658",
"succeeded": true,
"errorMessage": null,
"value": {
"id": 64,
"type": "REMITTANCE",
"invoiceNumber": 1233321,
"series": "55",
"creationDate": "2020-06-22T15:30:00-03:00",
"key": "12345678901234567890123456789012345678901232",
"url": "http://site.com.br/download/1233321.pdf",
"fileId": "c0586356-bb81-4908-8de6-94b6f37e2c59"
},
"innerSingleStatuses": [],
"succeeded": true,
"anySucceeded": false,
"failed": false,
"allFailed": false,
"baseErrorMessage": null,
"errorMessage": "",
"exception": null
}
7.13 - Serviço de envio de etiquetas de expedição para uma ou mais Ordens de Compra¶
URL: <URL base para utilização dos serviços>/SendOrdersShippingLabelMarketplace
JSON (Enviado em "Data" para envio de etiquetas ("MarketplaceData" )
| Atributo | Tipo | Informação | Obrigatório |
|---|---|---|---|
| productDescription | string | Descrição do produto. | Sim |
| customProductDescription | string | Descrição da máscara do produto. | Não |
| cargoIdentifier | string | Identificador da carga. | Sim |
| providerSaleOrderIdentifier | string | Identificador do pedido de venda no fornecedor. | Sim |
| volume | string | Volume da carga. | Sim |
| barcode | string | Código de barras. | Sim |
| sku | string | Sku do produto. | Sim |
"Data": {
"Orders":
[
{
"OrderIdentifier": "OrdemTeste",
"ShippingLabels":
[
{
"ProductDescription": "Teste",
"CustomProductDescription": "Teste1",
"CargoIdentifier": "44",
"ProviderSaleOrderIdentifier": "orderIdentififer",
"Volume": "2",
"Barcode": "4395394934893333",
"Sku": "TESTE11"
},
{
"ProductDescription": "Teste2",
"CustomProductDescription": "Teste2",
"CargoIdentifier": "22",
"ProviderSaleOrderIdentifier": "orderIdentififer2",
"Volume": "2",
"Barcode": "43953949344445666",
"Sku": "TESTE22"
}
]
}
]
}
7.14 - Retorno do envio de etiquetas de expedição para uma ou mais Ordens de Compra¶
JSON (Retornado no "Resultado" na Consulta de tarefas do FoccoSMF - Descrito no Item 1.2)
| Atributo | Tipo | Informação |
|---|---|---|
| List | List\<Status\<ShippingLabelResponse>> | Lista de status |
| Key | string | Identificador do registro enviado. |
| Cnpj | string | Cnpj da integração. |
| Succeeded | bool | Sucesso ou falha da requisição. |
| ErrorMessage | string | Mensagem de erro. |
| Value | ShippingLabelResponse | Etiqueta retornada |
7.14.1 Estrutura da Etiqueta Retornada¶
| Atributo | Tipo | O que significa |
|---|---|---|
| Id | long | Identificador do registro no FoccoHUB. |
| productDescription | string | Descrição do produto. |
| customProductDescription | string | Descrição da máscara do produto. |
| cargoIdentifier | string | Identificador da carga. |
| providerSaleOrderIdentifier | string | Identificador do pedido de venda no fornecedor. |
| volume | string | Volume da carga. |
| barcode | string | Código de barras. |
| sku | string | Sku do produto. |
{
"Key": "1",
"Cnpj": "0256897589658",
"succeeded": true,
"errorMessage": null,
"value":
{
"Id": 1,
"ProductDescription": "Teste",
"CustomProductDescription": "Teste1",
"CargoIdentifier": "44",
"ProviderSaleOrderIdentifier": "orderIdentififer",
"Volume": "2",
"Barcode": "4395394934893333",
"Sku": "TESTE11"
},
"innerSingleStatuses": [],
"succeeded": true,
"anySucceeded": false,
"failed": false,
"allFailed": false,
"baseErrorMessage": null,
"errorMessage": "",
"exception": null
}
}
7.15 - Serviço de Consulta de Nota Fiscal de Saída¶
URL: <URL base para utilização dos serviços>/CheckInvoicesMarketplace
JSON (Enviado na Consulta de Notas Fiscais no FoccoSMF)
| Atributo | Tipo | Informação | Obrigatório |
|---|---|---|---|
| Document(document) | string | CNPJ do Marketplace. | Sim |
| InitialDate(issued_on_begin) | string | Data Inicial da Busca | Sim |
| EndDate(issued_on_end) | string | Data Final da Busca. | Sim |
{
"document": "12345678910123",
"issued_on_begin": "2021-06-04T00:00:00",
"issued_on_end": "2021-05-21T00:00:00"
}
7.16 - Retorno de Consulta de Nota Fiscal de Saída¶
JSON (Retornado no "Resultado" da Consulta de Notas Fiscais do FoccoSMF
| Atributo | Tipo | Informação |
|---|---|---|
| Cnpj | string | CNPJ da empresa |
| Marketplace | string | Marketplace do FoccoHub |
| OrderId | string | ID do pedido no marketplace |
| MarketplaceVenda | string | Nome do marketplace de venda |
| AccessKey | string | Chave de acesso da nota |
| Link | string | Link onde consta a chave de acesso da nota |
| Number | string | Número da nota fiscal |
| Series | string | Série da nota fiscal |
| TipoNota | TipoNotaFiscal | Tipo de nota recebida |
| Situacao | SituacaoNotaFiscal | Situação atual da nota |
| Processo | ProcessoNotaFiscal | Processo pela qual a nota está sendo importada (padrão/dropshipping) |
| Xml | string | Xml da nota fiscal |
| MarketplaceNumber | string | Número do pedido |
| Token | string | Token para acesso ao pedido |
Valores aceitos em campos de enumeração¶
TipoNotaFiscal¶
| Nome | Valor |
|---|---|
| Remessa | "REMESSA" |
| Simples | "SIMPLES" |
| Venda | "VENDA" |
SituacaoNotaFiscal¶
| Nome | Valor |
|---|---|
| Autorizada | "A" |
| Cancelada | "C" |
ProcessoNotaFiscal¶
| Nome | Valor |
|---|---|
| Padrao | "PADRAO" |
| Dropshipping | "DROPSHIPPING_FOCCOHUB" |
{
"Cnpj": "123456789101234",
"Marketplace": "Marketplaces",
"OrderId": 1,
"MarketplaceVenda": "Marketplace Venda",
"AccessKey": "as4d4a54asd",
"Link": "/link/exemplo",
"Number": "1",
"Series": "2012857454123331",
"TipoNota": "REMESSA",
"Situacao": "A",
"Processo": "PADRAO",
"Xml": "<xml>...</xml>",
"MarketplaceNumber": "Marketplace Number",
"Token": "SKABD787d5DAS45DA44EXEMPLO"
}
7.17 - Serviço de Remoção de Ordens do Feed (Fila de Pedidos)¶
URL: <URL base para utilização dos serviços>/SendRemovalOrderFeedMarkeplace
JSON (Enviado na Remoção de Ordens do Feed ao FoccoSMF)
| Atributo | Tipo | Informação | Obrigatório |
|---|---|---|---|
| OrdersFeed | List\<object> | Lista de Ordens a serem removidas do feed. | |
| Cnpj | string | CNPJ do Marketplace. | Sim |
| OrderId | string | ID do pedido no Marketplace. | Sim |
| MarketplaceNumber | string | Número do pedido no Marketplace. | Sim |
| Marketplace | string | Identificação do Marketplace. | Sim |
| Handle | string | Handle de identificação do pedido no Marketplace. | Não |
| Token | string | Token para acesso ao pedido. | Não |
{
"Data": {
"OrdersFeed": [
{
"Cnpj": "12345678912345",
"OrderId": "12345",
"MarketplaceNumber": "Marketplace Number",
"Marketplace": "Marketplace",
"Handle": "Handle",
"Token": "Token"
}
]
}
}
7.18 - Retorno de Remoção de Ordens do Feed (Fila de Pedidos)¶
JSON (Retornado no "Resultado" da Remoção de Ordens do Feed do FoccoSMF)
| Atributo | Tipo | Informação |
|---|---|---|
| OrderStatusResponses | List\<object> | Lista de Ordens removidas do feed. |
| Cnpj | string | CNPJ do Marketplace. |
| Marketplace | string | Identificação do Marketplace. |
| OrderId | string | ID do pedido no Marketplace. |
| RequestStatus | string | Status do retorno. |
| Message | string | Mensagem de retorno. |
{
"OrderStatusResponses": [
{
"Cnpj": "12345678912345",
"Marketplace": "Marketplace",
"OrderId": "12345",
"RequestStatus": "NoContent",
"Message": "Remoção do pedido realizado com sucesso da fila."
}
]
}