---
title: "Export Vendors"
method: POST
path: "/v1/web/vendor/export"
tags: ["Vendor"]
---

# Export Vendors

`POST /v1/web/vendor/export`

This is a streaming endpoint. BFFs should pipe the stream response back to user's browser.

## Request body

- object
  - `format` 'csv', required
  - `fields` union[] — columns to include; defaults to all
    - union
      - 'name'
      - 'status'
      - 'country'
      - 'currencyCode'
      - 'legalName'
      - 'taxId'
      - 'address'
      - 'merchantCategory'
      - 'contactName'
      - 'contactEmail'
      - 'contactPhone'
      - 'externalId'
      - 'id'
      - 'createdAt'
      - 'updatedAt'
  - `ids` string[]
  - `externalIds` string[]
  - `statuses` union[]
    - union
      - 'active'
      - 'disabled'
      - 'deleted'
  - `ownerUserIds` string[]
  - `ownerUserGroupIds` string[]
  - `countries` string[]
  - `spendCategoryIds` string[]
  - `merchantIds` string[]
  - `nameLike` string
  - `legalNameLike` string
  - `createdAt` object[]
    - `op` union, required
      - 'lt'
      - 'lte'
      - 'eq'
      - 'ne'
      - 'gte'
      - 'gt'
    - `value` string, date-time, required
  - `updatedAt` object[]
    - `op` union, required
      - 'lt'
      - 'lte'
      - 'eq'
      - 'ne'
      - 'gte'
      - 'gt'
    - `value` string, date-time, required
  - `orderBy` object[]
    - `field` union, required
      - 'createdAt'
      - 'updatedAt'
    - `direction` union, required
      - 'asc'
      - 'desc'

## Response `200`

Default Response

- string

## Other responses

- `400` — Default Response
- `401` — The access to this resource has been denied
- `403` — The access to this resource is forbidden
- `default` — Catch-all error response for any unexpected internal errors

---

[API](https://skmtc.net/funneldash/apis/surface-web-api.md) · [All operations](https://skmtc.net/funneldash/apis/surface-web-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/funneldash/surface-web-api/versions/ac700d65f443/schema)