Web Services

This document describes the web service interface for Logtrade ControlTower
Genererated 2017-01-16.

GetStatus method

Syntax

StatusResponse GetStatus(
		Authorization authorization, 
		string ConsignmentId, 
		string ShipmentNumber
)

Description

Gets status for a shipment

Parameters

NameDatatypeDescription
authorizationAuthorizationAuthorization data
ConsignmentIdstringConsignment id
Use either ConsignmentId or ShipmentNumber
ShipmentNumberstringShipment number
Use either ShipmentNumber or Reference

Return value

A status response

GetExportedInvoices method

Syntax

ExportedInvoicesResult GetExportedInvoices(
		Authorization authorization
)

Description

Get a list of url's for exported invoices

Parameters

NameDatatypeDescription
authorizationAuthorizationAuthorization data

Return value

Exported invoice list

GetPriceQuote method

Syntax

PriceQuoteResponse GetPriceQuote(
		Authorization authorization, 
		string ConsignmentIds, 
		string ShipmentNumbers, 
		string SenderReferences
)

Description

Gets price quotes for shipments

Parameters

NameDatatypeDescription
authorizationAuthorizationAuthorization data
ConsignmentIdsstringConsignment ID's
ShipmentNumbersstringShipment numbers
SenderReferencesstringSender referencenses

Return value

A price respones

Types

Authorization

Description

Contains data needed for authorizations

Properties

PropertyDatatypeValidationsDescription
UserIdstringMandatory
Maximum length = 70		User identification
Svenska: "Användaridentitet" English: "User identification"
PasswordstringMandatory
Maximum length = 35		User password
Svenska: "Lösenord" English: "Password"
LicenseNumberstring
Length = 10		License number
Svenska: "Licensnummer" English: "License number"
ApplicationIdstringMandatoryApplication assigned identity
Please contact LogTrade Technology AB for this value
Svenska: "Affärssystemidentitet för webservice-gränssnitt" English: "ERP application vendor identification"
LocaleLocaleEnum(none)User locale

StatusResponse

Description

Status response

Properties

PropertyDatatypeValidationsDescription
ResultResultEnum(none)Request result
ShipmentNumberstring(none)Shipment number
Svenska: "Sändningsnummer" English: "Shipment number"
ForwarderNamestring(none)Forwarder name
Svenska: "Transportör" English: "Carrier"
LatestStatusstring(none)Latest status description
IsDeliveredbool(none)Is delivered
Depending on the event code used by the forwarder, this flag is not guaranteed to be correct.
Svenska: "Levererad" English: "Is delivered"
Messagestring(none)Error message
Used when Result is AuthorizationError, ArgumentError or InternalError
Svenska: "Message" English: "Message"

Arrays

ArrayDatatypeDescription
AddressesAddressDetail
Shipment addresses
GoodsItemsGoodsItemDetail
Goods items
StatusEventsStatusEvent
All collected status events

ExportedInvoicesResult

Description

Exported invoices response

Properties

PropertyDatatypeValidationsDescription
ResultResultEnum(none)Request result
Messagestring(none)Error message
Used when Result is AuthorizationError, ArgumentError or InternalError
Svenska: "Message" English: "Message"

Arrays

ArrayDatatypeDescription
InvoicesExportedInvoiceDetail
Invoice details

ExportedInvoiceDetail

Description

Invoice detail

Properties

PropertyDatatypeValidationsDescription
InvoiceNumberstring(none)Invoice number
Svenska: "Fakturanummer" English: "Invoice number"
InvoiceDateDate(none)Invoice date
Svenska: "Fakturadatum" English: "Invoice date"
ForwarderCodestring(none)ForwarderCode
Svenska: "Transportör" English: "Carrier"
Urlstring(none)Url for fetching the invoice

PriceQuoteResponse

Description

Price quote response

Properties

PropertyDatatypeValidationsDescription
ResultResultEnum(none)Request result
Messagestring(none)Error message
Used when Result is AuthorizationError, ArgumentError or InternalError
Svenska: "Message" English: "Message"

Arrays

ArrayDatatypeDescription
PriceQuotesPriceQuote
Price Quotes

PriceQuote

Description

Price quote

Properties

PropertyDatatypeValidationsDescription
ShipmentNumberstring(none)Shipment number
Svenska: "Sändningsnummer" English: "Shipment number"
ProductCodestring(none)Assigned product
Svenska: "Produktkod" English: "Product code"
ConsignmentIdstring(none)Consignment ID
Svenska: "Uppdragsnummer" English: "Consignment id"
SenderReferencestring(none)Sender reference
Svenska: "Avsändarens referens" English: "Sender reference"
PriceQuoteAmountdecimal(none)Price quote
PriceQuoteCurrencystring(none)Price quote currency

AddressDetail

Description

Address detail

Properties

PropertyDatatypeValidationsDescription
AddressTypeAddressTypeEnum(none)Address type
Svenska: "Adresstyp" English: "Address type"
Namestring(none)Name
Svenska: "Namn" English: "Name"

Arrays

ArrayDatatypeDescription
AddressLinesstring
Address lines

GoodsItemDetail

Description

Goods item detail

Properties

PropertyDatatypeValidationsDescription
NumberOfPackagesint(none)Number of packages
Svenska: "Antal kolli" English: "Number of packages"
TypeOfPackagesstring(none)Type of packages
Svenska: "Kollislag" English: "Type of package"
GrossWeightdecimal(none)Gross weight
Svenska: "Bruttovikt" English: "Gross weight"
Volumedecimal(none)Volume
Svenska: "Volym" English: "Volume"

Arrays

ArrayDatatypeDescription
PackageDetailsPackageItemDetail
Package item details

PackageItemDetail

Description

Package details

Properties

PropertyDatatypeValidationsDescription
PackageNumberstring(none)Package number
Svenska: "Kollinummer" English: "Package number"
GrossWeightdecimal(none)Gross weight
Svenska: "Bruttovikt" English: "Gross weight"
Volumedecimal(none)Volume
Svenska: "Volym" English: "Volume"
TypeOfPackagesstring(none)Type of package
Svenska: "Kollislag" English: "Type of package"

StatusEvent

Description

Status event

Properties

PropertyDatatypeValidationsDescription
TimeStampDateTime(none)Event time stamp
Svenska: "Time stamp (Logtrade.Common.EdiWarning)" English: "Time stamp"
Descriptionstring(none)Event description
Svenska: "Beskrivning" English: "Description"
Locationstring(none)Event location
EventCodestring(none)Event code
Code value depends on forwarder code list
Svenska: "Händelsekod" English: "Event code"
ReasonCodestring(none)Reason code
Code value depends on forwarder code list
Svenska: "Orsakskod" English: "Reason code"

Date

Description

Date

Comments

Date is a normal DateTime instance where only the Date part is used

Enumerations

ResultEnum

Description

Service result

Values

ValueDescription
SuccessSuccess
NotFoundNo matching shipment found
AuthorizationErrorAuthorization error
ArgumentErrorArgument error
InternalErrorInternal error

LocaleEnum

Description

Locale value

Values

ValueDescription
svSwedish
enEnglish
daDanish

AddressTypeEnum

Description

Address type

Values

ValueDescription
SenderSender address
RecipientRecipient address
PickupPickup address
DeliveryDelivery address
AgentAgent address
Copyright© 2007-2014, LogTrade Technology AB. All rights reserved. Generated 2017-01-16