List advertiser terms

Prev Next
Get
/v1/publishers/{publisherId}/advertiser-terms

Returns programme terms and conditions (T&C) for the advertisers named in advertiserId. Use it to check an advertiser's commission, paid search, partner-type and deduplication rules before or after joining their programme; a partnership is not required. The caller needs any role on the publisher account {publisherId}. Results are ordered numerically by advertiserId, ascending. Read-only; no side effects.

Security
HTTP
Type bearer

Personal Access Token, sent as Authorization: Bearer <token>.

Path parameters
publisherId
stringRequired

Identifier of the publisher account.

Pattern^[0-9]+$
Example45678
Query parameters
advertiserId
array of stringRequired

Advertisers to return terms for; supply one id or several comma-separated, for example advertiserId=1001,1002. At most 50. Partnership is not required. An id that does not identify an existing advertiser, or identifies an advertiser with no stored terms, is omitted from results. Each id may appear only once.

Unique itemstrue
Example[ "1001", "1002" ]
Item Pattern^[0-9]+$
Item Example1001
Responses
200

Programme terms for the selected advertisers.

Headers
RateLimit-Limit
integer
Maximum number of requests you can make in a burst under your own rate limit. Absent when the request did not count against your own limit.
Minimum1
Example5
RateLimit-Remaining
integer
Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.
Minimum0
Example0
RateLimit-Reset
integer
Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.
Minimum0
Example1
{
  "results": [
    {
      "advertiserId": "1001",
      "updatedAt": "2026-01-21T09:44:06Z",
      "term": {
        "commission": {
          "transactionIncludeVat": false,
          "transactionIncludeDeliveryCharges": true,
          "transactionIncludeCreditCardsFees": false,
          "transactionIncludeGiftWrapping": false,
          "productCategoriesExcluded": true,
          "productCategoriesExcludedList": [
            "Category 1"
          ],
          "declineCommissionReasons": [
            "ORDER_CANCELED",
            "ORDER_RETURNED"
          ]
        },
        "searchEnginePromo": {
          "fullCommissionOnPaidSearch": true,
          "fullCommissionOnDirectLinks": false,
          "fullCommissionOnBrandNameUrl": false,
          "fullCommissionOnBrandNamePaidSearch": false,
          "fullCommissionOnBrandNameInNegativeKeywords": false,
          "fullCommissionOnDisplayAdsWithBrandVariation": false,
          "fullCommissionOnDisplayAdsWithMisspelling": false,
          "fullCommissionOnDisplayAdsWithBrandAndOtherKeywords": false,
          "fullCommissionOnPlaceShoppingAdsWithDirectLink": true,
          "allowToEarnCommissionsOnSpecificGroups": false,
          "commissionOnPaidSearchActivitySearchEngines": [
            "YAHOO"
          ],
          "commissionOnPaidSearchHasIneligibleKeywords": false,
          "activityOnComparisonShoppingServiceInSeparateAccount": false
        },
        "preferredPartnerTypes": {
          "allowedPartnerTypes": [
            "MEDIA_BROKERS"
          ],
          "promoTypesRestriction": false
        },
        "deduplication": {
          "isDeduplicationOnAdvertiserChannels": true,
          "deduplicationChannels": [
            "PPC_BRAND"
          ]
        },
        "additionalTerms": "

Additional programme terms (HTML).

", "brandingTerms": "

Branding terms (HTML).

" } }, { "advertiserId": "1002", "updatedAt": "2025-11-02T14:10:00Z", "term": { "commission": { "transactionIncludeVat": true, "transactionIncludeDeliveryCharges": false, "transactionIncludeCreditCardsFees": false, "transactionIncludeGiftWrapping": false, "productCategoriesExcluded": false, "declineCommissionReasons": [ "NOT_ELIGIBLE" ] }, "searchEnginePromo": { "fullCommissionOnPaidSearch": false, "allowToEarnCommissionsOnSpecificGroups": false, "commissionOnPaidSearchHasIneligibleKeywords": false, "activityOnComparisonShoppingServiceInSeparateAccount": false }, "preferredPartnerTypes": { "allowedPartnerTypes": [], "promoTypesRestriction": false }, "deduplication": { "isDeduplicationOnAdvertiserChannels": false, "deduplicationChannels": [] }, "additionalTerms": "

Short programme terms.

" } } ] }
Expand All
object
results
Array of object (AdvertiserProgrammeTermsListItem)

Programme terms for the requested advertisers that exist and have stored terms, ordered numerically by advertiserId, ascending.

Max items50
object

Programme terms for one requested advertiser.

advertiserId
string

Advertiser account identifier.

Pattern^[0-9]+$
Example1001
updatedAt
string (date-time)

UTC timestamp when these programme terms were last updated.

Example2026-01-21T09:44:06Z
term
object (Term)

Advertiser programme terms and conditions (T&C).

commission
object

Commission calculation and decline rules.

transactionIncludeVat
boolean

Whether commission is calculated on the transaction amount including VAT.

Examplefalse
transactionIncludeDeliveryCharges
boolean

Whether commission is calculated on the transaction amount including delivery charges.

Exampletrue
transactionIncludeCreditCardsFees
boolean

Whether commission is calculated on the transaction amount including credit card fees.

Examplefalse
transactionIncludeGiftWrapping
boolean

Whether commission is calculated on the transaction amount including gift-wrapping charges.

Examplefalse
productCategoriesExcluded
boolean

Whether some product categories are excluded from commission. When true, productCategoriesExcludedList names those categories.

Exampletrue
productCategoriesExcludedList
Array of string

Product categories excluded from commission. Not empty when productCategoriesExcluded is true.

Example[ "Category 1" ]
string
declineCommissionReasons
Array of string

Reasons the advertiser may decline a commission. May be empty when no decline reasons are configured.

Unique itemstrue
Example[ "ORDER_CANCELED", "ORDER_RETURNED" ]
string
Valid values[ "ORDER_CANCELED", "ORDER_RETURNED", "ORDER_PARTIALLY_RETURNED", "NOT_ELIGIBLE", "MIN_ORDER_VALUE", "COUPON_NOT_ALLOWED", "NOT_VALID_CUSTOMER", "NOT_VALID_ORDER", "ORDER_NOT_FULFILLED", "CREDIT_FAILED", "PPC_TERMS_NOT_MET", "QUERY_WINDOW_PASSED", "COMMISSION_ALREADY_PAID", "ORDER_REF_NOT_FOUND", "ORDER_NOT_FOUND", "CONVERSION_DIFFERENT_CHANNEL", "CONVERSION_DIFFERENT_PARTNER", "PROGRAMME_NOT_ACTIVE", "BUSINESS_CLOSED", "OTHER" ]
declineCommissionOtherReasonsNotes
string

Free-text explanation used when declineCommissionReasons contains OTHER, in which case it is not blank.

ExampleCommission declined for a reason agreed in the programme terms.
searchEnginePromo
object

Paid search and promotional activity rules.

fullCommissionOnPaidSearch
boolean

Whether the publisher earns full commission on paid-search traffic.

Exampletrue
fullCommissionOnDirectLinks
boolean

Whether the publisher earns full commission on traffic from direct links. Omitted when fullCommissionOnPaidSearch is false.

Examplefalse
fullCommissionOnBrandNameUrl
boolean

Whether the publisher earns full commission when the brand name appears in the destination URL. Omitted when fullCommissionOnPaidSearch is false.

Examplefalse
fullCommissionOnBrandNamePaidSearch
boolean

Whether the publisher earns full commission on paid search that bids on the brand name. Omitted when fullCommissionOnPaidSearch is false.

Examplefalse
fullCommissionOnBrandNameInNegativeKeywords
boolean

Whether the publisher still earns full commission when the brand name is present only as a negative keyword (the campaign excludes the brand rather than bidding on it). Omitted when fullCommissionOnPaidSearch is false.

Examplefalse
fullCommissionOnDisplayAdsWithBrandVariation
boolean

Whether the publisher earns full commission on display ads that use a variation of the brand name. Omitted when fullCommissionOnPaidSearch is false.

Examplefalse
fullCommissionOnDisplayAdsWithMisspelling
boolean

Whether the publisher earns full commission on display ads that use a misspelling of the brand name. Omitted when fullCommissionOnPaidSearch is false.

Examplefalse
fullCommissionOnDisplayAdsWithBrandAndOtherKeywords
boolean

Whether the publisher earns full commission on display ads that combine the brand name with other keywords. Omitted when fullCommissionOnPaidSearch is false.

Examplefalse
fullCommissionOnPlaceShoppingAdsWithDirectLink
boolean

Whether the publisher earns full commission on shopping ads that use a direct link to the advertiser. Omitted when fullCommissionOnPaidSearch is false.

Exampletrue
allowToEarnCommissionsOnSpecificGroups
boolean

Whether commission on paid search is limited to specific publisher groups. When true, allowToEarnCommissionsOnSpecificGroupsDetails describes those groups.

Examplefalse
allowToEarnCommissionsOnSpecificGroupsDetails
string

Which publisher groups may earn commission on paid search, as plain text. Present and not blank when allowToEarnCommissionsOnSpecificGroups is true; else omitted.

ExampleApproved brand-bidding partners only.
commissionOnPaidSearchActivitySearchEngines
Array of string

Search engines on which paid-search activity is allowed. At least one search engine is present when fullCommissionOnPaidSearch is true; omitted when it is false.

Unique itemstrue
Example[ "YAHOO" ]
string
Valid values[ "GOOGLE", "YAHOO", "BING", "OTHER" ]
commissionOnPaidSearchActivitySearchOtherNotes
string

Notes for search engines other than the listed ones, as plain text. Present when commissionOnPaidSearchActivitySearchEngines contains OTHER.

ExampleRegional search engines agreed with the advertiser.
commissionOnPaidSearchHasIneligibleKeywords
boolean

Whether some keywords are ineligible for paid-search commission. When true, commissionOnPaidSearchIneligibleKeywords lists them.

Examplefalse
commissionOnPaidSearchIneligibleKeywords
Array of string

Keywords that do not earn paid-search commission. Not empty, with no blank entries, when commissionOnPaidSearchHasIneligibleKeywords is true.

Example[ "competitor-brand" ]
string
activityOnComparisonShoppingServiceInSeparateAccount
boolean

Whether comparison-shopping activity must run in an account separate from the publisher's other paid-search activity.

Examplefalse
preferredPartnerTypes
object

Allowed partner types and promo restrictions.

allowedPartnerTypes
Array of string

Publisher types the advertiser allows to promote the programme. Must contain at least one type.

Unique itemstrue
Example[ "MEDIA_BROKERS" ]
string
Valid values[ "CSS", "COMMUNITIES_UGC", "COMPARISON_ENGINE", "EDITORIAL_CONTENT", "MEDIA_CONTENT", "LEAD_GENERATION_CONTENT", "SHOPPING_DIRECTORY", "CONTENT_CREATORS_AND_INFLUENCERS", "RETARGETING_DISPLAY", "CONTEXTUAL_TARGETING", "DIRECT_TRAFFIC", "MEDIA_BROKERS", "MOBILE_TRAFFIC", "SOCIAL_TRAFFIC", "AD_NETWORKS", "LEAD_GENERATION_EMAIL", "NEWSLETTERS", "RETARGETING_EMAIL", "CASHBACK", "DISCOUNT_CODE", "LOYALTY", "VIRTUAL_INCENTIVES", "DIRECT_LINKING", "DOMAIN_PARKING", "LINKING_VIA_LANDING_PAGES", "MOBILE_SEARCH", "SOCIAL_SEARCH", "SUB_NETWORKS" ]
promoTypesRestriction
boolean

Whether the advertiser restricts promotional methods beyond allowedPartnerTypes. When true, promoTypesRestrictionDetails describes the restriction.

Examplefalse
promoTypesRestrictionDetails
string

Description of the promotional-method restriction. Present and not empty when promoTypesRestriction is true.

ExampleNo incentivised traffic.
deduplication
object

Deduplication settings across advertiser channels.

isDeduplicationOnAdvertiserChannels
boolean

Whether the advertiser deduplicates publisher conversions against its own channels (for example paid search or email).

Exampletrue
deduplicationChannels
Array of string

Advertiser channels that take priority over the publisher when deduplication is on, in which case it is not empty.

Unique itemstrue
Example[ "PPC_BRAND" ]
string
Valid values[ "PPC_BRAND", "PPC_GENERIC", "EMAIL_ADVERTISING", "DISPLAY_ADVERTISING", "DIRECT_PARTNERSHIPS", "PRICE_COMPARISON", "IN_HOUSE_PROGRAMME", "OTHER_NETWORKS" ]
additionalTerms
string

Additional programme terms written by the advertiser, as an HTML fragment. Omitted when the advertiser has not written any. Consumers must sanitise the HTML before rendering.

Min length1
Example<p>Additional programme terms (HTML).</p>
brandingTerms
string

Branding terms written by the advertiser, as an HTML fragment. Omitted when the advertiser has not written any. Consumers must sanitise the HTML before rendering.

Example<p>Branding terms (HTML).</p>
400

Invalid request: a non-numeric publisherId, or an invalid advertiserId query (missing, non-numeric, duplicated, or more than 50 ids).

Headers
RateLimit-Limit
integer
Maximum number of requests you can make in a burst under your own rate limit. Absent when the request did not count against your own limit.
Minimum1
Example5
RateLimit-Remaining
integer
Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.
Minimum0
Example0
RateLimit-Reset
integer
Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.
Minimum0
Example1
{
  "type": "https://help.awin.com/apis/error",
  "title": "Bad Request",
  "status": 400,
  "detail": "The advertiserId query parameter is invalid.",
  "code": "VALIDATION_FAILED",
  "errors": [
    {
      "pointer": "/advertiserId",
      "detail": "must contain between 1 and 50 numeric advertiser ids"
    }
  ]
}
Expand All
object
type
string (uri-reference)

A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.

Default"https://help.awin.com/apis/error"
Examplehttps://help.awin.com/apis/error
title
string

A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.

ExampleNot Found
status
integer

The HTTP status code, repeated here for convenience.

Example404
detail
string

A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.

ExampleResource not found with that ID
instance
string (uri-reference)

A URI reference identifying this specific occurrence, typically the request path.

Example/v1/advertisers/12345/prepayments
code
string

A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.

Valid values[ "VALIDATION_FAILED", "INVALID_SORT", "UNAUTHORIZED", "MISSING_TOKEN", "INVALID_TOKEN", "FORBIDDEN", "ACCESS_DENIED", "CLIENT_NOT_CONFIGURED", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "CONFLICT", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "BUSINESS_RULE_VIOLATION", "TOO_MANY_REQUESTS", "USER_RATE_LIMIT_EXCEEDED", "ROUTE_RATE_LIMIT_EXCEEDED", "LINK_SHORTENER_QUOTA_EXCEEDED", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "DEPENDENCY_UNAVAILABLE", "GATEWAY_TIMEOUT", "FEATURE_NOT_ENABLED", "ACCOUNT_IN_DEBT", "DUPLICATE_ENQUIRY_ID", "TRANSACTION_QUERY_NOT_PENDING", "MEMBERSHIP_INACTIVE", "ORDER_REF_ALREADY_TRACKED", "ORDER_REF_ALREADY_QUERIED", "TRANSACTION_DATE_BEFORE_ADVERTISER_LIVE_DATE", "CURRENCY_NOT_SUPPORTED", "CURRENCY_MISMATCH", "TRANSACTION_DATE_IN_FUTURE", "TRANSACTION_DATE_TOO_OLD", "OVERRIDE_NOT_ALLOWED" ]
ExampleNOT_FOUND
errors
Array of object

One entry per field that failed validation.

object
pointer
string

An RFC 6901 JSON Pointer to the offending field in the request.

Example/name
detail
string

A human-readable explanation of this field's failure.

Examplemust be 100 characters or fewer
401

Unauthorized

{
  "type": "https://help.awin.com/apis/error",
  "title": "Unauthorized",
  "status": 401,
  "detail": "No valid credentials were supplied with the request",
  "code": "UNAUTHORIZED"
}
object

Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.

type
string (uri-reference)

A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.

Default"https://help.awin.com/apis/error"
Examplehttps://help.awin.com/apis/error
title
string

A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.

ExampleNot Found
status
integer

The HTTP status code, repeated here for convenience.

Example404
detail
string

A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.

ExampleResource not found with that ID
instance
string (uri-reference)

A URI reference identifying this specific occurrence, typically the request path.

Example/v1/advertisers/12345/prepayments
code
string

A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.

Valid values[ "VALIDATION_FAILED", "INVALID_SORT", "UNAUTHORIZED", "MISSING_TOKEN", "INVALID_TOKEN", "FORBIDDEN", "ACCESS_DENIED", "CLIENT_NOT_CONFIGURED", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "CONFLICT", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "BUSINESS_RULE_VIOLATION", "TOO_MANY_REQUESTS", "USER_RATE_LIMIT_EXCEEDED", "ROUTE_RATE_LIMIT_EXCEEDED", "LINK_SHORTENER_QUOTA_EXCEEDED", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "DEPENDENCY_UNAVAILABLE", "GATEWAY_TIMEOUT", "FEATURE_NOT_ENABLED", "ACCOUNT_IN_DEBT", "DUPLICATE_ENQUIRY_ID", "TRANSACTION_QUERY_NOT_PENDING", "MEMBERSHIP_INACTIVE", "ORDER_REF_ALREADY_TRACKED", "ORDER_REF_ALREADY_QUERIED", "TRANSACTION_DATE_BEFORE_ADVERTISER_LIVE_DATE", "CURRENCY_NOT_SUPPORTED", "CURRENCY_MISMATCH", "TRANSACTION_DATE_IN_FUTURE", "TRANSACTION_DATE_TOO_OLD", "OVERRIDE_NOT_ALLOWED" ]
ExampleNOT_FOUND
403

Forbidden

Headers
RateLimit-Limit
integer
Maximum number of requests you can make in a burst under your own rate limit. Absent when the request did not count against your own limit.
Minimum1
Example5
RateLimit-Remaining
integer
Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.
Minimum0
Example0
RateLimit-Reset
integer
Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.
Minimum0
Example1
{
  "type": "https://help.awin.com/apis/error",
  "title": "Forbidden",
  "status": 403,
  "detail": "You do not have the correct privileges to access this resource",
  "code": "FORBIDDEN"
}
object

Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.

type
string (uri-reference)

A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.

Default"https://help.awin.com/apis/error"
Examplehttps://help.awin.com/apis/error
title
string

A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.

ExampleNot Found
status
integer

The HTTP status code, repeated here for convenience.

Example404
detail
string

A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.

ExampleResource not found with that ID
instance
string (uri-reference)

A URI reference identifying this specific occurrence, typically the request path.

Example/v1/advertisers/12345/prepayments
code
string

A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.

Valid values[ "VALIDATION_FAILED", "INVALID_SORT", "UNAUTHORIZED", "MISSING_TOKEN", "INVALID_TOKEN", "FORBIDDEN", "ACCESS_DENIED", "CLIENT_NOT_CONFIGURED", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "CONFLICT", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "BUSINESS_RULE_VIOLATION", "TOO_MANY_REQUESTS", "USER_RATE_LIMIT_EXCEEDED", "ROUTE_RATE_LIMIT_EXCEEDED", "LINK_SHORTENER_QUOTA_EXCEEDED", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "DEPENDENCY_UNAVAILABLE", "GATEWAY_TIMEOUT", "FEATURE_NOT_ENABLED", "ACCOUNT_IN_DEBT", "DUPLICATE_ENQUIRY_ID", "TRANSACTION_QUERY_NOT_PENDING", "MEMBERSHIP_INACTIVE", "ORDER_REF_ALREADY_TRACKED", "ORDER_REF_ALREADY_QUERIED", "TRANSACTION_DATE_BEFORE_ADVERTISER_LIVE_DATE", "CURRENCY_NOT_SUPPORTED", "CURRENCY_MISMATCH", "TRANSACTION_DATE_IN_FUTURE", "TRANSACTION_DATE_TOO_OLD", "OVERRIDE_NOT_ALLOWED" ]
ExampleNOT_FOUND
429

Too Many Requests

Headers
Retry-After
integerRequired
Number of seconds to wait before retrying the request.
Minimum0
Example1
RateLimit-Limit
integer
Maximum number of requests you can make in a burst under your own rate limit. Absent when the request did not count against your own limit.
Minimum1
Example5
RateLimit-Remaining
integer
Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.
Minimum0
Example0
RateLimit-Reset
integer
Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.
Minimum0
Example1
userRateLimitExceeded
{
  "type": "https://help.awin.com/apis/error",
  "title": "User rate limit exceeded",
  "status": 429,
  "detail": "You have exceeded your rate limit across the public API. Retry after the number of seconds in the Retry-After header",
  "code": "USER_RATE_LIMIT_EXCEEDED"
}
routeRateLimitExceeded
{
  "type": "https://help.awin.com/apis/error",
  "title": "Route rate limit exceeded",
  "status": 429,
  "detail": "This endpoint is receiving more requests than it can accept right now. Retry after the number of seconds in the Retry-After header",
  "code": "ROUTE_RATE_LIMIT_EXCEEDED"
}
tooManyRequests
{
  "type": "https://help.awin.com/apis/error",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "Rate limit exceeded",
  "code": "TOO_MANY_REQUESTS"
}
object

Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.

type
string (uri-reference)

A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.

Default"https://help.awin.com/apis/error"
Examplehttps://help.awin.com/apis/error
title
string

A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.

ExampleNot Found
status
integer

The HTTP status code, repeated here for convenience.

Example404
detail
string

A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.

ExampleResource not found with that ID
instance
string (uri-reference)

A URI reference identifying this specific occurrence, typically the request path.

Example/v1/advertisers/12345/prepayments
code
string

A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.

Valid values[ "VALIDATION_FAILED", "INVALID_SORT", "UNAUTHORIZED", "MISSING_TOKEN", "INVALID_TOKEN", "FORBIDDEN", "ACCESS_DENIED", "CLIENT_NOT_CONFIGURED", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "CONFLICT", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "BUSINESS_RULE_VIOLATION", "TOO_MANY_REQUESTS", "USER_RATE_LIMIT_EXCEEDED", "ROUTE_RATE_LIMIT_EXCEEDED", "LINK_SHORTENER_QUOTA_EXCEEDED", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "DEPENDENCY_UNAVAILABLE", "GATEWAY_TIMEOUT", "FEATURE_NOT_ENABLED", "ACCOUNT_IN_DEBT", "DUPLICATE_ENQUIRY_ID", "TRANSACTION_QUERY_NOT_PENDING", "MEMBERSHIP_INACTIVE", "ORDER_REF_ALREADY_TRACKED", "ORDER_REF_ALREADY_QUERIED", "TRANSACTION_DATE_BEFORE_ADVERTISER_LIVE_DATE", "CURRENCY_NOT_SUPPORTED", "CURRENCY_MISMATCH", "TRANSACTION_DATE_IN_FUTURE", "TRANSACTION_DATE_TOO_OLD", "OVERRIDE_NOT_ALLOWED" ]
ExampleNOT_FOUND
503

Service Unavailable

Headers
Retry-After
integerRequired
Number of seconds to wait before retrying the request.
Minimum0
Example1
RateLimit-Limit
integer
Maximum number of requests you can make in a burst under your own rate limit. Absent when the request did not count against your own limit.
Minimum1
Example5
RateLimit-Remaining
integer
Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.
Minimum0
Example0
RateLimit-Reset
integer
Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.
Minimum0
Example1
{
  "type": "https://help.awin.com/apis/error",
  "title": "Service Unavailable",
  "status": 503,
  "detail": "The service is temporarily unavailable",
  "code": "SERVICE_UNAVAILABLE"
}
object

Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.

type
string (uri-reference)

A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.

Default"https://help.awin.com/apis/error"
Examplehttps://help.awin.com/apis/error
title
string

A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.

ExampleNot Found
status
integer

The HTTP status code, repeated here for convenience.

Example404
detail
string

A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.

ExampleResource not found with that ID
instance
string (uri-reference)

A URI reference identifying this specific occurrence, typically the request path.

Example/v1/advertisers/12345/prepayments
code
string

A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.

Valid values[ "VALIDATION_FAILED", "INVALID_SORT", "UNAUTHORIZED", "MISSING_TOKEN", "INVALID_TOKEN", "FORBIDDEN", "ACCESS_DENIED", "CLIENT_NOT_CONFIGURED", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "CONFLICT", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "BUSINESS_RULE_VIOLATION", "TOO_MANY_REQUESTS", "USER_RATE_LIMIT_EXCEEDED", "ROUTE_RATE_LIMIT_EXCEEDED", "LINK_SHORTENER_QUOTA_EXCEEDED", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "DEPENDENCY_UNAVAILABLE", "GATEWAY_TIMEOUT", "FEATURE_NOT_ENABLED", "ACCOUNT_IN_DEBT", "DUPLICATE_ENQUIRY_ID", "TRANSACTION_QUERY_NOT_PENDING", "MEMBERSHIP_INACTIVE", "ORDER_REF_ALREADY_TRACKED", "ORDER_REF_ALREADY_QUERIED", "TRANSACTION_DATE_BEFORE_ADVERTISER_LIVE_DATE", "CURRENCY_NOT_SUPPORTED", "CURRENCY_MISMATCH", "TRANSACTION_DATE_IN_FUTURE", "TRANSACTION_DATE_TOO_OLD", "OVERRIDE_NOT_ALLOWED" ]
ExampleNOT_FOUND
default

Internal Server Error

Headers
RateLimit-Limit
integer
Maximum number of requests you can make in a burst under your own rate limit. Absent when the request did not count against your own limit.
Minimum1
Example5
RateLimit-Remaining
integer
Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.
Minimum0
Example0
RateLimit-Reset
integer
Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.
Minimum0
Example1
{
  "type": "https://help.awin.com/apis/error",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}
object

Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.

type
string (uri-reference)

A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.

Default"https://help.awin.com/apis/error"
Examplehttps://help.awin.com/apis/error
title
string

A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.

ExampleNot Found
status
integer

The HTTP status code, repeated here for convenience.

Example404
detail
string

A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.

ExampleResource not found with that ID
instance
string (uri-reference)

A URI reference identifying this specific occurrence, typically the request path.

Example/v1/advertisers/12345/prepayments
code
string

A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.

Valid values[ "VALIDATION_FAILED", "INVALID_SORT", "UNAUTHORIZED", "MISSING_TOKEN", "INVALID_TOKEN", "FORBIDDEN", "ACCESS_DENIED", "CLIENT_NOT_CONFIGURED", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "CONFLICT", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "BUSINESS_RULE_VIOLATION", "TOO_MANY_REQUESTS", "USER_RATE_LIMIT_EXCEEDED", "ROUTE_RATE_LIMIT_EXCEEDED", "LINK_SHORTENER_QUOTA_EXCEEDED", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "DEPENDENCY_UNAVAILABLE", "GATEWAY_TIMEOUT", "FEATURE_NOT_ENABLED", "ACCOUNT_IN_DEBT", "DUPLICATE_ENQUIRY_ID", "TRANSACTION_QUERY_NOT_PENDING", "MEMBERSHIP_INACTIVE", "ORDER_REF_ALREADY_TRACKED", "ORDER_REF_ALREADY_QUERIED", "TRANSACTION_DATE_BEFORE_ADVERTISER_LIVE_DATE", "CURRENCY_NOT_SUPPORTED", "CURRENCY_MISMATCH", "TRANSACTION_DATE_IN_FUTURE", "TRANSACTION_DATE_TOO_OLD", "OVERRIDE_NOT_ALLOWED" ]
ExampleNOT_FOUND