|
Important note: The Portal Data WS is going to be replaced by the new Shipment Data API. The new API is using newer, faster, and more secure technology and we recommend that you use this API going forward. Read more: Using the Shipment Data API Data in the Portal Data WS will be limited to the last 12 months. |
URL to Portal Data WS:
https://customer-api.consignorportal.com/PortalData/PortalData.svc
See the WSDL here:
https://customer-api.consignorportal.com/PortalData/PortalData.svc?wsdl
As a single file:
https://customer-api.consignorportal.com/PortalData/PortalData.svc?singleWsdl
Links to all the method descriptions including fields, request and response examples:
- GetCarrierEventsByEventCode
- GetEvents
- GetShipmentsByDateRange
- GetShipmentsByAllOrderNumbers
- GetShipmentByOrderNumber
- GetShipmentsByPackageNumber
- GetShipmentsByShipmentNumber
- GetShipmentStatus
- IsShipmentClosed
- SendEvent
GetCarrierEventsByEventCode
Get track and trace(carrier) events on shipments within a date range and by event codes. The method returns track and trace(carrier) events that matches the event codes within the given date range.
|
FIELD |
TYPE |
DESCRIPTION |
|
userName |
string |
Mandatory. Consignor Portal user name. |
|
password |
string |
Mandatory. Consignor Portal password. |
|
eventDateTimeStart |
dateTime |
Mandatory. Start date and time for the search. If time zone is included it must also be included in eventDateTimeEnd |
|
eventDateTimeEnd |
dateTime |
Mandatory. End date and time for the search. If time zone is included it must also be included in eventDateTimeStart |
|
eventCodes |
ArrayOfString |
Mandatory. Event codes for the search. |
|
installationValue |
string |
Consignor installation Id.
|
|
actors |
ArrayOfInt |
Optional. Actor Id(s) for the search or empty array. |
Request:
<edis:GetCarrierEventsByEventCode>
<edis:userName>Your userName</edis:userName>
<edis:password>Your password</edis:password>
<edis:eventDateTimeStart>2021-01-27T08:00:00</edis:eventDateTimeStart>
<edis:eventDateTimeEnd>2021-01-28T08:00:00</edis:eventDateTimeEnd>
<edis:eventCodes>
<arr:string>15</arr:string>
</edis:eventCodes>
<edis:installationValue>Your installationId</edis:installationValue>
</edis:GetCarrierEventsByEventCode>
Response:
<a:BaseEventGuid>084d4434-d7c4-e511-8119-069a0e10f3v1</a:BaseEventGuid>
<a:CarrierName>Service Broker</a:CarrierName>
<a:CityName/>
<a:Date>2021-01-27T10:18:00</a:Date>
<a:KindId>22990</a:KindId>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>40170716517461346067</a:Barcode>
<a:Esid>2719918086</a:Esid>
<a:IsShipment>true</a:IsShipment>
<a:OrderNumber>67514</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-27T10:22:00.343</a:ServerDate>
<a:StatusCode>15</a:StatusCode>
<a:StatusState>InProgress</a:StatusState>
<a:StatusText>Customer not at home at pickup</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:BaseEventGuid>df1eb251-d8c4-e511-8119-069a0e10f3v1</a:BaseEventGuid>
<a:CarrierName>Service Broker</a:CarrierName>
<a:CityName/>
<a:Date>2021-01-27T10:20:00</a:Date>
<a:KindId>22990</a:KindId>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>40170716517461554726</a:Barcode>
<a:Esid>2719917767</a:Esid>
<a:IsShipment>true</a:IsShipment>
<a:OrderNumber>1952200</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-27T10:32:04.023</a:ServerDate>
<a:StatusCode>15</a:StatusCode>
<a:StatusState>InProgress</a:StatusState>
<a:StatusText>Customer not at home at pickup</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
GetEvents
Get events on shipments within a date range. The method returns carrier measurements, Consignor and track and trace (carrier) events.
|
FIELD |
TYPE |
DESCRIPTION |
|
userName |
string |
Mandatory. Consignor Portal user name. |
|
password |
string |
Mandatory. Consignor Portal password. |
|
eventDateTimeStart |
dateTime |
Mandatory. Start date and time for the search. If time zone is included it must also be included in eventDateTimeEnd |
|
eventDateTimeEnd |
dateTime |
Mandatory. End date and time for the search. If time zone is included it must also be included in eventDateTimeStart |
Request:
<edis:GetEvents>
<edis:userName>Your userName</edis:userName>
<edis:password>Your password</edis:password>
<edis:eventDateTimeStart>2021-01-19T20:44:00</edis:eventDateTimeStart>
<edis:eventDateTimeEnd>2021-01-19T22:38:00</edis:eventDateTimeEnd>
</edis:GetEvents>
Response:
<a:Event>
<a:Date>2021-01-19T20:44:21</a:Date>
<a:KindId>39</a:KindId>
<a:Origin>ClientData</a:Origin>
<a:Parent>
<a:Barcode>40170716483417240837</a:Barcode>
<a:Esid>2005634920</a:Esid>
<a:IsShipment>true</a:IsShipment>
</a:Parent>
<a:ServerDate>2021-01-19T20:44:33.633</a:ServerDate>
<a:StatusState>InProgress</a:StatusState>
<a:StatusText>test</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
<a:UserId>19166</a:UserId>
</a:Event>
<a:Event>
<a:Date>2021-01-19T22:38:00</a:Date>
<a:KindId>40</a:KindId>
<a:Origin>ClientData</a:Origin>
<a:Parent>
<a:Barcode>40170716483417240837</a:Barcode>
<a:Esid>2005634920</a:Esid>
<a:IsShipment>true</a:IsShipment>
</a:Parent>
<a:ServerDate>2021-01-19T22:37:41.41</a:ServerDate>
<a:StatusState>Closing</a:StatusState>
<a:StatusText>test closed</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
<a:UserId>19166</a:UserId>
</a:Event>
GetShipmentsByDateRange
Get shipment data on shipments within a date range. The method returns packages, references, amounts, carrier measurement, track and trace (carrier / ScanApp) events, sender and receiver.
|
FIELD |
TYPE |
DESCRIPTION |
|
userName |
string |
Mandatory. Consignor Portal user name. |
|
password |
string |
Mandatory. Consignor Portal password. |
|
installationValue |
string |
Consignor installation Id. |
|
actors |
ArrayOfInt |
Optional. Actor Id(s) for the search or empty array. |
|
startDateTime |
dateTime |
Mandatory. Start date and time for the search. If time zone is included it must also be included in endDateTime |
|
endDateTime |
dateTime |
Mandatory. End date and time for the search. - Maximum date range for start and end date is 30 days. - If start and end date are not provided, the search will be within the last 30 days. |
|
pageIndex |
integer |
Optional. The result will show 20 shipments per page. |
Request:
<edis:GetShipmentsByDateRange>
<edis:userName>Your userName</edis:userName>
<edis:password>Your password</edis:password>
<edis:installationValue>Your installationId</edis:installationValue>
<edis:actors>
<arr:int>Your actorId</arr:int>
</edis:actors>
<edis:startDateTime>2021-01-14T09:00:00</edis:startDateTime>
<edis:endDateTime>2021-01-15T15:15:00</edis:endDateTime>
<edis:pageIndex>0</edis:pageIndex>
</edis:GetShipmentsByDateRange>
Response:
The response will be the same as for the methods GetShipmentsByOrderNumber, GetShipmentsByShipmentNumber, GetShipmentsByPackageNumber and will contain all the shipments within the specified date range.
GetShipmentsByAllOrderNumbers
Use to search for shipments by order number. Will search data from the last 6 months and return shipments where the order number matches the main order number or an additional order number on a shipment.
|
FIELD |
TYPE |
DESCRIPTION |
|
userName |
string |
Mandatory. Consignor Portal user name. |
|
password |
string |
Mandatory. Consignor Portal password. |
|
installationValue |
string |
Consignor installation Id. |
|
actors |
ArrayOfInt |
Optional. Actor Id(s) for the search or empty array. |
|
orderNumber |
string |
Mandatory. The order number to search for. |
|
pageIndex |
integer |
Optional. The result will show 20 shipments per page. |
Request:
<edis:GetShipmentsByAllOrderNumbers>
<edis:userName>Your userName</edis:userName>
<edis:password>Your password</edis:password>
<edis:installationValue>Your installationId</edis:installationValue>
<edis:actors>
<arr:int>Your actorId</arr:int>
</edis:actors>
<edis:orderNumber>1234 (your order number)</edis:orderNumber>
<edis:pageIndex>2</edis:pageIndex>
</edis:GetShipmentsByAllOrderNumbers>
Response:
<a:Shipment>
<a:ActorCsid>65</a:ActorCsid>
<a:ActorName>Consignor AS</a:ActorName>
<a:Addresses>
<a:Address>
<a:Attention>John Doe</a:Attention>
<a:City>OSLO</a:City>
<a:CountryClientId>160</a:CountryClientId>
<a:CountryCode>NO</a:CountryCode>
<a:CountryName>Norway</a:CountryName>
<a:Email>john@hotmail.com</a:Email>
<a:Kind>Receiver</a:Kind>
<a:Name1>Test AS</a:Name1>
<a:POCity>OSLO</a:POCity>
<a:POPostCode>0267</a:POPostCode>
<a:PostCode>0267</a:PostCode>
<a:Street1>Test address</a:Street1>
</a:Address>
<a:Address>
<a:City>Oslo</a:City>
<a:CountryClientId>160</a:CountryClientId>
<a:CountryCode>NO</a:CountryCode>
<a:CountryName>Norway</a:CountryName>
<a:Kind>Sender</a:Kind>
<a:Name1>Consignor AS</a:Name1>
<a:POBox>0342, Test</a:POBox>
<a:POCity>OSLO</a:POCity>
<a:POPostCode>0342</a:POPostCode>
<a:Phone>12345678</a:Phone>
<a:PostCode>0342</a:PostCode>
<a:Street1>Test address</a:Street1>
</a:Address>
</a:Addresses>
<a:Amounts>
<a:Amount>
<a:CurrencyClientId>1</a:CurrencyClientId>
<a:CurrencyCode>NOK</a:CurrencyCode>
<a:Kind>FixedPrice</a:Kind>
<a:Value>170.00</a:Value>
</a:Amount>
</a:Amounts>
<a:CarriagePayer>Sender</a:CarriagePayer>
<a:CarrierId>142</a:CarrierId>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:Details/>
<a:Esid>2699308703</a:Esid>
<a:Events>
<a:Event>
<a:Date>2021-01-14T11:26:38</a:Date>
<a:KindId>4</a:KindId>
<a:Origin>Consignor</a:Origin>
<a:Parent>
<a:Barcode>40170716487237366760</a:Barcode>
<a:Esid>2699308703</a:Esid>
<a:IsShipment>true</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-14T11:27:29.213</a:ServerDate>
<a:StatusState>Opening</a:StatusState>
<a:StatusText>Printed</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:Date>2021-01-14T11:26:38</a:Date>
<a:KindId>1</a:KindId>
<a:Origin>Consignor</a:Origin>
<a:Parent>
<a:Barcode>40170716487237366760</a:Barcode>
<a:Esid>2699308703</a:Esid>
<a:IsShipment>true</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-14T11:27:29.223</a:ServerDate>
<a:StatusState>Opening</a:StatusState>
<a:StatusText>Created (by import)</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:Date>2021-01-14T11:26:38</a:Date>
<a:KindId>25</a:KindId>
<a:Origin>Consignor</a:Origin>
<a:Parent>
<a:Barcode>40170716487237366760</a:Barcode>
<a:Esid>2699308703</a:Esid>
<a:IsShipment>true</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-14T11:27:29.23</a:ServerDate>
<a:StatusState>Opening</a:StatusState>
<a:StatusText>Shipment label printed</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:Date>2021-01-14T15:15:01.227</a:Date>
<a:KindId>17</a:KindId>
<a:Origin>Consignor</a:Origin>
<a:Parent>
<a:Barcode>40170716487237366760</a:Barcode>
<a:Esid>2699308703</a:Esid>
<a:IsShipment>true</a:IsShipment>
<a:OrderNumber>1234</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-14T15:15:42.79</a:ServerDate>
<a:StatusState>Opening</a:StatusState>
<a:StatusText>Transmitted</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
</a:Events>
<a:ImportDate>2021-01-14T11:26:38</a:ImportDate>
<a:InstallationId>11111111111</a:InstallationId>
<a:InstallationName>Consignor AS</a:InstallationName>
<a:IsConceptCarrier>true</a:IsConceptCarrier>
<a:IsConceptProduct>true</a:IsConceptProduct>
<a:LabelPrintDate>2021-01-14T11:26:38</a:LabelPrintDate>
<a:LatestStatusText>Utlevert</a:LatestStatusText>
<a:Lines>
<a:Line>
<a:DangerousGoods/>
<a:LineNumberOfPackages>1</a:LineNumberOfPackages>
<a:LineUnits
xmlns:b="http://schemas.datacontract.org/2004/07/EdiSoft.Common.Domain"/>
<a:Number>1</a:Number>
<a:Packages>
<a:Package>
<a:Details/>
<a:Events>
<a:Event>
<a:BaseEventGuid>91c80bfe-efba-e511-8119-069a0e10e3c1</a:BaseEventGuid>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:CityName>OSLO</a:CityName>
<a:Date>2021-01-14T19:23:00</a:Date>
<a:KindId>614</a:KindId>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>00370716487237366667</a:Barcode>
<a:Esid>0</a:Esid>
<a:IsShipment>false</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-14T19:53:03.307</a:ServerDate>
<a:StatusCode>RR</a:StatusCode>
<a:StatusState>InProgress</a:StatusState>
<a:StatusText>Innleveringsregistrert</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:BaseEventGuid>91c80bfe-efba-e511-8119-069a0e10e3c1</a:BaseEventGuid>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:CityName>OSLO</a:CityName>
<a:Date>2021-01-14T19:23:00</a:Date>
<a:KindId>613</a:KindId>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>00370716487237366667</a:Barcode>
<a:Esid>0</a:Esid>
<a:IsShipment>false</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-14T19:53:03.307</a:ServerDate>
<a:StatusCode>RG</a:StatusCode>
<a:StatusState>InProgress</a:StatusState>
<a:StatusText>Ankomstregistrert</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:BaseEventGuid>4f374ed4-37bb-e511-8119-069a0e10e3c1</a:BaseEventGuid>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:Date>2021-01-14T19:23:00</a:Date>
<a:Height>250</a:Height>
<a:Length>380</a:Length>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>00370716487237366667</a:Barcode>
<a:Esid>0</a:Esid>
<a:IsShipment>false</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:PriceBruto>202.00</a:PriceBruto>
<a:ServerDate>2021-01-15T04:27:28.21</a:ServerDate>
<a:StatusState>InProgress</a:StatusState>
<a:StatusText/>
<a:Type>Measurement Price</a:Type>
<a:Volume>36100000</a:Volume>
<a:Weight>18850</a:Weight>
<a:Width>380</a:Width>
</a:Event>
<a:Event>
<a:BaseEventGuid>1f14b262-5dbb-e511-8119-069a0e10e3c1</a:BaseEventGuid>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:CityName>OSLO</a:CityName>
<a:Date>2021-01-15T08:35:00</a:Date>
<a:KindId>1550</a:KindId>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>00370716487237366667</a:Barcode>
<a:Esid>0</a:Esid>
<a:IsShipment>false</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-15T08:56:05.087</a:ServerDate>
<a:StatusCode>R3</a:StatusCode>
<a:StatusState>InProgress</a:StatusState>
<a:StatusText>Opplastet til distribusjonen</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:BaseEventGuid>81d94943-87bb-e511-8119-069a0e10e3c1</a:BaseEventGuid>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:CityName>OSLO</a:CityName>
<a:Date>2021-01-15T13:25:00</a:Date>
<a:KindId>612</a:KindId>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>00370716487237366667</a:Barcode>
<a:Esid>0</a:Esid>
<a:IsShipment>false</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-15T13:57:26.227</a:ServerDate>
<a:StatusCode>RI</a:StatusCode>
<a:StatusState>Closing</a:StatusState>
<a:StatusText>Utlevert</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
</a:Events>
<a:ItemNumber>1</a:ItemNumber>
<a:Number>00370716487237366667</a:Number>
<a:References/>
</a:Package>
</a:Packages>
<a:References>
<a:Reference>
<a:Kind>219</a:Kind>
<a:KindText>Line Shipment Booked</a:KindText>
<a:Value>True</a:Value>
</a:Reference>
</a:References>
</a:Line>
</a:Lines>
<a:LocationId>54</a:LocationId>
<a:LocationName>Consignor Group</a:LocationName>
<a:Messages/>
<a:Number>40170716487237366760</a:Number>
<a:NumberOfPackages>1</a:NumberOfPackages>
<a:OrderNumber>96169</a:OrderNumber>
<a:PackageUid>8badae65-9244-4376-b925-bcf21fdd468f</a:PackageUid>
<a:PayerAccountAtCarrier>00012345678</a:PayerAccountAtCarrier>
<a:PhysicalInstallationId>11111111111</a:PhysicalInstallationId>
<a:PickupDate>2021-01-14T00:00:00</a:PickupDate>
<a:ProductId>1032</a:ProductId>
<a:ProductName>Bedriftspakke</a:ProductName>
<a:References>
<a:Reference>
<a:Kind>62</a:Kind>
<a:KindText>CarrierCode</a:KindText>
<a:Value>PB</a:Value>
</a:Reference>
<a:Reference>
<a:Kind>99</a:Kind>
<a:KindText>Carrier Specific Shipment 2</a:KindText>
<a:Value>2</a:Value>
</a:Reference>
<a:Reference>
<a:Kind>13</a:Kind>
<a:KindText>DEPRECATED! Operator</a:KindText>
<a:Value>Import</a:Value>
</a:Reference>
</a:References>
<a:SenderAccountAtCarrier>00012345678</a:SenderAccountAtCarrier>
<a:Services>
<a:Service>
<a:ServiceId>142129</a:ServiceId>
<a:ServiceName>Ett utleveringsforsøk, deretter til postkontor</a:ServiceName>
</a:Service>
</a:Services>
<a:ShipmentConnections/>
<a:ShipmentCsid>300012</a:ShipmentCsid>
<a:ShipmentCustomDocuments
xmlns:b="http://schemas.datacontract.org/2004/07/EdiSoft.Common.Domain"/>
<a:ShipmentDocuments
xmlns:b="http://schemas.datacontract.org/2004/07/EdiSoft.Common.Domain"/>
<a:ShipmentKind>Normal</a:ShipmentKind>
<a:SubcarrierId>211</a:SubcarrierId>
<a:SubcarrierName>Pakker</a:SubcarrierName>
<a:SubmitDate>2021-01-14T11:26:38</a:SubmitDate>
<a:TransmitDate>2021-01-14T15:15:01.227</a:TransmitDate>
</a:Shipment>
GetShipmentsByOrderNumber
Searches for a shipment by main order number. Using the date interval is is possible to search data that is up to 12 months old. If no date interval is provided, it will search data from the last 30 days.
|
FIELD |
TYPE |
DESCRIPTION |
|
userName |
string |
Mandatory. Consignor Portal user name. |
|
password |
string |
Mandatory. Consignor Portal password. |
|
installationValue |
string |
Consignor installation Id. |
|
actors |
ArrayOfInt |
Optional. Actor Id(s) for the search or empty array. |
|
referenceNumber |
string |
Mandatory. The order number to search for. |
|
startDateTime |
dateTime |
Optional. Start date and time for the search. |
|
endDateTime |
dateTime |
Optional. End date and time for the search. - Maximum date range for start end end date is 30 days. - If start and end date are not provided, the search will be within the last 30 days. |
Request:
<edis:GetShipmentsByOrderNumber>
<edis:userName>Your userName</edis:userName>
<edis:password>Your password</edis:password>
<edis:installationValue>Your installationId</edis:installationValue>
<edis:actors>
<arr:int>Your actorId</arr:int>
</edis:actors>
<edis:referenceNumber>96169 (your order / reference number)</edis:referenceNumber>
<edis:startDateTime>2021-01-14T09:00:00</edis:startDateTime>
<edis:endDateTime>2021-01-15T15:15:00</edis:endDateTime>
</edis:GetShipmentsByOrderNumber>
Response:
<a:Shipment>
<a:ActorCsid>65</a:ActorCsid>
<a:ActorName>Consignor AS</a:ActorName>
<a:Addresses>
<a:Address>
<a:Attention>John Doe</a:Attention>
<a:City>OSLO</a:City>
<a:CountryClientId>160</a:CountryClientId>
<a:CountryCode>NO</a:CountryCode>
<a:CountryName>Norway</a:CountryName>
<a:Email>john@hotmail.com</a:Email>
<a:Kind>Receiver</a:Kind>
<a:Name1>Test AS</a:Name1>
<a:POCity>OSLO</a:POCity>
<a:POPostCode>0267</a:POPostCode>
<a:PostCode>0267</a:PostCode>
<a:Street1>Test address</a:Street1>
</a:Address>
<a:Address>
<a:City>Oslo</a:City>
<a:CountryClientId>160</a:CountryClientId>
<a:CountryCode>NO</a:CountryCode>
<a:CountryName>Norway</a:CountryName>
<a:Kind>Sender</a:Kind>
<a:Name1>Consignor AS</a:Name1>
<a:POBox>0342, Test</a:POBox>
<a:POCity>OSLO</a:POCity>
<a:POPostCode>0342</a:POPostCode>
<a:Phone>12345678</a:Phone>
<a:PostCode>0342</a:PostCode>
<a:Street1>Test address</a:Street1>
</a:Address>
</a:Addresses>
<a:Amounts>
<a:Amount>
<a:CurrencyClientId>1</a:CurrencyClientId>
<a:CurrencyCode>NOK</a:CurrencyCode>
<a:Kind>FixedPrice</a:Kind>
<a:Value>170.00</a:Value>
</a:Amount>
</a:Amounts>
<a:CarriagePayer>Sender</a:CarriagePayer>
<a:CarrierId>142</a:CarrierId>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:Details/>
<a:Esid>2699308703</a:Esid>
<a:Events>
<a:Event>
<a:Date>2021-01-14T11:26:38</a:Date>
<a:KindId>4</a:KindId>
<a:Origin>Consignor</a:Origin>
<a:Parent>
<a:Barcode>40170716487237366760</a:Barcode>
<a:Esid>2699308703</a:Esid>
<a:IsShipment>true</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-14T11:27:29.213</a:ServerDate>
<a:StatusState>Opening</a:StatusState>
<a:StatusText>Printed</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:Date>2021-01-14T11:26:38</a:Date>
<a:KindId>1</a:KindId>
<a:Origin>Consignor</a:Origin>
<a:Parent>
<a:Barcode>40170716487237366760</a:Barcode>
<a:Esid>2699308703</a:Esid>
<a:IsShipment>true</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-14T11:27:29.223</a:ServerDate>
<a:StatusState>Opening</a:StatusState>
<a:StatusText>Created (by import)</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:Date>2021-01-14T11:26:38</a:Date>
<a:KindId>25</a:KindId>
<a:Origin>Consignor</a:Origin>
<a:Parent>
<a:Barcode>40170716487237366760</a:Barcode>
<a:Esid>2699308703</a:Esid>
<a:IsShipment>true</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-14T11:27:29.23</a:ServerDate>
<a:StatusState>Opening</a:StatusState>
<a:StatusText>Shipment label printed</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:Date>2021-01-14T15:15:01.227</a:Date>
<a:KindId>17</a:KindId>
<a:Origin>Consignor</a:Origin>
<a:Parent>
<a:Barcode>40170716487237366760</a:Barcode>
<a:Esid>2699308703</a:Esid>
<a:IsShipment>true</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-14T15:15:42.79</a:ServerDate>
<a:StatusState>Opening</a:StatusState>
<a:StatusText>Transmitted</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
</a:Events>
<a:ImportDate>2021-01-14T11:26:38</a:ImportDate>
<a:InstallationId>11111111111</a:InstallationId>
<a:InstallationName>Consignor AS</a:InstallationName>
<a:IsConceptCarrier>true</a:IsConceptCarrier>
<a:IsConceptProduct>true</a:IsConceptProduct>
<a:LabelPrintDate>2021-01-14T11:26:38</a:LabelPrintDate>
<a:LatestStatusText>Utlevert</a:LatestStatusText>
<a:Lines>
<a:Line>
<a:DangerousGoods/>
<a:LineNumberOfPackages>1</a:LineNumberOfPackages>
<a:LineUnits
xmlns:b="http://schemas.datacontract.org/2004/07/EdiSoft.Common.Domain"/>
<a:Number>1</a:Number>
<a:Packages>
<a:Package>
<a:Details/>
<a:Events>
<a:Event>
<a:BaseEventGuid>91c80bfe-efba-e511-8119-069a0e10e3c1</a:BaseEventGuid>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:CityName>OSLO</a:CityName>
<a:Date>2021-01-14T19:23:00</a:Date>
<a:KindId>614</a:KindId>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>00370716487237366667</a:Barcode>
<a:Esid>0</a:Esid>
<a:IsShipment>false</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-14T19:53:03.307</a:ServerDate>
<a:StatusCode>RR</a:StatusCode>
<a:StatusState>InProgress</a:StatusState>
<a:StatusText>Innleveringsregistrert</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:BaseEventGuid>91c80bfe-efba-e511-8119-069a0e10e3c1</a:BaseEventGuid>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:CityName>OSLO</a:CityName>
<a:Date>2021-01-14T19:23:00</a:Date>
<a:KindId>613</a:KindId>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>00370716487237366667</a:Barcode>
<a:Esid>0</a:Esid>
<a:IsShipment>false</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-14T19:53:03.307</a:ServerDate>
<a:StatusCode>RG</a:StatusCode>
<a:StatusState>InProgress</a:StatusState>
<a:StatusText>Ankomstregistrert</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:BaseEventGuid>4f374ed4-37bb-e511-8119-069a0e10e3c1</a:BaseEventGuid>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:Date>2021-01-14T19:23:00</a:Date>
<a:Height>250</a:Height>
<a:Length>380</a:Length>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>00370716487237366667</a:Barcode>
<a:Esid>0</a:Esid>
<a:IsShipment>false</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:PriceBruto>202.00</a:PriceBruto>
<a:ServerDate>2021-01-15T04:27:28.21</a:ServerDate>
<a:StatusState>InProgress</a:StatusState>
<a:StatusText/>
<a:Type>Measurement Price</a:Type>
<a:Volume>36100000</a:Volume>
<a:Weight>18850</a:Weight>
<a:Width>380</a:Width>
</a:Event>
<a:Event>
<a:BaseEventGuid>1f14b262-5dbb-e511-8119-069a0e10e3c1</a:BaseEventGuid>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:CityName>OSLO</a:CityName>
<a:Date>2021-01-15T08:35:00</a:Date>
<a:KindId>1550</a:KindId>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>00370716487237366667</a:Barcode>
<a:Esid>0</a:Esid>
<a:IsShipment>false</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-15T08:56:05.087</a:ServerDate>
<a:StatusCode>R3</a:StatusCode>
<a:StatusState>InProgress</a:StatusState>
<a:StatusText>Opplastet til distribusjonen</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:BaseEventGuid>81d94943-87bb-e511-8119-069a0e10e3c1</a:BaseEventGuid>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:CityName>OSLO</a:CityName>
<a:Date>2021-01-15T13:25:00</a:Date>
<a:KindId>612</a:KindId>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>00370716487237366667</a:Barcode>
<a:Esid>0</a:Esid>
<a:IsShipment>false</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-15T13:57:26.227</a:ServerDate>
<a:StatusCode>RI</a:StatusCode>
<a:StatusState>Closing</a:StatusState>
<a:StatusText>Utlevert</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
</a:Events>
<a:ItemNumber>1</a:ItemNumber>
<a:Number>00370716487237366667</a:Number>
<a:References/>
</a:Package>
</a:Packages>
<a:References>
<a:Reference>
<a:Kind>219</a:Kind>
<a:KindText>Line Shipment Booked</a:KindText>
<a:Value>True</a:Value>
</a:Reference>
</a:References>
</a:Line>
</a:Lines>
<a:LocationId>54</a:LocationId>
<a:LocationName>Consignor Group</a:LocationName>
<a:Messages/>
<a:Number>40170716487237366760</a:Number>
<a:NumberOfPackages>1</a:NumberOfPackages>
<a:OrderNumber>96169</a:OrderNumber>
<a:PackageUid>8badae65-9244-4376-b925-bcf21fdd468f</a:PackageUid>
<a:PayerAccountAtCarrier>00012345678</a:PayerAccountAtCarrier>
<a:PhysicalInstallationId>11111111111</a:PhysicalInstallationId>
<a:PickupDate>2021-01-14T00:00:00</a:PickupDate>
<a:ProductId>1032</a:ProductId>
<a:ProductName>Bedriftspakke</a:ProductName>
<a:References>
<a:Reference>
<a:Kind>62</a:Kind>
<a:KindText>CarrierCode</a:KindText>
<a:Value>PB</a:Value>
</a:Reference>
<a:Reference>
<a:Kind>99</a:Kind>
<a:KindText>Carrier Specific Shipment 2</a:KindText>
<a:Value>2</a:Value>
</a:Reference>
<a:Reference>
<a:Kind>13</a:Kind>
<a:KindText>DEPRECATED! Operator</a:KindText>
<a:Value>Import</a:Value>
</a:Reference>
</a:References>
<a:SenderAccountAtCarrier>00012345678</a:SenderAccountAtCarrier>
<a:Services>
<a:Service>
<a:ServiceId>142129</a:ServiceId>
<a:ServiceName>Ett utleveringsforsøk, deretter til postkontor</a:ServiceName>
</a:Service>
</a:Services>
<a:ShipmentConnections/>
<a:ShipmentCsid>300012</a:ShipmentCsid>
<a:ShipmentCustomDocuments
xmlns:b="http://schemas.datacontract.org/2004/07/EdiSoft.Common.Domain"/>
<a:ShipmentDocuments
xmlns:b="http://schemas.datacontract.org/2004/07/EdiSoft.Common.Domain"/>
<a:ShipmentKind>Normal</a:ShipmentKind>
<a:SubcarrierId>211</a:SubcarrierId>
<a:SubcarrierName>Pakker</a:SubcarrierName>
<a:SubmitDate>2021-01-14T11:26:38</a:SubmitDate>
<a:TransmitDate>2021-01-14T15:15:01.227</a:TransmitDate>
</a:Shipment>
GetShipmentsByPackageNumber
Get shipment data on a package number. The method returns packages, refrences, amounts, carrier measurement, track and trace (carrier / ScanApp) events, sender and receiver.
|
FIELD |
TYPE |
DESCRIPTION |
|
userName |
string |
Mandatory. Consignor Portal user name. |
|
password |
string |
Mandatory. Consignor Portal password. |
|
installationValue |
string |
Consignor installation Id. |
|
actors |
ArrayOfInt |
Optional. Actor Id(s) for the search or empty array. |
|
packageNumber |
string |
Mandatory. The package number to search for. |
|
startDateTime |
dateTime |
Optional. Start date and time for the search. |
|
endDateTime |
dateTime |
Optional. End date and time for the search. - Maximum date range for start and end date is 30 days. - If start and end date are not provided, the search will be within the last 30 days. |
Request:
<edis:GetShipmentsByPackageNumber>
<edis:userName>Your userName</edis:userName>
<edis:password>Your password</edis:password>
<edis:installationValue>Your installationId</edis:installationValue>
<edis:actors>
<arr:int>Your actorId</arr:int>
</edis:actors>
<edis:packageNumber>00370716487237366667 (your package number)</edis:packageNumber>
<edis:startDateTime>2021-01-14T09:00:00</edis:startDateTime>
<edis:endDateTime>2021-01-15T15:15:00</edis:endDateTime>
</edis:GetShipmentsByPackageNumber>
Response:
<a:Shipment>
<a:ActorCsid>65</a:ActorCsid>
<a:ActorName>Consignor AS</a:ActorName>
<a:Addresses>
<a:Address>
<a:Attention>John Doe</a:Attention>
<a:City>OSLO</a:City>
<a:CountryClientId>160</a:CountryClientId>
<a:CountryCode>NO</a:CountryCode>
<a:CountryName>Norway</a:CountryName>
<a:Email>john@hotmail.com</a:Email>
<a:Kind>Receiver</a:Kind>
<a:Name1>Test AS</a:Name1>
<a:POCity>OSLO</a:POCity>
<a:POPostCode>0267</a:POPostCode>
<a:PostCode>0267</a:PostCode>
<a:Street1>Test address</a:Street1>
</a:Address>
<a:Address>
<a:City>Oslo</a:City>
<a:CountryClientId>160</a:CountryClientId>
<a:CountryCode>NO</a:CountryCode>
<a:CountryName>Norway</a:CountryName>
<a:Kind>Sender</a:Kind>
<a:Name1>Consignor AS</a:Name1>
<a:POBox>0342, Test</a:POBox>
<a:POCity>OSLO</a:POCity>
<a:POPostCode>0342</a:POPostCode>
<a:Phone>12345678</a:Phone>
<a:PostCode>0342</a:PostCode>
<a:Street1>Test address</a:Street1>
</a:Address>
</a:Addresses>
<a:Amounts>
<a:Amount>
<a:CurrencyClientId>1</a:CurrencyClientId>
<a:CurrencyCode>NOK</a:CurrencyCode>
<a:Kind>FixedPrice</a:Kind>
<a:Value>170.00</a:Value>
</a:Amount>
</a:Amounts>
<a:CarriagePayer>Sender</a:CarriagePayer>
<a:CarrierId>142</a:CarrierId>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:Details/>
<a:Esid>2699308703</a:Esid>
<a:Events>
<a:Event>
<a:Date>2021-01-14T11:26:38</a:Date>
<a:KindId>4</a:KindId>
<a:Origin>Consignor</a:Origin>
<a:Parent>
<a:Barcode>40170716487237366760</a:Barcode>
<a:Esid>2699308703</a:Esid>
<a:IsShipment>true</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-14T11:27:29.213</a:ServerDate>
<a:StatusState>Opening</a:StatusState>
<a:StatusText>Printed</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:Date>2021-01-14T11:26:38</a:Date>
<a:KindId>1</a:KindId>
<a:Origin>Consignor</a:Origin>
<a:Parent>
<a:Barcode>40170716487237366760</a:Barcode>
<a:Esid>2699308703</a:Esid>
<a:IsShipment>true</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-14T11:27:29.223</a:ServerDate>
<a:StatusState>Opening</a:StatusState>
<a:StatusText>Created (by import)</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:Date>2021-01-14T11:26:38</a:Date>
<a:KindId>25</a:KindId>
<a:Origin>Consignor</a:Origin>
<a:Parent>
<a:Barcode>40170716487237366760</a:Barcode>
<a:Esid>2699308703</a:Esid>
<a:IsShipment>true</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-14T11:27:29.23</a:ServerDate>
<a:StatusState>Opening</a:StatusState>
<a:StatusText>Shipment label printed</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:Date>2021-01-14T15:15:01.227</a:Date>
<a:KindId>17</a:KindId>
<a:Origin>Consignor</a:Origin>
<a:Parent>
<a:Barcode>40170716487237366760</a:Barcode>
<a:Esid>2699308703</a:Esid>
<a:IsShipment>true</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-14T15:15:42.79</a:ServerDate>
<a:StatusState>Opening</a:StatusState>
<a:StatusText>Transmitted</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
</a:Events>
<a:ImportDate>2021-01-14T11:26:38</a:ImportDate>
<a:InstallationId>11111111111</a:InstallationId>
<a:InstallationName>Consignor AS</a:InstallationName>
<a:IsConceptCarrier>true</a:IsConceptCarrier>
<a:IsConceptProduct>true</a:IsConceptProduct>
<a:LabelPrintDate>2021-01-14T11:26:38</a:LabelPrintDate>
<a:LatestStatusText>Utlevert</a:LatestStatusText>
<a:Lines>
<a:Line>
<a:DangerousGoods/>
<a:LineNumberOfPackages>1</a:LineNumberOfPackages>
<a:LineUnits
xmlns:b="http://schemas.datacontract.org/2004/07/EdiSoft.Common.Domain"/>
<a:Number>1</a:Number>
<a:Packages>
<a:Package>
<a:Details/>
<a:Events>
<a:Event>
<a:BaseEventGuid>91c80bfe-efba-e511-8119-069a0e10e3c1</a:BaseEventGuid>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:CityName>OSLO</a:CityName>
<a:Date>2021-01-14T19:23:00</a:Date>
<a:KindId>614</a:KindId>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>00370716487237366667</a:Barcode>
<a:Esid>0</a:Esid>
<a:IsShipment>false</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-14T19:53:03.307</a:ServerDate>
<a:StatusCode>RR</a:StatusCode>
<a:StatusState>InProgress</a:StatusState>
<a:StatusText>Innleveringsregistrert</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:BaseEventGuid>91c80bfe-efba-e511-8119-069a0e10e3c1</a:BaseEventGuid>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:CityName>OSLO</a:CityName>
<a:Date>2021-01-14T19:23:00</a:Date>
<a:KindId>613</a:KindId>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>00370716487237366667</a:Barcode>
<a:Esid>0</a:Esid>
<a:IsShipment>false</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-14T19:53:03.307</a:ServerDate>
<a:StatusCode>RG</a:StatusCode>
<a:StatusState>InProgress</a:StatusState>
<a:StatusText>Ankomstregistrert</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:BaseEventGuid>4f374ed4-37bb-e511-8119-069a0e10e3c1</a:BaseEventGuid>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:Date>2021-01-14T19:23:00</a:Date>
<a:Height>250</a:Height>
<a:Length>380</a:Length>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>00370716487237366667</a:Barcode>
<a:Esid>0</a:Esid>
<a:IsShipment>false</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:PriceBruto>202.00</a:PriceBruto>
<a:ServerDate>2021-01-15T04:27:28.21</a:ServerDate>
<a:StatusState>InProgress</a:StatusState>
<a:StatusText/>
<a:Type>Measurement Price</a:Type>
<a:Volume>36100000</a:Volume>
<a:Weight>18850</a:Weight>
<a:Width>380</a:Width>
</a:Event>
<a:Event>
<a:BaseEventGuid>1f14b262-5dbb-e511-8119-069a0e10e3c1</a:BaseEventGuid>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:CityName>OSLO</a:CityName>
<a:Date>2021-01-15T08:35:00</a:Date>
<a:KindId>1550</a:KindId>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>00370716487237366667</a:Barcode>
<a:Esid>0</a:Esid>
<a:IsShipment>false</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-15T08:56:05.087</a:ServerDate>
<a:StatusCode>R3</a:StatusCode>
<a:StatusState>InProgress</a:StatusState>
<a:StatusText>Opplastet til distribusjonen</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:BaseEventGuid>81d94943-87bb-e511-8119-069a0e10e3c1</a:BaseEventGuid>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:CityName>OSLO</a:CityName>
<a:Date>2021-01-15T13:25:00</a:Date>
<a:KindId>612</a:KindId>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>00370716487237366667</a:Barcode>
<a:Esid>0</a:Esid>
<a:IsShipment>false</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-15T13:57:26.227</a:ServerDate>
<a:StatusCode>RI</a:StatusCode>
<a:StatusState>Closing</a:StatusState>
<a:StatusText>Utlevert</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
</a:Events>
<a:ItemNumber>1</a:ItemNumber>
<a:Number>00370716487237366667</a:Number>
<a:References/>
</a:Package>
</a:Packages>
<a:References>
<a:Reference>
<a:Kind>219</a:Kind>
<a:KindText>Line Shipment Booked</a:KindText>
<a:Value>True</a:Value>
</a:Reference>
</a:References>
</a:Line>
</a:Lines>
<a:LocationId>54</a:LocationId>
<a:LocationName>Consignor Group</a:LocationName>
<a:Messages/>
<a:Number>40170716487237366760</a:Number>
<a:NumberOfPackages>1</a:NumberOfPackages>
<a:OrderNumber>96169</a:OrderNumber>
<a:PackageUid>8badae65-9244-4376-b925-bcf21fdd468f</a:PackageUid>
<a:PayerAccountAtCarrier>00012345678</a:PayerAccountAtCarrier>
<a:PhysicalInstallationId>11111111111</a:PhysicalInstallationId>
<a:PickupDate>2021-01-14T00:00:00</a:PickupDate>
<a:ProductId>1032</a:ProductId>
<a:ProductName>Bedriftspakke</a:ProductName>
<a:References>
<a:Reference>
<a:Kind>62</a:Kind>
<a:KindText>CarrierCode</a:KindText>
<a:Value>PB</a:Value>
</a:Reference>
<a:Reference>
<a:Kind>99</a:Kind>
<a:KindText>Carrier Specific Shipment 2</a:KindText>
<a:Value>2</a:Value>
</a:Reference>
<a:Reference>
<a:Kind>13</a:Kind>
<a:KindText>DEPRECATED! Operator</a:KindText>
<a:Value>Import</a:Value>
</a:Reference>
</a:References>
<a:SenderAccountAtCarrier>00012345678</a:SenderAccountAtCarrier>
<a:Services>
<a:Service>
<a:ServiceId>142129</a:ServiceId>
<a:ServiceName>Ett utleveringsforsøk, deretter til postkontor</a:ServiceName>
</a:Service>
</a:Services>
<a:ShipmentConnections/>
<a:ShipmentCsid>300012</a:ShipmentCsid>
<a:ShipmentCustomDocuments
xmlns:b="http://schemas.datacontract.org/2004/07/EdiSoft.Common.Domain"/>
<a:ShipmentDocuments
xmlns:b="http://schemas.datacontract.org/2004/07/EdiSoft.Common.Domain"/>
<a:ShipmentKind>Normal</a:ShipmentKind>
<a:SubcarrierId>211</a:SubcarrierId>
<a:SubcarrierName>Pakker</a:SubcarrierName>
<a:SubmitDate>2021-01-14T11:26:38</a:SubmitDate>
<a:TransmitDate>2021-01-14T15:15:01.227</a:TransmitDate>
</a:Shipment>
GetShipmentsByShipmentNumber
Get shipment data on a shipment number. The method returns packages, references, amounts, carrier measurement, track and trace(carrier / ScanApp) events, sender and receiver.
|
FIELD |
TYPE |
DESCRIPTION |
|
userName |
string |
Mandatory. Consignor Portal user name. |
|
password |
string |
Mandatory. Consignor Portal password. |
|
installationValue |
string |
Consignor installation Id. |
|
actors |
ArrayOfInt |
Optional. Actor Id(s) for the search or empty array. |
|
startDateTime |
dateTime |
Optional. Start date and time for the search. |
|
endDateTime |
dateTime |
Optional. End date and time for the search. - Maximum date range for start end end date is 30 days. - If start and end date are not provided, the search will be within the last 30 days. |
Request:
<edis:GetShipmentsByshipmentNumber>
<edis:userName>Your userName</edis:userName>
<edis:password>Your password</edis:password>
<edis:installationValue>Your installationId</edis:installationValue>
<edis:actors>
<arr:int>Your actorId</arr:int>
</edis:actors>
<edis:shipmentNumber>40170716487237366760 (your shipment number)</edis:shipmentNumber>
<edis:startDateTime>2021-01-14T09:00:00</edis:startDateTime>
<edis:endDateTime>2021-01-15T15:15:00</edis:endDateTime>
</edis:GetShipmentsByshipmentNumber>
Response:
<a:Shipment>
<a:ActorCsid>65</a:ActorCsid>
<a:ActorName>Consignor AS</a:ActorName>
<a:Addresses>
<a:Address>
<a:Attention>John Doe</a:Attention>
<a:City>OSLO</a:City>
<a:CountryClientId>160</a:CountryClientId>
<a:CountryCode>NO</a:CountryCode>
<a:CountryName>Norway</a:CountryName>
<a:Email>john@hotmail.com</a:Email>
<a:Kind>Receiver</a:Kind>
<a:Name1>Test AS</a:Name1>
<a:POCity>OSLO</a:POCity>
<a:POPostCode>0267</a:POPostCode>
<a:PostCode>0267</a:PostCode>
<a:Street1>Test address</a:Street1>
</a:Address>
<a:Address>
<a:City>Oslo</a:City>
<a:CountryClientId>160</a:CountryClientId>
<a:CountryCode>NO</a:CountryCode>
<a:CountryName>Norway</a:CountryName>
<a:Kind>Sender</a:Kind>
<a:Name1>Consignor AS</a:Name1>
<a:POBox>0342, Test</a:POBox>
<a:POCity>OSLO</a:POCity>
<a:POPostCode>0342</a:POPostCode>
<a:Phone>12345678</a:Phone>
<a:PostCode>0342</a:PostCode>
<a:Street1>Test address</a:Street1>
</a:Address>
</a:Addresses>
<a:Amounts>
<a:Amount>
<a:CurrencyClientId>1</a:CurrencyClientId>
<a:CurrencyCode>NOK</a:CurrencyCode>
<a:Kind>FixedPrice</a:Kind>
<a:Value>170.00</a:Value>
</a:Amount>
</a:Amounts>
<a:CarriagePayer>Sender</a:CarriagePayer>
<a:CarrierId>142</a:CarrierId>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:Details/>
<a:Esid>2699308703</a:Esid>
<a:Events>
<a:Event>
<a:Date>2021-01-14T11:26:38</a:Date>
<a:KindId>4</a:KindId>
<a:Origin>Consignor</a:Origin>
<a:Parent>
<a:Barcode>40170716487237366760</a:Barcode>
<a:Esid>2699308703</a:Esid>
<a:IsShipment>true</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-14T11:27:29.213</a:ServerDate>
<a:StatusState>Opening</a:StatusState>
<a:StatusText>Printed</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:Date>2021-01-14T11:26:38</a:Date>
<a:KindId>1</a:KindId>
<a:Origin>Consignor</a:Origin>
<a:Parent>
<a:Barcode>40170716487237366760</a:Barcode>
<a:Esid>2699308703</a:Esid>
<a:IsShipment>true</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-14T11:27:29.223</a:ServerDate>
<a:StatusState>Opening</a:StatusState>
<a:StatusText>Created (by import)</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:Date>2021-01-14T11:26:38</a:Date>
<a:KindId>25</a:KindId>
<a:Origin>Consignor</a:Origin>
<a:Parent>
<a:Barcode>40170716487237366760</a:Barcode>
<a:Esid>2699308703</a:Esid>
<a:IsShipment>true</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-14T11:27:29.23</a:ServerDate>
<a:StatusState>Opening</a:StatusState>
<a:StatusText>Shipment label printed</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:Date>2021-01-14T15:15:01.227</a:Date>
<a:KindId>17</a:KindId>
<a:Origin>Consignor</a:Origin>
<a:Parent>
<a:Barcode>40170716487237366760</a:Barcode>
<a:Esid>2699308703</a:Esid>
<a:IsShipment>true</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-14T15:15:42.79</a:ServerDate>
<a:StatusState>Opening</a:StatusState>
<a:StatusText>Transmitted</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
</a:Events>
<a:ImportDate>2021-01-14T11:26:38</a:ImportDate>
<a:InstallationId>11111111111</a:InstallationId>
<a:InstallationName>Consignor AS</a:InstallationName>
<a:IsConceptCarrier>true</a:IsConceptCarrier>
<a:IsConceptProduct>true</a:IsConceptProduct>
<a:LabelPrintDate>2021-01-14T11:26:38</a:LabelPrintDate>
<a:LatestStatusText>Utlevert</a:LatestStatusText>
<a:Lines>
<a:Line>
<a:DangerousGoods/>
<a:LineNumberOfPackages>1</a:LineNumberOfPackages>
<a:LineUnits
xmlns:b="http://schemas.datacontract.org/2004/07/EdiSoft.Common.Domain"/>
<a:Number>1</a:Number>
<a:Packages>
<a:Package>
<a:Details/>
<a:Events>
<a:Event>
<a:BaseEventGuid>91c80bfe-efba-e511-8119-069a0e10e3c1</a:BaseEventGuid>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:CityName>OSLO</a:CityName>
<a:Date>2021-01-14T19:23:00</a:Date>
<a:KindId>614</a:KindId>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>00370716487237366667</a:Barcode>
<a:Esid>0</a:Esid>
<a:IsShipment>false</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-14T19:53:03.307</a:ServerDate>
<a:StatusCode>RR</a:StatusCode>
<a:StatusState>InProgress</a:StatusState>
<a:StatusText>Innleveringsregistrert</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:BaseEventGuid>91c80bfe-efba-e511-8119-069a0e10e3c1</a:BaseEventGuid>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:CityName>OSLO</a:CityName>
<a:Date>2021-01-14T19:23:00</a:Date>
<a:KindId>613</a:KindId>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>00370716487237366667</a:Barcode>
<a:Esid>0</a:Esid>
<a:IsShipment>false</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-14T19:53:03.307</a:ServerDate>
<a:StatusCode>RG</a:StatusCode>
<a:StatusState>InProgress</a:StatusState>
<a:StatusText>Ankomstregistrert</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:BaseEventGuid>4f374ed4-37bb-e511-8119-069a0e10e3c1</a:BaseEventGuid>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:Date>2021-01-14T19:23:00</a:Date>
<a:Height>250</a:Height>
<a:Length>380</a:Length>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>00370716487237366667</a:Barcode>
<a:Esid>0</a:Esid>
<a:IsShipment>false</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:PriceBruto>202.00</a:PriceBruto>
<a:ServerDate>2021-01-15T04:27:28.21</a:ServerDate>
<a:StatusState>InProgress</a:StatusState>
<a:StatusText/>
<a:Type>Measurement Price</a:Type>
<a:Volume>36100000</a:Volume>
<a:Weight>18850</a:Weight>
<a:Width>380</a:Width>
</a:Event>
<a:Event>
<a:BaseEventGuid>1f14b262-5dbb-e511-8119-069a0e10e3c1</a:BaseEventGuid>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:CityName>OSLO</a:CityName>
<a:Date>2021-01-15T08:35:00</a:Date>
<a:KindId>1550</a:KindId>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>00370716487237366667</a:Barcode>
<a:Esid>0</a:Esid>
<a:IsShipment>false</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-15T08:56:05.087</a:ServerDate>
<a:StatusCode>R3</a:StatusCode>
<a:StatusState>InProgress</a:StatusState>
<a:StatusText>Opplastet til distribusjonen</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:BaseEventGuid>81d94943-87bb-e511-8119-069a0e10e3c1</a:BaseEventGuid>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:CityName>OSLO</a:CityName>
<a:Date>2021-01-15T13:25:00</a:Date>
<a:KindId>612</a:KindId>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>00370716487237366667</a:Barcode>
<a:Esid>0</a:Esid>
<a:IsShipment>false</a:IsShipment>
<a:OrderNumber>96169</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-15T13:57:26.227</a:ServerDate>
<a:StatusCode>RI</a:StatusCode>
<a:StatusState>Closing</a:StatusState>
<a:StatusText>Utlevert</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
</a:Events>
<a:ItemNumber>1</a:ItemNumber>
<a:Number>00370716487237366667</a:Number>
<a:References/>
</a:Package>
</a:Packages>
<a:References>
<a:Reference>
<a:Kind>219</a:Kind>
<a:KindText>Line Shipment Booked</a:KindText>
<a:Value>True</a:Value>
</a:Reference>
</a:References>
</a:Line>
</a:Lines>
<a:LocationId>54</a:LocationId>
<a:LocationName>Consignor Group</a:LocationName>
<a:Messages/>
<a:Number>40170716487237366760</a:Number>
<a:NumberOfPackages>1</a:NumberOfPackages>
<a:OrderNumber>96169</a:OrderNumber>
<a:PackageUid>8badae65-9244-4376-b925-bcf21fdd468f</a:PackageUid>
<a:PayerAccountAtCarrier>00012345678</a:PayerAccountAtCarrier>
<a:PhysicalInstallationId>11111111111</a:PhysicalInstallationId>
<a:PickupDate>2021-01-14T00:00:00</a:PickupDate>
<a:ProductId>1032</a:ProductId>
<a:ProductName>Bedriftspakke</a:ProductName>
<a:References>
<a:Reference>
<a:Kind>62</a:Kind>
<a:KindText>CarrierCode</a:KindText>
<a:Value>PB</a:Value>
</a:Reference>
<a:Reference>
<a:Kind>99</a:Kind>
<a:KindText>Carrier Specific Shipment 2</a:KindText>
<a:Value>2</a:Value>
</a:Reference>
<a:Reference>
<a:Kind>13</a:Kind>
<a:KindText>DEPRECATED! Operator</a:KindText>
<a:Value>Import</a:Value>
</a:Reference>
</a:References>
<a:SenderAccountAtCarrier>00012345678</a:SenderAccountAtCarrier>
<a:Services>
<a:Service>
<a:ServiceId>142129</a:ServiceId>
<a:ServiceName>Ett utleveringsforsøk, deretter til postkontor</a:ServiceName>
</a:Service>
</a:Services>
<a:ShipmentConnections/>
<a:ShipmentCsid>300012</a:ShipmentCsid>
<a:ShipmentCustomDocuments
xmlns:b="http://schemas.datacontract.org/2004/07/EdiSoft.Common.Domain"/>
<a:ShipmentDocuments
xmlns:b="http://schemas.datacontract.org/2004/07/EdiSoft.Common.Domain"/>
<a:ShipmentKind>Normal</a:ShipmentKind>
<a:SubcarrierId>211</a:SubcarrierId>
<a:SubcarrierName>Pakker</a:SubcarrierName>
<a:SubmitDate>2021-01-14T11:26:38</a:SubmitDate>
<a:TransmitDate>2021-01-14T15:15:01.227</a:TransmitDate>
</a:Shipment>
GetShipmentStatus
Get events on shipment with a shipment number as input. The method returns carrier measurements / prices, Consignor and track and trace(carrier) events.
|
FIELD |
TYPE |
DESCRIPTION |
|
userName |
string |
Mandatory. Consignor Portal user name. |
|
password |
string |
Mandatory. Consignor Portal password. |
|
shipmentNumber |
string |
Mandatory. The shipment number to search for. |
|
startDateTime |
dateTime |
Optional. Start date and time for the search. |
|
endDateTime |
dateTime |
Optional. End date and time for the search. - If start and end date are not provided, the search will be within the last 10 days. |
Request:
<edis:GetShipmentStatus>
<edis:userName>Your userName</edis:userName>
<edis:password>Your password</edis:password>
<edis:shipmentNumber>40170716487237366760 (your shipment number)</edis:shipmentNumber>
<edis:startDateTime>2021-01-11T09:00:00</edis:startDateTime>
<edis:endDateTime>2021-01-14T15:00:00</edis:endDateTime>
</edis:GetShipmentStatus>
Response:
<a:Event>
<a:Date>2021-01-12T09:10:09</a:Date>
<a:KindId>1</a:KindId>
<a:Origin>Consignor</a:Origin>
<a:Parent>
<a:Barcode>40170716487237366760</a:Barcode>
<a:Esid>2699307722</a:Esid>
<a:IsShipment>true</a:IsShipment>
<a:OrderNumber>96141</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-12T09:15:45.893</a:ServerDate>
<a:StatusState>Opening</a:StatusState>
<a:StatusText>Created (by import)</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:Date>2021-01-12T09:10:09</a:Date>
<a:KindId>4</a:KindId>
<a:Origin>Consignor</a:Origin>
<a:Parent>
<a:Barcode>40170716487237366760</a:Barcode>
<a:Esid>2699307722</a:Esid>
<a:IsShipment>true</a:IsShipment>
<a:OrderNumber>96141</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-12T09:15:45.93</a:ServerDate>
<a:StatusState>Opening</a:StatusState>
<a:StatusText>Printed</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:Date>2021-01-12T09:10:09</a:Date>
<a:KindId>25</a:KindId>
<a:Origin>Consignor</a:Origin>
<a:Parent>
<a:Barcode>40170716487237366760</a:Barcode>
<a:Esid>2699307722</a:Esid>
<a:IsShipment>true</a:IsShipment>
<a:OrderNumber>96141</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-12T09:15:46.04</a:ServerDate>
<a:StatusState>Opening</a:StatusState>
<a:StatusText>Shipment label printed</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:Date>2021-01-12T15:15:01.337</a:Date>
<a:KindId>17</a:KindId>
<a:Origin>Consignor</a:Origin>
<a:Parent>
<a:Barcode>40170716487237366760</a:Barcode>
<a:Esid>2699307722</a:Esid>
<a:IsShipment>true</a:IsShipment>
<a:OrderNumber>96141</a:OrderNumber>
</a:Parent>
<a:ServerDate>2021-01-12T15:15:42.103</a:ServerDate>
<a:StatusState>Opening</a:StatusState>
<a:StatusText>Transmitted</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:BaseEventGuid>76896f97-44b9-e511-8119-069a0e10e3c1</a:BaseEventGuid>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:CityName>OSLO</a:CityName>
<a:Date>2021-01-12T16:49:00</a:Date>
<a:KindId>614</a:KindId>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>00370716487237366667</a:Barcode>
<a:Esid>0</a:Esid>
<a:IsShipment>false</a:IsShipment>
</a:Parent>
<a:ServerDate>2021-01-12T16:53:30.543</a:ServerDate>
<a:StatusCode>RR</a:StatusCode>
<a:StatusState>InProgress</a:StatusState>
<a:StatusText>Innleveringsregistrert</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:BaseEventGuid>d4b1887a-a5b9-e511-8119-069a0e10e3c1</a:BaseEventGuid>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:Date>2021-01-12T16:49:00</a:Date>
<a:Height>240</a:Height>
<a:Length>380</a:Length>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>00370716487237366667</a:Barcode>
<a:Esid>0</a:Esid>
<a:IsShipment>false</a:IsShipment>
</a:Parent>
<a:PriceBruto>235.00</a:PriceBruto>
<a:ServerDate>2021-01-13T04:27:00.867</a:ServerDate>
<a:StatusState>InProgress</a:StatusState>
<a:StatusText/>
<a:Type>Measurement Price</a:Type>
<a:Volume>34656000</a:Volume>
<a:Weight>18900</a:Weight>
<a:Width>380</a:Width>
</a:Event>
<a:Event>
<a:BaseEventGuid>a61e547f-bab9-e511-8119-069a0e10e3c1</a:BaseEventGuid>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:CityName>STAVANGER</a:CityName>
<a:Date>2021-01-13T06:14:00</a:Date>
<a:KindId>613</a:KindId>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>00370716487237366667</a:Barcode>
<a:Esid>0</a:Esid>
<a:IsShipment>false</a:IsShipment>
</a:Parent>
<a:ServerDate>2021-01-13T06:57:37.997</a:ServerDate>
<a:StatusCode>RG</a:StatusCode>
<a:StatusState>InProgress</a:StatusState>
<a:StatusText>Ankomstregistrert</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:BaseEventGuid>5c95380e-cbb9-e511-8119-069a0e10e3c1</a:BaseEventGuid>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:CityName>STAVANGER</a:CityName>
<a:Date>2021-01-13T08:37:00</a:Date>
<a:KindId>1550</a:KindId>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>00370716487237366667</a:Barcode>
<a:Esid>0</a:Esid>
<a:IsShipment>false</a:IsShipment>
</a:Parent>
<a:ServerDate>2021-01-13T08:56:05.993</a:ServerDate>
<a:StatusCode>R3</a:StatusCode>
<a:StatusState>InProgress</a:StatusState>
<a:StatusText>Opplastet til distribusjonen</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
<a:Event>
<a:BaseEventGuid>1501b078-e8b9-e511-8119-069a0e10e3c1</a:BaseEventGuid>
<a:CarrierName>Bring(New)</a:CarrierName>
<a:CityName>STAVANGER</a:CityName>
<a:Date>2021-01-13T11:54:00</a:Date>
<a:KindId>612</a:KindId>
<a:Origin>ReturnData</a:Origin>
<a:Parent>
<a:Barcode>00370716487237366667</a:Barcode>
<a:Esid>0</a:Esid>
<a:IsShipment>false</a:IsShipment>
</a:Parent>
<a:ServerDate>2021-01-13T12:28:25.267</a:ServerDate>
<a:StatusCode>RI</a:StatusCode>
<a:StatusState>Closing</a:StatusState>
<a:StatusText>Utlevert</a:StatusText>
<a:Type>TrackAndTrace</a:Type>
</a:Event>
IsShipmentClosed
Checks if a shipment has a closing event.
|
FIELD |
TYPE |
DESCRIPTION |
|
userName |
string |
Mandatory. Consignor Portal user name. |
|
password |
string |
Mandatory. Consignor Portal password. |
Request:
<edis:IsShipmentClosed>
<edis:userName>Your userName</edis:userName>
<edis:password>Your password</edis:password>
<edis:barcode>40170716487237366760 (your shipment number)</edis:barcode>
</edis:IsShipmentClosed>
Response:
<a:StatusInfo>
<a:Barcode>40170716487237366760</a:Barcode>
<a:IsClosed>true</a:IsClosed>
<a:ShipmentNumber>40170716487237366760</a:ShipmentNumber>
</a:StatusInfo>
SendEvent
The SendEvent method provides the ability to add a new event to a shipment. StatusCode is customizable in the way that it is created on the first request and then reused on the following requests. The StatusText that was defined concurrently with the creation, relates to that StatusCode. This means that the StatusText is not needed in the request when the same StatusCode is used again as the text defined on creation will be used.
|
FIELD |
TYPE |
DESCRIPTION |
|
userName |
string |
Mandatory. Consignor Portal user name. |
|
password |
string |
Mandatory. Consignor Portal password. |
|
AttachmentByte |
base64Binary / byte array |
Optional. Attach a binary of a picture. |
|
Attachment |
string / Attachment |
Mandatory if there is an attachment.
|
|
Comments |
string |
Optional. Shown on shipments below the status text. |
|
Date |
dateTime |
Mandatory. Represents this Event Date |
|
IdentifierType |
String Possible values: |
Mandatory. Used to identify the shipment that the event is sent to. |
|
IdentifierValue |
string | Mandatory. The value for the IdentifierType (shipment) to add the event to. |
|
StatusCode |
string | Mandatory. Field creating a code for the status for this user so it can be resent and reused. |
|
StatusIsClosed |
boolean | Optional. Marks the shipment as Closed (Delivered). |
|
StatusText |
string | Label text for the status. Optional if sent for that Status Code. |
Request:
<edis:SendEvent>
<edis:userName>YourUser</edis:userName>
<edis:password>YourPassword</edis:password>
<edis:submitEvent>
<edis1:Date>2021-01-19T18:07:21</edis1:Date>
<edis1:ParentIdentifier>
<edis2:IdentifierType>Barcode</edis2:IdentifierType>
<edis2:IdentifierValue>40170716483417240837</edis2:IdentifierValue>
</edis1:ParentIdentifier>
<edis1:StatusCode>L1</edis1:StatusCode>
<edis1:StatusIsClosed>false</edis1:StatusIsClosed>
<edis1:StatusText>test</edis1:StatusText>
</edis:submitEvent>
</edis:SendEvent>
Response:
<SendEventResult>true</SendEventResult>