/Reports

Esse recurso emite relatórios de pedidos.

/Orders/Report

Relatório de pedidos

GET /v1/merchant/orders/report

Query Parameters

Name
Type
Description

start

string

Data inicial. Formato YYYY-MM-DD.

end

string

Data final. Formato YYYY-MM-DD.

{
    "merchantId": "716",
    "startReport": "2019-06-04",
    "endReport": "2019-06-04",
    "amountCart": "327.30",
    "amountShipment": "114.81",
    "amountTotal": "442.11",
    "receivableAmountCart": "261.84",
    "receivableAmountShipment": "0.00",
    "receivableAmountIncident": "20.12",
    "receivableAmountSubscription": "0.00",
    "receivableAmountTotal": "281.96",
    "deductionAmountTotal": "0.00",
    "deductionAmountCart": "0.00",
    "deductionAmountShipment": "0.00",
    "brokeringAmountCart": "65.46",
    "brokeringAmountShipment": "114.81",
    "ordersQuantity": "19",
    "incidentsQuantity": "1",
    "orders": [
        {
            "orderId": "1057829",
            "planId": "2",
            "paymentTypeId": "32",
            "paymentMoment": "2",
            "title": "Alelo Alimentação",
            "createdAt": "2019-06-04",
            "amountCart": "41.25",
            "amountCartDiscount": "0.00",
            "amountShipment": "5.99",
            "amountShipmentDiscount": "0.00",
            "amountDiscount": "0.00",
            "amountTotal": "47.24",
            "receivableAmountCart": "33.00",
            "receivableAmountShipment": "0.00",
            "deductionAmountCart": "0",
            "deductionAmountShipment": "0",
            "brokeringAmountCart": "8.25",
            "brokeringAmountShipment": "5.99",
            "object": "ReportOrderItem"
        },
        {
            "orderId": "1057835",
            "planId": "2",
            "paymentTypeId": "9",
            "paymentMoment": "2",
            "title": "Visa",
            "createdAt": "2019-06-04",
            "amountCart": "23.75",
            "amountCartDiscount": "0.00",
            "amountShipment": "5.99",
            "amountShipmentDiscount": "0.00",
            "amountDiscount": "0.00",
            "amountTotal": "29.74",
            "receivableAmountCart": "19.00",
            "receivableAmountShipment": "0.00",
            "deductionAmountCart": "0",
            "deductionAmountShipment": "0",
            "brokeringAmountCart": "4.75",
            "brokeringAmountShipment": "5.99",
            "object": "ReportOrderItem"
        }
    ],
    "incidents": [
        {
            "orderId": "1057832",
            "amount": "20.12",
            "notes": "Cliente não atendeu para receber o pedido.",
            "object": "ReportOrderIncident"
        }
    ],
    "object": "ReportOrder"
}

Last updated