Shipment Request

With this call, a shipment can be created within MBE systems. 

Note that, the container RecipientDeliveryPoint is for internal use, it does not have to be filled in.
For shipments outside the EU, it is mandatory to fill in the ProformaInvoice node.

In particular:

• CustomerMbeId must be populated with the ID of the customer HUB to which the shipment is to be associated. N.B. This field is optional, and, if used, the customer must be of type AH (Auction House);
  
  

• ShipperType can be set with MBE or COURIERLDV. These parameter controls which document is returned in the API response, but does not affect the actual shipment processing logic. In essence, this parameter acts as a response format selector rather than a processing instruction.
  
  The creation and finalization of the courier waybill documents is determined by the MOL user's permissions configured by the Store:

  • When the MOL user has waybill printing permissions enabled, the courier waybill will always be created and finalized regardless of the ShipperType value. Setting this parameter to COURIERLDV will return the courier waybill document in the response stream, while setting it to MBE will return the MBE shipping label instead. However, in both cases, the courier waybill is still generated in the background

  • If the MOL user lacks courier waybill printing permissions, only the MBE shipping label will be available regardless of the parameter value.
    
    

• Service to be set with the value previously obtained with the ShippingOptionsRequest call;
  
  

• PackageType to be valued with GENERIC;
  
  

• 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 active, 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;
  
  

• 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 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
    
    

• DepartmentID, to be valued with the appropriate HUB department ID (retrieved through the ListDepartmentsRequest), if the shipment must be linked to a specific department (also check the ListDepartmentsRequest).
  Depending on the two settings Customer address as sender and Mandatory Department, set by the store for the MOL user, the following validations are applied:
  
  

  • "Customer address as sender = true" , "Mandatory Department = true"
    
    

    • 1. If Department is provided in the call => Customer address = use the department provided in the call. Sender address = Customer address;

      2. If Department is NOT provided in the call => Customer address = use department configured on the MOL user;

      3. If the department configured on the MOL user does not exist, the Error stating “Department is mandatory for the current MBE Online user, but not provided” will be shown.  Sender address = Customer address;
         
         

  • "Customer address as sender = true" , "Mandatory Department = false"

• • • 1. Department is provided in the call => Customer address=use the department provided in the call. Sender address= Customer address;

      2. Department is NOT provided in the call=> Customer address= use the customer address even if a department is configured on the MOL user. Sender address=Customer address;
         
         

  • "Customer address as sender = false" , "Mandatory Department = true"
    
    

    • 1. Department is provided in the call => Error stating "The department ID provided mismatch the user configuration";

      2. Department is NOT provided in the call => Customer address=use department configured on the MOL user. If the department configured on the MOL user does not exist use the customer address. Sender address=store address;

• • "Customer address as sender=false" , "Mandatory Department=false"
    
    

    1. 1. Department is provided in the call => Error stating "The department ID provided mismatch the user configuration";

       2. Department is NOT provided in the call => Customer address= use the customer address even if a department is configured on the MOL user. Sender address= Store address.

Note: Call used also by eShip Plugins