Creating a Report

Overview

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

Authorization: JWT {id_token}
Accept: application/json
Content-Type: application/json

Payload:

Check the example below

Response codes:

201: Created
400: Bad Request
401: Unauthorized

Languages

Language is optional if you do not pass anything it will return as en-us, after this call it will return the id of that request in the response which can be called.
We have the following options as language:

pt-br
en-us

Request

curl --location 'https://partners-sandbox-api.olist.com/v1/seller-products/' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: JWT eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJZel90TVpiXzdOd2NMZVVaT0tYc2NRdW8wUE4zN0JvYkNONjhFdE80WVFzIn0.eyJleHAiOjE3MzY2MjY3NzUsImlhdCI6MTczNjU0MDM3NSwiYXV0aF90aW1lIjoxNzM2NTM5MjkxLCJqdGkiOiIzODQ4YzIxYS1jMDA5LTQ3YTQtYTQ0Ni04MmJkM2M3NmFjNTMiLCJpc3MiOiJodHRwczovL2F1dGgtZW5naW5lLm9saXN0LmNvbS9yZWFsbXMvM3JkLXBhcnR5LXNhbmRib3giLCJhdWQiOiJkZXZlbG9wZXJzIiwic3ViIjoiMDYzYTlkYzctZGU5MC00N2NmLWFiZGUtMWRhMTc0MTMwY2RhIiwidHlwIjoiSUQiLCJhenAiOiJkZXZlbG9wZXJzIiwic2Vzc2lvbl9zdGF0ZSI6IjllNTViNTJjLTQyYTItNGM0My05NmEyLWFkOWFlMDk1Zjg0MSIsImF0X2hhc2giOiJTWmlvZ29UVnp6M1BfcWVDT013M0JRIiwiYWNyIjoiMSIsInNpZCI6IjllNTViNTJjLTQyYTItNGM0My05NmEyLWFkOWFlMDk1Zjg0MSIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJkZXZlbG9wZXJzIiwiZW1haWwiOiJkZXZlbG9wZXJzQHBhcnRuZXJzLXNhbmRib3gtYXBpLm9saXN0LmNvbSJ9.OIZRFGb5HhL4NoJJqlAMMdnPzRvlh4mXmHV6wzAhlDpbl6zglUeriGsDNqaCt8vm4CFWI7zLh3PqPxNvDOQlue2PoPDyyXNFp2wxrnJdnAAz0aDylpGUFCCRr18uNjEBXC9FLxRVRyzqGcxcA-OJXEneg5BW-aki9GZFHJcmRk5dgfo9oerFo4qMUG42nyLbKaKuLO4B9VH_wjkhtOCeLTo9p-rGi3CRTjpp_9jCPt_hGIITi30qC8iGwW8zxcUuwavDpEq1zZ3Unq6DKNx8jI9ViWE526Zf0hTk_ICitoYkdyx4ri20iFlXoE2t157MgvdiPXDtf9tO24y1i_rArA' \
--data '{
	"reference_year": "2025",
	"reference_month": "1",
	"language": "pt-br"
}'

Response

{
    "id": "05472b94-f6f4-4939-b2cb-fc2c2ef0b1f6",
    "seller_id": "1c150ef8-c540-4cab-99ce-4e572b7b2f1b",
    "reference_month": 9,
    "reference_year": 2022,
    "status": "pending",
    "url": null,
    "language": "pt-br",
    "created_at": "2023-02-08T13:29:19.490032Z",
    "updated_at": "2023-02-08T13:29:19.490048Z",
    "bucket": null,
    "key": null,
    "region": "br",
    "final_report": false
}

What's Next

Retrieving a Report