PuppetVendors

## Sections
• [Introduction](https://app.theneo.io/puppetvendors/developers_1/introduction.md): PuppetVendors API enables you to manage all your shop resources programmatically. Be it getting access to your vendors, users, shops, payouts, fulfillment, or commissions. The PuppetVendors API follows the general patterns of REST.
• [Errors](https://app.theneo.io/puppetvendors/developers_1/errors.md): PuppetVendors API uses the following status or error codes. The API rate limit is 100 requests per minute.
• [Authentication](https://app.theneo.io/puppetvendors/developers_1/authentication.md): PuppetVendors uses API keys to allow access to the API. Access to the API is only available to shops on the Enterprise plan . You must exchange your API key for a JWT token used for making direct API calls to your shop resources within PuppetVendors. Title Required? Type Description Min Length Max Length apiKey true string Unique API Key shopDomain true string Unique Shopify Domain Both apiKey and shopDomain can be found in the API Access navigation under Settings . PuppetVendors expects the JWT token to be included in all subsequent API requests to the server in a header. Each JWT token is valid for 12 hours.
  • [Refresh Token](https://app.theneo.io/puppetvendors/developers_1/authentication/refresh-token.md): You must refresh your JWT token every 12 hours to continue making API requests to your shop resources.
• [Vendors](https://app.theneo.io/puppetvendors/developers_1/vendors.md): are your business partners, drop shippers, artists, and consignors you work with whom you wish to share your sales commissions with on PuppetVendors. The Vendor resource allows you to manage their business information including but not limited to their name, commission type, commission rate, and business profile.
  • [Retrieve a list of vendors](https://app.theneo.io/puppetvendors/developers_1/vendors/retrieve-a-list-of-vendors.md): List all vendors associated with the shop resource.
  • [Create a vendor](https://app.theneo.io/puppetvendors/developers_1/vendors/create-a-vendor.md): Creates a new vendor associated with the shop resource. Title Required? Type Description Min Length Max Length vendorName true string The name of the vendor you want to use. commissionType true string The commission type you want to set. The value must be “percentage” or “flat” commissionAmount true integer The commission amount you want to keep. 0-100 for "percentage" and any integer for "flat"
  • [Retrieve a specific vendor](https://app.theneo.io/puppetvendors/developers_1/vendors/retrieve-a-specific-vendor.md): List a specific vendor based on the vendorId associated with the shop resource. Parameters Title Required? Type Description Min Length Max Length :vendorId true String The vendor's unique id you want to retrieve.
  • [Update a vendor](https://app.theneo.io/puppetvendors/developers_1/vendors/update-a-vendor.md): Updates information for a specific vendor associated with the shop resource. Parameters Title Required? Type Description Min Length Max Length :vendorId true String The vendor's unique id you want to retrieve. Title Required? Type Description Min Length Max Length vendorName true string The name of the vendor you want to use. commissionType true string The commission type you want to set. The value must be “percentage” or “flat” commissionAmount true integer The commission amount you want to keep. 0-100 for "percentage" and any integer for "flat"
  • [Delete a vendor](https://app.theneo.io/puppetvendors/developers_1/vendors/delete-a-vendor.md): Deletes a vendor and all information linked to it using its vendorId . Data removed includes sales, commissions, products, fulfillment, and all resources for this vendor. Parameters Title Required? Type Description Min Length Max Length :vendorId true String The vendor's unique id you want to delete.
  • [Retrieve a list of vendor profile fields](https://app.theneo.io/puppetvendors/developers_1/vendors/retrieve-a-list-of-vendor-profile-fields.md): List all profile fields that can be attached to a vendor profile associated with a shop resource. Vendor profile fields can be updated at https://app.puppetvendors.com/setting/account.
  • [Update profile information for a specific vendor](https://app.theneo.io/puppetvendors/developers_1/vendors/update-profile-information-for-a-specific-vendor.md): Updates information for a specific vendor associated with the shop resource. Parameters Title Description Title Description Title Description Title Required? Type Description Min Length Max Length :vendorId true String The vendor's unique id whose profile you want to update. The list of profile fields is specific for any shop resource. Get the list via the Retrieve a list of vendor profile fields requests above. Title Description Title Description Title Description Title Required? Type Description Min Length Max Length field true string The name of the profile field to update value true string The value to be assigned to the field
  • [Update business address for a specific vendor](https://app.theneo.io/puppetvendors/developers_1/vendors/update-business-address-for-a-specific-vendor.md): Updates information for a specific vendor associated with the shop resource. Parameters Title Description Title Description Title Description Title Required? Type Description Min Length Max Length :vendorId true String The vendor's unique id whose profile you want to update. Title Description Title Description Title Description Title Required? Type Description Min Length Max Length address1 false string The value to be assigned to the vendor's business address1 address2 false string The value to be assigned to the vendor's business address2 city false string The value to be assigned to the vendor's business city state false string The value to be assigned to the vendor's business state postalCode false string The value to be assigned to the vendor's business postalCode
• [Users](https://app.theneo.io/puppetvendors/developers_1/users.md): are vendor staffs or owner who receives login credentials to the vendor portal. Each vendor staff or owner account will only be able to view their own sale line items, orders, payouts, fulfillment, etc.
  • [Retrieve a list of users](https://app.theneo.io/puppetvendors/developers_1/users/retrieve-a-list-of-users.md): List all users associated with the shop resource.
  • [Create a user](https://app.theneo.io/puppetvendors/developers_1/users/create-a-user.md): Creates a new user associated with a vendor resource. Title Required? Type Description Min Length Max Length vendorId true string A unique vendorId. This user will have access to this vendor's information. email true string The user's email address used for logging into the vendor portal. password true string The user's password used for logging into the vendor portal.
  • [Retrieve a specific user](https://app.theneo.io/puppetvendors/developers_1/users/retrieve-a-specific-user.md): List a specific user based on the userId associated with the vendor resource. Parameters Title Required? Type Description Min Length Max Length :userId true String The user's unique id you want to retrieve.
  • [Update a user](https://app.theneo.io/puppetvendors/developers_1/users/update-a-user.md): Updates information for a specific vendor associated with the shop resource. Parameters Title Required? Type Description Min Length Max Length :userId true String The user's unique id you want to update. Title Required? Type Description Min Length Max Length email true string The user's email address used for logging into the vendor portal. password true string The user's password used for logging into the vendor portal.
  • [Delete a user](https://app.theneo.io/puppetvendors/developers_1/users/delete-a-user.md): Deletes a user using the user's unique userId . Deleting a user will disable the ability for them to log into the vendor portal. Parameters Title Required? Type Description Min Length Max Length :userId true String The user's unique id you want to delete.
• [Reports](https://app.theneo.io/puppetvendors/developers_1/reports.md): The reports API allows you to query vendor-specific order information to generate reports to your needs.
  • [Retrieve a list of vendor-specific order information](https://app.theneo.io/puppetvendors/developers_1/reports/retrieve-a-list-of-vendor-specific-order-information.md): List all orders associated with the shop as well as a vendor resource Title Required? Type Description start false date Start date from when order reports should start - (GMT) -Format: YYYY-MM-DD E.g.: 2022-01-25 end false date End date from when order reports should stop - (GMT). Format: YYYY-MM-DD E.g.: 2022-06-30 vendorId true string Filter payouts only for a specific vendor by vendorId e.g.: 6315b3dbede5eb3c453b03c4 offset false integer The record count where the next result will start limit false integer Max: 100
• [Payouts](https://app.theneo.io/puppetvendors/developers_1/payouts.md): represent the money owed to your business partners, drop shippers, artists, and consignors. The payouts API allows you to query payouts information based on multiple parameters to meet your business requirements.
  • [Retrieve a list of payouts](https://app.theneo.io/puppetvendors/developers_1/payouts/retrieve-a-list-of-payouts.md): List all payouts associated with the shop resource. Title Required? Type Description Min Length Max Length start false date Start fetching payouts from order date (GMT). Format: YYYY-MM-DD E.g.: 2022-01-25 end false date End fetching payouts to order date (GMT). Format: YYYY-MM-DD E.g.: 2022-06-30 vendorId false string Filter payouts only for a specific vendor by vendorId status false string Whether the payout has been made or not. Possible values: paid / partial / unpaid fulfillment false string Whether the payout item has been fulfilled or not. Possible values: fulfilled / unfulfilled offset false integer The record count where the next result will start limit false integer Max: 100
• [Fulfillments](https://app.theneo.io/puppetvendors/developers_1/fulfillments.md): indicate whether items whether physical or digital have been fulfilled by you - the business owner or your vendors. The fulfillments API allows you to query fulfillment information based on multiple query parameters to meet your business requirements.
  • [Retrieve a list of fulfillments](https://app.theneo.io/puppetvendors/developers_1/fulfillments/retrieve-a-list-of-fulfillments.md): List all fulfillments associated with the shop resource. Title Required? Type Description Min Length Max Length start false date Start fetching fulfillments from order date (GMT). Format: YYYY-MM-DD E.g.: 2022-01-25 end false date End fetching fulfillments to order date (GMT). Format: YYYY-MM-DD E.g.: 2022-06-30 vendorId false string Filter payouts only for a specific vendor by vendorId fulfillment false string Whether the payout item has been fulfilled or not. Possible values: fulfilled / unfulfilled offset false integer The record count where the next result will start limit false integer Max: 100
  • [Create a fulfillment](https://app.theneo.io/puppetvendors/developers_1/fulfillments/create-a-fulfillment.md): Creates a fulfillment associated with an order. Please note to only fulfill items for one order at a time. Title Required? Type Description Min Length Max Length trackingNumber true string Unique tracking number provided by your shippingCarrier e.g.: GM99999999999 trackingUrl true string Tracking URL for the order items shippingCarrier true string Shipping Carrier/Tracking Company options. The list found at https://shopify.dev/api/admin-rest/2021-10/resources/fulfillment lineItemsToFulfill true array lineItems _id to fulfill can be found at list fulfillment items
• [Commissions](https://app.theneo.io/puppetvendors/developers_1/commissions.md): represent the money you keep for your services or profit before sending the payouts to your business partners, drop shippers, artists, and consignors. The commissions API allows you to query all commission information based on your vendors or skus.
  • [Retrieve a list of commissions by vendors](https://app.theneo.io/puppetvendors/developers_1/commissions/retrieve-a-list-of-commissions-by-vendors.md): List all commissions associated with the shop resource set at the vendor level.
  • [Retrieve a list of commissions by skus](https://app.theneo.io/puppetvendors/developers_1/commissions/retrieve-a-list-of-commissions-by-skus.md): List all commissions associated with the shop resource set at the sku level.