Returns a list of available services for a given integration profile.

Request

Post

`DeleteConfigRequest`

Field Name	Type	Description
AuthorizationToken	`Guid`	Authorization token uniquely identifying each integration profile

Sample

{
  "AuthorizationToken": "a8e53e86eead4b69beaa0afcc29b67fb"
}

Response

`UserAvailableServicesResponse`

Field Name	Type	Description
Services	`CourierService[]`	List of available services. See Endpoint - UserAvailableServicesEndpoint - CourierService
IsError	`Boolean`	Indicates if there is an error
ErrorMessage	`String / null`	Error message

`CourierService`

Field Name	Type	Description
ServiceName	`String`	Service name as appears to the user
ServiceCode	`String`	Service code
ServiceTag	`String`	Service tag. Arbitrary value
ServiceGroup	`String`	Service grouping name
ServiceUniqueId	`Guid`	Unique Identifier for the service. Linnworks will use this ID in the generate consignment label request. It has to be unique for each service
ConfigItems	`ConfigItem[]`	Each service can have configuration items associated with it. See Endpoint - UserAvailableServicesEndpoint - ConfigItem
ServiceProperty	`ServiceProperty[]`	Each service has a list of properties. Endpoint - UserAvailableServicesEndpoint - ServiceProperty

`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
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	`ListValue[]`	List of ListValues. The config item ValueType =5 (LIST) can have a list of available values the user can select from the drop-down list. See Endpoint - UserAvailableServicesEndpoint - ListValue
ValueType	`Integer`	Value type: 0 = String, 1 = Integer, 2 = Double, 3 = Boolean, 4 = Password, 5 = List

ListValue

Field Name	Type	Description
Display	`String`	Value displayed in the drop-down list
Value	`String`	Drop-down item value

ServiceProperty

Field Name	Type	Description
PropertyName	`String`	Property Name
PropertyValue	`String`	Property Value

Sample

{
  "Services": [
    {
      "ServiceName": "Fast2Door Next Day",
      "ServiceCode": "CODE1",
      "ServiceTag": "SOMETAG",
      "ServiceGroup": "Fast2Door",
      "ServiceUniqueId": "6a47631504db4d25a25ce6917a1bcad9",
      "ConfigItems": [
        {
          "ListValues": [
            {
              "Display": "Up to 500",
              "Value": "500"
            },
            {
              "Display": "Up to 1000",
              "Value": "1000"
            }
          ],
          "ValueType": 5,
          "ConfigItemId": "InsuranceConver",
          "Name": "Insurance Cover",
          "Description": "Additional Insurance cover",
          "GroupName": "Insurance",
          "SortOrder": 1,
          "SelectedValue": "500",
          "RegExValidation": null,
          "RegExError": null,
          "MustBeSpecified": false,
          "ReadOnly": false
        }
      ],
      "ServiceProperty": [
        {
          "PropertyName": "LABELTAG",
          "PropertyValue": "Next Day"
        }
      ]
    }
  ],
  "IsError": false,
  "ErrorMessage": null
}