API:er för Registration Form

Den här sidan beskriver det publika API:et för att hantera Registration Forms – registreringsformulären som dina grossistkunder skickar in. Alla fyra åtgärder delar samma bas-URL, rubriker och autentisering som beskrivs i Publika API:er.

Note

Ett Registration Forms fältlayout (elements) kan bli komplex. Innan du bygger en förfrågan från grunden rekommenderar vi att du använder GET på ett befintligt formulär som du skapat i appen, för att se ett verkligt exempel på den struktur som förväntas, och sedan justerar bara det du behöver.

Skapa ett Registration Form

Slutpunkt

POST https://wholesale.samita.io/api/v1/registration-forms

Begäranderubriker

Rubrik	Beskrivning	Obligatorisk
X-SAMITA-API-KEY	API-nyckel som tillhandahålls i appen Wholesale	Ja
X-SAMITA-SHOP-URL	Shopify-butikens domän i formatet xxx.myshopify.com	Ja
CONTENT-TYPE	Måste vara application/json	Ja

Det här API:et kräver behörigheten Create på API-nyckeln.

Begärandekropp

Fält på toppnivå:

Fält	Typ	Obligatorisk	Beskrivning
title	sträng	Rekommenderas	Formulärets namn i appen.
status	boolesk	Rekommenderas	Om formuläret är aktivt.
shopify_integration	objekt	Ja	Styr hur inskickade formulär kopplas till Shopify-kunder – se nedan.
elements	array	Ja	Formulärets fält, i visningsordning – se nedan.
header	objekt	Nej	Rubriktext som visas högst upp i formuläret.
footer	objekt	Nej	Sidfotsknappar och text som visas längst ned i formuläret.
general	objekt	Nej	Godkännandebeteende och standardtaggar för kunder.
errorMessage	objekt	Nej	Anpassad text för valideringsfel.
reCaptcha	objekt	Nej	Om reCAPTCHA krävs i det här formuläret.
afterSubmit	objekt	Nej	Vad som händer när en kund skickar in formuläret.

shopify_integration

Fält	Typ	Anmärkningar
ifExist	sträng (obligatoriskt)	returnError, continueAndUpdate eller continueAndIgnoreError – vad som händer om en inskickad mejladress redan har ett kundkonto.
showMessage	boolesk	Visa ett meddelande som hänvisar kunden till att logga in i stället.
messageRedirectToLogin	sträng	Text för det meddelandet.
sendEmailInvite	boolesk	Skicka Shopifys mejl för kontoaktivering.
acceptsMarketing	boolesk	Anmäl den nya kunden till marknadsföringsmejl.

elements (array med fältobjekt)

Varje element behöver en type – vanliga typer är text, email, phone, password, number, name, url, checkbox, radio, country, datetime, file, hidden, heading, paragraph, devider och html.

Fält	Typ	Gäller för	Anmärkningar
type	sträng (obligatoriskt)	alla	Elementtyp.
columnWidth	tal (obligatoriskt utom för devider)	alla	33.33, 50 eller 100.
label / placeholder / description	sträng	inmatningstyper	Fältmärkning.
required	boolesk (obligatoriskt för heading, paragraph, devider, html)	dessa typer	Om fältet måste fyllas i.
hasConfirm, labelConfirm, placeholderConfirm, descriptionConfirm	—	password	Lägger till ett fält för bekräftelse av lösenord.
options, defaultOptions, defaultOption, defaultSelected	—	checkbox, radio, country	Konfiguration av alternativlistan.
inlineOption	tal (obligatoriskt)	checkbox, radio	20, 25, 33.33, 50 eller 100.
heading / text	sträng	heading / paragraph	Innehåll som visas.
html	sträng	html	Rått HTML-block.
allowed-multiple	boolesk	file	Tillåt uppladdning av flera filer.
allowed-extension	array	file	Valfria av: csv, pdf, jpg, jpeg, gif, svg, png, psd, ai, stl, stp, step, doc, docx, txt, ex2, dxf, gbr, eps, mov, mp4, xls, xlsx, ods, numbers, xlsm, zip, heic, heif.
format, date-format, time-format	sträng	datetime	format: date/time/date-and-time. date-format: Y-m-d/d-m-Y/m-d-Y/d-m/m-d. time-format: 12h/24h.
integration	sträng	alla	Kopplar det här fältet till en Shopify-kundegenskap: email, phone, first_name, last_name, addresses.address1, addresses.address2, addresses.city, addresses.province, addresses.zip, addresses.company, addresses.country, password, tags[], or note[].

header, footer, general, errorMessage, reCaptcha, afterSubmit

Avsnitt	Fält	Typ	Anmärkningar
header	active	boolesk	Visa/dölj rubriken.
header	title	sträng, max 255
header	description	sträng
footer	description	sträng
footer	previousText, nextText, submitText, resetButtonText	sträng	Knapptexter.
footer	resetButton, submitFullWidth	boolesk
footer	submitAlignment	sträng	left, center eller right.
general	customerTaxExempt	boolesk
general	customerProcess	sträng	review-approving (manuellt godkännande) eller approving (automatiskt).
general	customerTags	array	Taggar som läggs på godkända kunder.
errorMessage	required, invalidName, invalidEmail, invalidURL, invalidPhone, invalidNumber, invalidPassword, confirmPasswordNotMatch, customerAlreadyExists, fileSizeLimit, fileNotAllowed, requiredCaptcha, shopifyInvalidPhone, shopifyPhoneHasAlready, shopifyInvalidProvice, otherError	sträng	Anpassad text per valideringsfel.
reCaptcha	enable	boolesk
afterSubmit	action	sträng	clearForm, redirectToPage eller hideForm.
afterSubmit	message, redirectUrl	sträng

Svar

200 – Success returnerar den skapade posten. Se exemplet under Hämta ett Registration Form nedan för svarets struktur.

Uppdatera ett Registration Form

PUT https://wholesale.samita.io/api/v1/registration-forms/{id}

Samma rubriker som vid Create. Skicka bara de fält du vill ändra – title, status och secret_configs (hela konfigurationsobjektet, i samma struktur som GET returnerar, under nyckeln configs) är alla valfria. Fält som inte anges behåller sitt nuvarande värde. Det här API:et kräver behörigheten Update.

Hämta ett Registration Form

GET https://wholesale.samita.io/api/v1/registration-forms/{id}

Samma rubriker som vid Create, ingen begärandekropp. Det här API:et kräver behörigheten View.

Exempel på 200 – Success:

{
  "id": 1,
  "title": "Wholesale Registration",
  "status": true,
  "created_at": "2026-01-15T10:00:00",
  "updated_at": "2026-01-15T10:00:00",
  "configs": {
    "header": {
      "active": true,
      "title": "Apply for a wholesale account",
      "description": ""
    },
    "footer": {
      "previousText": "Back",
      "nextText": "Next",
      "submitText": "Submit",
      "resetButton": false,
      "resetButtonText": "Reset",
      "submitFullWidth": false,
      "submitAlignment": "left"
    },
    "general": {
      "customerTaxExempt": false,
      "customerProcess": "review-approving",
      "customerTags": ["wholesale"]
    },
    "reCaptcha": {
      "enable": false
    },
    "afterSubmit": {
      "action": "clearForm",
      "message": "Thanks! We'll review your application shortly.",
      "redirectUrl": ""
    },
    "integration": {
      "shopify": {
        "ifExist": "returnError",
        "showMessage": true,
        "sendEmailInvite": true,
        "acceptsMarketing": false,
        "integrationElements": {
          "email": "email",
          "first_name": "first_name",
          "last_name": "last_name"
        }
      }
    },
    "elements": [
      { "id": "first_name", "type": "name", "label": "First name", "required": true, "columnWidth": 50 },
      { "id": "last_name", "type": "name", "label": "Last name", "required": true, "columnWidth": 50 },
      { "id": "email", "type": "email", "label": "Email", "required": true, "columnWidth": 100 }
    ]
  }
}

Ta bort ett Registration Form

DELETE https://wholesale.samita.io/api/v1/registration-forms/{id}

Samma rubriker som vid Create. Skicka en parameter ids – en kommaseparerad lista med formulär-ID som ska tas bort (som frågesträngsparameter eller JSON-kroppsfält), till exempel ids=1,2,3. Det här API:et kräver behörigheten Delete.

200 – Success:

{
  "success": true
}

Felsvar

Alla fyra slutpunkter delar samma felsvar som resten av det publika API:et – se Publika API:er för 401 Unauthorized, 403 Forbidden och 429 Too Many Requests.