Skip to main content
POST
/
catalogs
/
premiums
cURL
curl --request POST \
  --url http://localhost:3000/connect/v1/catalogs/premiums/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "id": "<string>",
  "options": [
    {
      "name": "<string>",
      "amount": 123,
      "id": "<string>",
      "is_active": true,
      "creator": "<string>",
      "updater": "<string>"
    }
  ],
  "category": "PAYOUT",
  "type": "PER_TRANSACTION",
  "amount": 123,
  "included": true,
  "dependant_on_card": true,
  "applicable_activity": "BUY",
  "calculation_type": "NORMAL",
  "is_active": true,
  "creator": "<string>",
  "updater": "<string>",
  "owner": "<string>"
}
'
{
  "name": "<string>",
  "id": "<string>",
  "options": [
    {
      "name": "<string>",
      "amount": 123,
      "id": "<string>",
      "updated_on": "2023-11-07T05:31:56Z",
      "created_on": "2023-11-07T05:31:56Z",
      "is_active": true,
      "creator": "<string>",
      "updater": "<string>"
    }
  ],
  "updated_on": "2023-11-07T05:31:56Z",
  "created_on": "2023-11-07T05:31:56Z",
  "category": "PAYOUT",
  "type": "PER_TRANSACTION",
  "amount": 123,
  "included": true,
  "dependant_on_card": true,
  "applicable_activity": "BUY",
  "calculation_type": "NORMAL",
  "is_active": true,
  "creator": "<string>",
  "updater": "<string>",
  "owner": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.fairfood.org/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Body

application/json
​
name
string
required
Required string length: 1 - 100
​
id
string
​
options
object[]
​
category
enum<string>
Available options:
PAYOUT,
TRANSACTION
​
type
enum<string>
Available options:
PER_TRANSACTION,
PER_KG,
PER_UNIT_CURRENCY,
PER_FARMER
​
amount
number | null
​
included
boolean
​
dependant_on_card
boolean
​
applicable_activity
enum<string>
Available options:
BUY,
SELL
​
calculation_type
enum<string>
Available options:
NORMAL,
MANUAL,
OPTIONS
​
is_active
boolean
​
creator
string
​
updater
string
​
owner
string

Response

201 - application/json
​
name
string
required
Required string length: 1 - 100
​
id
string
​
options
object[]
​
updated_on
string<date-time>
read-only
​
created_on
string<date-time>
read-only
​
category
enum<string>
Available options:
PAYOUT,
TRANSACTION
​
type
enum<string>
Available options:
PER_TRANSACTION,
PER_KG,
PER_UNIT_CURRENCY,
PER_FARMER
​
amount
number | null
​
included
boolean
​
dependant_on_card
boolean
​
applicable_activity
enum<string>
Available options:
BUY,
SELL
​
calculation_type
enum<string>
Available options:
NORMAL,
MANUAL,
OPTIONS
​
is_active
boolean
​
creator
string
​
updater
string
​
owner
string