Breadcrumbs

orders/create (post) - DEPRECATED


This documentation is deprecated and replaced by orders/create (POST)


DEPRECATED


To create new orders using the new order form settings, this is only for the new order form.

  • The request should be of type form-data.

  • data parameter is where you put the json object and its mandatory.

  • zipFile parameter is mandatory and should be only one file .zip contains all the files included in the json object.

  • Datetime is in UTC


URL

(POST) orders/create


REQUEST BODY:

These parameters are included as form-data key value pairs in request body:

data


Description


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, zero based index of the option number)

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

  • parserProfileId(int, optional)

  • files (Array[Object])

    • name (string)

    • deadline (DateTime)

  • customFields (Array, optional)

    • key (string)

    • text (string)

  • instructions (string, optional)


zipFile

combines all the files declared in the files property in the data object
To add reference material, create a folder named ___ref___ to your zip file and place your reference files. Optionally, add "___ref___\\" before the file name.

Required

Body payload example:

JavaScript
{
	"reference": "order-name",
	"client": {
		"companyId": 5404018
	},
	"option": 0,
	"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": "___ref___\\xxxxxxxxxx.xml", "deadline": "2018-08-01T00:00:01.0000000Z" }
	],
	"customFields": [
		{ "key": "CustomStr1", "text": "My value" },
		{ "key": "CustomStr2", "text": "Another value" },
	]
}


SUCCESS RESULTS

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

2147483647