Retrieving a Report

Overview

Endpoint: https://{base_url}/v1/transaction-reports/{report_id}/
Method: GET
Headers:

• Authorization: JWT {id_token}
• Accept: application/json

The URL must contain the following parameters:

• report_id: Unique report id generated by Olist;

Payload:

This method does not need any payload in body.

Response codes:

• 200: Ok
• 400: Badrequest
• 401: Unauthorized

Request

curl --location 'https://{base_url}/v1/transaction-reports/{report_id}/' \
--header 'Accept: application/json' \
--header 'Authorization: JWT {id_token}'

Response

{
    "id": "05472b94-f6f4-4939-b2cb-fc2c2ef0b1f6",
    "seller_id": "1c150ef8-c540-4cab-99ce-4e572b7b2f1b",
    "reference_month": 9,
    "reference_year": 2022,
    "status": "done",
    "url": "https://olist-financial.s3.amazonaws.com/transaction-report/1c150ef8-c540-4cab-99ce-4e572b7b2f1b/setembro2022-relatorio-financeiro-olist-d41d8cd98f00b204e9800998ecf8427e.xlsx?AWSAccessKeyId=AKIAWAGEX7QI2NTCENQU&Signature=bMAS0%2BvTAgTM%2FVHoi1SWdxXAolk%3D&Expires=1676468106",
    "language": "pt-br",
    "created_at": "2023-02-08T13:29:19.490032Z",
    "updated_at": "2023-02-08T13:29:27.884856Z",
    "region": "br"
}

What's Next