Skip to main content

Zuper API Endpoints

The Zuper API endpoints the iPaaS.com integration calls, grouped by entity, with the region-specific base URL and authentication.

See what the Zuper integration can do →

Portal Info

The Zuper web portal is available at https://app.zuperpro.com.

API Endpoints Intro

The Zuper API is a REST API. Its base URL is region-specific and must be determined for your account before making calls.

To find your base URL:

  1. Call the Config API with your company login name:

POST https://accounts.zuperpro.com/api/config
Content-Type: application/json{ "company_name": "your-company-login-name" }

  1. Read the dc_api_url value from the response:

{ "dc_api_url": "https://us-west-1c.zuperpro.com", "company_name": "your-company-login-name", "env": "production" }

  1. Append /api to build your base URL:

https://us-west-1c.zuperpro.com/api

Sandbox base URL example: https://us-west-1c.zuperpro.com/api

Table of Contents

  • Customer Endpoints

  • Organization Endpoints

  • Invoice Endpoints

  • Jobs Endpoints

  • Location Endpoints

  • Product Endpoints

  • Product Categories Endpoints

  • Product Inventory Endpoints

  • User Endpoints

  • Webhook Endpoints

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}/activation

Organization Endpoints

Create an Organization (POST)

[Base URL]/organization

Update an Organization (PUT)

[Base URL]/organization/{id}

Invoice Endpoints

Get an Invoice by Id (GET)

[Base URL]/invoice/{id}

Get an Invoice by Filter (GET)

[Base URL]/invoice?filter.invoice_uid={id}

Jobs Endpoints

Get a Job by Id (GET)

[Base URL]/jobs/{id}

Get a Job's Notes by Job Id (GET)

[Base URL]/jobs/{id}/notes

Location 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]/products/category

Product Inventory Endpoints

Add or Update Product Stock (POST)

[Base URL]/product/{id}/update_stock

User 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}/update

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}

Authorization

Zuper authenticates with an API key. Every request includes your Zuper API key in the x-api-key request header. There is no separate token-exchange or authorization endpoint; the API key is created in your Zuper account (Settings > Account Settings > API Keys) and entered in the iPaaS.com subscription settings.

Related Documents

Related Articles
Did this answer your question?