Download Sales Report

GET {{baseUrl}}/sales/download-report?userId=&tenantId=&status=COMPLETED&from=&to=&locale.baseLocale.language=&locale.baseLocale.script=&locale.baseLocale.region=&locale.baseLocale.variant=

Description

This endpoint allows you to download a sales report based on specified parameters. It provides a downloadable file containing detailed information about the sales that match the specified criteria.

Headers

• Accept: application/octet-stream

• ApiKey: The platform API key is required to use this endpoint - {{PlatformApiKey}}

• baseUrl: The base URL of the API.

Query Parameters

• userId: (string)
• tenantId: (string)
• status: COMPLETED
• from: (string)
• to: (string)
• locale.baseLocale.language: (string)
• locale.baseLocale.script: (string)
• locale.baseLocale.region: (string)
• locale.baseLocale.variant: (string)

Response

• Status: OK (200)
• Content-Type: application/octet-stream

Headers

• Accept: text/plain

PARAMS

• userId: (string)
• saleId: (string)
• parentPartialSaleId: (string)
• tenantId: (string)
• paymentReference: (string)
• requestId: (string)
• countryCode: (string)
• customerId: (string)
• businessId: (string)
• agentId: (string)
• paymentStatus: REFUNDED
• deliveryStatus: SHIPPED
• deliveryMode: PICK_UP
• paymentMode: IN_STORE
• totalAmount: (double)
• fromAmount: (double)
• orderNumber: (string)
• globalOrderNumber: (string)
• paymentMethod: BANK_TRANSFER
• partialMode: PARTIAL_SALE
• toAmount: (double)
• customerIds: (string)
• search: (string)
• from: (string)
• to: (string)
• locale.baseLocale.language: (string)
• locale.baseLocale.script: (string)
• locale.baseLocale.region: (string)
• locale.baseLocale.variant: (string)

Sample Request

curl --location -g '{{baseUrl}}/sales/download-report?userId=&saleId=&parentPartialSaleId=&tenantId=&paymentReference=&requestId=&countryCode=&customerId=&businessId=&agentId=&paymentStatus=REFUNDED&deliveryStatus=SHIPPED&deliveryMode=PICK_UP&paymentMode=IN_STORE&totalAmount=&fromAmount=&orderNumber=&globalOrderNumber=&paymentMethod=BANK_TRANSFER&partialMode=PARTIAL_SALE&toAmount=&customerIds=&search=&from=&to=&locale.baseLocale.language=&locale.baseLocale.script=&locale.baseLocale.region=&locale.baseLocale.variant=' \
--header 'Accept: text/plain'

Sample Response

{}