GKS Public API

Integrera din webbshop med GKS och få ett automatiserat orderflöde som skapar upp försäljningsorder i GKS samt vid behov arbetsorder för tillverkning.

Detta är ett nyare API och ersätter tidigare funktionalitet i PlaceSimpleOrder API.

Med följande REST-API går det att ta emot lagda order från din webbshop. Den mottagna försäljningsordern blir underlag för fakturering, men kan även skapa upp tillverkningsorder utifrån kända artikelnummer.

Skillnader mot PlaceSimpleOrder API

• API:et ligger i molnet och drift ingår vilket gör det enklare att ansluta nya externa system.

• Framtidssäker. Detta API fungerar direkt mot GKS4, men är även bakåtkompatibelt och går att koppla mot GKS3.

• Modernare och enklare teknik med JSON över REST.

• Utökad med ytterligare funktionalitet:

  • Möjlighet att få in artikelnummer.

  • Möjlighet att få tillverkningsorder att skapas automatiskt för kända artikelnummer.

  • Kunna få in flera leveransadresser per orderrad/produkt. Dvs. en färdig distribution med antal till respektive adress.

  • Möjlighet att få in kostnad per orderrad.

  • Möjlighet att få in en rabattsats.

  • Möjlighet att få in valuta.

Säkerhet

OAuth 2.0 client credentials flow.

Teknisk dokumentation

Places a sales order.

post

Authorizations

Body

customerNumberstring · min: 1 · max: 10required

The customer number in GKS of the buyer. A company with this customer number must exist in GKS.

Example: K100421

billingContactobjectrequired

billingCompanyInfoobject

billToobject

shipToobject

orderTitlestring | nullable

Optional name of the sales order that will be useful when searching for the order.

promisedDeliveryDatestring · date-time | nullable

orderedstring · date-time | nullable

Obsolete. We do not see a business need to change the date of purchase. It should always be the same date as the order request is received.

purchaseOrderNumberstring · max: 25

An optional purchase order number from the buyer. In PlaceSimpleOrder API, "CustOrderNo".

isExportboolean

isExportWithinEuboolean

languageCodestring | nullable

The preferred language (ISO 639-1) of documents communicated with the buyer, i.e. order confirmation. Accepted values: sv, no, en

currencyCodestring | nullable

The currency of the amounts in this sales order. ISO 4217.

Example: SEK

noteFromCustomerstring | nullable

A comment added by the customer during placement of the order. Commonly with instructions to the seller.

salesOrderlinesobject[]required

hasAllotmentsbooleanread-only

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/salesorders' \
  --header 'Content-Type: application/json' \
  --data '{
    "customerNumber": "K100421",
    "billingContact": {
      "firstName": "text",
      "lastName": "text",
      "email": "text",
      "phone": "text",
      "phoneMobile": "text",
      "eInvoiceCode": "text"
    },
    "billingCompanyInfo": {
      "name": "text",
      "department": "text",
      "invoiceEmail": "[e-mail]"
    },
    "billTo": {
      "address1": "Storgatan 1",
      "address2": "Garageinfart 2",
      "address3": "text",
      "city": "Stockholm",
      "zipCode": "114 44",
      "state": "FL",
      "countryCode": "SE"
    },
    "shipTo": {
      "recipientName": "text",
      "address": {
        "address1": "Storgatan 1",
        "address2": "Garageinfart 2",
        "address3": "text",
        "city": "Stockholm",
        "zipCode": "114 44",
        "state": "FL",
        "countryCode": "SE"
      },
      "contactName": "text",
      "contactMobilePhone": "text",
      "contactEmail": "text"
    },
    "orderTitle": "text",
    "promisedDeliveryDate": "2025-03-17T21:23:53.266Z",
    "ordered": "2025-03-17T21:23:53.266Z",
    "purchaseOrderNumber": "text",
    "isExport": true,
    "isExportWithinEu": true,
    "languageCode": "text",
    "currencyCode": "SEK",
    "noteFromCustomer": "text",
    "salesOrderlines": [
      {
        "articleNumber": "text",
        "description": "text",
        "quantity": 1,
        "salesUnit": "text",
        "unitPrice": 1,
        "vatPercent": 1,
        "discountPercent": 1,
        "costWork": 1,
        "costMaterial": 1,
        "costSubcontractWork": 1,
        "profitCenterCode": "14",
        "weightPerUnit": 1,
        "shipOrderline": true,
        "allotments": [
          {
            "qtyToShip": 1,
            "shipTo": {
              "recipientName": "text",
              "address": {
                "address1": "Storgatan 1",
                "address2": "Garageinfart 2",
                "address3": "text",
                "city": "Stockholm",
                "zipCode": "114 44",
                "state": "FL",
                "countryCode": "SE"
              },
              "contactName": "text",
              "contactMobilePhone": "text",
              "contactEmail": "text"
            }
          }
        ]
      }
    ],
    "hasAllotments": true
  }'

200

400

404

500

200

{
  "orderNumber": 1
}

Success. The sales order was created.

Skapa tillverkningsorder

Beskrivning av funktionalitet

Från en inkommande webborder via API:et finns nu möjlighet att automatiskt få tillverkningsorder uppskapade.

Genom att koppla artikelnummer till en utvald produktmall kommer API:et automatiskt kunna skapa upp en tillverkningsorder då den identifierar att en känd artikel har beställts. Tillhörande jobb blir även direkt synligt i GKS Plan för produktionen att påbörja tillverkning. Artikelnumret identifieras om det finns i fältet för artikel på produktmallen.

Tillverkningsordern skapas upp med det inkommande artikelnumret och beskrivningen som kommer in på den fria orderraden från webbportalen. Numret på friordern sätts i början på benämningen för att kunna spåra vilken friorder som fick in beställningen. Webportalens ordernummer sätts också i fältet för beställningsnummer på arbetsordern.

Skapa en produktmall för en artikel

Börja med att skapa en kund i företagsregistret med firmanamn PLACESIMPLEORDER om denna inte redan är upplagd. Kund-ID kan sättas till valfritt värde.

Skapa därefter en tillverkningsoffert och välj kunden. Lägg därefter till en ny produkt. Sedan sätter du artikelnummer i fält Mall för artikel. När allt är klart sparar du offerten. Offerten kan med fördel sparas med 0 i värde.

En produktmall med ett artikelnummer.

Listning av artiklar med produktionsmallar

Kopplingen mellan ett artikelnummer och en mall visas i ett separat program som heter Produktmallar Place Simple Order (Produktmallar.exe). Programmet finns tillgängligt i GKS3-mappen från och med GKS3 Kalkyl v3.83.1.

Vid start av programmet visas en vy där man ser alla artiklar och till vilka offertmallar som dessa är kopplade till.

Lista med alla artikelnummer och dess kopplade mall.

GKS3: Installation

I GKS4 finns API tillgängligt som standard, tillsammans med tjänsten för att skapa tillverkningsorder. Om du använder GKS3 behöver du däremot installera både en API-adapter och en tjänst på din serverdator.

Installera API-Adapter

1. Ladda ner och installera ASP.NET Core 8.0 Runtime Hosting Bundle för Windows.

2. Skapa en mapp för API:et, t.ex. c:\inetpub\wwwroot\gks3api och lägg filer från paketet du erhållit av Simutek.

3. Kopiera in GKS.INI till mappen.

4. Konvertera appen till en applikation i IIS Manager.

5. Testa åtkomst genom en webbläsare: http://localhost/gks3api/swagger/index.html .

6. Se till att API:et görs tillgängligt externt via brandvägg.

Installera tjänst för att skapa tillverkningsorder

1. Kontrollera att mappen c:\gks3\PlaceSimpleOrder finns på serverdator, samt att den innehåller filerna:

   • CreateProdOrderNT.exe

   • dbexpsda41.dll

   • GKS.INI

2. Kör kommando: CreateProdOrderNT.exe -install