Embedded Files
WARNING: This request will not be in use by the end of July 2025. All merchants should be using ShipmentListV3Request, that is an improved version of this request.
This is an improved version of the ShipmentsListRequest, optimised for obtaining a higher number of shipments through a paginated output. It is recommended to use this request, instead of the legacy one, if you need to retrieve information for a large number of shipments (in the range of hundreds).
In the request:
the StoreId and CustomerId fields (because they were actually no longer processed in the old version either) are deprecated
the <Page> field was added with a value ranging from 1 to <TotalPages> (which you get from the output)
fields <DateFrom> and <DateTo> do not have any specific limits, as pagination was introduced to handle a large number of shipments queried in the request call
as many MBE Master Trackings may be entered in the <MBEMasterTrackings> field as desired (no limits)
the parameter <WithCourierWaybill> follows the same rules listed in the ShipmentListRequest page.
the optional parameter <ToBeClosed> was added
if true, only shipments yet to be closed will be returned
if false, only finalised shipments with a generated waybill will be returned
if absent, all shipments, both finalised and yet to be closed, will be returned
the optional parameter <DepartmentID> was added
if populated, only shipments from that department will be returned
if not populated, all shipments will be shown without any filtering on the department
If absent, all shipments will be shown without any filtering on the department
In the response:
the <Page> field was added for showing the returned page (1 if in the request no page is requested; otherwise, the page requested in the request) and the <TotalPages> field
By default, the system returns a maximum of 25 shipments per page; following pages can be requested in the <Page> field as seen above
At the end of each shipment, there will always be the new fields <ShipmentToBeClosed> and <DepartmentID>, which will indicate whether the shipment is to be closed and if it belongs to a department
Request Sample (given a date range)
Request Sample (given a date range)
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.onlinembe.eu/ws/">
<soapenv:Header/>
<soapenv:Body>
<ws:ShipmentsListV2Request>
<RequestContainer>
<System></System>
<Credentials>
<Username></Username>
<Passphrase></Passphrase>
</Credentials>
<InternalReferenceID>dhhdg</InternalReferenceID>
<DateFrom>2023-11-12</DateFrom>
<DateTo>2023-12-11</DateTo>
<WithCourierWaybill>false</WithCourierWaybill>
<Page></Page>
</RequestContainer>
</ws:ShipmentsListV2Request>
</soapenv:Body>
</soapenv:Envelope>
Response Sample
Response Sample
<ShipmentsFullInfo>
<ShipmentFullInfo>
<ReceiverInfo>
<CompanyName>Econaiccacs SRL</CompanyName>
<Name>Econaiccacs SRL</Name>
<Address>Via Medeghino 31</Address>
<ZipCode>20141</ZipCode>
<City>Milano</City>
<State>MI</State>
<Country>Italy</Country>
<Phone>054350435</Phone>
<Emails>dgggg@gsdffdfds.com</Emails>
</ReceiverInfo>
<ShipmentInfo>
<Description>ECOMMERCE SHOP PURCHASE</Description>
<COD>false</COD>
<Insurance>false</Insurance>
<MBEService>MBE Standard</MBEService>
<Courier>TNT</Courier>
<CourierService>Economy Express</CourierService>
<Items>
<Item>
<Dimensions>
<Lenght>10.0</Lenght>
<Height>10.0</Height>
<Width>10.0</Width>
</Dimensions>
</Item>
</Items>
<Date>2023-12-06</Date>
</ShipmentInfo>
<TrackingInfo>
<MasterTrackingMBE>IT0001-0P-000000177Z</MasterTrackingMBE>
<TrackingsMBE>
<TrackingMBE>IT0001-0P-000000177Z-01</TrackingMBE>
</TrackingsMBE>
<Labels>
<Label>
<Stream>XXX</Stream>
<Type>MBE_WAYBILL</Type>
</Label>
</Labels>
<CourierMasterTrk>WS54881381</CourierMasterTrk>
</TrackingInfo>
</ShipmentFullInfo>
<Page>1</Page>
<TotalPages>10</TotalPages>
</RequestContainer>
</ns3:ShipmentsListV2RequestResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Page updated
Report abuse