FlavorCloud Partner API Documentation

Unsubscribe Webhooks

POST

/Webhooks/UnSubscribe

Webhooks

Unsubscribe to the Events.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Reference

string

optional

This field is for your reference. A good use of it would be to provide your order number or store name here.

Events

array[string]

required

Allowed values:

SHIPMENT_CREATEDSHIPMENT_COMPLETEDSHIPMENT_CANCELLEDSHIPMENT_CANCELLATION_ERRORSHIPMENT_ERRORRETURN_SHIPMENT_CREATEDRETURN_SHIPMENT_ERRORRETURN_SHIPMENT_CANCELLEDTRACKING_UPDATESORDER_PLACEDCONSOLIDATE_SHIPMENT_CREATEDCONSOLIDATE_SHIPMENT_ERROR

Example

{
    "Reference": "unsubscribe-webhook-001",
    "Events": [
        "SHIPMENT_CREATED"
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://partnerapi.flavorcloud.com/Webhooks/UnSubscribe' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Reference": "unsubscribe-webhook-001",
    "Events": [
        "SHIPMENT_CREATED"
    ]
}'

Responses

🟢200Un-Subscribe Webhooks Response

application/json

Body

Reference

string

required

This field is for your reference. A good use of it would be to provide your order number or store name here.

Status

string

required

Your FlavorCloud application id

Message

string

required

Your rest api key

Example

{
    "Reference": "string",
    "Status": "string",
    "Message": "string"
}

🟠401Authentication Error

🟠422Validation Error

🔴500Error Response

Modified at 2025-04-28 20:51:37

Subscribe Webhooks

Get Invoice Detail