Skip to content
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://panorays-papi-v2-documentation.redocly.app/_mock/swagger
https://api.panoraysapp.com

Supplier

Use these routes to access and update your suppliers.

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Tags

Tag actions (Create, Delete, Get, Update) apply to company tags only. Tags can’t be updated via the supplier endpoint, as they may link to multiple suppliers. When a company tag is updated/deleted, all associated suppliers are automatically updated — no separate supplier update is needed.

Operations

Request

This endpoint will update the name of a tag.

Security
bearer
Bodyapplication/jsonrequired
object(UpdateTagDto)
curl -i -X PUT \
  'https://panorays-papi-v2-documentation.redocly.app/_mock/swagger/v2/tags/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

An object of the tag.

Bodyapplication/json
object(GetTagOutputDto)
Response
application/json
{}

Request

This endpoint will delete a tag.

Security
bearer
Path
idstringrequired
curl -i -X DELETE \
  'https://panorays-papi-v2-documentation.redocly.app/_mock/swagger/v2/tags/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

An object with field message with deletion status - Tag deleted successfully.

Bodyapplication/json
object(GetTagOutputDto)
Response
application/json
{}
Operations
Operations
Operations
Operations

Webhooks Intro

The hook api provides a simple way of registering to events that happen with your suppliers

Getting Started

The following steps will walk you through the process of registering and reacting to webhooks.

  1. Register an API token

If you don’t already have an API token, you can generate one through Panorays platform or contact Panorays Support at support@panorays.com.

  1. Register your app

Before you can start receiving events, register your application with Panorays using the Handshake API call.

  1. Subscribe to relevant events

You will only receive event calls for events you subscribe to using the Subscribe API call.
Note: You can unsubscribe at any time using the Unsubscribe API call.

  1. Start receiving events

You're done! From now on, you will receive notifications for every event you subscribed to.

To learn how to secure your app and ensure you handle events only from Panorays, read about Verifying requests.

Verify Requests

Panorays signs every request with a secret that's unique to your service account, using this secret you can verify that the incoming request arrived from Panorays servers.

Operations
Operations