This request is made in two situations:

Firstly when a customer is going through the integration wizard to integrate the channel. To complete the wizard returns "UserConfig" as the step name and this will indicate the wizard is complete.

The second instance is when the config is loaded the call is made to load any dynamic ConfigItems that may be required to show on the Linnworks config UI. SaveConfigEndpoint will be called on each wizard step and when the config is saved.

If the config is loaded and the StepName is not "UserConfig" it will load the config wizard and take them through the stages until "UserConfig" is returned. This can be especially useful if the user is required to go through additional steps down the line such as updating an auth token.

Request

Post

`UserConfigRequest`

Field Name	Type	Description
AuthorizationToken	`String`	Token that you generated for this customer.

Sample

{
	"AuthorizationToken": "a8e53e86eead4b69beaa0afcc29b67fb",
}

Response

`UserConfigResponse`

Field Name	Type	Description
IsConfigActive	`Boolean`	`Identifies whether the integration profile is in Active mode. Meaning the customer completed the integration wizard and can use the integration`
ConfigStatus	`String`	Configuration stage name. You must provide the same name to the UpdateConfig endpoint
ConfigStage	`ConfigStage`	Config stage class. See Endpoint - User Config - ConfigState
WizardStepDescription	`String`	Description of the current wizard step.
IsError	`Boolean`	`Indicates if there is an error`
ErrorMessage	`String / null`	Error message

`ConfigStage`

Field Name	Type	Description
WizardStepDescription	`String`	Description of the configuration stage
WizardStepTitle	`String`	Title of the configuration stage
ConfigItems	`ConfigItem[]`	List of ConfigItems. See Endpoint - User Config - ConfigItem

`ConfigItem`

Field Name	Type	Description
ConfigItemId	`String`	Unique name for the config item (MAX 20 chars)
Name	`String`	Value displayed on the user interface
Description	`string`	Tooltip text for the config item
GroupName	`String`	Config item group name. Config item will be rendered on the UI grouped by this value
SortOrder	`Integer`	`Sort order of the config item. Config items will be rendered on the screen in this order`
SelectedValue	`String`	`Selected value`
RegExValidation	`String/null`	`RegEx validation`
RegExError	`String/null`	Error message that will be displayed when RegEx validation fails
MustBeSpecified	`Boolean`	Identifies whether the config item must have value specified
ReadOnly	`Boolean`	Identifies whether the field is read only
ListValues	`ConfgItemListItem[]`	List of ConfigItemListItem. The config item ValueType =5 (LIST) can have a list of available values the user can select from the drop down list. See Endpoint - User Config - ConfigListItem
ValueType	`Integer`	String = 0, Integer = 1, Double = 2, Boolean = 3, Password = 4, List = 5

`ConfigListItem`

Field Name	Type	Description
Display	`String`	User friendly visible value.
Value	`String`	Drop down item value.

Sample

{
  "IsConfigActive": false,
  "ConfigStatus": "StageStatusName",
  "ConfigStage": {
    "WizardStepDescription": "Description of the stage.",
    "WizardStepTitle": "Title of the wizard Stage",
    "ConfigItems": [
      {
        "ConfigItemId": "ITEM1",
        "Name": "Config Item 1",
        "Description": "Description Item 1",
        "GroupName": "Group item",
        "SortOrder": 1,
        "SelectedValue": "",
        "RegExValidation": null,
        "RegExError": null,
        "MustBeSpecified": true,
        "ReadOnly": false,
        "ListValues": [
          {
            "Display": "List Value 1",
            "Value": "1"
          }
        ],
        "ValueType": 5
      }
    ]
  },
  "IsError": false,
  "ErrorMessage": null
}