Endpoint - UserAvailableServicesEndpoint

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

Request

Post

DeleteConfigRequest

Field NameTypeDescription
AuthorizationTokenGuidAuthorization token uniquely identifying each integration profile

Sample

{
  "AuthorizationToken": "a8e53e86eead4b69beaa0afcc29b67fb"
}

Response

UserAvailableServicesResponse

Field NameTypeDescription
ServicesCourierService[]List of available services. See Endpoint - UserAvailableServicesEndpoint - CourierService
IsErrorBooleanIndicates if there is an error
ErrorMessageString / nullError message

CourierService

Field NameTypeDescription
ServiceNameStringService name as appears to the user
ServiceCodeStringService code
ServiceTagStringService tag. Arbitrary value
ServiceGroupStringService grouping name
ServiceUniqueIdGuidUnique Identifier for the service. Linnworks will use this ID in the generate consignment label request. It has to be unique for each service
ConfigItemsConfigItem[]Each service can have configuration items associated with it. See Endpoint - UserAvailableServicesEndpoint - ConfigItem
ServicePropertyServiceProperty[]Each service has a list of properties. Endpoint - UserAvailableServicesEndpoint - ServiceProperty

ConfigItem

Field NameTypeDescription
ConfigItemIdStringUnique name for the config item (MAX 40 chars)
NameStringValue displayed on the user interface
DescriptionStringTooltip text for the config item
GroupNameStringConfig item group name. Config item will be rendered on the UI grouped by this value
SortOrderIntegerSort order of the config item. Config items will be rendered on the screen in this order
RegExValidationString / nullRegEx validation
RegExErrorString / nullError message that will be displayed when RegEx validation fails
MustBeSpecifiedBooleanIdentifies whether the config item must have value specified
ReadOnlyBooleanIdentifies whether the field is read only
ListValuesListValue[]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
ValueTypeIntegerValue type: 0 = String, 1 = Integer, 2 = Double, 3 = Boolean, 4 = Password, 5 = List

ListValue

Field NameTypeDescription
DisplayStringValue displayed in the drop-down list
ValueStringDrop-down item value

ServiceProperty

Field NameTypeDescription
PropertyNameStringProperty Name
PropertyValueStringProperty 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
}