Artikelen opvragen

<< Klik hier om de inhoudsopgave te tonen >>

Navigatie:  API aanroepen >

Artikelen opvragen

Aanroep

Naam: GetProducts

 

Aanroep structuur

<?xml version="1.0" encoding="utf-8"?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

<SOAP-ENV:Header/>

<S:Body>

  <ns2:GetProducts xmlns:ns2="https://api.stip-t.nl/v1/">

    <securityToken></securityToken>

    <filters>

       <filter>

         <field></field>

         <operator></operator>

         <value></value>

       <filter>

       ...

     </filters>

     <orderBy></orderBy>

  </ns2:GetProducts>

</S:Body>

</S:Envelope>

 

Verklaring

Tag/veldnaam

Type

Opmerkingen/beperkingen

Omschrijving

securityToken

string

verplicht

securityToken verkregen bij login

filters

List<Filter>

LET OP:

indien geen filters dan worden ALLE artikelen opgehaald

filterlijst voor Product velden (zie hieronder in de Antwoord structuur en Verklaring)

zie Filter

orderBy

string

sortering, komma gescheiden lijst van veldnamen. Een veldnaam kan gevolgd worden door sleutelwoord ASC (oplopend, default) of DESC (aflopend).

B.v.: ledgerAccNo, unitPrice DESC

 

Antwoord

Naam: GetProductsResponse

 

Antwoord structuur

<?xml version="1.0" encoding="utf-8"?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

<SOAP-ENV:Header/>

<S:Body>

  <ns2:GetProductsResponse xmlns:ns2="https://api.stip-t.nl/v1/">

    <result>

      <error></error>

      <errorMessage></errorMessage>

      <productList>

        <product>

          <productNo></productNo>

          <description></description>

          <unitPrice></unitPrice>

          <ledgerAccNo></ledgerAccNo>

          <vatCode></vatCode>

          <productGroupCode></productGroupCode>

           <userFieldList>

            <userField>

              <key></key>

              <value></value>

            </userField>

             ...

          </userFieldList>

        </product>

      </productList>

    </result>

  </ns2:GetProductsResponse>

</S:Body>

</S:Envelope>

 

Verklaring

Tag/veldnaam

Type

result

RequestResult

Tag/veldnaam

Type

Omschrijving

error

boolean

false indien geen fouten, true indien er fouten zijn opgetreden

errorMessage

string

foutboodschap, alleen gevuld indien error = true

productList

ProductList

Tag/veldnaam

Type

product

Product

Tag/veldnaam

Type

Omschrijving

productNo

string

artikelnummer

description

string

artikel omschrijving

unitPrice

float

stuksprijs

ledgerAccNo

string

Stip-T omzet grootboekrekening

vatCode

string

Stip-T BTW code

productGroupCode

string

Stip-T artikelgroep code

userFieldList

List<UserField>

Een artikel kan gebruikersvelden bevatten, zie UserField