Verified by GS1 API Pro

API Pro gir i likhet med API Basic ubegrenset med oppslag mot Verified by GS1 fra eget system, og har flere typer oppslag. Dessuten kan man bli varslet på alle GLN som man har aktive i eget system med GLN Varsling.

Type oppslag som kan gjøres

GLN Varsling:

GLN-informasjon er «ferskvare», så aktører bør ha dette oppdatert til enhver tid.

Ved bruk av API PRO kan man abonnere på varsel om endring på GLN man har i eget system, og dermed oppnå full datakvalitet. Det betyr at man til enhver tid kan holde eget kunderegister oppdatert med korrekt GLN-informasjon.

Adresser assosiert med et GLN er verifisert mot Statens Kartverk.

• Alle endringer på et GLN vil varsles

• Nedleggelser/konkurser av GLN vil varsles

Med GLN Varsling kan alle GLN i eget system automatisk oppdateres.

Når en kunde går i konkurs, får ny adresse, slår seg sammen med en annen bedrift eller bytter navn, så kan dette automatisk oppdateres i eget system.

Med GLN Varsling kan dere være trygg på at varer blir levert til riktig sted og at digitale handelsmeldinger fungerer og går dit de skal.

Her er det både tid og penger å spare.

Dokumentasjon

I denne pakken inngår tilgang til følgende API, med de tekniske navnene, ‘GRP API’ og ‘KeyMgmt public web API v2’. Førstnevnte gir tilgang til søketjenestene som beskrevet for API Basic, mens sistnevte gir tilgang til resten av endepunktene for en dypere integrasjon.

Swagger er et verktøysett for å dokumentere og teste APIer ved hjelp av OpenAPI-spesifikasjonen. Her kan du se dokumentasjonen til APIene i Swagger:

Eksempel

• Abonnere på GLN varsling

  Endepunkt:

  

  Beskrivelse

  Med dette endepunktet kan man registrere de GLNene som man ønsker å abonnere på. Feletet accountId representerer identiteten til selskapet som abonnerer på tjenesten og tildeles av GS1 Norway.

  Request – eksempel

  {
    "accountId": 99999,
    "gln": "7080004038660"
  }

  Response

  {
    "notificationSubscriptionId": 7
  }

• Motta varsel om endring

  Endepunkt:

  

  Beskrivelse

  Beskrivelse: Dette endepunktet gir deg varsel dersom det er skjedd endringer på et GLN du abonnerer på. I dette eksempelet listes de GLN det har skjedd endringer på etter en gitt dato. Merk at dette endepunktet polles ved egendefinerte intervaller.

  Request – eksempel

  {
    «accountId»: 99999,
    «filter»: {
      «createdAfterUtc»: «2023-11-30T10:56:01.9205678Z»
    },
    «ordering»: []
  }

  Response

  {
    «result»: {
      «info»: {
        «ordering»: [
          {
            «by»: «Id»,
            «direction»: «DESC»
          }
        ],
        «pageSize»: 100,
        «count»: 1,
        «canHaveMoreData»: false,
        «nextPageOffset»: [
          «384712»
        ]
      },
      «items»: [
        {
          «area»: «Locations»,
          «type»: «ChangedByAdmin»,
          «severity»: «Success»,
          «threadId»: «49e40181-4f30-47f3-927f-9a9075b9427d»,
          «gln»: «7080004038660»,
          «createdByCompanyGln»: «7080004038660»,
          «createdByCompanyName»: «GS1 NORWAY»,
          «glnHistoryId»: «df65070a-3736-45a7-bb70-24e9612fb2f5»,
          «createdAtTimeUtc»: «2024-03-13T09:31:20.2691736Z»,
          «createdBy»: «egil.wist@gs1.no«
        }
      ]
    }
  }

• Eksempel: filtrert oppslag på ulike felt

  Endepunkt:

  

  Beskrivelse

  Dette endepunktet gir deg mulighet for å gjøre et filtrert oppslag mot GLN basen. Det kan filtreres på følgende egenskaper:

  • Lokasjonsnavn
  • GLN
  • EierGLN
  • Org.nr.
  • Gateadresse
  • Status

  I eksempelet under er det benyttet org.nr.

  Request – eksempel

  {
    «filter»: {
      «companyNum»: {
        «value»: «813885492»,
        «type»: «Equals»
      }
    },
    «paging»: {
      «pageSize»: 200
    },
    «ordering»: [
      {
        «by»: «Id»,
        «direction»: «ASC»
      }
    ]
  }

  Response

  {
    «result»: {
      «info»: {
        «ordering»: [
          {
            «by»: «Id»,
            «direction»: «ASC»
          }
        ],
        «pageSize»: 200,
        «count»: 1,
        «canHaveMoreData»: false,
        «nextPageOffset»: [
          «7080010017017»
        ]
      },
      «items»: [
        {
          «id»: «7080010017017»,
          «status»: «Active»,
          «stage»: «Live»,
          «companyPrefixId»: «70800»,
          «accountId»: 47965,
          «accountName»: «EKÅS AS»,
          «ownerCompany»: {
            «id»: 51147,
            «gln»: «7080010017017»,
            «externalId»: «e518caf4-18d5-49e4-ac31-1306e11aceb7»,
            «name»: «EKÅS AS»,
            «vat»: «813885492»,
            «organizationForm»: «AS»
          },
          «createdAtTimeUtc»: «2024-03-14T08:28:55.0810077Z»,
          «deactivatedDateTime»: «0001-01-01T00:00:00Z»,
          «lastModifiedAtTimeUtc»: «2024-03-14T08:28:55.2663768Z»,
          «isLocked»: false,
          «isVisible»: true,
          «locationInfo»: {
            «glnTypes»: [
              «LEGAL_ENTITY»
            ],
            «locationTypes»: [],
            «name»: «EKÅS AS»,
            «address»: {
              «buildingNumber»: » «,
              «streetAddress»: «Marthe Plassens veg 13»,
              «city»: «KONGSVINGER»,
              «postalCode»: «2208»,
              «coordinates»: {
                «srid»: «UTM33N»,
                «y»: «6675973.01»,
                «x»: «333362.08»
              },
              «verificationStatus»: «Valid»
            },
            «companyNum»: «813885492»,
            «companyName»: «EKÅS AS»,
            «organizationForm»: «AS»,
            «isThirdPartyWarehouse»: false,
            «sourceChannel»: «Api»,
            «partyRoleCodes»: [],
            «causeOfGlnRegistration»: «EPD/Tradesolution»,
            «internalNote»: «»,
            «version»: 1,
            «validFromTimeUtc»: «2024-03-14T08:28:55.2663768Z»
          },
          «concurrencyToken»: «AAAAAAUmzF8=»
        }
      ]
    }
  }
  

*Kan i visse tillfeller begrenses for å beskytte systemets pålitelighet. **Faktureres forskuddsvis per kvartal.

—

—

—

Kontakt

Trenger du hjelp med å komme i gang med GLN?

Ta gjerne kontakt.

—

Glenn Schei

Produktansvarlig GLN
918 00 011
gs@gs1.no

—

—

Sindre Følling Sørensen

Software Developer
458 33 625
ss@gs1.no

—

—