Exports Logs

This endpoint allows you to export store logs

Scopes

scope.read - Scope Read Only

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

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

Query Params

event

enum<string>

optional

Allowed values:

product.createdproduct.updatedproduct.deletedproduct.status.changed.hiddenproduct.status.changed.salecustomer.createdcustomer.updatedcustomer.bannedcustomer.unbannedcustomer.add.to.groupcustomer.group.createdcustomer.group.updated

from

string

optional

Export Logs from a specific date

string

optional

Export Logs to a specific date

employee

integer

optional

Employee ID. Get a list of Employee IDs from here

Responses

🟢200Success

application/json

Body

status

integer

required

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

required

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

array [object {4}]

required

type

enum<string>

required

Event Type

Allowed values:

product_pricesorders

user

object

required

created_at

string

required

Webhook Creation Timestamp

url

string

required

Event URL

Example

{
    "status": 200,
    "success": true,
    "data": [
        {
            "type": "product-prices",
            "user": {
                "id": 46179442,
                "name": "الامين يوسف"
            },
            "created_at": "2024-10-14 11:53:55",
            "url": "https://zzzzzzz"
        },
        {
            "type": "orders",
            "user": {
                "id": 46179442,
                "name": "الامين يوسف"
            },
            "created_at": "2024-10-14 11:53:55",
            "url": "https://zzzzzzz"
        }
    ]
}

🟠401error_unauthorized_401

Request

Request samples

Responses