API

Gem Logic API låter dig integrera med externa system och automatisera arbetsflöden. Du kan använda det för att hantera produkter, försäljningar, kontakter, reparationer, inventeringar och utskriftsjobb programmatiskt.

Navigera till Inställningar ‣ API för att skapa och hantera dina API-nycklar.

Autentisering

Alla API-förfrågningar måste inkludera en API-nyckel i HTTP-huvudet x-api-key. Du kan skapa nycklar från sidan Inställningar ‣ API. Nycklar kan inaktiveras eller tas bort när som helst.

Exempelförfrågan:

curl -X GET https://your-instance.gem-logic.com/api/marketplaces/ \
  -H "x-api-key: YOUR_API_KEY"

Risk

Håll dina API-nycklar hemliga. Dela aldrig dem i offentliga repositories eller på klientsidan. Om en nyckel äventyras, inaktivera den omedelbart och skapa en ny.

Bas-URL

Alla endpoints är relativa till din instans-URL, under prefixet /api/:

https://your-instance.gem-logic.com/api/

Responsformat

Alla responser returneras som JSON. Lyckade förfrågningar returnerar en 200 (för GET) eller 201 (för POST) statuskod. Fel returnerar lämplig statuskod med ett meddelande:

  • 200 OK — lyckad GET-förfrågan

  • 201 Created — lyckad POST-förfrågan

  • 400 Bad Request — ogiltig eller saknad data

  • 401 Unauthorized — ogiltig eller saknad API-nyckel

  • 404 Not Found — resursen finns inte

Endpoints

Marknadsplatser

Metod

GET

URL

/api/marketplaces/

Beskrivning

Returnerar en lista över alla försäljningskanaler.

Responsfält:

Fält

Typ

Beskrivning

id

integer

Unik identifierare

marketplace

string

Marketplace-namn

Produkter

Lista produkter

Metod

GET

URL

/api/products/{marketplace_id}

Beskrivning

Returnerar produkter filtrerade efter marketplace. Använd marketplace-ID från marketplaces-slutpunkten.

Responsfält:

Fält

Typ

Beskrivning

id

integer

Unik identifierare

item_sku

string

Produkt-SKU

created

datetime

Skapandedatum

status

string

Produktstatus

images

array

Lista över produktbilder (id, image)

item_weight

decimal

Vikt

item_height

decimal

Höjd

item_length

decimal

Längd

item_width

decimal

Bredd

Skapa produktbild

Metod

POST

URL

/api/products/create/image/

Beskrivning

Ladda upp en produktbild med base64-kodning. Om produktens SKU inte redan finns skapas en ny produkt automatiskt.

Förfrågningsfält:

Fält

Typ

Krävs

Beskrivning

item_sku

string

Ja

Produkt-SKU att koppla bilden till

image

string (base64)

Ja

Base64-kodad bilddata

Försäljning

Lista försäljningar

Metod

GET

URL

/api/sales/

Beskrivning

Returnerar en lista över alla försäljningsordrar.

Responsfält:

Fält

Typ

Beskrivning

order_id

string

Unik orderidentifierare

Skapa försäljning

Metod

POST

URL

/api/sales/create/

Beskrivning

Skapar en ny försäljningsorder.

Kontakter

Metod

GET

URL

/api/contacts/

Beskrivning

Returnerar en lista över alla kontakter.

Responsfält:

Fält

Typ

Beskrivning

id

integer

Unik identifierare

complete_name

string

Fullständigt namn

contact_type

string

Typ av kontakt

email

string

E-postadress

phone

string

Telefonnummer

language

string

Föredraget språk

Reparationer

Skapa reparation

Metod

POST

URL

/api/repairs/create/

Beskrivning

Skapar en ny reparationsorder med ett tillhörande reparationsartikel. Om verkooppunt eller avdelning inte anges används den först tillgängliga.

Förfrågningsfält:

Fält

Typ

Krävs

Beskrivning

client_id

integer

Nej

ID för kund/kontakt

marketplace

sträng / heltal

Nej

ID eller namn för verkooppunt

division_id

integer

Nej

ID för affärsavdelning

title

string

Nej

Titel eller beskrivning av reparationsartikeln

repair_info_1

string

Nej

Ytterligare reparationskommentar

repair_info_2

string

Nej

Ytterligare reparationskommentar

repair_info_3

string

Nej

Ytterligare reparationskommentar

quantity

decimal

Nej

Antal (standard: 1)

weight

decimal

Nej

Artikelvikt

weight_unit

string

Nej

Enhet för viktmätning

size

string

Nej

Artikelstorlek

color

string

Nej

Artikelfärg

engravement

string

Nej

Graveringstext

client_reference | string

Nej

Kundens referensnummer

Exempelsvar:

{"message": "Repair created successfully.", "order_id": "R-0001"}

Lägg till artikel till reparation

Metod

POST

URL

/api/repairs/add-item/

Beskrivning

Lägger till en ny artikel till en befintlig reparationsorder.

Förfrågningsfält:

Fält

Typ

Krävs

Beskrivning

order_id

string

Ja

Order-ID för reparationen som artikeln ska läggas till

item_sku

string

Nej

Produkt-SKU att länka med artikeln

title

string

Nej

Titel eller beskrivning

repair_info_1

string

Nej

Ytterligare reparationskommentar

repair_info_2

string

Nej

Ytterligare reparationskommentar

repair_info_3

string

Nej

Ytterligare reparationskommentar

quantity

decimal

Nej

Antal (standard: 1)

weight

decimal

Nej

Artikelvikt

weight_unit

string

Nej

Enhet för viktmätning

size

string

Nej

Artikelstorlek

color

string

Nej

Artikelfärg

engravement

string

Nej

Graveringstext

client_reference | string

Nej

Kundens referensnummer

cost

decimal

Nej

Artikelns kostnad

Inventeringar

Skapa inventering

Metod

POST

URL

/api/inventory-counts/

Beskrivning

Skapar en ny inventeringssession.

Responsfält:

Fält

Typ

Beskrivning

id

string

Inventerings-ID

created_at

datetime

Tidsstämpel för skapande

status

string

Alltid active

tag_count

integer

Antal räknade produkter

Lista inventeringens produkter

Metod

GET

URL

/api/inventory-counts/{inventory_count_id}/products/

Beskrivning

Returnerar alla produkter som räknats i en specifik inventering.

Responsfält:

Fält

Typ

Beskrivning

id

string

Unik identifierare

created_at

datetime

När produkten räknades

product_sku

string

Produkt-SKU

product_name

string

Produktnamn

quantity

integer

Räknad kvantitet

Interaktiv API-utforskare

Gem Logic innehåller en inbyggd interaktiv API-utforskare driven av Swagger UI. Du kan komma åt den via länken API-dokumentation på sidan Inställningar ‣ API. Utforskaren låter dig testa varje slutpunkt direkt från din webbläsare.

Se även