Seller - API

O cadastro de todo fluxo de sellers dentro do YMI pode ser gerenciado através da API disponibilizada pela Yamí.
Abaixo seguem as especificações sobre a utilização dela.

Para consulta do Seller

Método: GET
URL: http://{{account}}.run.ymi.io/sellers/{{id}}
Headers:
 - Email
 - Hash

Para inserção do Seller

Para inserir um novo seller é necessário se atentar ao campos obrigatórios para preenchimento.

Método: POST
URL: http://{{account}}.run.ymi.io/sellers/
Headers:
 - Content-Type : application/json

Body:

{
   "include_freight":"1", obrigatório // incluir frete? 1 para sim e 0 para não
   "name":"Nome do Seller", obrigatório
   "email":"emaildoseller@email.com", obrigatório
   "dockId": // json com o formato abaixo, contendo o(s) identificador(es) correspondente(s) a entidade a ser cadastrada, pelo menos 1 é ncessário.
   [
      "11" obrigatório
   ],

   "commission" :  // json com o formato abaixo, contendo os dois parametros, percentual e fixo
   [
    {
         "type":"percent", obrigatório // Valor da comissão baseado no valor percentual
         "value":"30"  // número

       },

    {
        "type":"fix", obrigatório // valor da comissão baseada em um valor fixo
        "value":"10" // número

   }
 ],
"custom_fields":null,
"gatewayAccount":"XXXXXXXX" obrigatório para integração com a MOIP //identificador do Seller no Gateway de Pagamento - para moip, considera-se id da conta, para o pagseguro utiliza-se a public key

"street": "Rua 1", // texto obrigatório

"number": "12", // número APENAS obrigatório

"complement": "Logo ali", // texto 

"neighborhood": "Centro", // texto obrigatório

"city": "São Paulo", // texto obrigatório

"uf": "SP", // apenas 2 letras correspondentes ao estado obrigatório

"document": // json com o formato abaixo, contendo os dois parametros, tipo e valor
{    

    "type":"CPF", obrigatório
    "value":"724234589456" // número obrigatório

},
"birth_date": "2015-05-07",// número com os traços obrigatório

"phone": "(11) 9866547", // número obrigatório

"postal_code": "45214-856", // número com o traço obrigatório

"country": "BRA", // apenas três letras correspondentes ao país obrigatório

Os campos de dados da companhia (abaixo) são obrigatórios apenas no caso de o cadastro ser de uma entidade jurídica e houver integração com a MOIP 
"company_data" : {
        "name":"Teste", // texto livre
        "businessName":"Teste", // texto livre
        "taxDocument":"10.971.941\/0001-26", // número com os pontos e traços
        "cnae":"1234", // número
        "mainActivityDescription":"minha atividade", // texto livre
        "openingDate":"12/05/2016", // número com as barras
        "phone":"(11) 3434-3434", // número com o hífen
        "street":"Rua Teste", // texto livre
        "number":"123", // APENAS número
        "complement":"", // texto livre
        "neighborhood":"Bairro Teste", // texto livre
        "city":"São Paulo", // texto livre
        "zipCode":"00053-211", // número com o hífen
        "state":"SP", // apenas 2 letras correspondentes ao estado
        "country":"BRA" // apenas três letras correspondentes ao país
    }

}

Para atualização do Seller

Método: PUT
URL: http://{{account}}.run.ymi.io/sellers/{{id}}
Headers:
 - Email
 - Hash

Body:

{
   "include_freight":"1", // incluir frete? 1 para sim e 0 para não
   "name":"Nome do Seller",
   "email":"emaildoseller@email.com",
   "dockId":[
      "11"
   ], // identificador para identificação do Seller
   "commission" : [
    {
         "type":"percent", // Valor da comissão baseado no valor percentual
         "value":"30"
       },

    {
        "type":"fix", // valor da comissão baseada em um valor fixo
        "value":"10"
   }
 ],
"custom_fields":null, 
"gatewayAccount":"XXXXXXXX" // identificador do Seller no Gateway de Pagamento - para moip, considera-se id da conta, para o pagseguro utiliza-se a public key
"street": "Rua 1",
"number": "12",
"complement": "Logo ali",
"neighborhood": "Centro",
"city": "São Paulo",
"uf": "SP",
"document": {

    "type":"CPF","value":"724234589456"

},
"birth_date": "2015-05-07",
"phone": "(11) 9866547",
"postal_code": "45214-856",
"country": "BRA",
 "company_data" : {
        "name":"Teste",
        "businessName":"Teste",
        "taxDocument":"10.971.941\/0001-26",
        "cnae":"1234",
        "mainActivityDescription":"minha atividade",
        "openingDate":"12/05/2016",
        "phone":"(11) 3434-3434",
        "street":"Rua Teste",
        "number":"123",
        "complement":"",
        "neighborhood":"Bairro Teste",
        "city":"São Paulo",
        "zipCode":"00053-211",
        "state":"SP",
        "country":"BRA"
    }

}

O parâmetro custom_fields é utilizado caso seja necessário em algum fluxo personalizado.