Endpoint - Save Config

Endpoint used for either saving the user config or on every wizard step

This request is made in two situations:

At the end of every config wizard step as a customer enters / edits the fields and on the config screen if custom config items are supplied back when the step name is "UserConfig".

Linnworks will provide the entire object that was provided back with the only field ever changing being the SelectedValue. This is passed back cast as string as fields may be of many different types.

Request

Post

SaveConfigRequest

Field NameTypeDescription
AuthorizationTokenStringAuthorization Token from the customers integration.
ConfigItemsConfigItem[]See: Endpoint - User Config - ConfigItem
StepNameStringThe step name Linnworks thinks it’s on. It’s good to check this field incase wizards get out of sync for any reason.

Sample

{
	"StepName": "AddCredentials",
	"ConfigItems": [
		{
			"ConfigItemId": "APIKey",
			"Name": "API Key",
			"Description": "Website API Key",
			"GroupName": "API Credentials",
			"SortOrder": 1,
			"SelectedValue": "AnApiKeyGoesHere",
			"RegExValidation": null,
			"RegExError": null,
			"MustBeSpecified": true,
			"ReadOnly": false,
			"ListValues": [],
			"ValueType": "PASSWORD"
		},
		{
			"ConfigItemId": "APISecretKey",
			"Name": "API Secret Key",
			"Description": "Website API Secret Key",
			"GroupName": "API Credentials",
			"SortOrder": 2,
			"SelectedValue": "MYSuperSecretKey",
			"RegExValidation": null,
			"RegExError": null,
			"MustBeSpecified": true,
			"ReadOnly": false,
			"ListValues": [],
			"ValueType": "PASSWORD"
		},
		{
			"ConfigItemId": "IsOauth",
			"Name": "Is Oauth",
			"Description": "Defines if the authentication type is Oauth",
			"GroupName": "API Settings",
			"SortOrder": 3,
			"SelectedValue": "False",
			"RegExValidation": null,
			"RegExError": null,
			"MustBeSpecified": true,
			"ReadOnly": false,
			"ListValues": [],
			"ValueType": "BOOLEAN"
		}
	],
	"AuthorizationToken": "1fdea65984c54a91ae8549de68844ca9"
}

Response

SaveConfigResponse

Field NameTypeDescription
AuthorizationTokenStringAuthorization Token from the customers integration.
ConfigItemsConfigItem[]See: Endpoint - User Config - ConfigItem
StepNameStringThe next wizard step name.
WizardStepDescriptionStringDescription of the next wizard step.
WizardStepTitleStringUser visible title displayed on the integration wizard.

SomeNewType

Field NameTypeDescription
Value 1GUID
Value 2String

Sample

{
	"Error": null,
	"StepName": "OrderSetup",
	"WizardStepDescription": "Definition of tax settings and items to return",
	"WizardStepTitle": "Order Setup",
	"ConfigItems": [
		{
			"ConfigItemId": "PriceIncTax",
			"Name": "Price Includes Tax",
			"Description": "Defines if the price of an item includes tax",
			"GroupName": "Tax",
			"SortOrder": 1,
			"SelectedValue": "False",
			"RegExValidation": null,
			"RegExError": null,
			"MustBeSpecified": true,
			"ReadOnly": false,
			"ListValues": [],
			"ValueType": "BOOLEAN"
		},
		{
			"ConfigItemId": "DownloadVirtualItems",
			"Name": "Download Virtual Items",
			"Description": "Check to allow the download of virtual items",
			"GroupName": "Items",
			"SortOrder": 2,
			"SelectedValue": "False",
			"RegExValidation": null,
			"RegExError": null,
			"MustBeSpecified": false,
			"ReadOnly": false,
			"ListValues": [],
			"ValueType": "BOOLEAN"
		}
	]
}