EDeduzz
MyEduzz

Obtém uma lista detalhada de vendas com base nos filtros fornecidos

Changed on
get/myeduzz/v1/sales

Request

Query parameters

pagenumber

Página atual

itemsPerPagenumber

Número de itens por página

startDatestring date-time required

Data de início das vendas

endDatestring date-time required

Data de término das vendas

referenceDate'dueDate' | 'paidAt' | 'createdAt' | 'updatedAt'

Campo de data de referência para consultar as vendas

contractIdnumber

Id do contrato

status'open' | 'processing' | 'paid' | 'canceled' | 'waitingRefund' | 'refunded' | 'duplicated' | 'expired' | 'recovering' | 'waitingPayment' | 'scheduled' | 'negotiated'

Status da venda

productIdnumber

Id do produto

affiliateIdnumber

Id do afiliado

buyerEmailstring

Email do comprador

buyerDocumentstring

CPF ou CNPJ do comprador

Response

Lista de vendas

pagesnumber required

Número de páginas

pagenumber required

Página atual

itemsPerPagenumber required

Número máximo de itens por página

totalItemsnumber required

Número total de items

Changes

  • f93320e6a417Revision changes
    • info

      the query request parameter affiliateId became optional

    • info

      the query request parameter buyerDocument became optional

    • info

      the query request parameter buyerEmail became optional

    • info

      the query request parameter contractId became optional

    • info

      the query request parameter itemsPerPage became optional

    • info

      the query request parameter page became optional

    • info

      the query request parameter productId became optional

    • info

      the query request parameter referenceDate became optional

    • info

      the query request parameter status became optional

  • 8e41c62b53a8Revision changes
    • breaking

      the query request parameter referenceDate was restricted to a list of enum values

    • breaking

      the query request parameter status was restricted to a list of enum values

    • breaking

      the query request parameter affiliateId became required

    • breaking

      the query request parameter buyerDocument became required

    • breaking

      the query request parameter buyerEmail became required

    • breaking

      the query request parameter contractId became required

    • breaking

      the query request parameter endDate became required

    • breaking

      the query request parameter itemsPerPage became required

    • breaking

      the query request parameter page became required

    • breaking

      the query request parameter productId became required

    • breaking

      the query request parameter referenceDate became required

    • breaking

      the query request parameter startDate became required

    • breaking

      the query request parameter status became required

    • breaking

      added the pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ to the query request parameter endDate

    • breaking

      added the pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ to the query request parameter startDate

    • breaking

      for the query request parameter affiliateId, the type changed from string to number

    • breaking

      for the query request parameter contractId, the type changed from string to number

    • breaking

      for the query request parameter endDate, the format changed from no format to date-time

    • breaking

      for the query request parameter itemsPerPage, the type changed from string to number

    • breaking

      for the query request parameter page, the type changed from string to number

    • breaking

      for the query request parameter productId, the type changed from string to number

    • breaking

      for the query request parameter startDate, the format changed from no format to date-time

    • info

      added the new enum value canceled to the query request parameter status

    • info

      added the new enum value createdAt to the query request parameter referenceDate

    • info

      added the new enum value dueDate to the query request parameter referenceDate

    • info

      added the new enum value duplicated to the query request parameter status

    • info

      added the new enum value expired to the query request parameter status

    • info

      added the new enum value negotiated to the query request parameter status

    • info

      added the new enum value open to the query request parameter status

    • info

      added the new enum value paid to the query request parameter status

    • info

      added the new enum value paidAt to the query request parameter referenceDate

    • info

      added the new enum value processing to the query request parameter status

    • info

      added the new enum value recovering to the query request parameter status

    • info

      added the new enum value refunded to the query request parameter status

    • info

      added the new enum value scheduled to the query request parameter status

    • info

      added the new enum value updatedAt to the query request parameter referenceDate

    • info

      added the new enum value waitingPayment to the query request parameter status

    • info

      added the new enum value waitingRefund to the query request parameter status