{
    "swagger": "2.0",
    "info": {
        "title": "Frenet API",
        "version": "",
        "description": "Bem vindo à documentação da API Frenet. Serão apresentados todos os serviços disponíveis em nossa API para você criar uma integração de maneira rápida e objetiva.\n\nLembre-se que para você ter acesso a API da Frenet é preciso se cadastrar no painel administrativo e obter um token de acesso. Acesse https://painel.frenet.com.br e obtenha o seu token em \"Dados Cadastrais\"."
    },
    "paths": {
        "/partner/register": {
            "post": {
                "responses": {
                    "200": {
                        "description": "OK",
                        "headers": {},
                        "examples": {
                            "application/json": {
                                "Success": true,
                                "Token": "AAABBB2222CCC222DD222"
                            }
                        }
                    }
                },
                "summary": "Cadastrar um novo cliente",
                "description": "A criação de novo usuário, quando executada com sucesso pelo Frenet, retornará um token este token é exigido pela API de cotação do Frenet, por este motivo o parceiro deverá salva-lo e enviar nas chamadas do cotador Frenet.\n\nObserve que algumas informações precisam ser solicitadas ao suporte do Frenet.",
                "tags": [
                    "Onboarding de clientes"
                ],
                "parameters": [],
                "produces": [
                    "application/json"
                ]
            },
            "put": {
                "responses": {
                    "200": {
                        "description": "OK",
                        "headers": {},
                        "examples": {
                            "application/json": {
                                "Success": true,
                                "Token": "AAABBB2222CCC222DD222"
                            }
                        }
                    }
                },
                "summary": "Atualizar um cliente existente",
                "description": "Para atualizar alguma informação do lojista o parceiro deverá chamar a API de Onboard com o novo valor para o campo, assim como na criação de novos usuários a atualização também exige algumas informações que precisam ser solicitadas ao suporte do Frenet",
                "tags": [
                    "Onboarding de clientes"
                ],
                "parameters": [],
                "produces": [
                    "application/json"
                ]
            }
        },
        "/shipping/info": {
            "get": {
                "responses": {
                    "200": {
                        "description": "OK",
                        "headers": {},
                        "examples": {
                            "application/json": {
                                "Message": "",
                                "ShippingSeviceAvailableArray": [
                                    {
                                        "Carrier": "TNT",
                                        "CarrierCode": "TNT",
                                        "ServiceCode": "RNC",
                                        "ServiceDescription": "TNT Rodoviário"
                                    },
                                    {
                                        "Carrier": "Correios",
                                        "CarrierCode": "COR",
                                        "ServiceCode": "40010",
                                        "ServiceDescription": "Sedex"
                                    }
                                ]
                            }
                        },
                        "schema": {
                            "type": "object",
                            "properties": {
                                "ShippingSeviceAvailableArray": {
                                    "type": "array",
                                    "items": {
                                        "type": "object",
                                        "properties": {
                                            "ServiceCode": {
                                                "type": "string"
                                            },
                                            "ServiceDescription": {
                                                "type": "string"
                                            },
                                            "Carrier": {
                                                "type": "string"
                                            },
                                            "CarrierCode": {
                                                "type": "string"
                                            }
                                        }
                                    }
                                },
                                "Message": {
                                    "type": "string"
                                }
                            }
                        }
                    }
                },
                "summary": "GET",
                "description": "",
                "tags": [
                    "Shipping"
                ],
                "parameters": [],
                "produces": [
                    "application/json"
                ]
            }
        },
        "/shipping/quote": {
            "post": {
                "responses": {
                    "200": {
                        "description": "OK",
                        "headers": {},
                        "examples": {
                            "application/json": {
                                "ShippingSevicesArray": [
                                    {
                                        "Carrier": "Correios",
                                        "DeliveryTime": "1",
                                        "Msg": "",
                                        "ServiceCode": "40010",
                                        "ServiceDescription": "Sedex",
                                        "ShippingPrice": "31.71"
                                    }
                                ]
                            }
                        }
                    }
                },
                "summary": "POST",
                "description": "",
                "tags": [
                    "Shipping"
                ],
                "parameters": [],
                "produces": [
                    "application/json"
                ]
            }
        },
        "/tracking/trackinginfo": {
            "post": {
                "responses": {
                    "200": {
                        "description": "OK",
                        "headers": {},
                        "examples": {},
                        "schema": {
                            "type": "object",
                            "properties": {
                                "TrackingNumber": {
                                    "type": "string"
                                },
                                "ServiceDescrition": {
                                    "type": "string"
                                },
                                "ErrorMessage": {
                                    "type": "string"
                                },
                                "TrackingEvents": {
                                    "type": "array",
                                    "items": {
                                        "type": "object",
                                        "properties": {
                                            "EventDateTime": {
                                                "type": "string"
                                            },
                                            "EventLocation": {
                                                "type": "string"
                                            },
                                            "EventDescription": {
                                                "type": "string"
                                            },
                                            "EventType": {
                                                "type": "string"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "summary": "POST",
                "description": "",
                "tags": [
                    "Tracking"
                ],
                "parameters": [
                    {
                        "name": "body",
                        "in": "body",
                        "schema": {
                            "type": "object",
                            "properties": {
                                "Token": {
                                    "type": "string"
                                },
                                "ShippingServiceCode": {
                                    "type": "string"
                                },
                                "TrackingNumber": {
                                    "type": "string"
                                },
                                "InvoiceNumber": {
                                    "type": "string"
                                },
                                "InvoiceSerie": {
                                    "type": "string"
                                },
                                "RecipientDocument": {
                                    "type": "string"
                                },
                                "OrderNumber": {
                                    "type": "string"
                                }
                            },
                            "example": {
                                "ShippingServiceCode": "04669",
                                "TrackingNumber": "TE123456785AA",
                                "InvoiceNumber": "",
                                "InvoiceSerie": "",
                                "RecipientDocument": "",
                                "OrderNumber": ""
                            }
                        }
                    }
                ]
            }
        },
        "/CEP/Address/{cep}": {
            "get": {
                "responses": {
                    "200": {
                        "description": "OK",
                        "headers": {},
                        "examples": {
                            "application/json": {
                                "CEP": "04011060",
                                "City": "São Paulo",
                                "District": "Vila Mariana",
                                "Message": "ok",
                                "Street": "Rua José Antônio Coelho",
                                "UF": "SP"
                            }
                        }
                    }
                },
                "summary": "GET",
                "description": "",
                "tags": [
                    "CEP"
                ],
                "parameters": [
                    {
                        "name": "cep",
                        "in": "path",
                        "description": "",
                        "required": true,
                        "type": "string"
                    }
                ],
                "produces": [
                    "application/json"
                ]
            }
        }
    },
    "definitions": {
        "Tracking Info": {}
    }
}