---
updatedAt: 2026-06-30T16:05:21.000Z
agentTools:
  projectIndex: https://docs.pelcro.com/llms.txt
---

# Export vendors

Queue a CSV export of vendor records.

## Overview

Queue a CSV export of all vendor records. The export is processed asynchronously and a download link is emailed to the authenticated user.

**Example:** Export all vendors for import into your accounting system.

***

## Important Behaviors

* **Async processing**: The export is queued and processed in the background. A download link is sent via email when ready.
* **Returns 422** if there are no vendors to export.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "core-api",
    "version": "1.88"
  },
  "servers": [
    {
      "url": "https://www.pelcro.com/api/v1/core"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "x-bearer-format": "bearer"
      },
      "sec1": {
        "type": "apiKey",
        "in": "query",
        "name": "site_id"
      }
    }
  },
  "security": [
    {
      "sec0": [],
      "sec1": []
    }
  ],
  "paths": {
    "/vendors/export": {
      "get": {
        "summary": "Export vendors",
        "description": "Queue a CSV export of vendor records.",
        "operationId": "api-core-export-vendors",
        "parameters": [
          {
            "name": "site_id",
            "in": "query",
            "description": "The unique identifier of the site associated with your account.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "Authorization",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "default": "Bearer eyJ***"
            }
          },
          {
            "name": "search",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter vendors by search term."
          }
        ],
        "responses": {
          "200": {
            "description": "Success.",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"message\": \"Your export request is now queued for processing, we'll send an email to publisher@example.net as soon as your export is ready.\"\n}"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthenticated.",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": {
                      "error": "Unauthenticated."
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Forbidden.",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": {
                      "error": "Unauthorized"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Nothing to export.",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": {
                      "error": "There is nothing to export for the selected date range, please try again."
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "x-readme": {
          "code-samples": [
            {
              "language": "php",
              "code": "use GuzzleHttp\\Client;\n\n$site_id = 0; // (int) your site id here\n$vednor_id = 0; // (int) the vednor id here\n$api_key = '' // (string) your api key here\n  \n$uri = \"vendors/{$vednor_id}\";\n\n$config = [\n  'base_uri' => 'https://www.pelcro.com/api/v1/core/'\n];\n\n$client = new Client($config);\n\n$options = [\n    'json' => [\n        'site_id' => $site_id,              // Optional: integer, min 1\n        'first_name' => $first_name,         // Optional: string, max 255\n        'last_name' => $last_name,          // Optional: string, max 255\n        'email' => $email,                   // Optional: email, max 255, must be unique\n        'phone' => $phone,                   // Optional: nullable string, max 20\n        'birthdate' => $birthdate,           // Optional: nullable date format (YYYY-MM-DD)\n        'job_title' => $job_title,           // Optional: nullable string, max 255\n        'metadata' => $metadata,             // Optional: array\n    ],\n    'headers' => [\n        'Accept' => 'application/json',\n        'Authorization' => 'Bearer ' . $api_key\n    ]\n];\n\n$response = $client->request('PUT', $uri, $options);"
            }
          ],
          "samples-languages": [
            "php"
          ]
        }
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```

# Sibling pages

* [List vendors](https://docs.pelcro.com/reference/api-core-list-vendors.md)
* [Create vendor](https://docs.pelcro.com/reference/api-core-create-vendor.md)
* [Get vendor](https://docs.pelcro.com/reference/api-core-get-vendor.md)
* [Update vendor](https://docs.pelcro.com/reference/api-core-update-vendor.md)
* [Delete vendor](https://docs.pelcro.com/reference/api-core-delete-vendor.md)
* [Payout Details](https://docs.pelcro.com/reference/api-core-vendor-payout-details.md)