# PuppetVendors API

- [PuppetVendors API](https://dev.puppetvendors.com/index.md): Public REST API for the PuppetVendors multi-vendor marketplace platform
- [Authentication](https://dev.puppetvendors.com/api-reference/authentication.md): Authenticate with the PuppetVendors API
- [List Vendors](https://dev.puppetvendors.com/api-reference/endpoint/list-vendors.md): Retrieve all vendors registered in your shop
- [Get Vendor](https://dev.puppetvendors.com/api-reference/endpoint/get-vendor.md): Retrieve a single vendor by ID
- [Create Vendor](https://dev.puppetvendors.com/api-reference/endpoint/create-vendor.md): Register a new vendor in your shop
- [Update Vendor](https://dev.puppetvendors.com/api-reference/endpoint/update-vendor.md): Modify a vendor's name or commission settings
- [Delete Vendor](https://dev.puppetvendors.com/api-reference/endpoint/delete-vendor.md): Soft-delete a vendor from your shop
- [Get Vendor Profile](https://dev.puppetvendors.com/api-reference/endpoint/get-vendor-profile.md): Retrieve a vendor's custom profile fields
- [Update Vendor Profile](https://dev.puppetvendors.com/api-reference/endpoint/update-vendor-profile.md): Update a vendor's custom profile fields
- [Get Vendor Address](https://dev.puppetvendors.com/api-reference/endpoint/get-vendor-address.md): Retrieve a vendor's business address
- [Update Vendor Address](https://dev.puppetvendors.com/api-reference/endpoint/update-vendor-address.md): Set or update a vendor's business address
- [Get Vendor Profile Fields](https://dev.puppetvendors.com/api-reference/endpoint/get-shop-profile.md): List the custom profile fields available for vendors
- [List Users](https://dev.puppetvendors.com/api-reference/endpoint/list-users.md): Retrieve all vendor portal users
- [Get User](https://dev.puppetvendors.com/api-reference/endpoint/get-user.md): Retrieve a single vendor portal user
- [Create User](https://dev.puppetvendors.com/api-reference/endpoint/create-user.md): Create a vendor portal user account
- [Update User](https://dev.puppetvendors.com/api-reference/endpoint/update-user.md): Update a vendor portal user's email or password
- [Delete User](https://dev.puppetvendors.com/api-reference/endpoint/delete-user.md): Permanently delete a vendor portal user account
- [Get Order](https://dev.puppetvendors.com/api-reference/endpoint/get-order.md): Retrieve an order or its calculated line items
- [List Products](https://dev.puppetvendors.com/api-reference/endpoint/list-products.md): Retrieve products with pagination
- [List Payouts](https://dev.puppetvendors.com/api-reference/endpoint/list-payouts.md): Retrieve payout line items with filtering
- [List Fulfillments](https://dev.puppetvendors.com/api-reference/endpoint/list-fulfillments.md): Retrieve fulfillment data for line items
- [Create Fulfillment](https://dev.puppetvendors.com/api-reference/endpoint/create-fulfillment.md): Fulfill line items with tracking information
- [Get Commissions by Vendor](https://dev.puppetvendors.com/api-reference/endpoint/get-commissions-by-vendor.md): List commission rates for all vendors
- [Get Commissions by SKU](https://dev.puppetvendors.com/api-reference/endpoint/get-commissions-by-sku.md): List commission rates and cost of goods per SKU
- [Bulk Upload SKU Commissions](https://dev.puppetvendors.com/api-reference/endpoint/bulk-upload-commissions.md): Upsert SKU-level commissions and cost of goods in bulk
- [Get Vendor Reports](https://dev.puppetvendors.com/api-reference/endpoint/get-reports.md): Retrieve calculated line item reports for a vendor
- [Update Line Items](https://dev.puppetvendors.com/api-reference/endpoint/update-line-items.md): Update report data and cost of goods for line items
- [V2 Vendor API Introduction](https://dev.puppetvendors.com/api-reference/v2/vendor/introduction.md): Overview of the PuppetVendors V2 Vendor API (Alpha)
- [Quick Start](https://dev.puppetvendors.com/api-reference/v2/vendor/quickstart.md): Get up and running with the PuppetVendors Vendor API in 5 minutes
- [Vendor Authentication](https://dev.puppetvendors.com/api-reference/v2/vendor/authentication.md): Authenticate with the PuppetVendors V2 API using a vendor API key
- [API Keys & Scopes](https://dev.puppetvendors.com/api-reference/v2/vendor/api-keys-scopes.md): Create vendor API keys and understand permission scopes
- [Pagination](https://dev.puppetvendors.com/api-reference/v2/vendor/pagination.md): Cursor-based pagination in the V2 Vendor API
- [Error Handling](https://dev.puppetvendors.com/api-reference/v2/vendor/errors.md): Standard error responses in the V2 Vendor API
- [Authenticate](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-authenticate.md): Exchange your vendor API key for a JWT token
- [Refresh Token](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-refresh-token.md): Exchange a valid vendor token for a new one with extended expiry
- [Vendor Portal Login](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/portal-login.md): Authenticate a vendor user with email and password; returns a JWT
- [Vendor Portal Signup](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/portal-signup.md): Create a new vendor portal signup request (pending merchant approval)
- [Forgot Password](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/portal-forgot-password.md): Send a password reset link to a vendor's email
- [Vendor Portal Logout](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/portal-logout.md): Invalidate the current vendor session token
- [Refresh Vendor Token](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/portal-refresh-token.md): Exchange a valid vendor token for a new one with extended expiry
- [List Vendors for User](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/portal-list-vendors.md): Get all vendor accounts linked to the authenticated user
- [List Orders](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-list-orders.md): Retrieve vendor-scoped orders with cursor-based pagination
- [Get Order](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-get-order.md): Retrieve a single order with vendor-scoped line items
- [Get Order Counts](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/order-counts.md): Get a count of orders grouped by fulfillment status
- [Get Order Timeline](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/get-order-timeline.md): Get the timeline of events and notes for a specific order
- [Add Order Timeline Note](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/add-order-timeline.md): Add a note to an order's timeline
- [List Products](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-list-products.md): Retrieve vendor-scoped products with cursor-based pagination
- [Get Product](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/get-product.md): Retrieve a single product with full details including variants, images, and metafields
- [Create Product](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-create-product.md): Create a new product as a vendor with Shopify sync
- [Update Product](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/update-product.md): Full product update via Shopify productSet mutation
- [Delete Product](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/delete-product.md): Delete a product from Shopify and soft-delete locally
- [Get Product Counts](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/product-counts.md): Get a breakdown of how many products you have in each status
- [Update Product Status](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/update-product-status.md): Change a product's status to ACTIVE or DRAFT
- [Duplicate Product](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/duplicate-product.md): Clone an existing product into a new draft
- [Update Product Inventory](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/update-product-inventory.md): Inventory-only update without touching product/variant data
- [Upload Product Media](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/upload-product-media.md): Upload media to Shopify staging for later use in product creation
- [AI Product Description](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/ai-description.md): Generate a product description using AI based on product details
- [Generate Barcode](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/generate-barcode.md): Generate a unique barcode for a product variant
- [List Fulfillments](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-list-fulfillments.md): Retrieve vendor-scoped fulfillment items with cursor-based pagination
- [Create Fulfillment](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-create-fulfillment.md): Fulfill line items with tracking information as a vendor
- [Update Fulfillment](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-update-fulfillment.md): Update fulfillment tracking information as a vendor
- [Get Fulfillment Counts](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/fulfillment-counts.md): Get a breakdown of fulfillment counts by status
- [Get Fulfillment Stats](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/fulfillment-stats.md): Get headline fulfillment performance statistics
- [List Fulfillment Events](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/list-fulfillment-events.md): List all tracking events for a line item's fulfillment
- [Create Fulfillment Event](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/create-fulfillment-event.md): Create a tracking event for a line item's fulfillment
- [Update Fulfillment Event](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/update-fulfillment-event.md): Update an existing fulfillment event
- [Bulk Create Fulfillment Events](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/bulk-create-fulfillment-events.md): Create multiple fulfillment events in a single request (max 100)
- [Generate Vendor Invoice PDF](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/generate-invoice.md): Generate a single-order vendor invoice PDF (S3 URL, 48h expiry)
- [Generate Packing Slip PDF](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/generate-packing-slip.md): Generate a single-order packing slip PDF (S3 URL, 48h expiry)
- [Generate Shipping Label PDF](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/generate-shipping-label.md): Generate a shipping label PDF for order fulfillment (S3 URL, 48h expiry)
- [Generate Customer Invoice PDF](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/generate-customer-invoice-doc.md): Generate a customer-facing invoice PDF (S3 URL, 48h expiry)
- [Generate Grouped Invoice by Vendor](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/generate-grouped-invoice.md): Consolidated invoice PDF for all orders from specific vendors within a date range
- [List Payouts](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-list-payouts.md): Retrieve vendor-scoped payout transactions with cursor-based pagination
- [Get Payout](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-get-payout.md): Retrieve a single payout transaction with item details
- [Payout Summary](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/payout-summary.md): Get a high-level summary of payout totals and the next scheduled payout
- [List Payout Transactions](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/payout-transactions.md): List payout transactions with cursor pagination and filters
- [Get Payout Batch Detail](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/payout-batch-detail.md): Get detailed breakdown of a specific payout batch
- [List Pending Payouts](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/pending-payouts.md): List line items that are pending payout with offset pagination
- [List Customers](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-list-customers.md): Retrieve a paginated customer directory from vendor order data
- [List Discounts](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-list-discounts.md): Retrieve vendor-scoped discount codes
- [Create Discount](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-create-discount.md): Create a new discount code as a vendor
- [Update Discount](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-update-discount.md): Update an existing vendor discount code
- [Delete Discount](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-delete-discount.md): Delete a vendor discount code
- [Get Shipping Rates for Order](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/get-shipping-rates-op.md): Fetch real-time shipping rates for an order's line items
- [Purchase Shipping Label](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/purchase-shipping-label.md): Purchase a shipping label for an order using a selected rate
- [Generate Generic Label](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/generate-generic-label.md): Generate a generic shipping label without purchasing a carrier rate
- [List Shipping Dimensions](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/list-shipping-dimensions.md): Retrieve saved shipping dimension presets
- [Create Shipping Dimension](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/create-shipping-dimension.md): Create a new shipping dimension preset
- [Update Shipping Dimension](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/update-shipping-dimension.md): Update an existing shipping dimension preset
- [Delete Shipping Dimension](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/delete-shipping-dimension.md): Delete a shipping dimension preset
- [Get My Vendor Profile](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/get-my-profile.md): Retrieve the authenticated vendor's own profile
- [Update My Vendor Profile](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/update-my-profile.md): Update the authenticated vendor's own profile
- [Get My Vendor Address](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/get-my-address.md): Retrieve the authenticated vendor's own address
- [Update My Vendor Address](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/update-my-address.md): Update the authenticated vendor's own address
- [Get Account Settings](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/get-account-settings.md): Retrieve the authenticated user's account information
- [Update Account Settings](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/update-account-settings.md): Update the authenticated user's account information or password
- [Get Profile Settings](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/get-profile-settings.md): Retrieve the vendor's storefront profile grouped by portal tabs
- [Update Profile Settings](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/update-profile-settings.md): Update the vendor's storefront profile using strict tab-based sections
- [Get Shipping Rates](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/get-shipping-rates.md): Retrieve the vendor's shipping rate configuration
- [Update Shipping Rates](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/update-shipping-rates.md): Set or update the vendor's shipping rate configuration
- [List Warehouses](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/list-warehouses.md): Retrieve all warehouses (locations) for the authenticated vendor
- [Get Warehouse](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/get-warehouse.md): Retrieve a single warehouse by its locationId
- [Add Warehouse](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/create-warehouse.md): Add a new warehouse / location to the vendor
- [Update Warehouse](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/update-warehouse.md): Update an existing warehouse at the given index
- [Delete Warehouse](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/delete-warehouse.md): Remove a warehouse at the given index
- [List Team Members](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/list-team-members.md): Retrieve team members for the vendor account
- [Create Team Member](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/create-team-member.md): Invite a new team member to the vendor account
- [Update Team Member](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/update-team-member.md): Update an existing team member's details or permissions
- [Delete Team Member](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/delete-team-member.md): Remove a team member from the vendor account
- [List Users](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-list-users.md): Retrieve a paginated list of users belonging to the vendor
- [Get User](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/get-user.md): Retrieve a single vendor portal user by ID
- [Create User](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-create-user.md): Create a new user account for the vendor
- [Update User](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-update-user.md): Update an existing user account belonging to the vendor
- [Delete User](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-delete-user.md): Delete a user account belonging to the vendor
- [List Available Integrations](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/list-integrations.md): Return the list of integration providers supported by the vendor portal
- [PayPal](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-get-paypal.md): Retrieve the vendor's PayPal integration
- [PayPal](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-update-paypal.md): Configure or update the vendor's PayPal integration
- [Delete PayPal Configuration](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/delete-paypal.md): Remove the vendor's PayPal email
- [Stripe](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-get-stripe.md): Retrieve the vendor's Stripe Connect integration status
- [Initiate Stripe Connect](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/stripe-connect.md): Start the Stripe Connect onboarding process for the vendor
- [Disconnect Stripe Account](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/delete-stripe.md): Disconnect and delete the vendor's Stripe Connect account
- [Shippo](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-get-shippo.md): Retrieve the vendor's Shippo shipping integration
- [Shippo](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-update-shippo.md): Configure or update the vendor's Shippo integration
- [Delete Shippo Configuration](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/delete-shippo.md): Remove the vendor's Shippo API key
- [ShipStation](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-get-shipstation.md): Retrieve the vendor's ShipStation integration
- [ShipStation](https://dev.puppetvendors.com/api-reference/v2/endpoint/vendor-update-shipstation.md): Configure or update the vendor's ShipStation integration
- [Delete ShipStation Configuration](https://dev.puppetvendors.com/api-reference/v2/vendor/endpoint/delete-shipstation.md): Remove the vendor's ShipStation API credentials
- [V2 Merchant API Introduction](https://dev.puppetvendors.com/api-reference/v2/merchant/introduction.md): Overview of the PuppetVendors V2 Merchant API (Alpha)
- [Merchant Authentication](https://dev.puppetvendors.com/api-reference/v2/merchant/authentication.md): Authenticate with the PuppetVendors V2 API using a merchant API key
- [Authenticate and get API token](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/authenticate.md): Authenticate using an API key to obtain a JWT token. The key's prefix determines the token scope: - **Merchant key** (`mk_live_…` / `mk_test_…`, from Settings → API Access):   returns a merchant-scoped token with full access. Named, rotatable and   revocable per integration. - **Vendor key** (`vk_li…
- [Verify an API key reaches the service](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/verify.md): Pure probe — confirms the key is valid and reachable, returns the scopes/mode/identity it carries, but does NOT issue a JWT or count as a use (lastUsedAt unchanged).
- [Refresh API token](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/refresh-token.md): Exchange a valid (non-expired) token for a new one with extended expiry. Use this to maintain sessions without requiring re-authentication.
- [List vendors with pagination](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/list-vendors.md): Retrieve a paginated list of vendors. **Merchant scope only** - vendor tokens cannot access this endpoint.
- [Create a new vendor](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/create-vendor.md): Create a new vendor in the shop. **Merchant scope only**.
- [Get a single vendor](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/get-vendor.md): Retrieve a vendor by ObjectId. **Merchant scope only**.
- [Update a vendor](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/update-vendor.md): Update an existing vendor. **Merchant scope only**.
- [Delete a vendor (soft delete)](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/delete-vendor.md): Soft delete a vendor by setting isHidden=true. The vendor data is preserved but hidden from lists. **Merchant scope only**.
- [Get vendor profile](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/get-vendor-profile.md): Get vendor profile fields (company name, contact info, etc.). **Merchant scope only**.
- [Update vendor profile](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/update-vendor-profile.md): Update vendor profile fields. **Merchant scope only**.
- [Get vendor address](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/get-vendor-address.md): Get vendor address fields. **Merchant scope only**.
- [Update vendor address](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/update-vendor-address.md): Update vendor address fields. **Merchant scope only**.
- [List users (vendor-scoped)](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/list-users.md): When authenticated with a **vendor** JWT, lists users belonging to that vendor. Merchant tokens use the merchant admin list endpoint on the same path.
- [Create user (vendor-scoped)](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/create-user.md): Create a new user account. **Merchant scope only**.
- [Get a single user](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/get-user.md): Retrieve a user by ObjectId. **Merchant scope only**.
- [Update user (vendor-scoped)](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/update-user.md): Update an existing user. **Merchant scope only**.
- [Delete user (vendor-scoped)](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/delete-user.md): Delete a user account. **Merchant scope only**.
- [List payout methods](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/list-payout-methods.md): List your vendors with the payout methods each one can currently be paid with (Stripe, PayPal, Global Payouts, or manual). A method is available only when the vendor is set up for it and the shop has it enabled and connected. Requires the `admin:payouts` permission.
- [List pending payouts](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/list-pending-payouts.md): List each vendor's unpaid payout total for a date window. Requires the `admin:payouts` permission.
- [List a vendor's pending items](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/list-pending-payout-items.md): List the unpaid line items and adjustments that make up one vendor's pending payout. Requires the `admin:payouts` permission.
- [Preview a payout](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/dry-run-payout.md): Preview what a payout would pay, with totals and any validation issues, without creating anything. Requires the `admin:payouts:make_payment` permission.
- [Create a payout](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/make-payout-payment.md): Pay a selection of line items and adjustments for one or more vendors (up to 50), one batch per vendor using a single payout method. Runs asynchronously: returns a `transactionId` to poll. Send a unique `Idempotency-Key` so retries are safe. Requires the `admin:payouts:make_payment` permission.
- [Get a payout](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/get-payout-run.md): Get the current status of a payout and its per-vendor batches by `transactionId`. Requires the `admin:payouts` permission.
- [Retry a payout batch](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/retry-payout-batch.md): Retry a payout batch that was rejected. Runs asynchronously; poll the transaction for the result. Requires the `admin:payouts:make_payment` permission.
- [Mark a payout batch as paid](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/mark-payout-batch-paid.md): Mark a payout batch as paid when it was settled outside PuppetVendors. Runs asynchronously. Requires the `admin:payouts:make_payment` permission.
- [List payout transactions](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/list-payout-transactions.md): List past payout runs with their per-vendor batches, for the whole shop or a single vendor. Requires the `admin:payouts` permission.
- [List payout adjustments](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/list-payout-adjustments.md): Retrieve a paginated list of payout adjustments for the shop. **Merchant scope only**, requires the `admin:payouts` permission.
- [Create a payout adjustment](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/create-payout-adjustment.md): Create a manual payout adjustment (addition or deduction) for a vendor. **Merchant scope only**, requires the `admin:payouts` permission.
- [Get a payout adjustment](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/get-payout-adjustment.md): Retrieve a single payout adjustment by ObjectId. **Merchant scope only**, requires the `admin:payouts` permission.
- [Update a payout adjustment](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/update-payout-adjustment.md): Update a payout adjustment. **Merchant scope only**, requires the `admin:payouts` permission. `amount` and `type` must be changed together, because the stored sign is derived from both; the request schema enforces that pairing. Refused once the adjustment has been paid or deleted.
- [Delete a payout adjustment](https://dev.puppetvendors.com/api-reference/v2/merchant/endpoint/delete-payout-adjustment.md): Hard-delete a payout adjustment, at parity with legacy. **Merchant scope only**, requires the `admin:payouts` permission. Refused once the adjustment has been paid or deleted.

## OpenAPI Specs

- [openapi-merchant](/openapi-merchant.json)
- [openapi](/openapi.yaml)

## Optional

- [PuppetVendors](https://puppetvendors.com)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.