Home
version 1.0
Create Offer

Create a offer

GEThttps://trimida.com/api/v1/offers

Body Parameters

langstringrequired

Default offer language.

  • Allowed values: en | pl | de | cz | sk | fr | es
statusbooleanrequired

Should the offer be active.

saleIsBlockedbooleanrequired

Is sales enabled.

namestringrequired

Name of the offer.

urlKeystringrequired

Offer URL

  • Minimum value: 10 characters
fullUrlKeystringrequired

Full url with organization url

  • Minimum value: 10 characters
descriptionstring

Additional description for the customer visible in the registration form

offerDatearrayrequired

The offer ID.

statusbooleanrequired

The offer ID.

  • Minimum value: 2 characters
labelstringrequired

Display name of the offer session (e.g. "Turnus I").

startDatedaterequired

Start date of the session.

endDatedaterequired

End date of the session.

qtynumberrequired

Number of available spots for the session.

pricestring

Offer price.

specialPricestring

Promotional price of the offer.

currencystring

Offer currency.

  • Allowed values: pln | eur | czk | gbp
depositstring

Deposit amount.

paymentMethodarrayrequired

Available payment methods.

  • Allowed values: pln | eur | czk | gbp
rodoarray

List of GDPR consent identifiers required for this offer.

offerOptionsarray

The offer ID.

idnumberrequired

The offer ID.

titlestringrequired

Display name of the offer session (e.g. "Turnus I").

fieldTypestringrequired

Start date of the session.

  • Allowed values: fixed | percent
requireddaterequired

End date of the session.

  • Allowed values: true | false
offerOptionValuesarraysrequired

Number of available spots for the session.

idnumberrequired

The offer ID.

valuestringrequired

Display name of the offer session (e.g. "Turnus I").

pricenullrequired

Start date of the session.

priceTypestringrequired

End date of the session.

cmsSmallDescriptionstringrequired

The offer ID.

  • Minimum value: 100 characters
cmsLongDescriptionstringrequired

The offer ID.

  • Minimum value: 400 characters
documentIdstring | null

Unique document identifier automatically generated on creation.

metaTitlestring

SEO title used in the title tag of the page.

metaDescriptionstring

SEO description used in the meta description tag of the page.

offerMediastring

Photos of the offer.

isMainbooleanrequired

Is the photo main.

assetsarrayrequired

Array of files attached to the offer.

namestringrequired

Original file name.

typestringrequired

MIME type of the file (e.g. "image/jpeg", "application/pdf").

base64stringrequired

Base64-encoded file content.

Example Body Parameters


{
    "lang": "pl",
    "organizationId": "79e6e02f-d9f0-4f99-8b8b-b15d3a833a47",
    "status": true,
    "saleIsBlocked": true,
    "name": "example offer name",
    "urlKey": "example-offer-new",
    "fullUrlKey": "demo-trimida/example-offer-new",
    "description": "",
    "offerDate": [
        {
            "status": true,
            "label": "Example name",
            "startDate": "2026-04-10T22:00:00.000Z",
            "endDate": "2026-04-17T22:00:00.000Z",
            "qty": 5,
            "price": "1000",
            "specialPrice": "",
            "deposit": "",
            "currency": "pln"
        }
    ],
    "paymentMethod": [
        "casch_on_delivery",
        "bank_transfer",
        "payu"
    ],
    "rodo": [],
    "offerOptions": [],
    "cmsSmallDescription": "example small description",
    "cmsLongDescription": "<p>example long description with html</p>",
    "documentId": null,
    "metaTitle": "",
    "metaDescription": "",
    "offerMedia": []
}

Response


{
  "id": "sdfsdfsdf"
}