moveIT WEBCON interface to Webshop

Updated on 15 Jul 2024
2 Minutes to read

Print
Share
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

After completing a configuration in moveIT WEBCON, a JSON object must be passed to a shop controller via HTTP POST.

Structure of the JSON object

Header information

Field	Data type	Format	Description	Available from
LeafletId	Char	X(32)	Wishlist ID	46.10.00
EnvironmentID	Int	6	Environment ID, which can be used to uniquely identify the installation.	48.60.HF
DocType	Int	9	Document Type (1=Quotation / 2=Order)	48.60.HF
GUID	Char	X(40)	GUID of the document containing the configuration	48.60.HF
BasePosition	Char	X(2048)	If a completed configuration that has been transferred to the shopping cart is to be changed, the URL parameter &BasePosition= must be entered, which is assigned the GUID of position 1 (GUID from Section 1.1.2 Position Information of the First Position "1") of the configuration to be changed. After the configuration change has been completed, this GUID is given to the shopping cart when it is transferred again, which allows the WebShop to recognize that it is a change and also which item is to be replaced by the "new" one.	49.30.00
AdditionalResponseData	Char	X(2048)	Similar to BasePosition, "AdditionalResponseData" is also a URL parameter, the content of which is passed through to the shopping cart when moveIT WEBCON is called, allowing the WebShop to react to it. The URL parameter can be freely assigned. As a possible application, "AdditionalResponseData" in conjunction with "BasePosition" can be assigned to "ChangeAndReplace", for example, so that the web shop recognizes when it is handed over that it overwrites the BasePosition, which is in the shopping cart, with the new position. Or if necessary, a session ID can be passed here.	49.30.00

Position information

Content is generated per position/item

Field	Data type	Format	Description	Available from
Model	Char	X(24)	Model Number	46.10.00
ModelDescription	Char	X(128)	Description of the item	46.10.00
GrossPrice	Head	American Format ->>>.>>>.>>>.>>9.99	Net sales price in foreign currency (i.e. discounts and currency are used by the standard customer defined in the backend)	46.10.00
Currency	Char	X(3)	Currency	46.10.00
Quantity	Head	->>>.>>>.>>>.>>9.99	Quantity	46.10.00
Unit	Char	X(8)	Unit	46.10.00
ImageUrl	Char	X(2048)	Link to the image of the article/configuration	46.10.00
ProductText	LongChar	Unlimited	Generated product text from the configuration in HTML format	46.10.00
GUID	Char	X(40)	GUID of the position (unique ID assigned in the system)	48.60.HF
EAN	Char	X(20)	If the item has an EAN, it will be transferred	48.60.HF
ReferenceArticleNumber	Char	X(24)	If an article referencing is carried out on moveIT@web page, the reference article is transferred.	48.60.HF
GLN	Char	X(13)	In the "GLN/ILN" field, the actual, own supplier number can be stored, which is then transferred.	48.60.HF
PurchasePrice	Head	American Format ->>>.>>>.>>>.>>9.99	Calculated purchase price – is only correct if purchasing conditions are also maintained on moveIT@web side. ATTENTION: Once this has been maintained, encrypted communication should definitely be carried out.	48.60.HF

Example JSON Payload:

{
	"LeafletId": "997-20061819-24-24",
    "GUID": "f2c31881-49bd-939a-5414-efdf288325f7",
    "DocTyp": 2,
    "EnvironmentID": 997,
	"BasePosition": "",
	"AdditionalResponseData": "",
	"1": {
		"Model": "G_Gliederung",
		"ModelDescription": "Gliederung für Garagentor",
		"GrossPrice": 123.45,
		"PurchasePrice": 100.22,
		"Currency": "EUR",
		"Quantity": 1,
		"Unit": "Stk",
		"ImageUrl": "isswebdata\\Data\\WebConfigGraphics\\0104-6\\PosGraphic_1.jpg",
		"ProductText": "<div>text<\/div>",
		"GUID": "219020-11293993939-122",
		"EAN": "",
		"ReferenceArticleNumber": "",
		"GLN": "1222321",
		"2": {
			"Model": "GARAGENTOR",
			"ModelDescription": "Unterposition 1",
			"GrossPrice": 123.45,
			"PurchasePrice": 100.22,
			"Currency": "EUR",
			"Quantity": 1,
			"Unit": "Stk"
			"ImageUrl": "isswebdata\\Data\\WebConfigGraphics\\0104-6\\PosGraphic_2.jpg",
			"ProductText": "<div>text<\/div>"
			"GUID": "219020-11293993939-122",
			"EAN": "",
			"ReferenceArticleNumber": "",
			"GLN": "1222321"
		}
	}
}

If a position has a sub-position (because it is an outline position and its assigned sub-position), these sub-positions are listed as others within the first item, all of which have the same fields as the outline item.

The transfer to a shop controller or endpoint is done via HTTP-POST, where the JSON is sent as FormData in the request:

Was this article helpful?

What's Next

Beschreibung und Vorteile

Table of contents

Structure of the JSON object