Skip to end of metadata
Go to start of metadata

SWAPI


 

about

SWAPI
(Softwear Web-API) 
Version: 1.15
Date: 2 december 2015
Author: Jeroen de Vries 

Version history

2 december 2015

30 oktober 2015

  • getStatus aanpassen: toevoegen REFID documentatie

19 jun 2015

  • Toevoegen documentatie SendOrderSpecs

23 maart 2015

  • oude logo verwijderd uit het document (in header)
  • function SetClient: ook voorbeeld wholesale toegevoegd
  • parameter clientnr:string added


08 oct 2013

  • Added GetBasicOrderInfo function
  • Added getOrderProgress function

11 jul 2013

  • Added customer telephone
  • Added customer feed

25 jun 2013

  • Added JSON support
  • Removed SOAP support
  • Improved ADDCOUPON function

19 sep 2012

  • Added DISCOUNT-examples

23 jul 2012

  • Changed UUID-code for get token

2 nov 2011: 1.7

  • Added SENDRMA function
  • Added HTTPS support

27 dec 2011: 1.6

  • Added CHECKCOUPON function

18 oct 2011: 1.5

  • Added RAPTORSKU function

21 oct 2010: 1.4

  • Added barcode parameter to GETSTOCK

21 oct 2010: 1.2

  • Added multiple-article capability to GETSTOCK

04 oct 2010: 1.1

  • Added BLOCKCLIENT function

31 aug 2010: 1.0.a

  • Added pwd parameter to SETCLIENT function

10 aug 2010: 1.0

  • Changed all XML encoding from utf-8 to windows-1252
  • GETCLIENT can now be called with id and/or email address
  • SETCLIENT now returns id of newly created client
  • Added GETINVOICE function

07 jun 2010: Draft 0.9

  • Added SETCLIENT function

31 may 2010: Draft 0.8

  • Added GETCLIENT function

30 may 2010: Draft 0.7

  • Added SENDTRANSIT function

23 may 2010: Draft 0.6

  • Added perShop switch to GETSTOCK function

23 apr 2010: Draft 0.5

  • Added GETSTATUS function
  • Added GETCOUPONS function
  • Added REDEEMCOUPON function
  • Added ADDCOUPON function

05 jan 2010: Draft 0.4

  • Added RefiD to SENDORDER function
  • Added CANCELORDER function

27 nov 2009: Draft 0.3

  • Added Shipping and discount to SENDORDER function

20 nov 2009: Draft 0.2

  • Added SENDORDER function

31 oct 2009: Draft 0.1
 



The Softwear Web API (SWAPI) allows developers to interact with the Softwear ERP and POS systems.

The API is HTTP-based

All methods in SWAPI require a GET or POST request. HTTP response codes are not (yet) meaningful.

Let op!

The maximum size of a POST request is 48 kilobytes.


The API is a RESTful resource

SWAPI attempts to conform to the design principles of Representational State Transfer (REST).
Most methods take the optional format parameter that allows you to get results in the format of your choice.
SWAPI currently supports the following data formats: XML, HTML and JSON.

Test v.s production

For testing, use http://testapi.softwear.nl.
For production purposes, use http://webshop.softwear.nl or http://webshop.softwear.nl/scripts/FoxIsapi.dll/sww1.wreq1.mpx

Let op!

If the testapi is used, return values will be the same as the production api however, no changes are made in the database.

Please note that the testapi is significantly slower than the production api.

 


 


HTTPS

Encrypted services are available.
For testing, use https://www.softwear.nl/testapi
For production purposes, use https://webshop.softwear.nl/

Be aware that encrypted services run slower than unencrypted services.
We advice to run non-sensitive api’s like getStock on unencrypted services to keep them as fast as possible. Sensitive api’s, specifically those that deal with customer data like getclient and sendorder are better run on encrypted services.

DATAFEEDS

In addition to the api, several datafeeds can be downloaded upon request. Datafeeds are available for article information and client information. Datafeeds are refreshed automatically every 24 hrs. All datafeeds are in CSV format.
The content of the datafeeds can vary per project, for more information contact us at info@softwear.nl or 075-7630650.

TOKEN

The API uses a token for identification. If an API has been setup for a Softwear instance, a token will be provided. Throughout this documentation, a sample token will be used. This UUID token, 1660-8920-F99A-11E0-BE50-0800-200C-9A66, gives access to an example database.

The datafeed for the example database, the one with token=1660-8920-F99A-11E0-BE50-0800-200C-9A66 can be downloaded from:

http://www.softwear.nl/ism/1660-8920-F99A-11E0-BE50-0800-200C-9A66/a.csv

The customerfeed for the example database, the one with token=1660-8920-F99A-11E0-BE50-0800-200C-9A66 can be downloaded from:

http://www.softwear.nl/ism/1660-8920-F99A-11E0-BE50-0800-200C-9A66/cu.csv

 


 

function getStock.

This method is used to recieve the actual stock of an article.

Syntax 1:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?[function=]getstock&[token=]<shopid>[&articlecode=<articlecode>][&barcode=<barcode> ][&format=<xml/html>][&switches=<logical|detail|perShop>]
Syntax 2: http://testapi.softwear.nl/getstock/<shopid>/articlecode__<articlecode> /barcode__<barcode> [/format__<xml/html>][/switches__<logical|detail|perShop>]
elements in [ ] are optional
elements in <> should be replaced by literals

Example: http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?getstock&token=1660-8920-F99A-11E0-BE50-0800-200C-9A66&articlecode=00000002&format=xml&switches=logical

parameter: token:string
UUID shopid

parameter: articlecode:string
Articlecode of article for which stock should be returned.
Articlecode is case-sensitive.
Articlecode can be either a single artilecode or a comma separated list of articlecodes.

parameter: barcode:string
Barcode of article for which stock should be returned.
Barcode is case-sensitive.
Barcode can be either a single barcode or a comma separated list of barcodes.
Can be any barcode of article, stock for all variations of article will be returned.

parameter: switches:string
comma separated string of switches.
logical returns result as 1 or 0. 1 Means that there is at least one piece of that article in stock, regardless of size and color. The logical option can only be used when stock is retrieved for a single articlecode.
detail returns result per SKU (default)
perShop returns results per shop (implies detail)

 


 

function sendOrderSpec.

This method is used to set order specifications to a leading order in a Softwear backoffice.

Syntax 1: 
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?[function=]sendorderspecs[&token=]<shopid>[&nettterm]=<nettterm>[&discperc1]=<discperc1>[&discterm1]=<discterm1>[&discperc2]=<discperc2>[&discterm2]=<discterm2>[&fixdate]=<fixdate>[&reservationdate]=<reservationdate>[&remarks]=<remarks>[&notes]=<notes>[&signature]=<signature>[&carrier]=<carrier>&custnum=<custnum>&refid=<refid>

elements in [ ] are optional
elements in <> should be replaced by literals

Example: 
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?sendorderspecs&token=1660-8920-F99A-11E0-BE50-0800-200C-9A66&nettterm=30&discperc1=2.00&discterm1=10&fixdate=30-10-2015&reservationdate=19-06-2015&remarks=Telefonische order.&notes=&signature=&carrier=&custnum=1234&refid=50-32-1234

parameter: token:string
UUID shopid

parameter: nettterm:number
Term of payment in days

parameter: discperc1:number
Discount percentage (1)

parameter: discterm1:number
Term of discount (1) in days

parameter: discperc2:number
Discount percentage (2)

parameter: discterm1:number
Term of discount (2) in days

parameter: reservationdate:date 
Date of order issue from

parameter: fixdate:date
Date of order issue till

parameter: carrier:string
Name of carrier / expediter

parameter: custnum:string
Customer number of client

parameter: refid:string
Reference order number. This number uniquely identifies the leading order. If this number is supplied with this function, the same number must be used to send in the actual order.

 


 

function sendOrder.

This method is used to place an order in a Softwear backoffice.

Syntax 1:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?[function=]sendorder&[token=]<shopid>&custnum=<custnum>&email=<email>&title=<title>&firstname=<firstname>&middlename=<middlename>&lastname=<lastname>&street=<street>&housenum=<housenum>&houseadd=<houseadd>&zipcode=<zipcode>&city=<city>&countrycode=<countrycode>&remarks=<remarks>&shipping=<shipping>&discount=<discount> [&refid=<refid>][&articlecode=<articlecode>&color=<color>&size=<size>&qty=<qty>&price=<price>]*

elements in [ ] are optional
elements in <> should be replaced by literals

Example:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?sendorder&token=1660-8920-F99A-11E0-BE50-0800-200C-9A66&custnum=1234&email=jeroen@softwear.nl&title=Dhr&firstname=Jeroen&middlename=de&lastname=Vries&street=Veerdijk&housenum=42&houseadd=e&zipcode=15312MS&city=WORMER&countrycode=NL&remarks=Niet%20op%20maandag%20leveren&shipping=495&discount=1000&refid=65748392&articlecode=12345&color=200/600&size=68&qty=1&price=2995&articlecode=12345&color=200/600&size=74&qty=2&price=3995

parameter: token:string
UUID shopid

parameter: custnum:string
Customer number of client. Returning customers should be addressed by their existing emailadres, not necessarily their customernumber. Otherwise, a new customers will be created in Softwear.

parameter: email:string
email address of customer

parameter: title:string
Title of customer. Usually something like Mr/Mrs/Ms etc…

parameter: firstname:string
Customers firstname or initials

parameter: middlename:string
Customers middlename

parameter: lastname:string
Customers last- or familyname

parameter: street:string
Deliveryaddress streetname

parameter: housenum:string
Deliveryaddress house number

parameter: houseadd:string
Deliveryaddress housenumber addition

parameter: zipcode:string
Deliveryaddress zip or postal code

parameter: city:string
Deliveryaddress city

parameter: countrycode:string
Deliveryaddress countrycode.
Coded against ISO 3166: http://www.iso.org/iso/english_country_names_and_code_elements

parameter: remarks:string
Remarks

parameter: shipping:number
Shipping fee in eurocents or the actual fee times 100
Eg. € 4,95 would be represented as 495.
Shipping includes VAT

parameter:discount:number
Discount amount in eurocents or the actual amount times 100.
Eg. € 6,25 would be represented as 625.
This discount applies to the whole order, not to the individual articles listed below. Discount includes VAT. Use this parameter for coupons, sales, loyalty discount,etc.
Discounts for specific articles should be specified per article be changing the price parameter in the articlelist described below.

parameter:refid:string(10)
Reference order number.
This number uniquely identifies the order. If this number is supplied with this function, the same number can be used with the cancelorder function to cancel an order in the backoffice.

parameter: articlecode:string
Articlecode as found in datafeed.

parameter: color:string
Colorcode as found in datafeed.

parameter: size:string
Size as found in datafeed. When mailcolor/sucolor or mailcolor/cup are both used, concatenate them both with a slash ( / ) in between .

parameter: qty:integer
Nr. Pieces sold of most recently mentioned article

parameter: price:integer
Price of most recently mentioned article times 100
Price includes VAT
If price=0, Softwear will use the price that it knows for the article.
If price is less than known in Softwear, the difference will be treated as a discount.

The previous 5 parameters can be repeated as many times as needed to express the complete salesorder.
The order of these parameters is significant: articlecode, color, size, qty, price.

Return values
Results are returned in HTML.
On success, OK is returned, otherwise a human readable error message is returned.

Remarks:
Optionally, the sendOrder API can be configured to accept amounts excluding VAT.


 

function cancelOrder.

 

This method is used to cancel an existing order in a Softwear backoffice.

Syntax 1:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?[function=]cancelorder&[token=]<shopid>&refid=<refid>

elements in [ ] are optional
elements in <> should be replaced by literals

Example:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?cancelorder&token=1660-8920-F99A-11E0-BE50-0800-200C-9A66&refid=65748392

parameter: token:string
UUID shopid


parameter: refid:string(10)
Reference order number.
This number uniquely identifies the order. It is the same number originally supplied as refid when the order was created with the sendorder function.
 


 

function getStatus.

This method is used to recieve the historical transactions of a customer or a specific transaction.

Syntax 1:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?[function=]getstatus&[token=]<shopid>&email=<email>&custnum=<customernumber>[&format=<xml/html>]

Syntax 2: http://testapi.softwear.nl/getstatus/<shopid>/email__<email>[/format__<xml/html>]

elements in [ ] are optional
elements in <> should be replaced by literals

Example: http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?getstatus&token=1660-8920-F99A-11E0-BE50-0800-200C-9A66&email=jeroen@softwear.nl&format=xml

Example 2: http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?getstatus&token=1660-8920-F99A-11E0-BE50-0800-200C-9A66&refid=12345&format=xml

parameter: token:string
UUID shopid

Historical transactions of a customer:

parameter: custnum or email :string    (choose custnum OR email)

Emailaddress of clientnr

A specific transaction

parameter: refid: string(10)

Reference order number.
This number uniquely identifies the order. It is the same number originally supplied as refid when the order was created with the sendorder function.


 


 

function getCoupons.


This method is used to recieve the coupons status of a customer.

Syntax 1:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?[function=]getcoupons&[token=]<shopid>&email=<email>[&format=<xml/html>]

Syntax 2: http://testapi.softwear.nl/getcoupons/<shopid>/email__<email>[/format__<xml/html>]

elements in [ ] are optional
elements in <> should be replaced by literals

Example: http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?getcoupons&token=1660-8920-F99A-11E0-BE50-0800-200C-9A66&email=jeroen@softwear.nl&format=xml

parameter: token:string
UUID shopid

parameter: email:string
Emailaddress of client.

 


 

function redeemCoupon.


This method is used to redeem (part of) an existing coupon.

Syntax 1:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?[function=]redeemcoupon&[token=]<shopid>&couponid=<couponid> [&value=<value>][&format=<xml/html>]

Syntax 2: http://testapi.softwear.nl/redeemcoupon/<shopid>/couponid__<couponid> /[value__<value>][/format__<xml/html>]

elements in [ ] are optional
elements in <> should be replaced by literals

Example: http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?redeemcoupon&token=1660-8920-F99A-11E0-BE50-0800-200C-9A66& format=xml

parameter: token:string
UUID shopid

parameter: couponid:string
unique id of existing coupon.

parameter: value:string
Value to substract from coupon in eurocents.
Of value is omitted, the entire coupon is redeemed.
Value can only be specified for monetary coupons, not for percentage coupons. Percentage coupons can only be redeemed entirely.

 


 

function addCoupon.


This method is used to create a new coupon for an existing customer.

Syntax 1:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?[function=]addcoupon&[token=]<shopid>[&email=<email>]&couponid=<couponid >&value=<value>[&format=<xml/html>]

Syntax 2: http://testapi.softwear.nl/addcoupon/<shopid>[/email__<email>]/couponid__<couponid>/value__<value>[/format__<xml/html>]

elements in [ ] are optional
elements in <> should be replaced by literals

Example: http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?addcoupon&token=1660-8920-F99A-11E0-BE50-0800-200C-9A66&email=jeroen@softwear.nl&couponid=1234567890/value=1000&format=xml

Example: http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?addcoupon&token=1660-8920-F99A-11E0-BE50-0800-200C-9A66&couponid=1234567890/value=10%&format=xml

parameter: token:string
UUID shopid

parameter: email:string
Emailaddress of an existing client. If emailaddress is omitted, a generic coupon will be generated that can be redeemed by any client.

parameter: couponid:string
unique id for new coupon.
CouponId’s can contain all alphanumeric characters.
CouponId’s that start with a lowercase letter are special coupons that are redeemable multiple times (like couponcodes that are distributed in newspapers or other media). These coupons are not to be combined with email addresses.

All other coupons are redeemable up to their designated value.

parameter: value:string
Coupon value in eurocents or a percentage.
To create a percentage discount coupon, add a percent sign (%) to the value e.g. value=10%.


 

function checkCoupon.


This method is used to check the status of an existing anonymous coupon, i.e. a coupon that is not bound to a particular customer.

Syntax 1:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?[function=]checkcoupon&[token=]<shopid>&coupon=<couponid> [&value=<value>][&format=<xml/html>]

elements in [ ] are optional
elements in <> should be replaced by literals

Example: http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?checkcoupon&token=1660-8920-F99A-11E0-BE50-0800-200C-9A66&coupon=test&format=xml

parameter: token:string
UUID shopid

parameter: coupon:string
unique id of existing coupon.

 


 

function sendTransit.


This method is used to create a transit order in a Softwear backoffice.

Syntax 1:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?[function=]sendtransit&[token=]<shopid>&from=<sourceshop>&to=<destinationshopl>&articlecode=<articlecode>&color=<color>&size=<size>&qty=<qty>

elements in [ ] are optional
elements in <> should be replaced by literals

Example:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?sendtransit&token=1660-8920-F99A-11E0-BE50-0800-200C-9A66&from=Amsterdam&to=Wormer&articlecode=12345&color=200/600&size=74&qty=2

parameter: token:string
UUID shopid

parameter: from:string
Shopname where transit is originating. Shopname is case sensitive and should be obtained from the getstock function used with the perShop switch

parameter: to:string
Shopname where transit is going to. Shopname is case sensitive and should be obtained from the getstock function used with the perShop switch

parameter: articlecode:string
Articlecode as found in datafeed.

parameter: color:string
Colorcode as found in datafeed.

parameter: size:string
Size as found in datafeed.

parameter: qty:integer
Nr. Pieces sold of most recently mentioned article

Return values
Results are returned in HTML.
On success, OK is returned, otherwise a human readable error message is returned.

 


 

function getClient.


This method is used to recieve the address information of a customer.

Syntax 1:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?[function=]getclient&[token=]<shopid>[&email]<email>][&id]<id>][&format=<xml/html>][&switches=<list>]

Syntax 2: http://testapi.softwear.nl/getclient/<shopid>/[email__<email>][/format__<xml/html>][/switches__<logical>]


elements in [ ] are optional
elements in <> should be replaced by literals

Example: http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?getclient&token=1660-8920-F99A-11E0-BE50-0800-200C-9A66&email=jeroen@softwear.nl&format=xml

parameter: token:string
UUID shopid

parameter: email:string
Emailaddress of client.

parameter: switches:string
comma separated string of switches.
list returns a list emailaddresses for all active clients
detail returns details for client specified by email address parameter (default).

 


 

function setClient.


This method is used to add or update a client order in a Softwear backoffice.

Syntax 1 for use with Softwear retail systems:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?[function=]setclient&[token=]<shopid>&custnum=<custnum>&email=<email>&title=<title>&firstname=<firstname>&middlename=<middlename>&lastname=<lastname>&street=<street>&housenum=<housenum>&houseadd=<houseadd>&zipcode=<zipcode>&city=<city>&pwd=<pwd>&countrycode=<countrycode>

Syntax 2 for use with Softwear wholesale systems:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?[function=]setclient&[token=]<shopid>&custnum=<custnum>&email=<email>&title=&name=<name>&street=<street>&housenum=<housenum>&houseadd=<houseadd>&zipcode=<zipcode>&city=<city>&countrycode=<countrycode>

elements in [ ] are optional
elements in <> should be replaced by literals

Example for retail:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?setclient&token=1660-8920-F99A-11E0-BE50-0800-200C-9A66&custnum=1234&email=jeroen@softwear.nl&title=Dhr&firstname=Jeroen&middlename=de&lastname=Vries&street=Veerdijk&housenum=42&houseadd=e&zipcode=1531%20MS&city=WORMER&countrycode=NL

Example for wholesale:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?setclient&token=1660-8920-F99A-11E0-BE50-0800-200C-9A66&custnum=1234&email=jeroen@softwear.nl&name=Jeroen%20de%20Vries&street=Veerdijk&housenum=42&houseadd=e&zipcode=1531%20MS&city=WORMER&countrycode=NL&deliveryaddress=veerdijk%2014&deliverycountrycode=NL&deliverycity=Wormer&deliveryzipcode=1531%20MS

parameter: token:string
UUID shopid

parameter: custnum:string
Internal Softwear customernumber of client. Returning customers should be addressed by their existing email address, not necessarily their customernumber. Otherwise, a new customer will be created in Softwear.

parameter: clientnr:string
Customernumber of client. Returning customers should be addressed by their existing email address, not necessarily their customernumber. Otherwise, a new customer will be created in Softwear.

parameter: email:string
emailaddress of customer

parameter: title:string
Title of customer. Usually something like Mr/Mrs/Ms etc…

parameter: firstname:string
Customers firstname or initials

parameter: middlename:string
Customers middlename

parameter: lastname:string
Customers last- or familyname

parameter: telephone:string
Customers telephone

parameter (wholesale): name:string
Company name

parameter (wholesale): deliveryaddress:string
Delivery address

parameter (wholesale): deliverycountrycode:string
Delivery countrycode

parameter (wholesale): deliverycity:string
Delivery city

parameter (wholesale): deliverytelephone:string
Delivery telephone

parameter (wholesale): deliveryzipcode:string
Delivery zipcode

parameter (wholesale): vatnr:string
VAT nr

parameter: street:string
Deliveryaddress streetname

parameter: housenum:string
Deliveryaddress house number

parameter: houseadd:string
Deliveryaddress housenumber addition

parameter: zipcode:string
Deliveryaddress zip or postal code

parameter: city:string
Deliveryaddress city

parameter: password:string
Password. If not supplied, Softwear will generate a password.

parameter: countrycode:string
Deliveryaddress countrycode.
Coded against ISO 3166: http://www.iso.org/iso/english_country_names_and_code_elements

 


 

function getInvoice.


This method is used to recieve invoice data for a particular day from Softwear.

Syntax 1:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?[function=]getinvoice&[token=]<shopid> [&year]<year>] [&month]<month>] [&day]<day>][&format=<xml/html>]

Syntax 2: http://testapi.softwear.nl/getinvoice/<shopid>/[year__<year>][month__<month>][day__<day>][/format__<xml/html>]

elements in [ ] are optional
elements in <> should be replaced by literals

Example: http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?getinvoice&token=1660-8920-F99A-11E0-BE50-0800-200C-9A66&year=2010&month=8&day=12&format=xml

parameter: token:string
UUID shopid

parameter: year:number
Year to query.

parameter: month:number
Month to query.

parameter: day:number
Day to query.

 


 

function blockClient.


This method is used to block/unblock a client in a Softwear backoffice.

Syntax 1:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?[function=]blockclient&[token=]<shopid>&custnum=<custnum>&blocked=<true|false>


elements in [ ] are optional
elements in <> should be replaced by literals

Example:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?blockclient&token=1660-8920-F99A-11E0-BE50-0800-200C-9A66&custnum=1234&blocked=true

parameter: token:string
UUID shopid

parameter: custnum:string
Customernumber of client.

parameter: blocked:string
true to block a client, false to unblock.

 


 

function getBasicOrderInfo.


This method is used to get order-information out of a retail Softwear Back-office. Can be used to check if an sendorder has worked properly.

Syntax 1:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?[function=]getbasicorderinfo&[token=]<shopid>&refid=<refid>

elements in [ ] are optional
elements in <> should be replaced by literals

Example:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?getbasicorderinfo&token=1660-8920-F99A-11E0-BE50-0800-200C-9A66&refid=65748392

parameter: token:string
UUID shopid

parameter: refid:string(10)
Reference order number.
This number uniquely identifies the order. It is the same number originally supplied as refid when the order was created with the sendorder function.

Server-Response:
{"response”:”OK","refid":"65748392","amount":0.00,"interestdate":"01/10/13","collection":"102010,

"agent":"WEBSHOP","currency":"EURO" }

 


 

function getOrderProgress.


This method is used to retrieve the status of an order.

Syntax 1:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?[function=]getorderprogess&[token=]<shopid>&refid=<refid>

elements in [ ] are optional
elements in <> should be replaced by literals

Example:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?getorderprogress&token=1660-8920-F99A-11E0-BE50-0800-200C-9A66&refid=65748392


parameter: token:string
UUID shopid

parameter: refid:string(10)
Reference order number.
This number uniquely identifies the order. It is the same number originally supplied as refid when the order was created with the sendorder function.

Server-Response:
O = preorder
ON = order
P = packinglist for preorder
PN = packinglist
F = invoice for preorder
FN = invoice backorder

 


 

function raptorSKU.


This method is used to fetch article properties from a barcode. Can be used to implement cash registers.

Syntax 1:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?[function=]raptorsku&[token=]<shopid>&barcode=<barcode>


elements in [ ] are optional
elements in <> should be replaced by literals

Example:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?raptorsku&token=1660-8920-F99A-11E0-BE50-0800-200C-9A66&barcode=111

parameter: token:string
UUID shopid

parameter: barcode:string
max. 13 digit barcode.

 


 

function sendrma.


This method is used to place a returnorder in a Softwear backoffice. RMA’s should only be created for goods that have been invoiced to the customer. This information can be found in the getStatus api.

Syntax 1:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?[function=]sendrma&[token=]<shopid>&custnum=<custnum>[&articlecode=<articlecode>&color=<color>&size=<size>&qty=<qty>&line=<line>&price=<price>]*

elements in [ ] are optional
elements in <> should be replaced by literals

Example:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?sendorder&token=1660-8920-F99A-11E0-BE50-0800-200C-9A66&custnum=1234&articlecode=12345&color=200/600&size=68&qty=1&price=2995&articlecode=12345&color=200/600&size=74&qty=2&line=AC342&price=3995

parameter: token:string
UUID shopid

parameter: custnum:string
Customernumber of client.

This method is used to place a returnorder in a Softwear backoffice. RMA’s should only be created for goods that have been invoiced to the customer. This information can be found in the getStatus api.

Syntax 1:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?[function=]sendrma&[token=]<shopid>&custnum=<custnum>[&articlecode=<articlecode>&color=<color>&size=<size>&qty=<qty>&line=<line>&price=<price>[&reason=<reasoncode>]&remarks=<remarks>]*

elements in [ ] are optional
elements in <> should be replaced by literals

Example:
http://testapi.softwear.nl/scripts/foxisapi.dll/sww1.wreq1.mpx?sendorder&token=1660-8920-F99A-11E0-BE50-0800-200C-9A66&custnum=1234&articlecode=12345&color=200/600&size=68&qty=1&price=2995&articlecode=12345&color=200/600&size=74&qty=2&line=AC342&price=3995

parameter: token:string
UUID shopid

parameter: custnum:string
Customernumber of client.

parameter: articlecode:string
Articlecode as found in datafeed.

parameter: color:string
Colorcode as found in datafeed.

parameter: size:string
Size as found in datafeed. When mailcolor/sucolor or mailcolor/cup are both used, concatenate them both with a slash ( / ) in between .

parameter: qty:integer
Nr. Pieces sold of most recently mentioned article

parameter: line:integer
line code as found in getStatus api. This uniquely identifies an invoice line.

parameter: price:integer
Price of most recently mentioned article times 100
Price includes VAT

parameter: reason:string
Reason code. Codes can be found in the claims-reason table in Softwear.
Example: 00001

parameter: remarks:string
Remarks.

The previous 7 parameters can be repeated as many times as needed to express the complete rma.
The order of these parameters is significant: articlecode, color, size, qty, line, price, reason, remarks.
The last two parameters of the 7 are optional.

Return values
Results are returned in HTML.
On success, OK is returned, otherwise a human readable error message is returned.