Portal/Instance Identifier: https://app.zuperpro.com
Finding Your API Base URL
Zuper's API base URL varies by your company's region and must be determined dynamically before making API calls.
To find the base URL:
Call the Config API to get your account's specific API URL:
POST https://accounts.zuperpro.com/api/config
Content-Type: application/json
{
"company_name": "your-company-login-name"
}
2. Extract the dc_api_url from the response:
{
"dc_api_url": "https://us-west-1c.zuperpro.com",
"company_name": "your-company-login-name",
"env": "production"
}3. Construct your API base URL by appending /api:
https://us-west-1c.zuperpro.com/api
Base URL:
Sandbox URL: https://us-west-1c.zuperpro.com/api
Table of Contents
Customer Endpoints
Get a Customer by Id: (GET)
[Base URL]/customers/{id}Create a Customer (POST)
[Base URL]/customers
Update a Customer (PUT)
[Base URL]/customers/{id}Deactivate a Customer (POST)
[Base URL]/customers/{id}/activationOrganization Endpoints
Create an Organization (POST)
[Base URL]/organization
Update an Organization (PUT)
[Base URL]/organization/{id}Invoice Endpoints
Get Invoice by Filter (ID) (GET)
[Base URL]/invoice?filter.invoice_uid={id}Get an Invoice by ID (GET)
[Base URL]/invoice/{id}Jobs Endpoints
Get a Job by ID (GET)
[Base URL]/jobs/{id}Jobs Note Endpoints
Get a Jobs Note by Job ID (GET)
[Base URL]/jobs/{id}/noteLocation Endpoints
Get all locations (GET)
[Base URL]/products/location
Create a location (POST)
[Base URL]/products/location
Update a location (PUT)
[Base URL]/products/location/{Id}Product Endpoints
Get a Product by Id (GET)
[Base URL]/product/{id}Create a Product (POST)
[Base URL]/product
Update a Product (PUT)
[Base URL]/product/{id}Product Categories Endpoints
Get All Product Categories (GET)
[Base URL]/product/category
Product Inventory Endpoint
Add or Update Product Stock (POST)
[Base URL]/product/{ProductId}/update_stockUser Endpoints
Get a User by Id (GET)
[Base URL]/user/{id}Create a User (POST)
[Base URL]/user
Update a User (PUT)
[Base URL]/user/{Id}Webhook Endpoints
Get All Webhooks (GET)
[Base URL]/service/notifications/webhook
Create a Webhook (POST)
[Base URL]/service/notifications/webhook
Update a Webhook (PUT)
[Base URL]/service/notifications/webhook/{id}Delete a Webhook (DELETE)
[Base URL]/service/notifications/webhook/{id}