Get vendor agreement

Agreement

GET/api/v1/scent/agreement

Returns your own pricing model (CostPlusMargin or PercentageOfSale), supplier percentage (Model 2 only), and effective-from date. Never any partner rate, markup figure, or another vendor’s data. Capability-free — any authenticated credential may call this. A vendor with no agreement explicitly set yet resolves to CostPlusMargin with a null percentage and effectiveFrom.

Response

pricingModelstring (enum)

CostPlusMargin (“Model 1”): you declare cost, Linra adds a markup. PercentageOfSale (“Model 2”): you declare the final sale price; Linra + the reselling partner deduct a percentage of it.

supplierPercentagenumber (decimal)

Set only under a Model-2 (PercentageOfSale) agreement — the percentage of your own sale price that Linra + the reselling partner deduct.

effectiveFromstring (date-time)

Null only when you have never had an agreement explicitly set (resolves to the CostPlusMargin default).

Other responses

401No bearer token (UNAUTHORIZED_MISSING_TOKEN), an invalid token (UNAUTHORIZED_INVALID_TOKEN) or an expired one (UNAUTHORIZED_TOKEN_EXPIRED — mint a new token). UPSTREAM_AUTH_FAILED is different: a dependent service refused the Gateway itself. That is a server-side fault — retry later and do NOT re-mint your token. See the Rate limits & errors guide.

403The route is not available to your credential (FORBIDDEN).

404No API route matches this path (NOT_FOUND_ROUTE). A missing resource on a real route returns that service’s own NOT_FOUND_* code instead.

429Too many requests. Retry after the Retry-After header (seconds).

502A dependent service returned an invalid response (BAD_GATEWAY). Retry with backoff.

503The service is temporarily unavailable (SERVICE_UNAVAILABLE). Retry with backoff.

504A dependent service did not respond in time (GATEWAY_TIMEOUT). Retry with backoff.

cURL

curl --request GET \
  --url https://api-omni-vendors.linra.net/api/v1/scent/agreement \
  --header 'Authorization: Bearer $TOKEN'

JavaScript

const res = await fetch('https://api-omni-vendors.linra.net/api/v1/scent/agreement', {
  headers: {
    Authorization: `Bearer ${token}`,
  },
});
const { payload } = await res.json();

C#

var response = await httpClient.GetAsync("https://api-omni-vendors.linra.net/api/v1/scent/agreement");

var envelope = await response.Content.ReadFromJsonAsync<ApiResponse<VendorAgreementResponse>>();

Response

{
  "state": "SUCCESS",
  "payload": {
    "pricingModel": "CostPlusMargin",
    "supplierPercentage": 0,
    "effectiveFrom": "2026-08-22T09:14:03Z"
  },
  "details": null
}