Affiliate Links

get

Authorizations

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

OK

application/json

default

Error response

application/json

get

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/affiliate-links HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "wallet_id": "text",
    "enabled": true,
    "code": "text",
    "referer_type": "invalid",
    "tracking_length_days": 1,
    "apply_for_subscriptions": true,
    "discount_type": "none",
    "discount_amount": 1,
    "commission_type": "none",
    "commission_amount": 1,
    "created_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "created_at": "2025-08-21T15:12:05.436Z",
    "updated_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "updated_at": "2025-08-21T15:12:05.436Z"
  }
]

post

Authorizations

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Body

application/jsontext/jsonapplication/*+json

wallet_idstringRequired

enabledbooleanRequired

codestringRequired

referer_typestring · enumRequiredPossible values:

tracking_length_daysinteger · int32Required

apply_for_subscriptionsbooleanRequired

discount_typestring · enumRequiredPossible values:

discount_amountinteger · int64Required

commission_typestring · enumRequiredPossible values:

commission_amountinteger · int64Required

Responses

200

OK

application/json

default

Error response

application/json

post

HTTPcURLJavaScriptPython

POST /v1/stores/{storeId}/affiliate-links HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 220

{
  "wallet_id": "text",
  "enabled": true,
  "code": "text",
  "referer_type": "invalid",
  "tracking_length_days": 1,
  "apply_for_subscriptions": true,
  "discount_type": "none",
  "discount_amount": 1,
  "commission_type": "none",
  "commission_amount": 1
}

application/jsontext/jsonapplication/*+json

{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "wallet_id": "text",
  "enabled": true,
  "code": "text",
  "referer_type": "invalid",
  "tracking_length_days": 1,
  "apply_for_subscriptions": true,
  "discount_type": "none",
  "discount_amount": 1,
  "commission_type": "none",
  "commission_amount": 1,
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "created_at": "2025-08-21T15:12:05.436Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": "2025-08-21T15:12:05.436Z"
}

get

Authorizations

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

affiliateLinkIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

OK

application/json

default

Error response

application/json

get

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/affiliate-links/{affiliateLinkId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "wallet_id": "text",
  "enabled": true,
  "code": "text",
  "referer_type": "invalid",
  "tracking_length_days": 1,
  "apply_for_subscriptions": true,
  "discount_type": "none",
  "discount_amount": 1,
  "commission_type": "none",
  "commission_amount": 1,
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "created_at": "2025-08-21T15:12:05.436Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": "2025-08-21T15:12:05.436Z"
}

delete

Authorizations

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

affiliateLinkIdstring · flake-idRequiredExample: 411486491630370816

Responses

204

No Content

default

Error response

application/json

delete

HTTPcURLJavaScriptPython

DELETE /v1/stores/{storeId}/affiliate-links/{affiliateLinkId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

patch

Authorizations

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

affiliateLinkIdstring · flake-idRequiredExample: 411486491630370816

Body

application/jsontext/jsonapplication/*+json

enabledboolean | nullableOptional

codestring | nullableOptional

referer_typestring · enumOptionalPossible values:

tracking_length_daysinteger · int32 | nullableOptional

apply_for_subscriptionsboolean | nullableOptional

discount_typestring · enumOptionalPossible values:

discount_amountinteger · int64 | nullableOptional

commission_typestring · enumOptionalPossible values:

commission_amountinteger · int64 | nullableOptional

Responses

200

OK

application/json

default

Error response

application/json

patch

HTTPcURLJavaScriptPython

PATCH /v1/stores/{storeId}/affiliate-links/{affiliateLinkId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 201

{
  "enabled": true,
  "code": "text",
  "referer_type": "invalid",
  "tracking_length_days": 1,
  "apply_for_subscriptions": true,
  "discount_type": "none",
  "discount_amount": 1,
  "commission_type": "none",
  "commission_amount": 1
}

application/jsontext/jsonapplication/*+json

{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "wallet_id": "text",
  "enabled": true,
  "code": "text",
  "referer_type": "invalid",
  "tracking_length_days": 1,
  "apply_for_subscriptions": true,
  "discount_type": "none",
  "discount_amount": 1,
  "commission_type": "none",
  "commission_amount": 1,
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "created_at": "2025-08-21T15:12:05.436Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": "2025-08-21T15:12:05.436Z"
}