PlaceSimpleOrder API
Ett API för att skapa friorder i GKS3.
URL
Efter installation av PlaceSimpleOrder API nås webbtjänstens sida från:
Autentisering
Ange ett GKS3-konto i body:n under:
<Ticket>
<Username>EHANDEL</Username>
<Password>ehandel</Password>
</Ticket>
GKS-konot som anges måste minst ha behörigheten EHandel.
Exempelanrop
Följande HTTP-anrop kan skickas till servern. Första raden avser adressen till servern. Andra och tredje raden är headers. Följande rader tillhör body.
POST http://localhost/GKS.External.PlaceSimpleOrder/PlaceSimpleOrder.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://www.simutek.se/PlaceSimpleOrder/PlaceFreeOrder"
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PlaceFreeOrder xmlns="http://www.simutek.se/PlaceSimpleOrder/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Ticket>
<Username>EHANDEL</Username>
<Password>ehandel</Password>
</Ticket>
<Order>
<CustomerId>5</CustomerId>
<Title>En test-webborder</Title>
<CustOrderNo/>
<ExtOrderNo>0</ExtOrderNo>
<CustomerReferenceName>Ola Eriksson</CustomerReferenceName>
<CustomerReferencePhone/>
<CustomerReferenceMobile/>
<CustomerReferenceEmail/>
<DeliveryAddressRow1/>
<DeliveryAddressRow2/>
<DeliveryAddressRow3/>
<DeliveryAddressRow4/>
<CustomerName/>
<CustomerDepartment/>
<CustomerAddressRow1/>
<CustomerZipCode/>
<CustomerCity/>
<CustomerCountry/>
<Orderlines>
<Orderline>
<Specification>Visitkort</Specification>
<Quantity>100</Quantity>
<UnitPrice>5</UnitPrice>
</Orderline>
</Orderlines>
</Order>
<Test>false</Test>
</PlaceFreeOrder>
</s:Body>
</s:Envelope>
Byt ut localhost på första raden mot er servers fulla namn.
Byt ut CustomerId till ett kundnummer som finns i ert kundregister.
Med curl
curl -v -XPOST -H "SOAPAction: http://www.simutek.se/PlaceSimpleOrder/PlaceFreeOrder" -H "Content-Type: text/xml; charset=utf-8" --data-raw '<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <PlaceFreeOrder xmlns="http://www.simutek.se/PlaceSimpleOrder/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Ticket> <Username>ADMIN</Username> <Password></Password> </Ticket> <Order> <CustomerId>15058</CustomerId> <Title>En test-webborder2</Title> <CustOrderNo/> <CustomerReferenceName>Ola Eriksson</CustomerReferenceName> <CustomerReferencePhone/> <CustomerReferenceMobile/> <CustomerReferenceEmail/> <DeliveryAddressRow1/> <DeliveryAddressRow2/> <DeliveryAddressRow3/> <DeliveryAddressRow4/> <CustomerName/> <CustomerDepartment/> <CustomerAddressRow1/> <CustomerZipCode/> <CustomerCity/> <CustomerCountry/> <Orderlines> <Orderline> <Specification>Visitkort</Specification> <Quantity>100</Quantity> <UnitPrice>5</UnitPrice> </Orderline> </Orderlines> </Order> <Test>false</Test> </PlaceFreeOrder> </s:Body> </s:Envelope>' "http://localhost/GKS.External.PlaceSimpleOrder/PlaceSimpleOrder.asmx"
Teknisk dokumentation (WSDL)
Den tekniska dokumentationen är tillgänglig genom att addera frågesträngen ?WSDL
till tjänstens URL. Den går även att ladda ner här:
Dokumentation
Skapa friorder i GKS3
POST
/GKS.External.PlaceSimpleOrder/PlaceSimpleOrder.asmx
Beskrivning av de parameter som ingår i SOAP-anropet.
Anropet måste ha en (1) orderrad eller fler.
En obligatorisk parameter (required) måste vara inkluderad i anropet, men kan lämnas blank om inget annat framgår:
<CustomerReferenceEmail />
En frivillig (optional) parameter kan utelämnas.
En nullable parameter kan sättas till nil:
<EInvoiceCode xsi:nil="true" />
Request Body
SpecLanguage
int
Språk på ordern: 0: Svenska 1: Engelska 2: Norska Styr exempelvis språk som visas vid en utskrift av orderbekräftelse. (nullable)
CustomerId*
string
Kundnummer. Max 10 tecken. (får ej lämnas blank)
Title*
string
Orderbenämning. Max 80 tecken.
CustOrderNo
string
Beställningsnr.
Max 25 tecken.
ExtOrderNo
int
Externt referensnr för fri användning av anropande system.
CustomerReferenceName*
string
Referensens namn. Max 40 tecken.
CustomerReferencePhone*
string
Referensens telefon. Max 20 tecken.
CustomerReferenceMobile*
string
Referensens mobil. Max 20 tecken.
CustomerReferenceEmail*
string
Referensens e-post. Max 100 tecken.
DeliveryAddressRow1*
string
Leveransadress.
Max 80 tecken.
DeliveryAddressRow2*
string
Leveransadress. Max 80 tecken.
DeliveryAddressRow3*
string
Leveransadress. Max 80 tecken.
DeliveryAddressRow4*
string
Leveransadress. Max 80 tecken.
CustomerName*
string
Kundens företagsnamn, om angivet. I annat fall hämtas uppgiften från kundregistret. Max 128 tecken. (nullable)
CustomerDepartment*
string
Kundens avdelning, om angivet. I annat fall hämtas uppgiften från kundregistret. Max 128 tecken. (nullable)
CustomerAddressRow1*
string
Kundens fakturaadress, om angivet. I annat fall hämtas uppgiften från kundregistret.
Max 40 tecken. (nullable)
CustomerZipCode*
string
Kundens fakturaadress, om angivet. I annat fall hämtas uppgiften från kundregistret.
Max 10 tecken. (nullable)
CustomerCity*
string
Kundens fakturaadress, om angivet. I annat fall hämtas uppgiften från kundregistret.
Max 40 tecken. (nullable)
CustomerCountry*
string
Kundens fakturaadress, om angivet. I annat fall hämtas uppgiften från kundregistret. Max 40 tecken. (nullable)
Orderline.Specification*
string
Orderradens benämning. Max 80 tecken.
Orderline.Quantity*
int
Orderradens antal. Får inte vara negativt.
Orderline.UnitPrice*
double
Orderradens á-pris. Får inte vara negativt.
Orderline.ProfitCenterCode
string
Orderradens resultatenhet. Max 4 tecken.
PromisedDeliveryDate
dateTime
Utlovat leveransdatum (nullable)
PurchaseDate
dateTime
Beställningsdatum (nullable)
EInvoiceCode
string
Referensens e-fakturakod. Max 40 tecken. (nullable)
EmailInvoice
string
E-post för PDF-faktura. Max 100 tecken. (nullable)
OrderExport
enum
NoExport ExportWithinEU ExportOutsideEU (nullable)
VatProcentage
int
Moms. Tillåtna värden:
25
6
0 (nullable)
Orderline.SalesUnit
string
Orderradens försäljningsenhet Exempel: "st" Max 10 tecken.
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<s:Header xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" />
<soap:Body>
<PlaceFreeOrderResponse xmlns="http://www.simutek.se/PlaceSimpleOrder/">
<PlaceFreeOrderResult>true</PlaceFreeOrderResult>
<Error>
<Id>0</Id>
<Message />
</Error>
</PlaceFreeOrderResponse>
</soap:Body>
</soap:Envelope>
Last updated
Was this helpful?