Após a finalização do processo de compra via checkout, uma venda de itens (produtos, serviços, bilhetes e etc) ou assinatura (de planos de recorrência de produtos, serviços, bilhetes e etc) é gerada no sistema. Essas vendas e assinaturas podem ser consultadas e ter alguns de seus dados alterados para o usuário logado na plataforma. Por padrão a plataforma já conta com os processos de consulta e edição na área de minha conta mas fluxos alternativos podem ser desenvolvidos para as lojas a fim de melhorar a experiência do usuário.

• Consultar vendas
• Consultar assinaturas
• Consultar detalhes de uma venda
• Consultar detalhes de uma assinatura
• Editar dados de uma venda
• Pausar uma assinatura

Consultar vendas

[GET] /account/clients/{client}/orders

Onde:

• {client} é o id do cliente logado

No corpo de resposta estão disponíveis somente dados básicos da venda:

• id
  Número de identificação da venda
• datetime
  Data e hora da venda
• freight
  Valor de frete da venda
• discount
  Valor de desconto da venda
• total
  Valor total da venda

Consultar assinaturas

[GET] /account/clients/{client}/subscriptions

Onde:

• {client} é o id do cliente logado

No corpo de resposta estão disponíveis somente dados básicos da assinatura:

• id
  Número de identificação da assinatura
• start_at
  Data e hora de início da assinatura
• end_at
  Data e hora do término da assinatura
• status
  Status da assinatura
• plan
  Detalhes sobre o plano da assinatura, onde:
  • description
    Descrição do plano
  • amount
    Valor cobrado pelo plano
• freight
  Valor de frete da assinatura
• discount
  Valor de desconto da assinatura
• total
  Valor total da assinatura

Consultar detalhes de uma venda

[GET] /account/clients/{client}/orders/{order}

Onde:

• {client} é o id do cliente logado
• {order} é o id da venda a ser consultada

No corpo de resposta estão disponíveis os detalhes da venda:

• id
  Número de identificação da venda
• datetime
  Data e hora da venda
• freight
  Valor de frete da venda
• discount
  Valor de desconto da venda
• total
  Valor total da venda
• bank_slip_url
  Link do boleto, se houve
• deliveries
  Detalhes sobre a entrega, onde:
  • address
    • zip_code
      CEP do endereço de entrega da venda
    • address
      Endereço de entrega da venda
    • number
      Número do endereço de entrega da venda
    • complement
      Complemento do endereço de entrega da venda
    • neighborhood
      Bairro do endereço de entrega da venda
    • city
      Cidade do endereço de entrega da venda
    • state
      Estado do endereço de entrega da venda
    • country
      País do endereço de entrega da venda
  • zip_code_range
    • id
      Número de identificação da faixa de CEP da venda
    • description
      Descrição da faixa de CEP da venda
    • zip_code_start
      CEP de início da faixa de CEP da venda
    • zip_code_end
      CEP de término da faixa de CEP da venda
    • amount
      Valor base da faixa de CEP da venda
    • deadline
      Início do prazo previsto para entrega para essa faixa de CEP da venda
    • deadline_limit
      Término do prazo previsto para entrega para essa faixa de CEP da venda
    • scheduling_settings
      Coleção com os dados de configurações de agendamento para a faixa de CEP da venda, onde cada item da coleção:
      • id
        Número de identificação da configuração de agendamento
      • days_after_order_start
        Dias a partir da data de início a venda é o início do período possível para agendamento
      • days_after_order_limit
        Dias a partir da data de início a venda é o término do período possível para agendamento
      • mondays
        Valor booleano que indica se é possível agendamento às segundas-feiras.
      • tuesdays
        Valor booleano que indica se é possível agendamento às terças-feiras.
      • wednesdays
        Valor booleano que indica se é possível agendamento às quartas-feiras.
      • thursdays
        Valor booleano que indica se é possível agendamento às quintas-feiras.
      • fridays
        Valor booleano que indica se é possível agendamento às sextas-feiras.
      • saturdays
        Valor booleano que indica se é possível agendamento aos sábados.
      • sundays
        Valor booleano que indica se é possível agendamento aos domingos.
      • periods
        Coleção com os possíveis períodos para o agendamento, onde cada período:
        • id
          Número de identificação do período de agendamento
        • description
          Descrição do período de agendamento
        • start_at
          Horário de início do período de agendamento
        • end_at
          Horário de término do período de agendamento
      • exceptional_dates
        Coleção de datas excepcionais em que não é possível o agendamento, onde cada data:
        • date
          Data excepcional em que não é possível o agendamento
• client
  Detalhes sobre o comprador
  
  • email
    E-mail do cliente da venda
  • name1
    Nome principal do cliente da venda
  • name2
    Nome secundário do cliente da venda
  • full_name
    Nome completo do cliente da venda
  • document1
    Documento principal do cliente da venda
• payment_card
  Detalhes sobre o cartão utilizado na venda
  • brand
    Bandeira do cartão utilizado na venda
  • expiration_date
    Data de expiração do cartão utilizado na venda no formato "99/9999"
  • first_digits
    Primeiros dígitos do cartão utilizado na venda
  • holder_name
    Nome no cartão utilizado na venda
  • installments
    Número de parcelas utilizadas na venda
  • last_digits
    Últimos dígitos do cartão utilizado na venda
• extra_fields
  Array com os campos extras com informações adicionais da venda
  
  • label
    Nome do campo extra
  • slug
    Slug do campo extra
  • values
    Array com os valores desse campo extra pra essa venda

Consultar detalhes de uma assinatura

[GET] /account/clients/{client}/subscriptions/{subscription}

Onde:

• {client} é o id do cliente logado
• {subscription} é o id da assinatura a ser consultada

No corpo de resposta estão disponíveis os detalhes da assinatura:

• id
  Número de identificação da assinatura
• discount
  Valor de desconto da assinatura
• end_at
  Data de término da assinatura
• freight
  Valor de frete da assinatura
• start_at
  Data de início da assinatura
• status
  Status da assinatura
• total
  Valor total da assinatura
• plan
  Dados do plano da assinatura
  • amount
    Valor do plano da assinatura
  • auto_renew
    Flag sobre a configuração de renovação automática do plano da assinatura
  • description
    Descrição do plano da assinatura
• client
  Detalhes sobre o comprador
  
  • email
    E-mail do cliente da assinatura
  • name1
    Nome principal do cliente da assinatura
  • name2
    Nome secundário do cliente da assinatura
  • full_name
    Nome completo do cliente da assinatura
  • document1
    Documento principal do cliente da assinatura
• deliveries
  Detalhes sobre a entrega, onde:
  • address
    • zip_code
      CEP do endereço de entrega da assinatura
    • address
      Endereço de entrega da assinatura
    • number
      Número do endereço de entrega da assinatura
    • complement
      Complemento do endereço de entrega da assinatura
    • neighborhood
      Bairro do endereço de entrega da assinatura
    • city
      Cidade do endereço de entrega da assinatura
    • state
      Estado do endereço de entrega da assinatura
    • country
      País do endereço de entrega da assinatura
  • zip_code_range
    • id
      Número de identificação da faixa de CEP da assinatura
    • description
      Descrição da faixa de CEP da assinatura
    • zip_code_start
      CEP de início da faixa de CEP da assinatura
    • zip_code_end
      CEP de término da faixa de CEP da assinatura
    • amount
      Valor base da faixa de CEP da assinatura
    • deadline
      Início do prazo previsto para entrega para essa faixa de CEP da assinatura
    • deadline_limit
      Término do prazo previsto para entrega para essa faixa de CEP da assinatura
• extra_fields
  Array com os campos extras com informações adicionais da assinatura
  
  • label
    Nome do campo extra
  • slug
    Slug do campo extra
  • values
    Array com os valores desse campo extra pra essa venda

Editar dados de uma venda

[PUT] /account/clients/{client}/orders/{order}

Onde:

• {client} é o id do cliente logado
• {order} é o id da venda a ser editada

No corpo da requisição, os seguintes valores podem ser editados

• schedule.date
  É aceito valor de data no formato Y-m-d
• schedule.period_id
  É aceito valor no formato inteiro e existente entre a opções de período do agendamento da faixa de CEP da venda.

Pausar uma assinatura

[POST] /account/clients/{client}/subscriptions/{subscription}/pause

Onde:

• {client} é o id do cliente logado
• {subscription} é o id da assinatura a ser pausada

No corpo da requisição, os seguintes valores podem ser informados:

• cycles
  Número inteiro obrigatório da quantidade de ciclos que a assinatura deverá permanecer pausada
• reason
  Descrição textual não obrigatória sobre a motivação da pausa.