Example request:

curl --request GET \
    --get "http://localhost:8000/api/auth/email/verify/01JBQW8K7V2XZGHJK5MNPQRSTU/abc123...?expires=1234567890&signature=abc123..." \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/auth/email/verify/01JBQW8K7V2XZGHJK5MNPQRSTU/abc123..."
);

const params = {
    "expires": "1234567890",
    "signature": "abc123...",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, already verified):

{
    "message": "Email already verified"
}
 

Example response (200, success):

{
    "message": "Email verified successfully"
}
 

Example response (403, invalid signature):

{
    "message": "Invalid verification link"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost:8000/api/auth/email/verification-notification" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/auth/email/verification-notification"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "message": "Verification email sent"
}
 

Example response (200, already verified):

{
    "message": "Email already verified"
}
 

Example response (429, rate limited):

{
    "message": "Too many requests. Please try again later."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/auth/email/verification-status" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/auth/email/verification-status"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "verified": true
}
 

Example response (401, unauthenticated):

{
    "message": "Unauthenticated"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost:8000/api/user/two-factor-authentication" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"password\": \"secret123\"
}"

const url = new URL(
    "http://localhost:8000/api/user/two-factor-authentication"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "password": "secret123"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, success):

{
    "qr_code_svg": "<svg>...</svg>",
    "secret": "JBSWY3DPEHPK3PXP",
    "recovery_codes": [
        "abc123",
        "def456",
        "ghi789",
        "jkl012",
        "mno345",
        "pqr678",
        "stu901",
        "vwx234"
    ]
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost:8000/api/user/confirmed-two-factor-authentication" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"123456\"
}"

const url = new URL(
    "http://localhost:8000/api/user/confirmed-two-factor-authentication"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "code": "123456"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, success):

{
    "message": "Two-factor authentication confirmed successfully."
}
 

Example response (422, invalid code):

{
    "message": "Invalid authentication code."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request DELETE \
    "http://localhost:8000/api/user/two-factor-authentication" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"password\": \"secret123\"
}"

const url = new URL(
    "http://localhost:8000/api/user/two-factor-authentication"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "password": "secret123"
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, success):

{
    "message": "Two-factor authentication disabled successfully."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/user/two-factor-recovery-codes" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/user/two-factor-recovery-codes"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "recovery_codes": [
        "abc123",
        "def456",
        "ghi789",
        "jkl012",
        "mno345",
        "pqr678",
        "stu901",
        "vwx234"
    ]
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost:8000/api/user/two-factor-recovery-codes" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/user/two-factor-recovery-codes"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "recovery_codes": [
        "new123",
        "new456",
        "new789",
        "new012",
        "new345",
        "new678",
        "new901",
        "new234"
    ]
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost:8000/api/user/two-factor-sms" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/user/two-factor-sms"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "message": "SMS code sent successfully."
}
 

Example response (400, no phone):

{
    "message": "Phone number not set."
}
 

Example response (500, sms error):

{
    "message": "Failed to send SMS code.",
    "error": "Provider error"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost:8000/api/user/two-factor-sms/verify" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"123456\"
}"

const url = new URL(
    "http://localhost:8000/api/user/two-factor-sms/verify"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "code": "123456"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, success):

{
    "message": "SMS code verified successfully."
}
 

Example response (422, invalid):

{
    "message": "Invalid or expired code."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/keys" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/keys"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "data": [
        {
            "id": "01HQZX...",
            "name": "Production API Key",
            "key_prefix": "sk_live_abc123",
            "abilities": [
                "listings:read",
                "bids:create"
            ],
            "last_used_at": "2025-01-20T10:30:00Z",
            "last_used_ip": "192.168.1.1",
            "request_count": 1500,
            "expires_at": "2026-12-31T23:59:59Z",
            "is_active": true,
            "created_at": "2025-01-20T10:00:00Z"
        }
    ]
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost:8000/api/keys" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Production API Key\",
    \"abilities\": [
        \"listings:read\",
        \"bids:create\"
    ],
    \"expires_at\": \"2026-12-31T23:59:59Z\",
    \"ip_whitelist\": [
        \"192.168.1.1\"
    ],
    \"metadata\": [
        \"ab\"
    ]
}"

const url = new URL(
    "http://localhost:8000/api/keys"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Production API Key",
    "abilities": [
        "listings:read",
        "bids:create"
    ],
    "expires_at": "2026-12-31T23:59:59Z",
    "ip_whitelist": [
        "192.168.1.1"
    ],
    "metadata": [
        "ab"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):

{
    "data": {
        "id": "01HQZX...",
        "name": "Production API Key",
        "key": "sk_live_abc123...",
        "key_prefix": "sk_live_abc123",
        "abilities": [
            "listings:read",
            "bids:create"
        ],
        "expires_at": "2026-12-31T23:59:59Z",
        "created_at": "2025-01-20T10:00:00Z"
    },
    "message": "Save this key securely. It will not be shown again."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/keys/ab" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/keys/ab"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "data": {
        "id": "01HQZX...",
        "name": "Production API Key",
        "key_prefix": "sk_live_abc123",
        "abilities": [
            "listings:read",
            "bids:create"
        ],
        "last_used_at": "2025-01-20T10:30:00Z",
        "request_count": 1500,
        "is_active": true,
        "created_at": "2025-01-20T10:00:00Z"
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request DELETE \
    "http://localhost:8000/api/keys/ab" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"reason\": \"ab\"
}"

const url = new URL(
    "http://localhost:8000/api/keys/ab"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "reason": "ab"
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):

{
    "message": "API key revoked successfully"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost:8000/api/keys/ab/rotate" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/keys/ab/rotate"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (201):

{
    "data": {
        "id": "01HQZX...",
        "name": "Production API Key (rotated)",
        "key": "sk_live_xyz789...",
        "key_prefix": "sk_live_xyz789",
        "abilities": [
            "listings:read",
            "bids:create"
        ],
        "expires_at": "2026-12-31T23:59:59Z",
        "created_at": "2025-01-20T10:00:00Z"
    },
    "message": "Save this key securely. It will not be shown again."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/integrations/webhook-subscriptions?page=1" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/integrations/webhook-subscriptions"
);

const params = {
    "page": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": [
        {
            "id": "01JXYZ...",
            "tenant_id": "01JTENANT...",
            "name": "ERP Webhooks",
            "status": "active",
            "target_url": "https://example.com/hooks",
            "event_types": [
                "payment.v1.succeeded"
            ],
            "filters": [],
            "payload_mode": "hybrid",
            "consecutive_failures": 0,
            "paused_at": null,
            "last_delivery_at": null,
            "next_secret_valid_until": null,
            "created_at": "2026-02-27T17:00:00Z",
            "updated_at": "2026-02-27T17:00:00Z"
        }
    ],
    "links": {
        "first": "...",
        "last": "...",
        "prev": null,
        "next": "..."
    },
    "meta": {
        "current_page": 1,
        "per_page": 15
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost:8000/api/integrations/webhook-subscriptions" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ERP Webhooks\",
    \"target_url\": \"https:\\/\\/example.com\\/hooks\",
    \"event_types\": [
        \"bid.v1.placed\",
        \"order.v1.shipped\"
    ],
    \"filters\": [
        \"01JORDER...\"
    ],
    \"payload_mode\": \"hybrid\",
    \"metadata\": [
        \"erp\"
    ]
}"

const url = new URL(
    "http://localhost:8000/api/integrations/webhook-subscriptions"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "ERP Webhooks",
    "target_url": "https:\/\/example.com\/hooks",
    "event_types": [
        "bid.v1.placed",
        "order.v1.shipped"
    ],
    "filters": [
        "01JORDER..."
    ],
    "payload_mode": "hybrid",
    "metadata": [
        "erp"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201, success):

{
    "data": {
        "id": "01JXYZ...",
        "tenant_id": "01JTENANT...",
        "name": "ERP Webhooks",
        "status": "active",
        "target_url": "https://example.com/hooks",
        "event_types": [
            "bid.v1.placed",
            "order.v1.shipped"
        ],
        "filters": [],
        "payload_mode": "hybrid",
        "consecutive_failures": 0,
        "paused_at": null,
        "last_delivery_at": null,
        "next_secret_valid_until": null,
        "created_at": "2026-02-27T17:00:00Z",
        "updated_at": "2026-02-27T17:00:00Z"
    },
    "signing_secret": "abcdefghijklmnopqrstuvwxyz123456",
    "signing_secret_last4": "3456"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/integrations/webhook-subscriptions/ab" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/integrations/webhook-subscriptions/ab"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": {
        "id": "01JXYZ...",
        "tenant_id": "01JTENANT...",
        "name": "ERP Webhooks",
        "status": "active",
        "target_url": "https://example.com/hooks",
        "event_types": [
            "payment.v1.succeeded"
        ],
        "filters": [],
        "payload_mode": "hybrid",
        "consecutive_failures": 0
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PATCH \
    "http://localhost:8000/api/integrations/webhook-subscriptions/ab" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ERP Webhooks (Primary)\",
    \"target_url\": \"https:\\/\\/example.com\\/new-hooks\",
    \"event_types\": [
        \"bid.v1.placed\"
    ],
    \"filters\": [
        \"01JCAT...\"
    ],
    \"payload_mode\": \"reference\",
    \"metadata\": [
        \"erp-v2\"
    ]
}"

const url = new URL(
    "http://localhost:8000/api/integrations/webhook-subscriptions/ab"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "ERP Webhooks (Primary)",
    "target_url": "https:\/\/example.com\/new-hooks",
    "event_types": [
        "bid.v1.placed"
    ],
    "filters": [
        "01JCAT..."
    ],
    "payload_mode": "reference",
    "metadata": [
        "erp-v2"
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, success):

{
    "data": {
        "id": "01JXYZ...",
        "status": "active",
        "payload_mode": "reference"
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request DELETE \
    "http://localhost:8000/api/integrations/webhook-subscriptions/ab" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/integrations/webhook-subscriptions/ab"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (204, success):

Empty response
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost:8000/api/integrations/webhook-subscriptions/ab/pause" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/integrations/webhook-subscriptions/ab/pause"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": {
        "id": "01JXYZ...",
        "status": "paused",
        "paused_at": "2026-02-27T17:10:00Z"
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost:8000/api/integrations/webhook-subscriptions/ab/resume" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/integrations/webhook-subscriptions/ab/resume"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": {
        "id": "01JXYZ...",
        "status": "active",
        "paused_at": null
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost:8000/api/integrations/webhook-subscriptions/ab/rotate-secret" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/integrations/webhook-subscriptions/ab/rotate-secret"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": {
        "id": "01JXYZ...",
        "next_secret_valid_until": "2026-02-28T17:00:00Z"
    },
    "signing_secret": "newsecretvalue123",
    "signing_secret_last4": "e123"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/integrations/webhook-subscriptions/ab/deliveries?outcome=delivered&limit=50" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"outcome\": \"failed\",
    \"limit\": 16
}"

const url = new URL(
    "http://localhost:8000/api/integrations/webhook-subscriptions/ab/deliveries"
);

const params = {
    "outcome": "delivered",
    "limit": "50",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "outcome": "failed",
    "limit": 16
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, success):

{
    "data": [
        {
            "id": "01JDELIVERY...",
            "delivery_id": "01JDELIVERGROUP...",
            "tenant_id": "01JTENANT...",
            "subscription_id": "01JXYZ...",
            "integration_event_id": "01JEVENT...",
            "event_id": "f9d69bc6-9f2b-4d7d-9557-f6d71f3f2c80",
            "event_type": "payment.v1.succeeded",
            "attempt_number": 1,
            "scheduled_at": "2026-02-27T17:00:10Z",
            "sent_at": "2026-02-27T17:00:11Z",
            "completed_at": "2026-02-27T17:00:12Z",
            "outcome": "delivered",
            "http_status": 200,
            "latency_ms": 120,
            "error_code": null,
            "error_message": null,
            "next_attempt_at": null,
            "is_replay": false,
            "created_at": "2026-02-27T17:00:10Z"
        }
    ],
    "links": {
        "first": "...",
        "last": "..."
    },
    "meta": {
        "current_page": 1
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/integrations/deliveries/ab" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/integrations/deliveries/ab"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": {
        "id": "01JDELIVERY...",
        "delivery_id": "01JDELIVERGROUP...",
        "tenant_id": "01JTENANT...",
        "subscription_id": "01JXYZ...",
        "integration_event_id": "01JEVENT...",
        "event_id": "f9d69bc6-9f2b-4d7d-9557-f6d71f3f2c80",
        "event_type": "payment.v1.succeeded",
        "attempt_number": 1,
        "scheduled_at": "2026-02-27T17:00:10Z",
        "sent_at": "2026-02-27T17:00:11Z",
        "completed_at": "2026-02-27T17:00:12Z",
        "outcome": "delivered",
        "http_status": 200,
        "latency_ms": 120,
        "error_code": null,
        "error_message": null,
        "next_attempt_at": null,
        "is_replay": false,
        "created_at": "2026-02-27T17:00:10Z"
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost:8000/api/integrations/deliveries/ab/redeliver" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/integrations/deliveries/ab/redeliver"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (202, accepted):

{
    "data": {
        "id": "01JNEWDELIVERY...",
        "delivery_id": "01JNEWGROUP...",
        "tenant_id": "01JTENANT...",
        "subscription_id": "01JXYZ...",
        "integration_event_id": "01JEVENT...",
        "attempt_number": 1,
        "outcome": "queued",
        "is_replay": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/integrations/events?cursor=eyJvY2N1cnJlZF9hdCI6IjIwMjYtMDItMjdUMTc6MDA6MDBaIiwiaWQiOiIwMUpFVkVOVC4uLiJ9&limit=100&event_types[]=bid.v1.placed&event_types[]=order.v1.shipped&from=2026-02-27T00%3A00%3A00Z&to=2026-02-28T00%3A00%3A00Z" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"cursor\": \"ab\",
    \"limit\": 7,
    \"event_types\": [
        \"supply.item.v1.listing_submitted_for_approval\"
    ],
    \"from\": \"2026-05-04T20:47:20\",
    \"to\": \"2069-05-25\"
}"

const url = new URL(
    "http://localhost:8000/api/integrations/events"
);

const params = {
    "cursor": "eyJvY2N1cnJlZF9hdCI6IjIwMjYtMDItMjdUMTc6MDA6MDBaIiwiaWQiOiIwMUpFVkVOVC4uLiJ9",
    "limit": "100",
    "event_types[0]": "bid.v1.placed",
    "event_types[1]": "order.v1.shipped",
    "from": "2026-02-27T00:00:00Z",
    "to": "2026-02-28T00:00:00Z",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "cursor": "ab",
    "limit": 7,
    "event_types": [
        "supply.item.v1.listing_submitted_for_approval"
    ],
    "from": "2026-05-04T20:47:20",
    "to": "2069-05-25"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, success):

{
    "data": [
        {
            "event_id": "f9d69bc6-9f2b-4d7d-9557-f6d71f3f2c80",
            "event_type": "payment.v1.succeeded",
            "schema_version": 1,
            "occurred_at": "2026-02-27T17:01:00Z",
            "tenant_id": "01JTENANT...",
            "idempotency_key": "01JTENANT...:payment.v1.succeeded:01JPAY...",
            "resource": {
                "type": "payment",
                "id": "01JPAY..."
            },
            "data": {
                "order_id": "01JORDER...",
                "amount_minor": 550000,
                "currency": "USD"
            }
        }
    ],
    "next_cursor": "eyJvY2N1cnJlZF9hdCI6IjIwMjYtMDItMjdUMTc6MDE6MDBaIiwiaWQiOiIwMUpFVkVOVC4uLiJ9"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost:8000/api/integrations/replays" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"subscription_id\": \"01JXYZ...\",
    \"from\": \"2026-02-27T00:00:00Z\",
    \"to\": \"2026-02-28T00:00:00Z\",
    \"event_types\": [
        \"order.v1.shipped\"
    ]
}"

const url = new URL(
    "http://localhost:8000/api/integrations/replays"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "subscription_id": "01JXYZ...",
    "from": "2026-02-27T00:00:00Z",
    "to": "2026-02-28T00:00:00Z",
    "event_types": [
        "order.v1.shipped"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202, accepted):

{
    "accepted": true,
    "subscription_id": "01JXYZ..."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/profile" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/profile"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "user": {
        "id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
        "name": "John Doe",
        "email": "john@example.com",
        "profile": {
            "display_name": "John",
            "bio": "Collector",
            "website": "https://..."
        },
        "addresses": [],
        "payment_methods": []
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PUT \
    "http://localhost:8000/api/profile" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"John Doe\",
    \"email\": \"john@example.com\",
    \"phone\": \"+447700900000\"
}"

const url = new URL(
    "http://localhost:8000/api/profile"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "+447700900000"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, success):

{
    "message": "Profile updated successfully."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PUT \
    "http://localhost:8000/api/profile/details" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"display_name\": \"John the Collector\",
    \"bio\": \"Vintage camera collector since 1995\",
    \"website\": \"https:\\/\\/johndoe.com\",
    \"social_links\": {
        \"twitter\": \"johndoe\",
        \"instagram\": \"johndoe\"
    }
}"

const url = new URL(
    "http://localhost:8000/api/profile/details"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "display_name": "John the Collector",
    "bio": "Vintage camera collector since 1995",
    "website": "https:\/\/johndoe.com",
    "social_links": {
        "twitter": "johndoe",
        "instagram": "johndoe"
    }
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, success):

{
    "message": "Profile updated successfully.",
    "profile": {
        "display_name": "John the Collector",
        "bio": "..."
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/profile/avatar" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/profile/avatar"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

Binary image stream (content-type: image/jpeg or image/png)
 

Example response (404, no avatar):

Empty 404 when user has no avatar
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost:8000/api/profile/avatar" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "avatar=@/private/var/folders/40/p9d183kj4j78wtdbrp4kflth0000gn/T/php669ajftb1qf58G14PrP" 

const url = new URL(
    "http://localhost:8000/api/profile/avatar"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('avatar', document.querySelector('input[name="avatar"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Example response (200, success):

{
    "message": "Avatar uploaded successfully.",
    "avatar_url": "https://s3.amazonaws.com/..."
}
 

Example response (422, validation error):

{
    "message": "The avatar field is required.",
    "errors": {
        "avatar": [
            "The avatar field is required."
        ]
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request DELETE \
    "http://localhost:8000/api/profile/avatar" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/profile/avatar"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "message": "Avatar deleted successfully."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/addresses" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/addresses"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "addresses": [
        {
            "id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
            "type": "shipping",
            "full_name": "John Doe",
            "address_line_1": "123 Main St",
            "city": "London",
            "postal_code": "SW1A 1AA",
            "country": "GB",
            "is_default": true
        }
    ]
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost:8000/api/addresses" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"shipping\",
    \"label\": \"Home\",
    \"is_default\": true,
    \"full_name\": \"John Doe\",
    \"company\": \"Acme Corp\",
    \"address_line_1\": \"123 Main Street\",
    \"address_line_2\": \"Apt 4B\",
    \"city\": \"London\",
    \"state\": \"Greater London\",
    \"postal_code\": \"SW1A 1AA\",
    \"country\": \"GB\",
    \"phone\": \"+447700900000\"
}"

const url = new URL(
    "http://localhost:8000/api/addresses"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "shipping",
    "label": "Home",
    "is_default": true,
    "full_name": "John Doe",
    "company": "Acme Corp",
    "address_line_1": "123 Main Street",
    "address_line_2": "Apt 4B",
    "city": "London",
    "state": "Greater London",
    "postal_code": "SW1A 1AA",
    "country": "GB",
    "phone": "+447700900000"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201, success):

{
    "message": "Address created successfully.",
    "address": {
        "id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
        "type": "shipping",
        "full_name": "John Doe"
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/addresses/ab" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/addresses/ab"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "address": {
        "id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
        "type": "shipping",
        "full_name": "John Doe",
        "address_line_1": "123 Main St",
        "city": "London",
        "postal_code": "SW1A 1AA",
        "country": "GB",
        "is_default": true
    }
}
 

Example response (403, unauthorized):

{
    "message": "This action is unauthorized."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PUT \
    "http://localhost:8000/api/addresses/ab" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"shipping\",
    \"label\": \"ipzdszigdqrrkthq\",
    \"is_default\": false,
    \"full_name\": \"pvviwahfxqnyifdn\",
    \"company\": \"nzclnhfpvmsnpkyn\",
    \"address_line_1\": \"lnbgjdpzixzkhgml\",
    \"address_line_2\": \"xfmavknkckbhgmqy\",
    \"city\": \"eipywyxscplvrjza\",
    \"state\": \"qaveihafwfciilry\",
    \"postal_code\": \"ubypsenryjd\",
    \"country\": \"uo\",
    \"phone\": \"rkexffnsuub\"
}"

const url = new URL(
    "http://localhost:8000/api/addresses/ab"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "shipping",
    "label": "ipzdszigdqrrkthq",
    "is_default": false,
    "full_name": "pvviwahfxqnyifdn",
    "company": "nzclnhfpvmsnpkyn",
    "address_line_1": "lnbgjdpzixzkhgml",
    "address_line_2": "xfmavknkckbhgmqy",
    "city": "eipywyxscplvrjza",
    "state": "qaveihafwfciilry",
    "postal_code": "ubypsenryjd",
    "country": "uo",
    "phone": "rkexffnsuub"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, success):

{
    "message": "Address updated successfully.",
    "address": {
        "id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
        "type": "shipping",
        "full_name": "John Doe"
    }
}
 

Example response (403, unauthorized):

{
    "message": "This action is unauthorized."
}
 

Example response (422, validation error):

{
    "message": "The given data was invalid.",
    "errors": {
        "postal_code": [
            "The postal code field is required."
        ]
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request DELETE \
    "http://localhost:8000/api/addresses/ab" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/addresses/ab"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "message": "Address deleted successfully."
}
 

Example response (403, unauthorized):

{
    "message": "This action is unauthorized."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost:8000/api/addresses/ab/default" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/addresses/ab/default"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "message": "Address set as default successfully.",
    "address": {
        "id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
        "is_default": true
    }
}
 

Example response (403, unauthorized):

{
    "message": "This action is unauthorized."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/payment-methods" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/payment-methods"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "payment_methods": [
        {
            "id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
            "type": "card",
            "brand": "visa",
            "last_four": "4242",
            "exp_month": 12,
            "exp_year": 2025,
            "is_default": true,
            "billing_address": {
                "address_line_1": "123 Main St",
                "city": "London",
                "postal_code": "SW1A 1AA",
                "country": "GB"
            }
        }
    ]
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost:8000/api/payment-methods" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"stripe_payment_method_id\": \"pm_1234567890abcdef\",
    \"billing_address_id\": \"01JBQW8K7V2XZGHJK5MNPQRSTU\",
    \"is_default\": true
}"

const url = new URL(
    "http://localhost:8000/api/payment-methods"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "stripe_payment_method_id": "pm_1234567890abcdef",
    "billing_address_id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
    "is_default": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201, success):

{
    "message": "Payment method added successfully.",
    "payment_method": {
        "id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
        "type": "card",
        "brand": "visa",
        "last_four": "4242",
        "is_default": true
    }
}
 

Example response (422, invalid address):

{
    "message": "Invalid billing address."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/payment-methods/ab" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/payment-methods/ab"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "payment_method": {
        "id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
        "type": "card",
        "brand": "visa",
        "last_four": "4242",
        "exp_month": 12,
        "exp_year": 2025,
        "is_default": true,
        "billing_address": {
            "address_line_1": "123 Main St",
            "city": "London",
            "postal_code": "SW1A 1AA",
            "country": "GB"
        }
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PUT \
    "http://localhost:8000/api/payment-methods/ab" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"billing_address_id\": \"01JBQW8K7V2XZGHJK5MNPQRSTU\",
    \"is_default\": true
}"

const url = new URL(
    "http://localhost:8000/api/payment-methods/ab"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "billing_address_id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
    "is_default": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, success):

{
    "message": "Payment method updated successfully.",
    "payment_method": {
        "id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
        "is_default": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request DELETE \
    "http://localhost:8000/api/payment-methods/ab" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/payment-methods/ab"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "message": "Payment method deleted successfully."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost:8000/api/payment-methods/ab/default" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/payment-methods/ab/default"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "message": "Payment method set as default successfully.",
    "payment_method": {
        "id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
        "is_default": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost:8000/api/payment-methods/setup-intent" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/payment-methods/setup-intent"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "client_secret": "seti_1234567890abcdef_secret_1234567890abcdef"
}
 

Example response (500, stripe error):

{
    "message": "Failed to create setup intent.",
    "error": "Stripe error message"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost:8000/api/kyc/session" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/kyc/session"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "client_secret": "vs_1234567890abcdef_secret_1234567890abcdef"
}
 

Example response (400, already verified):

{
    "message": "KYC already verified."
}
 

Example response (500, provider error):

{
    "message": "Failed to create verification session."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/kyc/status" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/kyc/status"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, verified):

{
    "status": "verified",
    "verified_at": "2025-10-29T10:00:00.000000Z",
    "last_error": null
}
 

Example response (200, processing):

{
    "status": "processing",
    "verified_at": null,
    "last_error": null
}
 

Example response (200, none):

{
    "status": "none",
    "message": "No verification found."
}
 

Example response (200, failed):

{
    "status": "requires_input",
    "verified_at": null,
    "last_error": "Document image quality too low"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost:8000/api/kyc/retry" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/kyc/retry"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "client_secret": "vs_1234567890abcdef_secret_1234567890abcdef"
}
 

Example response (400, already verified):

{
    "message": "KYC already verified."
}
 

Example response (400, pending):

{
    "message": "Verification is still pending. Please wait."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/listings?category_id=01JBQW8K7V2XZGHJK5MNPQRSTU&include_descendants=1&status=live&condition=excellent&listing_type=fixed_price&is_fixed_price=1&fixed_price_min=1000&fixed_price_max=50000&price_min=10000&price_max=50000&has_buy_now=1&is_phygital=&per_page=20" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/listings"
);

const params = {
    "category_id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
    "include_descendants": "1",
    "status": "live",
    "condition": "excellent",
    "listing_type": "fixed_price",
    "is_fixed_price": "1",
    "fixed_price_min": "1000",
    "fixed_price_max": "50000",
    "price_min": "10000",
    "price_max": "50000",
    "has_buy_now": "1",
    "is_phygital": "0",
    "per_page": "20",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": [
        {
            "id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
            "title": "Vintage Camera",
            "description": "...",
            "starting_bid": 10000,
            "buy_now_price": 25000,
            "condition": "excellent",
            "status": "live",
            "is_phygital": false,
            "category": {
                "id": "...",
                "name": "Electronics"
            },
            "user": {
                "id": "...",
                "name": "John Seller"
            },
            "media": [
                {
                    "id": "...",
                    "url": "...",
                    "is_primary": true
                }
            ]
        }
    ],
    "links": {
        "first": "...",
        "last": "...",
        "prev": null,
        "next": "..."
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 10,
        "per_page": 20,
        "to": 20,
        "total": 200
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/listings/ending-soon" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/listings/ending-soon"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": [
        {
            "id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
            "title": "Vintage Camera",
            "starting_bid": 10000,
            "status": "live",
            "end_time": "2025-10-30T10:00:00.000000Z"
        }
    ],
    "links": {},
    "meta": {}
}
 

Example response (404, tenant not found):

{
    "message": "Tenant context is required."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/listings/ab" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/listings/ab"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": {
        "id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
        "title": "Vintage Camera",
        "description": "Fully functional vintage camera...",
        "starting_bid": 10000,
        "buy_now_price": 25000,
        "condition": "excellent",
        "status": "live",
        "is_phygital": false,
        "view_count": 42,
        "category": {
            "id": "...",
            "name": "Electronics"
        },
        "user": {
            "id": "...",
            "name": "John Seller"
        },
        "media": [
            {
                "id": "...",
                "url": "...",
                "is_primary": true
            }
        ],
        "attributes": [
            {
                "category_attribute": {
                    "name": "Brand"
                },
                "value": "Canon"
            }
        ],
        "tags": [
            {
                "name": "vintage"
            },
            {
                "name": "camera"
            }
        ]
    }
}
 

Example response (404, not found):

{
    "message": "Listing not found"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/my-listings?per_page=20" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/my-listings"
);

const params = {
    "per_page": "20",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": [
        {
            "id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
            "title": "My Vintage Camera",
            "status": "live",
            "created_at": "2025-10-29T10:00:00.000000Z"
        }
    ],
    "links": {},
    "meta": {}
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost:8000/api/listings" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"listing_type\": \"english\",
    \"title\": \"Vintage Canon Camera\",
    \"description\": \"Fully functional vintage Canon camera from 1980s...\",
    \"category_id\": \"01JBQW8K7V2XZGHJK5MNPQRSTU\",
    \"condition\": \"excellent\",
    \"starting_bid\": 10000,
    \"reserve_price\": 15000,
    \"buy_now_price\": 25000,
    \"fixed_price_amount\": 95,
    \"quantity\": 8,
    \"allow_offers\": false,
    \"min_offer_percent\": 1,
    \"auto_accept_percent\": 1,
    \"estimate_low\": 42,
    \"estimate_high\": 3,
    \"bid_increment\": 96,
    \"start_time\": \"2069-05-25\",
    \"end_time\": \"2069-05-25\",
    \"item_location\": \"dszigdqrrkthqpvv\",
    \"shipping_cost\": 8,
    \"is_local_pickup\": true,
    \"is_international_shipping\": false,
    \"currency\": \"wah\",
    \"is_phygital\": false,
    \"nft_contract_address\": \"0x1234567890abcdef...\",
    \"nft_token_id\": \"123\",
    \"nft_blockchain\": \"polygon\",
    \"digital_asset_url\": \"https:\\/\\/gaylord.com\\/quia-dignissimos-tempore-sapiente-nihil-quod-voluptate-unde.html\",
    \"digital_asset_type\": \"avknkckbhgmqyeip\",
    \"tax_status\": \"margin_scheme\",
    \"custom_attributes\": [
        \"ab\"
    ],
    \"tags\": [
        \"vintage\",
        \"camera\",
        \"electronics\"
    ],
    \"media_ids\": [
        \"01JBQW8K7V2XZGHJK5MNPQRSTU\"
    ],
    \"sales_model\": \"seller_led\",
    \"price_display_mode\": \"inherit\",
    \"attributes\": [
        {
            \"category_attribute_id\": \"...\",
            \"value\": \"Canon\"
        }
    ]
}"

const url = new URL(
    "http://localhost:8000/api/listings"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "listing_type": "english",
    "title": "Vintage Canon Camera",
    "description": "Fully functional vintage Canon camera from 1980s...",
    "category_id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
    "condition": "excellent",
    "starting_bid": 10000,
    "reserve_price": 15000,
    "buy_now_price": 25000,
    "fixed_price_amount": 95,
    "quantity": 8,
    "allow_offers": false,
    "min_offer_percent": 1,
    "auto_accept_percent": 1,
    "estimate_low": 42,
    "estimate_high": 3,
    "bid_increment": 96,
    "start_time": "2069-05-25",
    "end_time": "2069-05-25",
    "item_location": "dszigdqrrkthqpvv",
    "shipping_cost": 8,
    "is_local_pickup": true,
    "is_international_shipping": false,
    "currency": "wah",
    "is_phygital": false,
    "nft_contract_address": "0x1234567890abcdef...",
    "nft_token_id": "123",
    "nft_blockchain": "polygon",
    "digital_asset_url": "https:\/\/gaylord.com\/quia-dignissimos-tempore-sapiente-nihil-quod-voluptate-unde.html",
    "digital_asset_type": "avknkckbhgmqyeip",
    "tax_status": "margin_scheme",
    "custom_attributes": [
        "ab"
    ],
    "tags": [
        "vintage",
        "camera",
        "electronics"
    ],
    "media_ids": [
        "01JBQW8K7V2XZGHJK5MNPQRSTU"
    ],
    "sales_model": "seller_led",
    "price_display_mode": "inherit",
    "attributes": [
        {
            "category_attribute_id": "...",
            "value": "Canon"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201, success):

{
    "data": {
        "id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
        "title": "Vintage Canon Camera",
        "status": "pending",
        "created_at": "2025-10-29T10:00:00.000000Z"
    }
}
 

Example response (422, validation error):

{
    "message": "The title field is required.",
    "errors": {
        "title": [
            "The title field is required."
        ]
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PUT \
    "http://localhost:8000/api/listings/ab" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"listing_type\": \"dutch\",
    \"title\": \"Updated Camera Title\",
    \"description\": \"Updated description...\",
    \"category_id\": \"01JBQW8K7V2XZGHJK5MNPQRSTU\",
    \"condition\": \"good\",
    \"starting_bid\": 12000,
    \"reserve_price\": 18000,
    \"buy_now_price\": 30000,
    \"fixed_price_amount\": 100,
    \"bid_increment\": 94,
    \"start_time\": \"2069-05-25\",
    \"end_time\": \"2069-05-25\",
    \"item_location\": \"dszigdqrrkthqpvv\",
    \"shipping_cost\": 8,
    \"is_local_pickup\": false,
    \"is_international_shipping\": false,
    \"quantity\": 41,
    \"allow_offers\": false,
    \"min_offer_percent\": 1,
    \"auto_accept_percent\": 2,
    \"currency\": \"fxq\",
    \"custom_attributes\": [
        \"ab\"
    ],
    \"tags\": [
        \"vintage\",
        \"camera\"
    ],
    \"media_ids\": [
        \"ab\"
    ],
    \"price_display_mode\": \"whole_units\",
    \"attributes\": [
        {
            \"category_attribute_id\": \"...\",
            \"value\": \"Canon\"
        }
    ]
}"

const url = new URL(
    "http://localhost:8000/api/listings/ab"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "listing_type": "dutch",
    "title": "Updated Camera Title",
    "description": "Updated description...",
    "category_id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
    "condition": "good",
    "starting_bid": 12000,
    "reserve_price": 18000,
    "buy_now_price": 30000,
    "fixed_price_amount": 100,
    "bid_increment": 94,
    "start_time": "2069-05-25",
    "end_time": "2069-05-25",
    "item_location": "dszigdqrrkthqpvv",
    "shipping_cost": 8,
    "is_local_pickup": false,
    "is_international_shipping": false,
    "quantity": 41,
    "allow_offers": false,
    "min_offer_percent": 1,
    "auto_accept_percent": 2,
    "currency": "fxq",
    "custom_attributes": [
        "ab"
    ],
    "tags": [
        "vintage",
        "camera"
    ],
    "media_ids": [
        "ab"
    ],
    "price_display_mode": "whole_units",
    "attributes": [
        {
            "category_attribute_id": "...",
            "value": "Canon"
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, success):

{
    "data": {
        "id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
        "title": "Updated Camera Title",
        "updated_at": "2025-10-29T10:30:00.000000Z"
    }
}
 

Example response (403, unauthorized):

{
    "message": "This action is unauthorized."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PATCH \
    "http://localhost:8000/api/listings/ab" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"listing_type\": \"sealed\",
    \"title\": \"Updated Camera Title\",
    \"description\": \"Updated description...\",
    \"category_id\": \"01JBQW8K7V2XZGHJK5MNPQRSTU\",
    \"condition\": \"good\",
    \"starting_bid\": 12000,
    \"reserve_price\": 18000,
    \"buy_now_price\": 30000,
    \"fixed_price_amount\": 100,
    \"bid_increment\": 94,
    \"start_time\": \"2069-05-25\",
    \"end_time\": \"2069-05-25\",
    \"item_location\": \"dszigdqrrkthqpvv\",
    \"shipping_cost\": 8,
    \"is_local_pickup\": true,
    \"is_international_shipping\": false,
    \"quantity\": 41,
    \"allow_offers\": false,
    \"min_offer_percent\": 1,
    \"auto_accept_percent\": 2,
    \"currency\": \"fxq\",
    \"custom_attributes\": [
        \"ab\"
    ],
    \"tags\": [
        \"vintage\",
        \"camera\"
    ],
    \"media_ids\": [
        \"ab\"
    ],
    \"price_display_mode\": \"inherit\",
    \"attributes\": [
        {
            \"category_attribute_id\": \"...\",
            \"value\": \"Canon\"
        }
    ]
}"

const url = new URL(
    "http://localhost:8000/api/listings/ab"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "listing_type": "sealed",
    "title": "Updated Camera Title",
    "description": "Updated description...",
    "category_id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
    "condition": "good",
    "starting_bid": 12000,
    "reserve_price": 18000,
    "buy_now_price": 30000,
    "fixed_price_amount": 100,
    "bid_increment": 94,
    "start_time": "2069-05-25",
    "end_time": "2069-05-25",
    "item_location": "dszigdqrrkthqpvv",
    "shipping_cost": 8,
    "is_local_pickup": true,
    "is_international_shipping": false,
    "quantity": 41,
    "allow_offers": false,
    "min_offer_percent": 1,
    "auto_accept_percent": 2,
    "currency": "fxq",
    "custom_attributes": [
        "ab"
    ],
    "tags": [
        "vintage",
        "camera"
    ],
    "media_ids": [
        "ab"
    ],
    "price_display_mode": "inherit",
    "attributes": [
        {
            "category_attribute_id": "...",
            "value": "Canon"
        }
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, success):

{
    "data": {
        "id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
        "title": "Updated Camera Title",
        "updated_at": "2025-10-29T10:30:00.000000Z"
    }
}
 

Example response (403, unauthorized):

{
    "message": "This action is unauthorized."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request DELETE \
    "http://localhost:8000/api/listings/ab" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/listings/ab"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "message": "Listing deleted successfully"
}
 

Example response (403, unauthorized):

{
    "message": "This action is unauthorized."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost:8000/api/listings/ab/purchase" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"quantity\": 1,
    \"shipping_address_id\": \"ab\"
}"

const url = new URL(
    "http://localhost:8000/api/listings/ab/purchase"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "quantity": 1,
    "shipping_address_id": "ab"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/categories" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/categories"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": [
        {
            "id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
            "name": "Electronics",
            "description": "Electronic items",
            "icon": "https://...",
            "sort_order": 1,
            "is_active": true,
            "children": [
                {
                    "id": "...",
                    "name": "Cameras",
                    "parent_id": "01JBQW8K7V2XZGHJK5MNPQRSTU"
                }
            ]
        }
    ]
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/categories/tree" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/categories/tree"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": [
        {
            "id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
            "name": "Electronics",
            "children": [
                {
                    "id": "...",
                    "name": "Cameras",
                    "children": [
                        {
                            "id": "...",
                            "name": "Digital Cameras"
                        }
                    ]
                }
            ]
        }
    ]
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/categories/ab" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/categories/ab"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": {
        "id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
        "name": "Cameras",
        "description": "Camera equipment",
        "icon": "https://...",
        "parent": {
            "id": "...",
            "name": "Electronics"
        },
        "children": [],
        "attributes": [
            {
                "name": "Brand",
                "type": "string"
            }
        ]
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/categories/ab/attributes" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/categories/ab/attributes"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": [
        {
            "id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
            "category_id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
            "name": "Brand",
            "type": "string",
            "is_required": true,
            "options": [
                "Canon",
                "Nikon",
                "Sony"
            ],
            "sort_order": 1
        }
    ]
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/categories/01JBQW8K7V2XZGHJK5MNPQRSTU/sections" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/categories/01JBQW8K7V2XZGHJK5MNPQRSTU/sections"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": [
        {
            "id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
            "name": "Condition",
            "fields": [
                {
                    "name": "condition",
                    "type": "string",
                    "required": true
                }
            ]
        }
    ]
}
 

Example response (404, category not found):

{
    "message": "Category not found."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/collections?status=live&type=themed&is_promoted=1" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/collections"
);

const params = {
    "status": "live",
    "type": "themed",
    "is_promoted": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{"data": [{"id": "01JBQXM0VSXV9H8NR5TZW68SW6", "name": "Spring Showcase", "slug": "spring-showcase", "type": "themed", "status": "live", "listings_count": 24}], "meta": {...}}
 

Example response (400, missing tenant):

{
    "message": "Tenant context is required. Please provide a valid X-Tenant-ID header or ensure IdentifyTenant middleware is active."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/collections/spring-showcase" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/collections/spring-showcase"
);

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": {
        "id": "01JBQXM0VSXV9H8NR5TZW68SW6",
        "name": "Spring Showcase",
        "slug": "spring-showcase",
        "type": "themed",
        "status": "live",
        "vendor": null,
        "event": null,
        "listings_count": 24
    }
}
 

Example response (404, not found):

{
    "message": "Collection not found."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/collections/01JBQXM0VSXV9H8NR5TZW68SW6/listings?category_id=01JBQXM0VSXV9H8NR5TZW68SW6&condition=excellent&price_min=10000&price_max=50000&search=vintage&listing_type=fixed_price&is_fixed_price=1&has_buy_now=1&sort=ending_soon" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/collections/01JBQXM0VSXV9H8NR5TZW68SW6/listings"
);

const params = {
    "category_id": "01JBQXM0VSXV9H8NR5TZW68SW6",
    "condition": "excellent",
    "price_min": "10000",
    "price_max": "50000",
    "search": "vintage",
    "listing_type": "fixed_price",
    "is_fixed_price": "1",
    "has_buy_now": "1",
    "sort": "ending_soon",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{"data": [{"id": "01JBQXQRGN9V5M8F6T7Y2X3Z4A", "title": "Vintage Rangefinder", "status": "live", "starting_bid": 100000}], "meta": {...}}
 

Example response (404, collection not found):

{
    "message": "Collection not found."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost:8000/api/auctions?event_id=01JBQW8K7V2XZGHJK5MNPQRSTU&status=live&category_id=01JBQW8K7V2XZGHJK5MNPQRSTU&include_descendants=1&per_page=15" \
    --header "Authorization: Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/auctions"
);

const params = {
    "event_id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
    "status": "live",
    "category_id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
    "include_descendants": "1",
    "per_page": "15",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_KEY_OR_SANCTUM_TOKEN_HERE",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": [
        {
            "id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
            "listing_id": "01JBQW8K7V2XZGHJK5MNPQRSTU",
            "status": "live",
            "current_bid": 15000,
            "bid_count": 12,
            "start_time": "2025-10-29T10:00:00.000000Z",
            "end_time": "2025-10-30T10:00:00.000000Z",
            "listing": {
                "title": "Vintage Camera",
                "starting_bid": 10000
            }
        }
    ],
    "links": {},
    "meta": {}
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.