SeoclerksDevelopers

Reference

What the ids and values in other answers mean.

GET /categories

The service category tree

Scope: listings:read, or the broad read.

Parents first, in the site's order; not paginated. Services (type 0) only.

Parameters

NameWhereDescription
If-None-MatchheaderAn ETag from an earlier response.

Example request

curl "https://www.seoclerk.com/api/v1/categories" \
  -H "Authorization: Bearer $SEOCLERKS_API_KEY"

Response 200

A page of these in data, with meta.limit and meta.next_cursor.

FieldTypeDescription
idinteger
namestring
slugstring
parent_idinteger or null
depthinteger
listing_countinteger
urlstring
{
    "data": [
        {
            "id": 1024,
            "name": "Example",
            "slug": "string",
            "parent_id": 1024,
            "depth": 1,
            "listing_count": 1,
            "url": "https://www.seoclerk.com/example"
        }
    ],
    "meta": {
        "request_id": "9f2c4e1ab07d3351"
    }
}

Errors

GET /fee-schedule

What the site charges

Scope: balance:read, or the broad read.

The rates the site's own code charges.

Parameters

NameWhereDescription
If-None-MatchheaderAn ETag from an earlier response.

Example request

curl "https://www.seoclerk.com/api/v1/fee-schedule" \
  -H "Authorization: Bearer $SEOCLERKS_API_KEY"

Response 200

FieldTypeDescription
commissionobject
commission.percentnumber
commission.level_discountslist of object
commission.level_discounts[].seller_levelinteger
commission.level_discounts[].seller_labelstring
commission.level_discounts[].percentnumber
commission.adds_affiliate_excessboolean
commission.own_referral_percentnumber
commission.own_referral_minimummoney
commission.descriptionstring
direct_payobject
direct_pay.percentnumber
direct_pay.adds_affiliate_excessboolean
direct_pay.invoiced_frommoney
direct_pay.withdrawals_blocked_frommoney
direct_pay.descriptionstring
affiliateobject
affiliate.percentnumber
affiliate.direct_pay_percentnumber
affiliate.listing_minimum_percentnumber
affiliate.listing_maximum_percentnumber
affiliate.descriptionstring
buyer_service_feeobject or null
buyer_service_fee.amountmoney
buyer_service_fee.up_tomoney
withdrawal_feenullNo site fee.
deposit_feenullNo site fee.
{
    "data": {
        "commission": {
            "percent": 4.8,
            "level_discounts": [
                {}
            ],
            "adds_affiliate_excess": true,
            "own_referral_percent": 4.8,
            "own_referral_minimum": {
                "amount": "12.50",
                "currency": "USD"
            },
            "description": "A short description."
        },
        "direct_pay": {
            "percent": 4.8,
            "adds_affiliate_excess": true,
            "invoiced_from": {
                "amount": "12.50",
                "currency": "USD"
            },
            "withdrawals_blocked_from": {
                "amount": "12.50",
                "currency": "USD"
            },
            "description": "A short description."
        },
        "affiliate": {
            "percent": 4.8,
            "direct_pay_percent": 4.8,
            "listing_minimum_percent": 4.8,
            "listing_maximum_percent": 4.8,
            "description": "A short description."
        },
        "buyer_service_fee": {
            "amount": {
                "amount": "12.50",
                "currency": "USD"
            },
            "up_to": {
                "amount": "12.50",
                "currency": "USD"
            }
        },
        "withdrawal_fee": "string",
        "deposit_fee": "string"
    },
    "meta": {
        "request_id": "9f2c4e1ab07d3351"
    }
}

Errors

GET /order-statuses

What each order status means

Scope: orders:read, or the broad read.

Every value of an order's status; not paginated.

Parameters

NameWhereDescription
If-None-MatchheaderAn ETag from an earlier response.

Example request

curl "https://www.seoclerk.com/api/v1/order-statuses" \
  -H "Authorization: Bearer $SEOCLERKS_API_KEY"

Response 200

A page of these in data, with meta.limit and meta.next_cursor.

FieldTypeDescription
idinteger
namestring
descriptionstring
finalbooleanA finished order cannot be acted on.
{
    "data": [
        {
            "id": 1024,
            "name": "Example",
            "description": "A short description.",
            "final": true
        }
    ],
    "meta": {
        "request_id": "9f2c4e1ab07d3351"
    }
}

Errors