order

This article contains the technical specifications of Paazl's SOAP API order call.

Use this request to create a pending order in the Paazl database. The pending order will have a special order reference and will not be visible in the order overview of your web app account. You can include product attributes in the request to retrieve the shipping options and shipping rates that you have specified for that product in your delivery matrix.

Pending orders

When processing orders, Paazl uses two different order types to model the purchase transaction: a "pending order" and an "order". The pending order serves as a temporary reference point for available shipping options. When your customer selects an option and clicks "Buy", the pending order becomes an order and you have to commit it.

The following is a more detailed description of how this works:

1. A customer places an item in your webshop's shopping basket
2. Step 1 triggers an orderRequest call to Paazl with your reference code in the call's orderReference element
3. Paazl creates a pending order in its database using your reference code. The order is not yet visible on your account.
4. Your customer fills in his/her address details
5. Step 4 triggers a shippingOptionRequest call to Paazl, following which the returned options are displayed in your checkout
6. Your customer selects a shipping option, fills in his/her payment details, and clicks the "Buy" button
7. Step 5 triggers a commitOrderRequest call to Paazl. This call contains a reference to the pending order (pendingOrderReference) and a (new) reference for the order (orderReference)
8. Paazl creates the order in its database using the <orderReference> value, and displays the order in your webshop account

Example

Assume a customer is in your checkout and has filled in his/her address details. Using the orderRequest call's orderReference element, you tell Paazl that the reference code for the pending order is temp0001. That value is stored in Paazl's database but it is not visible in your webshop's Paazl account.

Your customer now clicks "Buy" and you send a commitOrder request to Paazl. You tell Paazl that the pending order concerned is temp0001 using the pendingOrderReference element. At the same time, using the orderReference element, you tell Paazl that the reference code you want to use for the committed order is order0001. Paazl creates the order with reference code order0001 and it appears in your Paazl account.

Product attributes

Paazl uses a product's attributes—such as height, weight, or value—to determine which shipping option applies to an order. It does this using the delivery matrix settings you have configured in your Paazl web app account. See About delivery matrices for information on how delivery matrices work.

Request

Element specifications

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:orderRequest>
        <mat:hash>2c3b01dc6bc280ffa4d643955555257b82d1d261</mat:hash>
         <mat:webshop>491</mat:webshop>
         <mat:targetWebshop></mat:targetWebshop>
         <mat:orderReference>214748364720151230095732</mat:orderReference>
         <mat:products>
            <mat:product>
               <mat:quantity>1</mat:quantity>
               <mat:packagesPerUnit>1</mat:packagesPerUnit>
               <mat:matrix></mat:matrix>
               <mat:weight>1</mat:weight>
               <mat:width>10</mat:width>
               <mat:height>15</mat:height>
               <mat:length>10</mat:length>
               <mat:volume></mat:volume>
               <mat:code></mat:code>
               <mat:description>Test</mat:description>
               <mat:countryOfManufacture>NL</mat:countryOfManufacture>
               <mat:unitPrice>50</mat:unitPrice>
               <mat:unitPriceCurrency>EUR</mat:unitPriceCurrency>
               <mat:hsTariffCode></mat:hsTariffCode>
               <mat:processingDays></mat:processingDays>
               <mat:promotionAbsolute></mat:promotionAbsolute>
               <mat:promotion></mat:promotion>
            </mat:product>
         </mat:products>
      </mat:orderRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response

Element specifications

Sample response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <orderResponse xmlns="http://www.paazl.com/schemas/matrix">
         <succes>Order successfully saved</succes>
      </orderResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>