Commit Order

GET http://testapi.worldbox.ch/v1/order

Commit an order. An order contains one or an infinite number of orderitems.

Please be aware

• If you order a report for a company that is found in the Worldbox index, the win number is mandatory.

• If you order a legal document or an offline report for a company not found in the index and therefore win-number is not yet defined, enter the companyrequestid which is returned from "Send CompanyRequest". Important: For each product, either a win-number or an existing companyrequestid must be specified.

• The price and currency will be taken from your Worldbox price table and account settings! If you don't have a customer price table the official retail price is taken.

Attention
Access to the Worldbox index for company data is restricted on the test server. We will provide you with a sandbox list for testing.

RequestBody
The webservice expects a real JSON-string in the request-body with content-type:application/json.
Below is the JSON-Object structure containing an array of order items.

JSON

{
   orderitems:[
      {
         language:"DE",
         customerreference:123456,
         win:"CH0000041446",
         productcode: "DLF150",
				 format:"PDF",        
         additionalinfo:"Any information accompanying the order"
      },
      {
         language:"DE",
         customerreference:123456,
         win:"CH0000041446",
         productcode: "DLF150",
         format:"xml",       
         additionalinfo:"Any information accompanying the order"
      }
   ]
}

Result

JSON

{
    ordernumber: 5966220642,
    orderitem: [
        {
            company: "Ascom (Schweiz) AG",
            reference: 123456,
            name: "Credit Report online",
            language: "DE",
            format: "XML",
            statuscode: 3,
            status: "processing",
            productcode: "DLF150",
            itemnumber: "1409B0113",
            comment: ""
        },
        {
            company: "Ascom (Schweiz) AG",
            reference: 123456,
            name: "Financial Report online",
            language: "DE",
            format: "PDF",
            statuscode: 3,
            status: "processing",
            productcode: "DLF150",
            itemnumber: "1409B0114",
            comment: ""
        }
    ],
    date: "2014-09-08T13:13:43Z",
    charge: "CHF 77.75"
}

Example JSON-request for company request without win-number
Use case: The company is not found in the Worldbox index and has therefore not yet a win-number. A "Company Request" has to be sent before in order to get a "companyrequestid".

JSON

{
   "orderitems":[
      {
         "language":"EN",
         "name": "Credit/Investigation report express (offline)",
         "customerreference":"API test order company request",
         "companyrequestid": "ff80808151ff6f4c015245fc84f400cf",
         "productcode": "REO125",
         "format":"PDF",
         "additionalinfo":"orderitem additional info customer text"
      }
   ]
}

📘

Update for existing API consumers

We streamlined the parameters used to commit an order. The order parameters 'country code, type and price are now all deprecated.

To make it easier to identify we use now product codes instead of the product id as identifier for example: Credit Report online has "productcode": "DLF150".

Please note that all changed API endpoints above maintain backward compatibility. But for new integrations we suggest to use the updated version.

🚧

Please note:

The "try it out" demo below to commit an order is disabled!