Back

openBatch

David Clapper

2019-10-01 09:19:52 UTC

This request can be used to group single shipments into a single batch. It generates a batch ID within the batch element. This request is currently only available for UPS World Ease.

Request

Element specifications

Element	Type	Required?	Description
hash	String(255)	Yes	An SHA-1 encrypted authentication code. The string you encrypt is a concatenation of the following substrings: <webshop ID> + <integration password> + <carrier code> + <shipping option> + <country code> + <current date: YYYYMMDD> You will find the webshop ID and integration password in your Paazl web app account under Settings > Account > My Account A list of Paazl carrier codes is available on Paazl's online help. You will the codes for the shipping options you have contracted from your carrier(s) in your Paazl web app account under Carriers > Shipping options The country code is the ISO 3166-2 code for the country of the address to which an order is being shipped. Example Webshop ID: "123" Integration password: "myPassword" Carrier code: "TNT" Country code: "NL" Shipping option: "AVG" Date: "18 April 2018" String to encrypt: "store12myPasswordTNTAVGNL20180418"
webshop	Long(10)	Yes	The Webshop ID of your main webshop. You will find this in the Paazl UI under Settings > My Account
targetWebshop	Long(10)	No	If you use multiple webshops, this is the webshop ID of a child webshop (.a.k.a. Paazl sub-account). You will find it in the Paazl web app account of the child webshop concerned under Settings > My Account. The hash you create using the webshop ID of your parent webshop (a.k.a. main account) will give you access to its child webshops as well.
distributor	String	No	The shipment's carrier. A list of Paazl carrier codes is available on Paazl's online help.
shippingOption	String	No	This is the Paazl code for the shipping option concerned. You will the codes for the shipping options you have contracted from your carrier(s) in your Paazl web app account under Carriers > Shipping options
country	String	No	The ISO 3166-2 code for the country of the address to which an order is being shipped.

Sample request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mat="http://www.paazl.com/schemas/matrix">
   <soapenv:Header/>
   <soapenv:Body>
      <mat:openBatchRequest>
         <mat:hash>84561469a264e02082c884f0d2f0e6fc7c50f1d0</mat:hash>
         <mat:webshop>491</mat:webshop>
         
         <mat:targetWebshop></mat:targetWebshop>
         
         <mat:distributor>UPS</mat:distributor>
         
         <mat:shippingOption>UPS_SAVER_WE</mat:shippingOption>
         
         <mat:country>US</mat:country>
      </mat:openBatchRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response

Element specifications

Element	Type	Required	Description
batch	String	Yes	The batch number.

Sample response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <openBatchResponse xmlns="http://www.paazl.com/schemas/matrix">
         <batch>1ZA2E6200400003450</batch>
      </openBatchResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>