Unique Product Webhook Documentation

Overview

The Unique Product Webhook is triggered whenever a product return is processed. It sends real-time updates about the status changes of unique products (PUIDs) when they are returned and processed, ensuring seamless tracking and synchronization of product lifecycle.

Tracked Statuses

The webhook is activated only for specific unique product statuses that occur during return processing:

Status	Description
TO_REFIT	Product needs repair or refurbishment
TO_RESTOCK	Product is ready to be restocked
OUT_OF_ORDER	Product is out of order
TO_REPAIR	Product needs repair
LOST	Product is lost

Webhook Payload

Whenever a product return is processed, the webhook sends the following payload:

{
    "omsOrderId": number,
    "uniqueProducts": [
        {
            "ean": "string",
            "puid": "string",
            "newStatus": "string",
            "previousStatus": "string"
        }
    ]
}

Example Payload

{
    "omsOrderId": 12345,
    "uniqueProducts": [
        {
            "ean": "1234567890123",
            "puid": "DTD123456",
            "newStatus": "TO_REFIT",
            "previousStatus": "AT_RENTER_HOME"
        },
        {
            "ean": "9876543210987",
            "puid": "DTD789012",
            "newStatus": "TO_RESTOCK",
            "previousStatus": "AT_RENTER_HOME"
        }
    ]
}

Webhook Endpoint Requirements

The external webhook must:

• Accept HTTP POST requests
• Support JSON payloads
• Respond with a 200 OK status to acknowledge receipt of the event

Webhook Activation Process

To activate the Unique Product Webhook for your system, please provide your webhook URL to one of our developers. We will configure the necessary integration and ensure the connection works properly. Contact our technical team to get started.