Embedded Files
The ShippingOptionsRequest operation allows retrieval of the MBE services available with the relative shipping cost.
In particular:
ShipType must always have MBE value
PackageType must always have GENERIC value
GoodType the allowed values are GOODS/ART/LUGGAGE. If you want to use SafeValue Art, it must be valorised with ART. In addition, since SafeValue Art is a service that is only activated if the generic SafeValue service is also activated, the SafeValue fields must also be valorised
MBESafeValue, if allowed by your MBE center, must be set as TRUE; MBESafeValueValue on the other hand, is a field that must be filled in with the value you want to ensure
MBESafeValue4Business, if allowed by your MBE center, must be set as TRUE; MBESafeValue4BusinessValue on the other hand, is a field that must be filled in with the value you want to ensure
Within this call, a number of optional extraservices can be called (TRUE/FALSE).
By entering them in the call, HUB will return shipping costs that will also include the called extraservices (if available, configured and enabled by the center for the MOL user):COD
CODValue
CODPaymentMethod
DeliveryPrivateHome
DeliveredDutyPaid
DeliveryDirect
Packaging1
SpecialHandling
AHPackaging1 to AHPackaging16
AHPickup1
AHPickup2
AHPickup3
Insurance
InsuranceValue
SaturdayDelivery
SignatureRequired
MBESafeValue
MBESafeValueValue
MBESafeValue4Business
MBESafeValue4BusinessValue
Note: Call used also by eShip Plugins
Request Sample
Request Sample
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.onlinembe.eu/ws/">
<soapenv:Header/>
<soapenv:Body>
<ws:ShippingOptionsRequest>
<RequestContainer>
<System>IT</System>
<InternalReferenceID>FF48BBF9-C36B-47B5-8BF9-E76F919B17E4</InternalReferenceID>
<ShippingParameters>
<DestinationInfo>
<ZipCode>20142</ZipCode>
<City>Milan</City>
<Country>IT</Country>
<State>MI</State>
</DestinationInfo>
<PackageType>GENERIC</PackageType>
<Items>
<Item>
<Weight>1</Weight>
<Dimensions>
<Lenght>1</Lenght>
<Height>1</Height>
<Width>1</Width>
</Dimensions>
</Item>
</Items>
<COD>false</COD>
<CODValue>100</CODValue>
<Insurance>false</Insurance>
<InsuranceValue>100</InsuranceValue>
<SaturdayDelivery>false</SaturdayDelivery>
<SignatureRequired>false</SignatureRequired>
<MBESafeValue>false</MBESafeValue>
<MBESafeValueValue></MBESafeValueValue>
<MBESafeValue4Business>false</MBESafeValue4Business>
<MBESafeValue4BusinessValue></MBESafeValue4BusinessValue>
</ShippingParameters>
</RequestContainer>
</ws:ShippingOptionsRequest>
</soapenv:Body>
</soapenv:Envelope>
In the response, the fields returned are in one or more ShippingOption containers. Each container describes a possible MBE service available, based on the combination of the settings configured by the Store on HUB for the MOL user and the services available according to the input parameters (destination, dimensions, extra services, etc.).
In details, in each container, the fields returned are the following:
Service: according to settings for the MBE Online user, this can be either a numeric or textual value and represents the service ID on HUB. This ID must be referenced in the ShipmentRequest to create a shipment linked to the corresponding MBE service
ServiceDesc: description of the MBE service (Standard, Express, etc.)
CourierAccount: courier account linked to the service
Courier: courier name
CourierDesc: courier description
CourierService: courier service (MBE ID)
CourierServiceDesc: courier service description
NetShipmentPrice: preview of the final price, excluding VAT and excluding the extraservices
NetShipmentTotalPrice: preview of the final price, excluding VAT and including the extraservice
CODAvailable: true if requested in input
InsuranceAvailable: true if requested in input
IdSubzone: MBE internal subzone ID
CustomDuties:
SubzoneDesc: MBE internal subzone description
MBESafeValueAvailable: true if requested in input
GrossShipmentPrice: preview of the final price, including VAT and excluding the extraservices
GrossShipmentTotalPrice: preview of the final price, including VAT and including the extraservices
MBESafeValue4BusinessAvailable: true if requested in input
TargetService: when true, it means that the courier service will be the one the MBE systems will use when creating a shipment, if a SmartChoice configuration has been defined by the Center for the MOL user
Response Sample
Response Sample
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<ns3:ShippingOptionsRequestResponse xmlns:ns3="http://www.onlinembe.eu/ws/">
<RequestContainer>
<InternalReferenceID>FF48BBF9-C36B-47B5-8BF9-E76F919B17E4</InternalReferenceID>
<Status>OK</Status>
<ShippingOptions>
<ShippingOption>
<Service>SEE</Service>
<ServiceDesc>MBE Express</ServiceDesc>
<CourierAccount>E826V2</CourierAccount>
<Courier>UPS</Courier>
<CourierDesc>UPS</CourierDesc>
<CourierService>USA</CourierService>
<CourierServiceDesc>Express Saver</CourierServiceDesc>
<NetShipmentPrice>35.98</NetShipmentPrice>
<NetShipmentTotalPrice>35.98</NetShipmentTotalPrice>
<CODAvailable>false</CODAvailable>
<InsuranceAvailable>false</InsuranceAvailable>
<IdSubzone>24</IdSubzone>
<CustomDuties>true</CustomDuties>
<SubzoneDesc>Milano</SubzoneDesc>
<MBESafeValueAvailable>false</MBESafeValueAvailable>
<GrossShipmentPrice>43.90</GrossShipmentPrice>
<GrossShipmentTotalPrice>43.90</GrossShipmentTotalPrice>
<MBESafeValue4BusinessAvailable>false</MBESafeValue4BusinessAvailable>
<isWW>false</isWW>
<TargetService>true</TargetService>
</ShippingOption>
<ShippingOption>
<Service>SSE</Service>
<ServiceDesc>MBE Standard</ServiceDesc>
<CourierAccount>102101229</CourierAccount>
<Courier>DHL</Courier>
<CourierDesc>DHL</CourierDesc>
<CourierService>DHN</CourierService>
<CourierServiceDesc>Express</CourierServiceDesc>
<NetShipmentPrice>21.23</NetShipmentPrice>
<NetShipmentTotalPrice>21.23</NetShipmentTotalPrice>
<CODAvailable>false</CODAvailable>
<InsuranceAvailable>false</InsuranceAvailable>
<IdSubzone>24</IdSubzone>
<CustomDuties>true</CustomDuties>
<SubzoneDesc>Milano</SubzoneDesc>
<MBESafeValueAvailable>false</MBESafeValueAvailable>
<GrossShipmentPrice>25.90</GrossShipmentPrice>
<GrossShipmentTotalPrice>25.90</GrossShipmentTotalPrice>
<MBESafeValue4BusinessAvailable>false</MBESafeValue4BusinessAvailable>
<isWW>false</isWW>
<TargetService>false</TargetService>
</ShippingOption>
</ShippingOptions>
<CanSeePrices>true</CanSeePrices>
</RequestContainer>
</ns3:ShippingOptionsRequestResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Page updated
Report abuse