Create Order (new order form)

Owned by lpercetti_wordbee (Deactivated)
Last updated: Nov 27, 2020 by Stephan Böhmig
1 min read

Use this method to create new orders using the new order form settings.

This is only for the new order form. The standard order form uses a different method.


URL

(POST) orders/newform?token={token}&data={data}

The files linked to the order should be sent within a single ZIP file as the body of the HTTP request. All the filenames insides the ZIP should be declared in the files parameter.

The ZIP must be attached as a binary payload. In Postman you woud use this option:

 


PARAMETERS

token

The token obtained on connection

Required

data

A json object containing a list of custom field ids and values. See below for details.

Parameters:

  • client (Object)
    • companyId (int)
    • personId (int, optional)
  • option (int)
  • deadline (DateTime)
  • reference (string)
  • manager (int)
  • sourceLanguage (string)
  • targetLanguages (Array[string])
  • domains (Array[int])
  • appointmentStartDate (DateTime, optional)
  • appointmentEndDate (DateTime, optional)
  • isAppointment (bool, optional)
  • isDeadlineByFiles (bool)
  • files (Array[Object])
    • name (string)
    • deadline (DateTime)
  • customFields (Array, optional)
    • key (string)
    • text (string)


Example:

{
	"reference": "order-name",
	"client": {
		"companyId": 5404018
	},
	"sourceLanguage": "en",
	"targetLanguages": ["pl-PL", "es-ES"],
	"deadline": null,
	"isDeadlineByFiles": true,
	"personId": 04645,
	"files": [
		{ "name": "xxxxxxxxx.html", "deadline": "2018-08-02T00:00:01.0000000Z" },
		{ "name": "xxxxxxxxxx.xml", "deadline": "2018-08-01T00:00:01.0000000Z" }
	],
	"customFields": [
		{ "key": "CustomStr1", "text": "My value" },
		{ "key": "CustomStr2", "text": "Another value" },
	]
}
Required


RESULTS

The method executes asynchronously. It returns the id of the asynchronous operation or 0 if the operation has completed immediately:

<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">2147483647</int>

Copyright Wordbee - Buzzin' Outside the Box since 2008