Skip to main content
GET
Export products
Any member of the organization can export. Choose the file format with the required type query parameter: ?type=csv answers a UTF-8 CSV file, ?type=xlsx an Excel workbook returned base64-encoded. The file lists every product of the organization, with no filters, and has one row per product with its name, description, value, SKU code, type, status and creation and last update dates. The headers and the type and status values are in Portuguese (Produto or Serviço, Ativo or Desativado). The Valor column is the price in reais, not in centavos like the value of the API, written the Brazilian way as text: a product whose value is 2500 shows 25,00 and one whose value is 150000 shows 1.500,00. The dates are DD/MM/YYYY HH:mm in Brasília time. An organization with no products gets a file with the header row and one blank row, whose Valor reads 0,00. The file is sent as an attachment named products-report-<timestamp>.csv or .xlsx. A file of more than 50,000 rows or 4 MiB is refused.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization whose products you want to export.

Format: UUID

Query Parameters

type
enum<string>
required

The file format: csv for a UTF-8 CSV file, xlsx for an Excel workbook returned base64-encoded.

Available options:
csv,
xlsx

Response

application/csv — The products as a UTF-8 CSV file, when ?type=csv.

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet — The Excel workbook, base64-encoded, when ?type=xlsx. It is always base64: this export has no switch for raw bytes.

The products as a UTF-8 CSV file, when ?type=csv.