YAyampi
Checkout - Vendedores

Criar vendedor

Changed on

Cria um novo vendedor associado à loja especificada pelo alias

post/{alias}/checkout/sellers

Request

  • Base URL
    https://api.dooki.com.br/v2
  • URL
    https://api.dooki.com.br/v2/{alias}/checkout/sellers
  • Auth
    API key in header User-Token and API key in header User-Secret-Key

Path parameters

aliasstring required

Alias da loja

Request body

affiliation_idinteger nullable

ID da afiliação de pagamento em que o vendedor será cadastrado; aceita apenas afiliações do gateway Pagar.me.

bank_account_idinteger nullable

ID da conta bancária que recebe as transferências do vendedor.

has_splitboolean nullable

Indica se o vendedor participa do split de pagamento dos pedidos.

transfer_enabledboolean required

Indica se as transferências automáticas para o vendedor estão habilitadas.

activeboolean nullable

Indica se o vendedor está ativo.

namestring required

Nome do vendedor.

emailstring email required

E-mail do vendedor, único dentro da loja.

documentstring required

CPF ou CNPJ do vendedor, conforme o document_type, único dentro da loja.

document_type'cpf' | 'cnpj' required

Tipo do documento informado em document.

transfer_interval'daily' | 'weekly' | 'monthly' required

Periodicidade das transferências automáticas para o vendedor.

transfer_dayinteger required

Dia da transferência automática, conforme o transfer_interval: 0 no diário, de 1 a 5 no semanal (dia da semana) e de 1 a 30 no mensal.

antecipatable_volume_percentageinteger nullable

Percentual do volume de vendas do vendedor disponível para antecipação.

automatic_antecipation_enabledboolean nullable

Indica se a antecipação automática dos recebíveis do vendedor está habilitada.

ref_codestring required

Código de referência do vendedor definido pela loja, único dentro da loja.

external_gateway_idinteger nullable

ID do vendedor no gateway de pagamento.

percentage_productsinteger required

Percentual do valor dos produtos repassado ao vendedor no split.

percentage_shippinginteger required

Percentual do valor do frete repassado ao vendedor no split.

charge_processing_feeboolean nullable

Indica se a taxa de processamento do pagamento é descontada do valor repassado ao vendedor quando há chargeback.

liableboolean required

Indica se o vendedor é responsável pelos chargebacks das vendas em que participa do split.

Example request

{
  "percentage_products": 5,
  "percentage_shipping": 5
}

Response

Vendedor criado com sucesso

idinteger

Identificador único do vendedor.

affiliation_idinteger

ID da afiliação de pagamento em que o vendedor foi cadastrado; aceita apenas afiliações do gateway Pagar.me.

bank_account_idinteger

ID da conta bancária que recebe as transferências do vendedor.

store_aliasstring

Alias da loja à qual o vendedor pertence.

has_splitboolean

Indica se o vendedor participa do split de pagamento dos pedidos.

transfer_enabledboolean required

Indica se as transferências automáticas para o vendedor estão habilitadas.

activeboolean

Indica se o vendedor está ativo.

namestring required

Nome do vendedor.

emailstring required

E-mail do vendedor, único dentro da loja.

documentstring required

CPF ou CNPJ do vendedor, conforme o document_type, único dentro da loja.

document_typestring required

Tipo do documento informado em document (cpf ou cnpj).

transfer_intervalstring required

Periodicidade das transferências automáticas para o vendedor (daily, weekly ou monthly).

transfer_daystring required

Dia da transferência automática, conforme o transfer_interval: 0 no diário, de 1 a 5 no semanal (dia da semana) e de 1 a 30 no mensal.

anticipatable_volume_percentageinteger

Percentual do volume de vendas do vendedor disponível para antecipação.

automatic_anticipation_enabledboolean

Indica se a antecipação automática dos recebíveis do vendedor está habilitada.

ref_codestring required

Código de referência do vendedor definido pela loja, único dentro da loja.

external_gateway_idstring

ID do vendedor no gateway de pagamento.

percentage_productsinteger required

Percentual do valor dos produtos repassado ao vendedor no split.

percentage_shippinginteger required

Percentual do valor do frete repassado ao vendedor no split.

charge_processing_feeboolean

Indica se a taxa de processamento do pagamento é descontada do valor repassado ao vendedor quando há chargeback.

liableboolean required

Indica se o vendedor é responsável pelos chargebacks das vendas em que participa do split.

Example response

{
  "name": "teste",
  "email": "teste@email.com",
  "document": "12345678912",
  "document_type": "cpf",
  "transfer_interval": "daily",
  "ref_code": "1",
  "percentage_products": 5,
  "percentage_shipping": 5
}

Changes