My Acclaro (Preview)

Reference

My Acclaro allows you to seamlessly connect to the Acclaro client portal to submit your translation projects directly.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)

Contact
Name	My Acclaro Support
URL	https://www.acclaro.com/support/
Email	[email protected]

Connector Metadata
Publisher	Acclaro Inc.
Website	https://www.acclaro.com/
Privacy Policy	https://www.acclaro.com/privacy-policy/
Categories	Collaboration;Content and Files

The Acclaro Web Service API is an extensible set of RESTful interfaces that allow customers and partners to automatically manage translation activities with Acclaro, such as file transfers, order creation, quality ratings and status reporting. With the API in use, source content that resides in commercial or custom developed content management systems can be programmatically sent for translation, then subsequently received and published. Any questions or feedback regarding the Acclaro API can be directed to [email protected].

Prerequisites

You need to be provided with a username and password for My Acclaro. To request the credentials, please contact [email protected] or go here.

Once you have been set up, log into the Portal and get your API key (a bearer token).

How to get credentials

Generate Tokens

The Acclaro API uses JSON (javascript object notation) Web Tokens for authentication. To generate valid API tokens, Acclaro customers can follow the steps below:

Directly contact your Acclaro sales or business development representative with your request for an API token OR send an email request to [email protected]

Once your request is approved, you will be provided login credentials to the ‘My Acclaro’ customer portal, where you can access the ‘Generate Web Token’ feature from your account Settings page. If you wish to develop and test your API integration with the My Acclaro (Sandbox) API, your sandbox web token can be used with the sandbox endpoint URL, but is not interchangeable with production endpoints.

After generating a web token, you will be presented a string of approximately 100 characters, which can be highlighted and copied to a local clipboard.

Presenting Tokens with Requests

Each API request must present a valid token. This is placed in the "Authorization" HTTP header with the "Bearer" schema.

Token Revocation

If concern ever arises that a token has been compromised, either through digital theft or through accidental public exposure, tokens may be revoked and uniquely re-generated in the Settings page of the ‘My Acclaro’ customer portal.

Token Implementation Details

The token is an RFC 7519 compliant JSON Web Token containing:

alg: HS256
typ: JWT

Payload

sub: acclaro-username
iat: timestamp

Signature - HMACSHA256 signature of first two sections

The issue timestamp is used in the revocation list and ensures that every token is unique. The only encryption method supported is HS256. Any attempts to use other encryption methods, such as NONE, will fail.

Get started with your connector

Service URL Endpoints

The Acclaro API is a RESTful interface, residing at:

Production: https://my.acclaro.com/api/v2
Sandbox: https://apisandbox.acclaro.com/api/v2

Arguments to API functions are passed as standard web parameters, which may be URL-encoded if the function is accessed with a GET, for example: https://api.acclaro.com/api/v2/orders?status=new

Arguments may also be encoded into a POST body when using multipart/form-data, usually when a file to be translated is being sent.

Return values are JSON encoded in the HTTP response. Every returned record will contain a field success which will be set to true if the call is successful, or false if it fails. On failure, there will be two additional fields in the record: errorCode is an integer with values as shown later in this document and errorMessage is a text string explaining the failure. On success, many calls have a field data which points to returned data.

Note that the two calls /orders/{orderid}/quote-document and /orders/{orderid}/files/{fileid} return the file data in the response rather than JSON data. You can differentiate between an error response of JSON data or a successful response of file data by checking the mime type or if the data starts with "success":.

Interactive Test Console

In the My Acclaro portal there is an interactive test console which can be accessed here.

This console enables developers to try out the API functionality and see the output of its calls. It is useful for quick tests of API sample workflows that include creating orders, attaching files and submitting for translation.

Order and File Status Summaries

Orders can have the following statuses:

new – order is being created by API user
getting quote – quote is being generated by Acclaro
needs approval – quote is available for client review
in preparation – order has been submitted to Acclaro and work has been started
in progress – order has been received by Acclaro
in review – initial translations have been delivered by Acclaro and are awaiting client feedback before final translations are delivered or client feedback has been provided and Acclaro is preparing final translations for delivery
complete – all final translated files in an order are ready for API user pickup
canceled – order and all its files have been canceled by Acclaro on request of API user

Source Files can have the following statuses:

new – file has been attached to an order that has not yet been submitted
getting quote – quote is being generated by Acclaro
in progress – file has been received by Acclaro as part of an order
preview – an in-progress version of the translated file is ready for API user pickup; editors and proofreaders can review and shared feedback for additional file translation improvements
complete – translated file is ready for API user pickup
canceled – file has been canceled by Acclaro on request of API user

Target Files can have the following status:

complete – translated file is ready for API user pickup

Callbacks

An API user may request to receive callbacks when their data changes. Use the call POST /orders/{orderid}/files/{fileid}/callback to be notified when a file changes, or POST /orders/{orderid}/callback to be notified when an order changes. Changes that may trigger a callback include editing an order's attributes, submitting an order, adding a comment to an order, a status change to an order, a finished version of a file appearing, adding a comment to a file, or a file's status changing.

Each of these API calls includes a URL as an argument. Acclaro will perform an HTTP GET operation on the supplied URL when the specified object changes. If your application needs to be passed a particular ID number to properly interpret this callback, please include it in your URL, i.e. https://www.company.com/admin/plugins/acclaro/filecallback.php?oid=12345.

Acclaro batches the dispatch of callbacks, so there may be a delay of several minutes between the object changing and customer notification. For security reasons, we suggest that on receiving a callback, your application should check its database to see that a valid object has been referenced, and then retrieve the current state of that object from Acclaro with GET /orders/{orderid}/files-info or GET order/{orderid}. In this way, invalid or extra callbacks will not cause problems.

Your script which receives the callback should return a successful HTTP response code in the 200 series. If any other response code is returned, we will assume that you failed to process the callback, and repeat it again a few minutes later. If you continue to return unsuccessful responses, we will retry several times before giving up. If you no longer wish to receive callbacks, you may use DELETE /orders/{orderid}/files/{fileid}/callback or DELETE /orders/{orderid}/callback.

The Callback functionality of the Acclaro API enables integration partners to build end to end automated translation workflows that identify and fetch completed translations as soon as they are available. With the power of callbacks, there are also some risks and coding best practices that should be followed to ensure optimal efficiencies for both the sending and receiving systems. For example, any attempts to change orders or files in response to callbacks indicating changes have occurred could create runaway loops. If you have any questions about callbacks or would like any peer review assistance for your integration code, please send your questions and relevant code snippets to [email protected] or contact your Acclaro customer representative.

Email Notifications

Similar to callbacks, the API also supports email notifications in a similar fashion with the following calls: POST /orders/{orderid}/files/{fileid}/email, POST /orders/{orderid}/callback, DELETE /orders/{orderid}/files/{fileid}/email and DELETE /orders/{orderid}/email. The same actions that would trigger a web callback will also trigger these emails to be sent.

The email notification messages are intended to be read by a person rather than a program, but do follow a consistent formatting style and contain links to the My Acclaro web portal. These emails are targeted at developers, but can be shared with non-developer colleagues if they would be interested in receiving notifications when relevant order and file statuses change. For more customer-friendly emails, see the delivery options in the My Acclaro portal or use a web callback to invoke a script to send your friendly email.

Due Dates

The due date in the Acclaro API is specified in ISO8601 format. For example, using "2016-09-22" will choose the current time of day on September 22. Using "2016-09-22T11:22" will choose 11:22am on that date, in the default time zone for the portal user account whose web token is being used for authentication. To specify with full time zone consideration, a format such as "2016-09-22T11:22:00-06:00" could be used, which would indicate 6 hours before GMT (United States Central Time).

Data Synchronization

The Acclaro translation management platform synchronizes its data with the Acclaro API on a frequent basis throughout each day. When leveraging the API’s functions in your application, it may be useful to consider time buffers for ensuring the data reporting accuracy. For example, it may take 15 minutes or more before the status of a newly submitted order displays ‘in progress’. If after an hour the API is reporting status that does not meet expectations, please contact [email protected] to report the issue.

Error Codes

When an API function does not complete normally, the returned record will have success = 0, and errorCode will be set to one of the values below. In addition, errorMessage will have a text string which might be more specific about the problem encountered.

Missing Authorization - we did not find a web token in the request.
Bad Authorization - a web token was provided, but did not pass cryptographic checks or refers to an account without proper permissions.
Incorrect Arguments - you failed to supply a required argument to the API call, or passed additional unexpected arguments.
Database Failure - a database failure occurred while processing the API call. Although the system has probably already alerted Acclaro’s system administrators, if you are seeing this error repeatedly, please let us know.
Permission Denied - you have attempted to perform an action on an object which you do not have access to.
File Exists - you have attempted to send a file with a name that conflicts with another file in the order.
Plunet Communication Failure - the API layer failed to communicate with Acclaro’s internal management system. Although the system has probably already alerted Acclaro’s system administrators, if you are seeing this error repeatedly, please let us know.
No Such Order - you have attempted to perform a call on an order that does not exist.
Cannot Delete - you have attempted to delete an order or file after work has started. Contact your Acclaro project manager to request a cancellation of work in progress.
Cannot Update - you have attempted to change an order or file after work has started. Contact your Acclaro project manager to request a cancellation of work in progress.
Bad Language - you have specified a source or target language that is not supported by Acclaro.
No Such File - you have attempted to perform a call on a file that does not exist.
Bad Date - we could not parse the provided date/time.
No Such Callback - we couldn't find the specified callback.
Bad Delivery - an unsupported delivery value was given
No Simulation - the simulation API calls are not enabled
Too Large - the submitted file is too large to be processed.

Known issues and limitations

The maximum amount of results per page is 50, it is recommended to paginate those queries that are expected to return more than 50 results.
The maximum amount of requests per minute allowed for each IP is 180; please contact support if this causes a limitation for you.

Common errors and remedies

Creating an Order and not submititng it:

When an Order is created, the Order remains open in case the user wants to add more items or needs more time to complete the Order. Once the Order is complete, the user has to "submit" the Order for translation.

It is common to miss this step when the API is ran manually through commands or manual steps.

By default, Acclaro will not take action on any Order that has not been submitted. In case you cannot submit the Order through the API or the UI for any reason, please contact your assigned Program Manager, or the support team at: [email protected]

Date format

The API works with ISO8601 date format, e.g. "2022-01-21T16:24:00-05:00", but dates, are output as strings in the JSON response. To convert the format from string to date, you may use this formula formatDateTime({anyMyAcclaroDateField},'g'). Fields that contain dates are created, modified, due_date, requested_due_date.

If you want to set a due date from any other tool, e.g. MS Forms, you will need to format it into ISO8601 using the same formula shown above.

FAQ

Does Acclaro provide a staging environment to test the API?

Acclaro provides a sandbox API environment which you can make API requests to. To access this environment you can change the endpoint to 'apisandbox.acclaro.com' and obtain a Bearer token for this environment accordingly. If you would like to change back to the production endpoint you will need to change to 'my.acclaro.com'.

Does Acclaro charge any fees for using the My Acclaro Portal?

No, Acclaro charges for the services requested through the portal My Acclaro, but the use of the portal and its API is free for all Acclaro customers.

Creating a connection

The connector supports the following authentication types:


Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
API Key	securestring	The API Key for this api	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Add a callback for file updates	Request that Acclaro invoke the supplied URL when the file changes in any way.
Add a callback for order string updates	Request that Acclaro invoke the supplied URL when the order string changes in any way. The callback will include a string_id query parameter, which can be used to fetch string details.
Add a callback for order updates	Request that Acclaro invoke the supplied URL when the order changes in any way. If your code is only concerned with certain changes, such as the status going to “complete”, you must retrieve the order information and check for that.
Add a comment for a file	Adds a comment to file. New comments are appended.
Add a comment to order	Adds a comment to an order. New comments are appended. If an order ever needs to be cancelled after it's been submitted, ‘CANCEL ORDER’ can be submitted as a comment.
Add a language to order	Adds an additional target language to an order without adding any new source files. The new target language will be applied to each source file previously submitted. There is no API call to delete an order language. If language deletion is needed, please contact your project manager who can perform this function with administrative access.
Add a review URL for a file	Adds a URL to a file so it may be referenced for in context review on the web. This assumes the URL is publically available or the translator has private access credentials to view the content. For source files this URL may assist translators in understanding the initial context and layout restrictions of the content. For target files, this URL may assist translators, editors and testers with verification workflows to ensure translated content appears as expected on the destination web pages.
Add a tag to order	Adds a tag or multiple tags to an order. Unique tags added to orders should be separated by commas. Tags can be used for grouping selections of orders.
Add source and target language to the order	For orders with 0 source files at time of submission, this call can be used to tell the system which languages are required for this order. Can only be used on new orders that have not been submitted or have not received quotes. Requests of already known languages will be ignored.
Add strings	Add strings to a string order type.
Approve a quote	This may only be performed on an order with status “needs approval“. Immediately updates the order status to “in preparation“ and instructs the project manager to get started on the order. Customer agrees to pay for the work performed. The order status will change to “in progress“ once work commences. Any additional comments for the order may be added with the quote approval.
Create an order	Creates an order for the current user with the given name. * The status of the order will be “new”.
Decline a quote	This may only be performed on an order with status “needs approva“. Decline the quote on this order. The order status will move back to “getting quote“. The project manager will see the comments, and either issue a revised quote or cancel the order. It is also recommended the client contact their project manager to discuss next steps.
Delete a callback added to order	Request that Acclaro no longer invoke the supplied URL when the order changes in any way.
Delete a callback added to the file	Request that Acclaro no longer invokes the supplied URL when the file changes in any way.
Delete a callback added to the file	Request that Acclaro no longer email the supplied address when the file changes in any way.
Delete a file from the order	Deletes the given file from the order, prior to an order being submitted. If a source file ever needs to be cancelled after it’s been submitted as part of an order, ‘CANCEL FILE’ can be submitted as a comment in /orders/{orderid}/files/{fileid}/comment. We also request that you separately contact your Acclaro project manager with the source file cancelation request.
Delete a tag from order	Deletes tags associated with orders. Tags can only be deleted one at a time.
Delete an order	Deletes an order for the current user with the given ID, if the order is status ‘new’ and the current user has proper account privileges.
Edit a comment on the order	Update a comment on the order.
Edit an order	Updates an order, returns the new record. After an order has been create and is of status ‘new’, function can be used to modify name and delivery attributes only. Arguments are the same as described in create order(/orders). Although duedate, delivery, estwordcount, and type are optional, care should be taken to submit the previous values of these if you do not wish to change them, otherwise they will be reset to default values.
Get a file	Returns the contents of a previously sent file. This is one of the few operations that does not return JSON data, instead directly returning the file contents. If an error occurs while processing the request, then the response will be JSON data, so the type of the response should always be checked.
Get a quote document	This is expected to be performed on an order with status “needs approval“, but will succeed on an order which has been through the quote process. Returns the quote, as a PDF, Word file, or RTF file. The Content-type header of the response will indicate the file type. This is one of the few operations that does not return JSON data, instead directly returning the file contents. If an error occurs while processing the request, then the response will be JSON data, so the type of the response should always be checked.
Get account information	Returns profile information about the API user account in use.
Get all orders	Returns all orders assigned to the current user, as an array of Order records. Note that older completed orders may be archived and removed from the active system . Can be filtered using status.
Get all supported order types	Returns all order types available for the account as an array of Order Types, each order type consisting of a name and a flag “default” which will be zero or one, indicating which order type will be set when none is specified.
Get an order	Returns order information based on the given id.
Get an order's comments	Returns information comments.
Get an order's file information	Returns information about all files in the order.
Get file information	Retrieves information about the given file.
Get language pairs	Returns a list of source/target pairs that may be used for translations.
Get order string by id	Get string for an order along with status and translated values if completed or preview ready.
Get order strings	Get all strings for an order along with their status and translated values if completed.
Get quote details	This is expected to be performed on an order with status “needs approval“, but will succeed on an order which has been through the quote process. Returns the quote value and line item details.
Get supported languages	Returns a list of supported languages.
Get system information	Returns a variety of helpful system information including version of API source code in use, service endpoint and last date of database synchronization.
Rate a file	Submits rating information about files. Rating scale is 1-5 with 1 being poor quality and 5 being perfect quality. Review text strings are optional and can be included to explain the reasoning for the rating such as identified errors or areas of translation improvement classifications.
Rate an order	Submits rating information about completed orders. Rating scale is 1-5 with 1 being poor quality and 5 being excellent quality.
Remove a comment from order	Removes a comment from the order.
Request a quote	This may only be performed on an order with status “new“. Immediately updates the order status to “getting quote” and returns the updated record. The assigned project manager will be sent the quote request. When a quote is generated, the order status will change to “needs approval“. At that time, the record returned from get order(/orders/{orderid} will include a “quoteprice“ and both /orders/{orderid}/quote-document and /orders/{orderid}/quote-details may be used.
Request an email on file changes	Request that Acclaro send an email message to the provided address when the file changes in any way. For customer-friendly email messages, see the delivery options in the My Acclaro portal. This email is a simple message geared towards developers.
Request an email on order changes	Request that Acclaro send an email message to the provided address when the order changes in any way. For customer-friendly email messages, see the delivery options in the My Acclaro portal. This email is a simple message geared towards developers.
Send a reference file	Adds a reference file to an order. Reference files are glossaries, style guides, or other supporting materials for the translator. The sourcelang is optional, and if supplied should be one of the language codes obtained from /info/languages. Targetlang is also optional, and if supplied should be one of the language codes obtained from /info/languages. Encoding is optional, and defaults to “UTF-8” if not specified. The filename and mime-type are taken from the file metadata. If a filename is supplied that duplicates the name of another file in this order, the system will make it unique by adding additional characters (i.e. “documentation.docx” may become “documentation2 .docx”). Returned file metadata includes both the originally supplied filename and the possibly-modified name that Acclaro will use. Individual file size is limited to 100MB maximum. In-progress orders may have new additional files added to them as long as the source and target languages match the original order’s files.
Send a source file	Adds a file to an order, taking the filename and mime-type from the file metadata. If no orderid is provided, a new order is automatically created. The sourcelang should be one of the language codes obtained from /info/languages. Targetlangs can be a single language code or several language codes in a comma-separated list. Encoding is optional, and defaults to “UTF-8” if not specified. ClientRef is an optional value meaningful to the API user typically used for Purchase Order numbers but can be used for any relevant information; if supplied when the file is loaded, it will be returned in all future calls about this file. If a filename is supplied that duplicates the name of another file in this order, the system will make it unique by adding additional characters (i.e. “documentation.docx” may become “documentation-2.docx”). Returned file metadata includes both the originally supplied filename and the possibly modified name that Acclaro will use. Individual file size is limited to 100MB maximum . The API is file agnostic, as there are no file type limitations. XLIFF files are a common translation industry standard and are fully supported. In-progress orders may have new additional files added to them as long as the source and target languages match the original order’s files. For continuous programmatic orders, it is recommended that the /orders/{orderid}/files be used to build orders up with source files before submission via the SubmitOrder call, as this is the most efficient path for Acclaro translation services to receive orders with multiple files and then return subsequent translation files. If clients wish to maintain specific folder and file structures for their source files, they can upload zip files which will be returned with translations in desired folder and file structures within target delivery zip files.
Stop an email from receiving order changes	Request that Acclaro no longer email the supplied address when the order changes in any way.
Submits the order for preparation	Immediately updates the order status to “in preparation”, returns the updated record. Order status will soon change to ‘in progress’ once the Acclaro system confirms receipt of all order details and files.

Add a callback for file updates

Operation ID:: AddACallbackForFileUpdates

Request that Acclaro invoke the supplied URL when the file changes in any way.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
fileid	fileid	True	string	the unique identifier assigned to a source or target file, i.e. the file ID.
url	url	True	string	The URL to be added to the callback system.

Returns

Name	Path	Type	Description
success	success	boolean	success
data	data	array of	data

Add a callback for order string updates

Operation ID:: AddACallbackForOrderStringUpdates

Request that Acclaro invoke the supplied URL when the order string changes in any way. The callback will include a string_id query parameter, which can be used to fetch string details.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
url	url	True	string	the callback URL to be used.

Returns

Name	Path	Type	Description
success	success	boolean	success
data	data	array of	data

Add a callback for order updates

Operation ID:: AddACallbackForOrderUpdates

Request that Acclaro invoke the supplied URL when the order changes in any way. If your code is only concerned with certain changes, such as the status going to “complete”, you must retrieve the order information and check for that.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
url	url	True	string	the callback URL.

Returns

Name	Path	Type	Description
success	success	boolean	success
data	data	array of	data

Add a comment for a file

Operation ID:: AddACommentForAFile

Adds a comment to file. New comments are appended.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
fileid	fileid	True	string	the unique identifier assigned to a source or target file, i.e. the file ID.
comment	comment	True	string	input your comment here.

Returns

Name	Path	Type	Description
success	success	boolean	success
fileid	data.fileid	integer	The file ID in My Acclaro
id	data.id	integer	id
orderid	data.orderid	integer	The ID of the Order in My Acclaro
filetype	data.filetype	string	Type of file
originalfilename	data.originalfilename	string	The original filename
original-filename	data.original-filename	string	The original filename
filename	data.filename	string	The filename
plunet-filename	data.plunet-filename	string	The filename in Plunet
encoding	data.encoding	string	Encoding
mimetype	data.mimetype	string	Mimetype
size	data.size	integer	Size
clientref	data.clientref	string	Client Reference
comments	data.comments	string	Comments
reviewurl	data.reviewurl	string	The Review URL
rating	data.rating	integer	Rating
review	data.review	string	Review
status	data.status	string	Status
targetfile	data.targetfile	string	The translated file
previewfile	data.previewfile	string	The translated file ready for preview
uploaded	data.uploaded	string	Date when the item was uploaded
code	data.sourcelang.code	string	ISO 639-1 language code
code3	data.sourcelang.code3	string	ISO 639-2 language code
description	data.sourcelang.description	string	Description
code	data.targetlang.code	string	ISO 639-1 language code
code3	data.targetlang.code3	string	ISO 639-2 language code
description	data.targetlang.description	string	Description
callbacks	data.callbacks	array of	Callback URLs
emails	data.emails	array of	Notification emails

Add a comment to order

Operation ID:: AddACommentToOrder

Adds a comment to an order. New comments are appended. If an order ever needs to be cancelled after it's been submitted, ‘CANCEL ORDER’ can be submitted as a comment.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
comment	comment	True	string	The text for the comment.

Returns

Name	Path	Type	Description
success	success	boolean	success
orderid	data.orderid	integer	The ID of the Order in My Acclaro
plunetid	data.user.plunetid	string	The ID of the item at Plunet
firstname	data.user.firstname	string	First name
lastname	data.user.lastname	string	Last name
company	data.user.company	string	Company
phone	data.user.phone	string	Phone number
email	data.user.email	string	Email address
created	data.user.created	string	Date created
modified	data.user.modified	string	Date modified
usergroup	data.usergroup	integer	User group
plunet-orderid	data.plunet-orderid	string	The ID of the Order at Plunet
plunet-requestid	data.plunet-requestid	string	The ID of the request at Plunet
plunet-quoteid	data.plunet-quoteid	integer	The ID of the Quote at Plunet
plunet-quotenum	data.plunet-quotenum	string	The number of the Quote at Plunet
name	data.name	string	Name
status	data.status	string	Status
process_type	data.process_type	string	Defines if Order will be processed using strings or files
ordertype	data.ordertype	string	Type of Order
referencefilecount	data.referencefilecount	integer	Count of reference files
targetfilecount	data.targetfilecount	integer	Count of translated files
requested_due_date	data.requested_due_date	string	Due date requested by client
duedate	data.duedate	string	Due date
clientref	data.clientref	string	Client Reference
delivery	data.delivery	string	Delivery
rating	data.rating	integer	Rating
review	data.review	string	Review
created	data.created	string	Date created
modified	data.modified	string	Date modified
sourcelang	data.sourcelang	array of	Source language
targetlang	data.targetlang	array of	Target language
ordertypecode	data.ordertypecode	integer	Order type code
emailaddress	data.emailaddress	string	Email address
emailquote	data.emailquote	integer	Email Quote to
emailfile	data.emailfile	integer	Email file to
emaildone	data.emaildone	integer	Email Done to
emailsubmit	data.emailsubmit	integer	Email submit to
emailcomment	data.emailcomment	integer	Email comment to
quoterequired	data.quoterequired	integer	Is Quote required?
autoapprove	data.autoapprove	integer	Auto approve quotes
autoapproveamt	data.autoapproveamt	integer	Auto approve MT quotes
tags	data.tags	array of	Order tags
estimatedwordcount	data.estimatedwordcount	integer	Estimated wordcount
lastdelivery	data.lastdelivery	string	Last delivery date
invoicedate	data.invoicedate	string	Invoice date
invoicedue	data.invoicedue	string	Invoice due date
in_preparation	data.in_preparation	string	“in_preparation” status
in_progress	data.in_progress	string	“in_progress” status
in_review	data.in_review	string	“in_review” status
completed	data.completed	string	“completed” status
canceled	data.canceled	string	“canceled” status
getting_quote	data.getting_quote	string	“getting_quote” status
needs_approval	data.needs_approval	string	“needs_approval” status
comments	data.comments	string	Comments
plunetid	data.account.plunetid	string	The ID of the item at Plunet
company	data.account.company	string	Company
phone	data.account.phone	string	Phone number
email	data.account.email	string	Email address
url	data.account.url	string	URL
created	data.account.created	string	Date created
modified	data.account.modified	string	Date modified
lastactivity	data.account.lastactivity	string	Date for last activity
callbacks	data.callbacks	array of	Callback URLs
emails	data.emails	array of	Notification emails
comment_id	data.comment_id	integer	comment_id
id	order.id	integer	id
user_id	order.user_id	integer	user ID
account_id	order.account_id	integer	Account ID
program_id	order.program_id	string	Program ID
is_scheduled	order.is_scheduled	integer	Is scheduled
scheduler_id	order.scheduler_id	string	Scheduler ID
plunet_user_id	order.plunet_user_id	string	Plunet user ID
plunet_account_id	order.plunet_account_id	string	Plunet account ID
request_id	order.request_id	string	Request ID
quote_required	order.quote_required	integer	Quote required
auto_approve	order.auto_approve	integer	Auto approve
auto_approve_amount	order.auto_approve_amount	integer	Auto approve amount
quoteid	order.quoteid	string	Quote ID
quotenum	order.quotenum	string	Quote number
erp_order_id	order.erp_order_id	string	ERP Order ID
name	order.name	string	Name
status	order.status	string	Status
due_at	order.due_at	string	Due at
requested_due_at	order.requested_due_at	string	Requested due at
rating	order.rating	integer	Rating
review	order.review	string	Review
created	order.created	string	Date created
modified_at	order.modified_at	string	Date modified
po_number	order.po_number	string	PO number
delivery_method	order.delivery_method	string	Delivery method
quoteprice	order.quoteprice	string	Quote price
do_not_sync	order.do_not_sync	integer	Do not Sync
hide	order.hide	integer	Hide
review_done	order.review_done	integer	Review done
has_order_cost_pdf	order.has_order_cost_pdf	integer	Has Order cost PDF
show_order_cost	order.show_order_cost	integer	Show Order cost
estimated_word_count	order.estimated_word_count	integer	Estimated wordcount
total_words	order.total_words	string	Total words
source_file_count	order.source_file_count	integer	Count of source files
target_file_count	order.target_file_count	integer	Count of translated files
origin	order.origin	string	Order Origin
price	order.price	string	Total Price
review_url	order.review_url	string	Review URL
currency	order.currency	string	currency
order_type	order.order_type	integer	Type of Order
process_type	order.process_type	string	Defines if Order will be processed using strings or files
over_due_sent	order.over_due_sent	integer	Over due sent
submitter_user_id	order.submitter_user_id	string	Submitter user ID
quote_file	order.quote_file	string	Quote file
quote_file_size	order.quote_file_size	string	Quote file size
quote_file_date	order.quote_file_date	string	Quote file date
pm_user_id	order.pm_user_id	string	PM user ID
pm_plunet_resource	order.pm_plunet_resource	string	PM Plunet Resource
last_user_comment_at	order.last_user_comment_at	string	Last user comment date
last_pm_comment_at	order.last_pm_comment_at	string	Last PM comment date
last_user_comment_read_at	order.last_user_comment_read_at	string	Last user comment read date
last_pm_comment_read_at	order.last_pm_comment_read_at	string	Last PM comment read date
original_order_id	order.original_order_id	string	Original Order ID
has_comments	order.has_comments	integer	Has comments
properties	order.properties	string	Properties
has_system_comments	order.has_system_comments	integer	Has system comments
plunet_quote_template	order.plunet_quote_template	string	Plunet Quote template
plunet_order_template	order.plunet_order_template	string	Plunet Order template
erp_type	order.erp_type	string	ERP type
erp_last_sync_push	order.erp_last_sync_push	string	ERP last sync push
erp_last_sync_pull	order.erp_last_sync_pull	string	ERP last sync pull
erp_last_sync_pull_completed_at	order.erp_last_sync_pull_completed_at	string	ERP last sync pull completed at
erp_last_pull_status	order.erp_last_pull_status	string	ERP last sync pull status
sync_task	order.sync_task	string	Syncronization task
sync_event_id	order.sync_event_id	string	Syncronization event ID
created_at	order.created_at	string	Date created
updated_at	order.updated_at	string	Date updated
has_dirty_tags	order.has_dirty_tags	integer	Has dirty tags
has_dirty_comments	order.has_dirty_comments	integer	Has dirty comments
status_in_prep_at	order.status_in_prep_at	string	Date for “in_preparation” status transition
status_in_progress_at	order.status_in_progress_at	string	Date for “in_progress” status transition
status_in_review_at	order.status_in_review_at	string	Date for “in_review” status transition
status_completed_at	order.status_completed_at	string	Date for “complete” status transition
status_canceled_at	order.status_canceled_at	string	Date for “canceled” status transition
status_getting_quote_at	order.status_getting_quote_at	string	Date for “getting_quote” status transition
status_needs_approval_at	order.status_needs_approval_at	string	Date for “needs_approval” status transition
order_link	order.order_link	string	Order link
id	order.notification_settings.id	integer	id
order_id	order.notification_settings.order_id	integer	order_id
email_file_done	order.notification_settings.email_file_done	integer	email_file_done
notify_on_order_complete	order.notification_settings.notify_on_order_complete	integer	notify_on_order_complete
notify_on_order_submit	order.notification_settings.notify_on_order_submit	integer	notify_on_order_submit
notify_on_quote_ready	order.notification_settings.notify_on_quote_ready	integer	notify_on_quote_ready
notify_on_new_comment	order.notification_settings.notify_on_new_comment	integer	notify_on_new_comment
order_complete_sent	order.notification_settings.order_complete_sent	integer	order_complete_sent
quote_ready_sent	order.notification_settings.quote_ready_sent	integer	quote_ready_sent
review_notify_status	order.notification_settings.review_notify_status	integer	review_notify_status
completed_notify_status	order.notification_settings.completed_notify_status	integer	completed_notify_status
created_at	order.notification_settings.created_at	string	Date created
updated_at	order.notification_settings.updated_at	string	Date updated
errorCode	errorCode	integer	Error Code

Add a language to order

Operation ID:: AddALanguageToOrder

Adds an additional target language to an order without adding any new source files. The new target language will be applied to each source file previously submitted. There is no API call to delete an order language. If language deletion is needed, please contact your project manager who can perform this function with administrative access.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
targetlang	targetlang	True	string	an additional target language to translate the Order into in ISO format, e.g. "de-de".

Returns

Name	Path	Type	Description
success	success	boolean	success
orderid	data.orderid	integer	The ID of the Order in My Acclaro
plunetid	data.user.plunetid	string	The ID of the item at Plunet
firstname	data.user.firstname	string	First name
lastname	data.user.lastname	string	Last name
company	data.user.company	string	Company
phone	data.user.phone	string	Phone number
email	data.user.email	string	Email address
created	data.user.created	string	Date created
modified	data.user.modified	string	Date modified
usergroup	data.usergroup	integer	User group
plunet-orderid	data.plunet-orderid	string	The ID of the Order at Plunet
plunet-requestid	data.plunet-requestid	string	The ID of the request at Plunet
plunet-quoteid	data.plunet-quoteid	integer	The ID of the Quote at Plunet
plunet-quotenum	data.plunet-quotenum	string	The number of the Quote at Plunet
name	data.name	string	Name
status	data.status	string	Status
process_type	data.process_type	string	Defines if Order will be processed using strings or files
ordertype	data.ordertype	string	Type of Order
referencefilecount	data.referencefilecount	integer	Count of reference files
targetfilecount	data.targetfilecount	integer	Count of translated files
requested_due_date	data.requested_due_date	string	Due date requested by client
duedate	data.duedate	string	Due date
clientref	data.clientref	string	Client Reference
delivery	data.delivery	string	Delivery
rating	data.rating	integer	Rating
review	data.review	string	Review
created	data.created	string	Date created
modified	data.modified	string	Date modified
sourcelang	data.sourcelang	array of string	Source language
targetlang	data.targetlang	array of string	Target language
ordertypecode	data.ordertypecode	integer	Order type code
emailaddress	data.emailaddress	string	Email address
emailquote	data.emailquote	integer	Email Quote to
emailfile	data.emailfile	integer	Email file to
emaildone	data.emaildone	integer	Email Done to
emailsubmit	data.emailsubmit	integer	Email submit to
emailcomment	data.emailcomment	integer	Email comment to
quoterequired	data.quoterequired	integer	Is Quote required?
autoapprove	data.autoapprove	integer	Auto approve quotes
autoapproveamt	data.autoapproveamt	integer	Auto approve MT quotes
tags	data.tags	array of	Order tags
estimatedwordcount	data.estimatedwordcount	integer	Estimated wordcount
lastdelivery	data.lastdelivery	string	Last delivery date
invoicedate	data.invoicedate	string	Invoice date
invoicedue	data.invoicedue	string	Invoice due date
in_preparation	data.in_preparation	string	“in_preparation” status
in_progress	data.in_progress	string	“in_progress” status
in_review	data.in_review	string	“in_review” status
completed	data.completed	string	“completed” status
canceled	data.canceled	string	“canceled” status
getting_quote	data.getting_quote	string	“getting_quote” status
needs_approval	data.needs_approval	string	“needs_approval” status
comments	data.comments	string	Comments
plunetid	data.account.plunetid	string	The ID of the item at Plunet
company	data.account.company	string	Company
phone	data.account.phone	string	Phone number
email	data.account.email	string	Email address
url	data.account.url	string	URL
created	data.account.created	string	Date created
modified	data.account.modified	string	Date modified
lastactivity	data.account.lastactivity	string	Date for last activity
callbacks	data.callbacks	array of	Callback URLs
emails	data.emails	array of	Notification emails

Add a review URL for a file

Operation ID:: AddAReviewUrlForAFile

Adds a URL to a file so it may be referenced for in context review on the web. This assumes the URL is publically available or the translator has private access credentials to view the content. For source files this URL may assist translators in understanding the initial context and layout restrictions of the content. For target files, this URL may assist translators, editors and testers with verification workflows to ensure translated content appears as expected on the destination web pages.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
fileid	fileid	True	string	the unique identifier assigned to a source or target file, i.e. the file ID.
url	url	True	string	the URL that should be used to run the review of the file.

Returns

Name	Path	Type	Description
success	success	boolean	success
fileid	data.fileid	integer	The file ID in My Acclaro
id	data.id	integer	id
orderid	data.orderid	integer	The ID of the Order in My Acclaro
filetype	data.filetype	string	Type of file
originalfilename	data.originalfilename	string	The original filename
original-filename	data.original-filename	string	The original filename
filename	data.filename	string	The filename
plunet-filename	data.plunet-filename	string	The filename in Plunet
encoding	data.encoding	string	Encoding
mimetype	data.mimetype	string	Mimetype
size	data.size	integer	Size
clientref	data.clientref	string	Client Reference
comments	data.comments	string	Comments
reviewurl	data.reviewurl	string	The Review URL
rating	data.rating	integer	Rating
review	data.review	string	Review
status	data.status	string	Status
targetfile	data.targetfile	string	The translated file
previewfile	data.previewfile	string	The translated file ready for preview
uploaded	data.uploaded	string	Date when the item was uploaded
code	data.sourcelang.code	string	ISO 639-1 language code
code3	data.sourcelang.code3	string	ISO 639-2 language code
description	data.sourcelang.description	string	Description
code	data.targetlang.code	string	ISO 639-1 language code
code3	data.targetlang.code3	string	ISO 639-2 language code
description	data.targetlang.description	string	Description
callbacks	data.callbacks	array of	Callback URLs
emails	data.emails	array of	Notification emails

Add a tag to order

Operation ID:: AddATagToOrder

Adds a tag or multiple tags to an order. Unique tags added to orders should be separated by commas. Tags can be used for grouping selections of orders.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
tag	tag	True	string	List of tags separated by comma.

Returns

Name	Path	Type	Description
success	success	boolean	success
orderid	data.orderid	integer	The ID of the Order in My Acclaro
plunetid	data.user.plunetid	string	The ID of the item at Plunet
firstname	data.user.firstname	string	First name
lastname	data.user.lastname	string	Last name
company	data.user.company	string	Company
phone	data.user.phone	string	Phone number
email	data.user.email	string	Email address
created	data.user.created	string	Date created
modified	data.user.modified	string	Date modified
usergroup	data.usergroup	integer	User group
plunet-orderid	data.plunet-orderid	string	The ID of the Order at Plunet
plunet-requestid	data.plunet-requestid	string	The ID of the request at Plunet
plunet-quoteid	data.plunet-quoteid	integer	The ID of the Quote at Plunet
plunet-quotenum	data.plunet-quotenum	string	The number of the Quote at Plunet
name	data.name	string	Name
status	data.status	string	Status
process_type	data.process_type	string	Defines if Order will be processed using strings or files
ordertype	data.ordertype	string	Type of Order
referencefilecount	data.referencefilecount	integer	Count of reference files
targetfilecount	data.targetfilecount	integer	Count of translated files
requested_due_date	data.requested_due_date	string	Due date requested by client
duedate	data.duedate	string	Due date
clientref	data.clientref	string	Client Reference
delivery	data.delivery	string	Delivery
rating	data.rating	integer	Rating
review	data.review	string	Review
created	data.created	string	Date created
modified	data.modified	string	Date modified
sourcelang	data.sourcelang	array of	Source language
targetlang	data.targetlang	array of	Target language
ordertypecode	data.ordertypecode	integer	Order type code
emailaddress	data.emailaddress	string	Email address
emailquote	data.emailquote	integer	Email Quote to
emailfile	data.emailfile	integer	Email file to
emaildone	data.emaildone	integer	Email Done to
emailsubmit	data.emailsubmit	integer	Email submit to
emailcomment	data.emailcomment	integer	Email comment to
quoterequired	data.quoterequired	integer	Is Quote required?
autoapprove	data.autoapprove	integer	Auto approve quotes
autoapproveamt	data.autoapproveamt	integer	Auto approve MT quotes
tags	data.tags	array of string	Order tags
estimatedwordcount	data.estimatedwordcount	integer	Estimated wordcount
lastdelivery	data.lastdelivery	string	Last delivery date
invoicedate	data.invoicedate	string	Invoice date
invoicedue	data.invoicedue	string	Invoice due date
in_preparation	data.in_preparation	string	“in_preparation” status
in_progress	data.in_progress	string	“in_progress” status
in_review	data.in_review	string	“in_review” status
completed	data.completed	string	“completed” status
canceled	data.canceled	string	“canceled” status
getting_quote	data.getting_quote	string	“getting_quote” status
needs_approval	data.needs_approval	string	“needs_approval” status
comments	data.comments	string	Comments
plunetid	data.account.plunetid	string	The ID of the item at Plunet
company	data.account.company	string	Company
phone	data.account.phone	string	Phone number
email	data.account.email	string	Email address
url	data.account.url	string	URL
created	data.account.created	string	Date created
modified	data.account.modified	string	Date modified
lastactivity	data.account.lastactivity	string	Date for last activity
callbacks	data.callbacks	array of	Callback URLs
emails	data.emails	array of	Notification emails
id	order.id	integer	id
user_id	order.user_id	integer	user ID
account_id	order.account_id	integer	Account ID
program_id	order.program_id	string	Program ID
is_scheduled	order.is_scheduled	integer	Is scheduled
scheduler_id	order.scheduler_id	string	Scheduler ID
plunet_user_id	order.plunet_user_id	string	Plunet user ID
plunet_account_id	order.plunet_account_id	string	Plunet account ID
request_id	order.request_id	string	Request ID
quote_required	order.quote_required	integer	Quote required
auto_approve	order.auto_approve	integer	Auto approve
auto_approve_amount	order.auto_approve_amount	integer	Auto approve amount
quoteid	order.quoteid	string	Quote ID
quotenum	order.quotenum	string	Quote number
erp_order_id	order.erp_order_id	string	ERP Order ID
name	order.name	string	Name
status	order.status	string	Status
due_at	order.due_at	string	Due at
requested_due_at	order.requested_due_at	string	Requested due at
rating	order.rating	integer	Rating
review	order.review	string	Review
created	order.created	string	Date created
modified_at	order.modified_at	string	Date modified
po_number	order.po_number	string	PO number
delivery_method	order.delivery_method	string	Delivery method
quoteprice	order.quoteprice	string	Quote price
do_not_sync	order.do_not_sync	integer	Do not Sync
hide	order.hide	integer	Hide
review_done	order.review_done	integer	Review done
has_order_cost_pdf	order.has_order_cost_pdf	integer	Has Order cost PDF
show_order_cost	order.show_order_cost	integer	Show Order cost
estimated_word_count	order.estimated_word_count	integer	Estimated wordcount
total_words	order.total_words	string	Total words
source_file_count	order.source_file_count	integer	Count of source files
target_file_count	order.target_file_count	integer	Count of translated files
origin	order.origin	string	Order Origin
price	order.price	string	Total Price
review_url	order.review_url	string	Review URL
currency	order.currency	string	currency
order_type	order.order_type	integer	Type of Order
process_type	order.process_type	string	Defines if Order will be processed using strings or files
over_due_sent	order.over_due_sent	integer	Over due sent
submitter_user_id	order.submitter_user_id	string	Submitter user ID
quote_file	order.quote_file	string	Quote file
quote_file_size	order.quote_file_size	string	Quote file size
quote_file_date	order.quote_file_date	string	Quote file date
pm_user_id	order.pm_user_id	string	PM user ID
pm_plunet_resource	order.pm_plunet_resource	string	PM Plunet Resource
last_user_comment_at	order.last_user_comment_at	string	Last user comment date
last_pm_comment_at	order.last_pm_comment_at	string	Last PM comment date
last_user_comment_read_at	order.last_user_comment_read_at	string	Last user comment read date
last_pm_comment_read_at	order.last_pm_comment_read_at	string	Last PM comment read date
original_order_id	order.original_order_id	string	Original Order ID
has_comments	order.has_comments	integer	Has comments
properties	order.properties	string	Properties
has_system_comments	order.has_system_comments	integer	Has system comments
plunet_quote_template	order.plunet_quote_template	string	Plunet Quote template
plunet_order_template	order.plunet_order_template	integer	Plunet Order template
erp_type	order.erp_type	string	ERP type
erp_last_sync_push	order.erp_last_sync_push	string	ERP last sync push
erp_last_sync_pull	order.erp_last_sync_pull	string	ERP last sync pull
erp_last_sync_pull_completed_at	order.erp_last_sync_pull_completed_at	string	ERP last sync pull completed at
erp_last_pull_status	order.erp_last_pull_status	string	ERP last sync pull status
sync_task	order.sync_task	string	Syncronization task
sync_event_id	order.sync_event_id	string	Syncronization event ID
created_at	order.created_at	string	Date created
updated_at	order.updated_at	string	Date updated
has_dirty_tags	order.has_dirty_tags	integer	Has dirty tags
has_dirty_comments	order.has_dirty_comments	integer	Has dirty comments
status_in_prep_at	order.status_in_prep_at	string	Date for “in_preparation” status transition
status_in_progress_at	order.status_in_progress_at	string	Date for “in_progress” status transition
status_in_review_at	order.status_in_review_at	string	Date for “in_review” status transition
status_completed_at	order.status_completed_at	string	Date for “complete” status transition
status_canceled_at	order.status_canceled_at	string	Date for “canceled” status transition
status_getting_quote_at	order.status_getting_quote_at	string	Date for “getting_quote” status transition
status_needs_approval_at	order.status_needs_approval_at	string	Date for “needs_approval” status transition
order_link	order.order_link	string	Order link
errorCode	errorCode	integer	Error Code

Add source and target language to the order

Operation ID:: AddSourceAndTargetLanguageToTheOrder

For orders with 0 source files at time of submission, this call can be used to tell the system which languages are required for this order. Can only be used on new orders that have not been submitted or have not received quotes. Requests of already known languages will be ignored.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
sourcelang	sourcelang	True	string	The source language to be added in iso format e.g. "en-us".
targetlang	targetlang	True	string	The target language to be added in iso format, e.g. "de-de".

Returns

Name	Path	Type	Description
success	success	boolean	success
orderid	data.orderid	integer	The ID of the Order in My Acclaro
plunetid	data.user.plunetid	string	The ID of the item at Plunet
firstname	data.user.firstname	string	First name
lastname	data.user.lastname	string	Last name
company	data.user.company	string	Company
phone	data.user.phone	string	Phone number
email	data.user.email	string	Email address
created	data.user.created	string	Date created
modified	data.user.modified	string	Date modified
usergroup	data.usergroup	integer	User group
plunet-orderid	data.plunet-orderid	string	The ID of the Order at Plunet
plunet-requestid	data.plunet-requestid	string	The ID of the request at Plunet
plunet-quoteid	data.plunet-quoteid	integer	The ID of the Quote at Plunet
plunet-quotenum	data.plunet-quotenum	string	The number of the Quote at Plunet
name	data.name	string	Name
status	data.status	string	Status
process_type	data.process_type	string	Defines if Order will be processed using strings or files
ordertype	data.ordertype	string	Type of Order
referencefilecount	data.referencefilecount	integer	Count of reference files
targetfilecount	data.targetfilecount	integer	Count of translated files
requested_due_date	data.requested_due_date	string	Due date requested by client
duedate	data.duedate	string	Due date
clientref	data.clientref	string	Client Reference
delivery	data.delivery	string	Delivery
rating	data.rating	integer	Rating
review	data.review	string	Review
created	data.created	string	Date created
modified	data.modified	string	Date modified
sourcelang	data.sourcelang	array of string	Source language
targetlang	data.targetlang	array of string	Target language
ordertypecode	data.ordertypecode	integer	Order type code
emailaddress	data.emailaddress	string	Email address
emailquote	data.emailquote	integer	Email Quote to
emailfile	data.emailfile	integer	Email file to
emaildone	data.emaildone	integer	Email Done to
emailsubmit	data.emailsubmit	integer	Email submit to
emailcomment	data.emailcomment	integer	Email comment to
quoterequired	data.quoterequired	integer	Is Quote required?
autoapprove	data.autoapprove	integer	Auto approve quotes
autoapproveamt	data.autoapproveamt	integer	Auto approve MT quotes
tags	data.tags	array of	Order tags
estimatedwordcount	data.estimatedwordcount	integer	Estimated wordcount
lastdelivery	data.lastdelivery	string	Last delivery date
invoicedate	data.invoicedate	string	Invoice date
invoicedue	data.invoicedue	string	Invoice due date
in_preparation	data.in_preparation	string	“in_preparation” status
in_progress	data.in_progress	string	“in_progress” status
in_review	data.in_review	string	“in_review” status
completed	data.completed	string	“completed” status
canceled	data.canceled	string	“canceled” status
getting_quote	data.getting_quote	string	“getting_quote” status
needs_approval	data.needs_approval	string	“needs_approval” status
comments	data.comments	string	Comments
plunetid	data.account.plunetid	string	The ID of the item at Plunet
company	data.account.company	string	Company
phone	data.account.phone	string	Phone number
email	data.account.email	string	Email address
url	data.account.url	string	URL
created	data.account.created	string	Date created
modified	data.account.modified	string	Date modified
lastactivity	data.account.lastactivity	string	Date for last activity
callbacks	data.callbacks	array of	Callback URLs
emails	data.emails	array of	Notification emails

Add strings

Operation ID:: AddStrings

Add strings to a string order type.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
value	value		string	value
target_lang	target_lang		array of string	Target language
source_lang	source_lang		string	Source language
key	key		string	Key
callback	callback		string	Callback

Returns

Name	Path	Type	Description
success	success	boolean	success
strings	data.strings	array of object	strings
value	data.strings.value	string	value
target_lang	data.strings.target_lang	array of string	Target language
source_lang	data.strings.source_lang	string	Source language
key	data.strings.key	string	Key
callback	data.strings.callback	string	Callback
meta	data.strings.meta	array of	Metadata
string_id	data.strings.string_id	integer	The String ID
batch_ids	data.batch_ids	array of object	Batch IDs
batch_id	data.batch_ids.batch_id	integer	The Batch ID
target_language	data.batch_ids.target_language	string	Target language

Approve a quote

Operation ID:: ApproveAQuote

This may only be performed on an order with status “needs approval“. Immediately updates the order status to “in preparation“ and instructs the project manager to get started on the order. Customer agrees to pay for the work performed. The order status will change to “in progress“ once work commences. Any additional comments for the order may be added with the quote approval.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
comment	comment		string	Any comment related to the Quote approval.

Returns

Name	Path	Type	Description
success	success	boolean	success
orderid	data.orderid	integer	The ID of the Order in My Acclaro
plunetid	data.user.plunetid	string	The ID of the item at Plunet
firstname	data.user.firstname	string	First name
lastname	data.user.lastname	string	Last name
company	data.user.company	string	Company
phone	data.user.phone	string	Phone number
email	data.user.email	string	Email address
created	data.user.created	string	Date created
modified	data.user.modified	string	Date modified
usergroup	data.usergroup	integer	User group
plunet-orderid	data.plunet-orderid	string	The ID of the Order at Plunet
plunet-requestid	data.plunet-requestid	string	The ID of the request at Plunet
plunet-quoteid	data.plunet-quoteid	integer	The ID of the Quote at Plunet
plunet-quotenum	data.plunet-quotenum	string	The number of the Quote at Plunet
name	data.name	string	Name
status	data.status	string	Status
process_type	data.process_type	string	Defines if Order will be processed using strings or files
ordertype	data.ordertype	string	Type of Order
referencefilecount	data.referencefilecount	integer	Count of reference files
targetfilecount	data.targetfilecount	integer	Count of translated files
requested_due_date	data.requested_due_date	string	Due date requested by client
duedate	data.duedate	string	Due date
clientref	data.clientref	string	Client Reference
delivery	data.delivery	string	Delivery
rating	data.rating	integer	Rating
review	data.review	string	Review
created	data.created	string	Date created
modified	data.modified	string	Date modified
sourcelang	data.sourcelang	array of string	Source language
targetlang	data.targetlang	array of string	Target language
ordertypecode	data.ordertypecode	integer	Order type code
emailaddress	data.emailaddress	string	Email address
emailquote	data.emailquote	integer	Email Quote to
emailfile	data.emailfile	integer	Email file to
emaildone	data.emaildone	integer	Email Done to
emailsubmit	data.emailsubmit	integer	Email submit to
emailcomment	data.emailcomment	integer	Email comment to
quoterequired	data.quoterequired	integer	Is Quote required?
autoapprove	data.autoapprove	integer	Auto approve quotes
autoapproveamt	data.autoapproveamt	integer	Auto approve MT quotes
tags	data.tags	array of	Order tags
estimatedwordcount	data.estimatedwordcount	integer	Estimated wordcount
lastdelivery	data.lastdelivery	string	Last delivery date
invoicedate	data.invoicedate	string	Invoice date
invoicedue	data.invoicedue	string	Invoice due date
in_preparation	data.in_preparation	string	“in_preparation” status
in_progress	data.in_progress	string	“in_progress” status
in_review	data.in_review	string	“in_review” status
completed	data.completed	string	“completed” status
canceled	data.canceled	string	“canceled” status
getting_quote	data.getting_quote	string	“getting_quote” status
needs_approval	data.needs_approval	string	“needs_approval” status
comments	data.comments	string	Comments
plunetid	data.account.plunetid	string	The ID of the item at Plunet
company	data.account.company	string	Company
phone	data.account.phone	string	Phone number
email	data.account.email	string	Email address
url	data.account.url	string	URL
created	data.account.created	string	Date created
modified	data.account.modified	string	Date modified
lastactivity	data.account.lastactivity	string	Date for last activity
callbacks	data.callbacks	array of	Callback URLs
emails	data.emails	array of	Notification emails

Create an order

Operation ID:: CreateAnOrder

Creates an order for the current user with the given name. * The status of the order will be “new”.

Parameters

Name	Key	Required	Type	Description
name	name	True	string	Name of the order.
comment	comment		string	Summary of the order.
duedate	duedate		string	Due date in ISO8601 format, e.g. "2016-09-28T16:24:00-05:00".
delivery	delivery		string	Delivery refers to optional additional upload repositories for completed translations besides the Acclaro API and My Acclaro customer portal. Delivery defaults to a choice of "none", but supports "email", "box", "dropbox", "google", "zendesk" and "hubspot". Additional 3rd party cloud service options may be added at later dates.
estwordcount	estwordcount		string	EstimatedWordCount is an optional value and may be used to assist with making a quote for this order, if the information is available.
clientref	clientref		string	ClientRef is an optional value meaningful to the API user; if supplied when the order is loaded, it will be returned in all future calls about this order.
type	type		string	Type is an optional field and refers to the order type which can be determined from the "/info/order-types" call.
process_type	process_type		string	Defines if the Order will be processed with files or strings.
metadata	metadata		string	This field allows to input JSON objects as metadata.

Returns

Name	Path	Type	Description
success	success	boolean	success
orderid	data.orderid	integer	The ID of the Order in My Acclaro
plunetid	data.user.plunetid	string	The ID of the item at Plunet
firstname	data.user.firstname	string	First name
lastname	data.user.lastname	string	Last name
company	data.user.company	string	Company
phone	data.user.phone	string	Phone number
email	data.user.email	string	Email address
created	data.user.created	string	Date created
modified	data.user.modified	string	Date modified
usergroup	data.usergroup	integer	User group
plunet-orderid	data.plunet-orderid	string	The ID of the Order at Plunet
plunet-requestid	data.plunet-requestid	string	The ID of the request at Plunet
plunet-quoteid	data.plunet-quoteid	integer	The ID of the Quote at Plunet
plunet-quotenum	data.plunet-quotenum	string	The number of the Quote at Plunet
name	data.name	string	Name
status	data.status	string	Status
process_type	data.process_type	string	Defines if Order will be processed using strings or files
ordertype	data.ordertype	string	Type of Order
referencefilecount	data.referencefilecount	integer	Count of reference files
targetfilecount	data.targetfilecount	integer	Count of translated files
requested_due_date	data.requested_due_date	string	Due date requested by client
duedate	data.duedate	string	Due date
clientref	data.clientref	string	Client Reference
delivery	data.delivery	string	Delivery
rating	data.rating	integer	Rating
review	data.review	string	Review
created	data.created	string	Date created
modified	data.modified	string	Date modified
sourcelang	data.sourcelang	array of	Source language
targetlang	data.targetlang	array of	Target language
ordertypecode	data.ordertypecode	integer	Order type code
emailaddress	data.emailaddress	string	Email address
emailquote	data.emailquote	integer	Email Quote to
emailfile	data.emailfile	integer	Email file to
emaildone	data.emaildone	integer	Email Done to
emailsubmit	data.emailsubmit	integer	Email submit to
emailcomment	data.emailcomment	integer	Email comment to
quoterequired	data.quoterequired	integer	Is Quote required?
autoapprove	data.autoapprove	integer	Auto approve quotes
autoapproveamt	data.autoapproveamt	integer	Auto approve MT quotes
tags	data.tags	array of	Order tags
estimatedwordcount	data.estimatedwordcount	integer	Estimated wordcount
lastdelivery	data.lastdelivery	string	Last delivery date
invoicedate	data.invoicedate	string	Invoice date
invoicedue	data.invoicedue	string	Invoice due date
in_preparation	data.in_preparation	string	“in_preparation” status
in_progress	data.in_progress	string	“in_progress” status
in_review	data.in_review	string	“in_review” status
completed	data.completed	string	“completed” status
canceled	data.canceled	string	“canceled” status
getting_quote	data.getting_quote	string	“getting_quote” status
needs_approval	data.needs_approval	string	“needs_approval” status
comments	data.comments	string	Comments
plunetid	data.account.plunetid	string	The ID of the item at Plunet
company	data.account.company	string	Company
phone	data.account.phone	string	Phone number
email	data.account.email	string	Email address
url	data.account.url	string	URL
created	data.account.created	string	Date created
modified	data.account.modified	string	Date modified
lastactivity	data.account.lastactivity	string	Date for last activity
callbacks	data.callbacks	array of	Callback URLs
emails	data.emails	array of	Notification emails
metadata	data.metadata	string	metadata

Decline a quote

Operation ID:: DeclineAQuote

This may only be performed on an order with status “needs approva“. Decline the quote on this order. The order status will move back to “getting quote“. The project manager will see the comments, and either issue a revised quote or cancel the order. It is also recommended the client contact their project manager to discuss next steps.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
comment	comment		string	Any comment related to the Quote declination.

Returns

Name	Path	Type	Description
success	success	boolean	success
orderid	data.orderid	integer	The ID of the Order in My Acclaro
plunetid	data.user.plunetid	string	The ID of the item at Plunet
firstname	data.user.firstname	string	First name
lastname	data.user.lastname	string	Last name
company	data.user.company	string	Company
phone	data.user.phone	string	Phone number
email	data.user.email	string	Email address
created	data.user.created	string	Date created
modified	data.user.modified	string	Date modified
usergroup	data.usergroup	integer	User group
plunet-orderid	data.plunet-orderid	string	The ID of the Order at Plunet
plunet-requestid	data.plunet-requestid	string	The ID of the request at Plunet
plunet-quoteid	data.plunet-quoteid	integer	The ID of the Quote at Plunet
plunet-quotenum	data.plunet-quotenum	string	The number of the Quote at Plunet
name	data.name	string	Name
status	data.status	string	Status
process_type	data.process_type	string	Defines if Order will be processed using strings or files
ordertype	data.ordertype	string	Type of Order
referencefilecount	data.referencefilecount	integer	Count of reference files
targetfilecount	data.targetfilecount	integer	Count of translated files
requested_due_date	data.requested_due_date	string	Due date requested by client
duedate	data.duedate	string	Due date
clientref	data.clientref	string	Client Reference
delivery	data.delivery	string	Delivery
rating	data.rating	integer	Rating
review	data.review	string	Review
created	data.created	string	Date created
modified	data.modified	string	Date modified
sourcelang	data.sourcelang	array of string	Source language
targetlang	data.targetlang	array of string	Target language
ordertypecode	data.ordertypecode	integer	Order type code
emailaddress	data.emailaddress	string	Email address
emailquote	data.emailquote	integer	Email Quote to
emailfile	data.emailfile	integer	Email file to
emaildone	data.emaildone	integer	Email Done to
emailsubmit	data.emailsubmit	integer	Email submit to
emailcomment	data.emailcomment	integer	Email comment to
quoterequired	data.quoterequired	integer	Is Quote required?
autoapprove	data.autoapprove	integer	Auto approve quotes
autoapproveamt	data.autoapproveamt	integer	Auto approve MT quotes
tags	data.tags	array of	Order tags
estimatedwordcount	data.estimatedwordcount	integer	Estimated wordcount
lastdelivery	data.lastdelivery	string	Last delivery date
invoicedate	data.invoicedate	string	Invoice date
invoicedue	data.invoicedue	string	Invoice due date
in_preparation	data.in_preparation	string	“in_preparation” status
in_progress	data.in_progress	string	“in_progress” status
in_review	data.in_review	string	“in_review” status
completed	data.completed	string	“completed” status
canceled	data.canceled	string	“canceled” status
getting_quote	data.getting_quote	string	“getting_quote” status
needs_approval	data.needs_approval	string	“needs_approval” status
comments	data.comments	string	Comments
plunetid	data.account.plunetid	string	The ID of the item at Plunet
company	data.account.company	string	Company
phone	data.account.phone	string	Phone number
email	data.account.email	string	Email address
url	data.account.url	string	URL
created	data.account.created	string	Date created
modified	data.account.modified	string	Date modified
lastactivity	data.account.lastactivity	string	Date for last activity
callbacks	data.callbacks	array of	Callback URLs
emails	data.emails	array of	Notification emails

Delete a callback added to order

Operation ID:: DeleteACallbackAddedToOrder

Request that Acclaro no longer invoke the supplied URL when the order changes in any way.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.

Returns

Name	Path	Type	Description
success	success	boolean	success
data	data	array of	data

Delete a callback added to the file

Operation ID:: DeleteACallbackAddedToTheFile

Request that Acclaro no longer invokes the supplied URL when the file changes in any way.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
fileid	fileid	True	string	the unique identifier assigned to a source or target file, i.e. the file ID.
url	url	True	string	The URL to be removed from the callback system.

Returns

Name	Path	Type	Description
success	success	boolean	success
data	data	array of	data

Delete a callback added to the file

Operation ID:: DeleteACallbackAddedToTheFile7

Request that Acclaro no longer email the supplied address when the file changes in any way.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
fileid	fileid	True	string	the unique identifier assigned to a source or target file, i.e. the file ID.
email	email	True	string	The email to be deleted to the callback system.

Returns

Name	Path	Type	Description
success	success	boolean	success
data	data	array of	data

Delete a file from the order

Operation ID:: DeleteAFileFromTheOrder

Deletes the given file from the order, prior to an order being submitted. If a source file ever needs to be cancelled after it’s been submitted as part of an order, ‘CANCEL FILE’ can be submitted as a comment in /orders/{orderid}/files/{fileid}/comment. We also request that you separately contact your Acclaro project manager with the source file cancelation request.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
fileid	fileid	True	string	the unique identifier assigned to a source or target file, i.e. the file ID.

Returns

Name	Path	Type	Description
success	success	boolean	success
data	data	array of	data

Delete a tag from order

Operation ID:: DeleteATagFromOrder

Deletes tags associated with orders. Tags can only be deleted one at a time.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
tag	tag	True	string	List of tags separated by comma.

Returns

Name	Path	Type	Description
success	success	boolean	success
orderid	data.orderid	integer	The ID of the Order in My Acclaro
plunetid	data.user.plunetid	string	The ID of the item at Plunet
firstname	data.user.firstname	string	First name
lastname	data.user.lastname	string	Last name
company	data.user.company	string	Company
phone	data.user.phone	string	Phone number
email	data.user.email	string	Email address
created	data.user.created	string	Date created
modified	data.user.modified	string	Date modified
usergroup	data.usergroup	integer	User group
plunet-orderid	data.plunet-orderid	string	The ID of the Order at Plunet
plunet-requestid	data.plunet-requestid	string	The ID of the request at Plunet
plunet-quoteid	data.plunet-quoteid	integer	The ID of the Quote at Plunet
plunet-quotenum	data.plunet-quotenum	string	The number of the Quote at Plunet
name	data.name	string	Name
status	data.status	string	Status
process_type	data.process_type	string	Defines if Order will be processed using strings or files
ordertype	data.ordertype	string	Type of Order
referencefilecount	data.referencefilecount	integer	Count of reference files
targetfilecount	data.targetfilecount	integer	Count of translated files
requested_due_date	data.requested_due_date	string	Due date requested by client
duedate	data.duedate	string	Due date
clientref	data.clientref	string	Client Reference
delivery	data.delivery	string	Delivery
rating	data.rating	integer	Rating
review	data.review	string	Review
created	data.created	string	Date created
modified	data.modified	string	Date modified
sourcelang	data.sourcelang	array of	Source language
targetlang	data.targetlang	array of	Target language
ordertypecode	data.ordertypecode	integer	Order type code
emailaddress	data.emailaddress	string	Email address
emailquote	data.emailquote	integer	Email Quote to
emailfile	data.emailfile	integer	Email file to
emaildone	data.emaildone	integer	Email Done to
emailsubmit	data.emailsubmit	integer	Email submit to
emailcomment	data.emailcomment	integer	Email comment to
quoterequired	data.quoterequired	integer	Is Quote required?
autoapprove	data.autoapprove	integer	Auto approve quotes
autoapproveamt	data.autoapproveamt	integer	Auto approve MT quotes
tags	data.tags	array of	Order tags
estimatedwordcount	data.estimatedwordcount	integer	Estimated wordcount
lastdelivery	data.lastdelivery	string	Last delivery date
invoicedate	data.invoicedate	string	Invoice date
invoicedue	data.invoicedue	string	Invoice due date
in_preparation	data.in_preparation	string	“in_preparation” status
in_progress	data.in_progress	string	“in_progress” status
in_review	data.in_review	string	“in_review” status
completed	data.completed	string	“completed” status
canceled	data.canceled	string	“canceled” status
getting_quote	data.getting_quote	string	“getting_quote” status
needs_approval	data.needs_approval	string	“needs_approval” status
comments	data.comments	string	Comments
plunetid	data.account.plunetid	string	The ID of the item at Plunet
company	data.account.company	string	Company
phone	data.account.phone	string	Phone number
email	data.account.email	string	Email address
url	data.account.url	string	URL
created	data.account.created	string	Date created
modified	data.account.modified	string	Date modified
lastactivity	data.account.lastactivity	string	Date for last activity
callbacks	data.callbacks	array of	Callback URLs
emails	data.emails	array of	Notification emails
id	order.id	integer	id
user_id	order.user_id	integer	user ID
account_id	order.account_id	integer	Account ID
program_id	order.program_id	string	Program ID
is_scheduled	order.is_scheduled	integer	Is scheduled
scheduler_id	order.scheduler_id	string	Scheduler ID
plunet_user_id	order.plunet_user_id	string	Plunet user ID
plunet_account_id	order.plunet_account_id	string	Plunet account ID
request_id	order.request_id	string	Request ID
quote_required	order.quote_required	integer	Quote required
auto_approve	order.auto_approve	integer	Auto approve
auto_approve_amount	order.auto_approve_amount	integer	Auto approve amount
quoteid	order.quoteid	string	Quote ID
quotenum	order.quotenum	string	Quote number
erp_order_id	order.erp_order_id	string	ERP Order ID
name	order.name	string	Name
status	order.status	string	Status
due_at	order.due_at	string	Due at
requested_due_at	order.requested_due_at	string	Requested due at
rating	order.rating	integer	Rating
review	order.review	string	Review
created	order.created	string	Date created
modified_at	order.modified_at	string	Date modified
po_number	order.po_number	string	PO number
delivery_method	order.delivery_method	string	Delivery method
quoteprice	order.quoteprice	string	Quote price
do_not_sync	order.do_not_sync	integer	Do not Sync
hide	order.hide	integer	Hide
review_done	order.review_done	integer	Review done
has_order_cost_pdf	order.has_order_cost_pdf	integer	Has Order cost PDF
show_order_cost	order.show_order_cost	integer	Show Order cost
estimated_word_count	order.estimated_word_count	integer	Estimated wordcount
total_words	order.total_words	string	Total words
source_file_count	order.source_file_count	integer	Count of source files
target_file_count	order.target_file_count	integer	Count of translated files
origin	order.origin	string	Order Origin
price	order.price	string	Total Price
review_url	order.review_url	string	Review URL
currency	order.currency	string	currency
order_type	order.order_type	integer	Type of Order
process_type	order.process_type	string	Defines if Order will be processed using strings or files
over_due_sent	order.over_due_sent	integer	Over due sent
submitter_user_id	order.submitter_user_id	string	Submitter user ID
quote_file	order.quote_file	string	Quote file
quote_file_size	order.quote_file_size	string	Quote file size
quote_file_date	order.quote_file_date	string	Quote file date
pm_user_id	order.pm_user_id	string	PM user ID
pm_plunet_resource	order.pm_plunet_resource	string	PM Plunet Resource
last_user_comment_at	order.last_user_comment_at	string	Last user comment date
last_pm_comment_at	order.last_pm_comment_at	string	Last PM comment date
last_user_comment_read_at	order.last_user_comment_read_at	string	Last user comment read date
last_pm_comment_read_at	order.last_pm_comment_read_at	string	Last PM comment read date
original_order_id	order.original_order_id	string	Original Order ID
has_comments	order.has_comments	integer	Has comments
properties	order.properties	string	Properties
has_system_comments	order.has_system_comments	integer	Has system comments
plunet_quote_template	order.plunet_quote_template	string	Plunet Quote template
plunet_order_template	order.plunet_order_template	integer	Plunet Order template
erp_type	order.erp_type	string	ERP type
erp_last_sync_push	order.erp_last_sync_push	string	ERP last sync push
erp_last_sync_pull	order.erp_last_sync_pull	string	ERP last sync pull
erp_last_sync_pull_completed_at	order.erp_last_sync_pull_completed_at	string	ERP last sync pull completed at
erp_last_pull_status	order.erp_last_pull_status	string	ERP last sync pull status
sync_task	order.sync_task	string	Syncronization task
sync_event_id	order.sync_event_id	string	Syncronization event ID
created_at	order.created_at	string	Date created
updated_at	order.updated_at	string	Date updated
has_dirty_tags	order.has_dirty_tags	integer	Has dirty tags
has_dirty_comments	order.has_dirty_comments	integer	Has dirty comments
status_in_prep_at	order.status_in_prep_at	string	Date for “in_preparation” status transition
status_in_progress_at	order.status_in_progress_at	string	Date for “in_progress” status transition
status_in_review_at	order.status_in_review_at	string	Date for “in_review” status transition
status_completed_at	order.status_completed_at	string	Date for “complete” status transition
status_canceled_at	order.status_canceled_at	string	Date for “canceled” status transition
status_getting_quote_at	order.status_getting_quote_at	string	Date for “getting_quote” status transition
status_needs_approval_at	order.status_needs_approval_at	string	Date for “needs_approval” status transition
order_link	order.order_link	string	Order link
errorCode	errorCode	integer	Error Code

Delete an order

Operation ID:: DeleteAnOrder

Deletes an order for the current user with the given ID, if the order is status ‘new’ and the current user has proper account privileges.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.

Returns

response: string

Edit a comment on the order

Operation ID:: EditACommentOnTheOrder

Update a comment on the order.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
commentid	commentid	True	string	The unique identifier assigned to the Comment, i.e. Comment ID.
comment	comment	True	string	the new text that will replace the existing comment.

Returns

Name	Path	Type	Description
success	success	boolean	success
orderid	data.orderid	integer	The ID of the Order in My Acclaro
plunetid	data.user.plunetid	string	The ID of the item at Plunet
firstname	data.user.firstname	string	First name
lastname	data.user.lastname	string	Last name
company	data.user.company	string	Company
phone	data.user.phone	string	Phone number
email	data.user.email	string	Email address
created	data.user.created	string	Date created
modified	data.user.modified	string	Date modified
usergroup	data.usergroup	integer	User group
plunet-orderid	data.plunet-orderid	string	The ID of the Order at Plunet
plunet-requestid	data.plunet-requestid	string	The ID of the request at Plunet
plunet-quoteid	data.plunet-quoteid	integer	The ID of the Quote at Plunet
plunet-quotenum	data.plunet-quotenum	string	The number of the Quote at Plunet
name	data.name	string	Name
status	data.status	string	Status
process_type	data.process_type	string	Defines if Order will be processed using strings or files
ordertype	data.ordertype	string	Type of Order
referencefilecount	data.referencefilecount	integer	Count of reference files
targetfilecount	data.targetfilecount	integer	Count of translated files
requested_due_date	data.requested_due_date	string	Due date requested by client
duedate	data.duedate	string	Due date
clientref	data.clientref	string	Client Reference
delivery	data.delivery	string	Delivery
rating	data.rating	integer	Rating
review	data.review	string	Review
created	data.created	string	Date created
modified	data.modified	string	Date modified
sourcelang	data.sourcelang	array of	Source language
targetlang	data.targetlang	array of	Target language
ordertypecode	data.ordertypecode	integer	Order type code
emailaddress	data.emailaddress	string	Email address
emailquote	data.emailquote	integer	Email Quote to
emailfile	data.emailfile	integer	Email file to
emaildone	data.emaildone	integer	Email Done to
emailsubmit	data.emailsubmit	integer	Email submit to
emailcomment	data.emailcomment	integer	Email comment to
quoterequired	data.quoterequired	integer	Is Quote required?
autoapprove	data.autoapprove	integer	Auto approve quotes
autoapproveamt	data.autoapproveamt	integer	Auto approve MT quotes
tags	data.tags	array of	Order tags
estimatedwordcount	data.estimatedwordcount	integer	Estimated wordcount
lastdelivery	data.lastdelivery	string	Last delivery date
invoicedate	data.invoicedate	string	Invoice date
invoicedue	data.invoicedue	string	Invoice due date
in_preparation	data.in_preparation	string	“in_preparation” status
in_progress	data.in_progress	string	“in_progress” status
in_review	data.in_review	string	“in_review” status
completed	data.completed	string	“completed” status
canceled	data.canceled	string	“canceled” status
getting_quote	data.getting_quote	string	“getting_quote” status
needs_approval	data.needs_approval	string	“needs_approval” status
comments	data.comments	string	Comments
plunetid	data.account.plunetid	string	The ID of the item at Plunet
company	data.account.company	string	Company
phone	data.account.phone	string	Phone number
email	data.account.email	string	Email address
url	data.account.url	string	URL
created	data.account.created	string	Date created
modified	data.account.modified	string	Date modified
lastactivity	data.account.lastactivity	string	Date for last activity
callbacks	data.callbacks	array of	Callback URLs
emails	data.emails	array of	Notification emails
id	order.id	integer	id
user_id	order.user_id	integer	user ID
account_id	order.account_id	integer	Account ID
program_id	order.program_id	string	Program ID
is_scheduled	order.is_scheduled	integer	Is scheduled
scheduler_id	order.scheduler_id	string	Scheduler ID
plunet_user_id	order.plunet_user_id	string	Plunet user ID
plunet_account_id	order.plunet_account_id	string	Plunet account ID
request_id	order.request_id	string	Request ID
quote_required	order.quote_required	integer	Quote required
auto_approve	order.auto_approve	integer	Auto approve
auto_approve_amount	order.auto_approve_amount	integer	Auto approve amount
quoteid	order.quoteid	string	Quote ID
quotenum	order.quotenum	string	Quote number
erp_order_id	order.erp_order_id	string	ERP Order ID
name	order.name	string	Name
status	order.status	string	Status
due_at	order.due_at	string	Due at
requested_due_at	order.requested_due_at	string	Requested due at
rating	order.rating	integer	Rating
review	order.review	string	Review
created	order.created	string	Date created
modified_at	order.modified_at	string	Date modified
po_number	order.po_number	string	PO number
delivery_method	order.delivery_method	string	Delivery method
quoteprice	order.quoteprice	string	Quote price
do_not_sync	order.do_not_sync	integer	Do not Sync
hide	order.hide	integer	Hide
review_done	order.review_done	integer	Review done
has_order_cost_pdf	order.has_order_cost_pdf	integer	Has Order cost PDF
show_order_cost	order.show_order_cost	integer	Show Order cost
estimated_word_count	order.estimated_word_count	integer	Estimated wordcount
total_words	order.total_words	string	Total words
source_file_count	order.source_file_count	integer	Count of source files
target_file_count	order.target_file_count	integer	Count of translated files
origin	order.origin	string	Order Origin
price	order.price	string	Total Price
review_url	order.review_url	string	Review URL
currency	order.currency	string	currency
order_type	order.order_type	integer	Type of Order
process_type	order.process_type	string	Defines if Order will be processed using strings or files
over_due_sent	order.over_due_sent	integer	Over due sent
submitter_user_id	order.submitter_user_id	string	Submitter user ID
quote_file	order.quote_file	string	Quote file
quote_file_size	order.quote_file_size	string	Quote file size
quote_file_date	order.quote_file_date	string	Quote file date
pm_user_id	order.pm_user_id	string	PM user ID
pm_plunet_resource	order.pm_plunet_resource	string	PM Plunet Resource
last_user_comment_at	order.last_user_comment_at	string	Last user comment date
last_pm_comment_at	order.last_pm_comment_at	string	Last PM comment date
last_user_comment_read_at	order.last_user_comment_read_at	string	Last user comment read date
last_pm_comment_read_at	order.last_pm_comment_read_at	string	Last PM comment read date
original_order_id	order.original_order_id	string	Original Order ID
has_comments	order.has_comments	integer	Has comments
properties	order.properties	string	Properties
has_system_comments	order.has_system_comments	integer	Has system comments
plunet_quote_template	order.plunet_quote_template	string	Plunet Quote template
plunet_order_template	order.plunet_order_template	string	Plunet Order template
erp_type	order.erp_type	string	ERP type
erp_last_sync_push	order.erp_last_sync_push	string	ERP last sync push
erp_last_sync_pull	order.erp_last_sync_pull	string	ERP last sync pull
erp_last_sync_pull_completed_at	order.erp_last_sync_pull_completed_at	string	ERP last sync pull completed at
erp_last_pull_status	order.erp_last_pull_status	string	ERP last sync pull status
sync_task	order.sync_task	string	Syncronization task
sync_event_id	order.sync_event_id	string	Syncronization event ID
created_at	order.created_at	string	Date created
updated_at	order.updated_at	string	Date updated
has_dirty_tags	order.has_dirty_tags	integer	Has dirty tags
has_dirty_comments	order.has_dirty_comments	integer	Has dirty comments
status_in_prep_at	order.status_in_prep_at	string	Date for “in_preparation” status transition
status_in_progress_at	order.status_in_progress_at	string	Date for “in_progress” status transition
status_in_review_at	order.status_in_review_at	string	Date for “in_review” status transition
status_completed_at	order.status_completed_at	string	Date for “complete” status transition
status_canceled_at	order.status_canceled_at	string	Date for “canceled” status transition
status_getting_quote_at	order.status_getting_quote_at	string	Date for “getting_quote” status transition
status_needs_approval_at	order.status_needs_approval_at	string	Date for “needs_approval” status transition
order_link	order.order_link	string	Order link
id	order.notification_settings.id	integer	id
order_id	order.notification_settings.order_id	integer	order_id
email_file_done	order.notification_settings.email_file_done	integer	email_file_done
notify_on_order_complete	order.notification_settings.notify_on_order_complete	integer	notify_on_order_complete
notify_on_order_submit	order.notification_settings.notify_on_order_submit	integer	notify_on_order_submit
notify_on_quote_ready	order.notification_settings.notify_on_quote_ready	integer	notify_on_quote_ready
notify_on_new_comment	order.notification_settings.notify_on_new_comment	integer	notify_on_new_comment
order_complete_sent	order.notification_settings.order_complete_sent	integer	order_complete_sent
quote_ready_sent	order.notification_settings.quote_ready_sent	integer	quote_ready_sent
review_notify_status	order.notification_settings.review_notify_status	integer	review_notify_status
completed_notify_status	order.notification_settings.completed_notify_status	integer	completed_notify_status
created_at	order.notification_settings.created_at	string	Date created
updated_at	order.notification_settings.updated_at	string	Date updated
errorCode	errorCode	integer	Error Code
order_id	newcommentid.order_id	integer	order_id
user_id	newcommentid.user_id	integer	user ID
account_id	newcommentid.account_id	integer	Account ID
body_html	newcommentid.body_html	string	body_html
body_text	newcommentid.body_text	string	body_text
mentioned_users	newcommentid.mentioned_users	string	mentioned_users
system_event	newcommentid.system_event	integer	system_event
is_notification_reply	newcommentid.is_notification_reply	boolean	is_notification_reply
original_comment_id	newcommentid.original_comment_id	integer	original_comment_id
display_created	newcommentid.display_created	string	display_created
review_task_id	newcommentid.review_task_id	string	review_task_id
updated_at	newcommentid.updated_at	string	Date updated
created_at	newcommentid.created_at	string	Date created
id	newcommentid.id	integer	id
id	newcommentid.user.id	integer	id
plunetid	newcommentid.user.plunetid	string	The ID of the item at Plunet
firstname	newcommentid.user.firstname	string	First name
lastname	newcommentid.user.lastname	string	Last name
company	newcommentid.user.company	string	Company
phone	newcommentid.user.phone	string	Phone number
email	newcommentid.user.email	string	Email address
password	newcommentid.user.password	string	password
remember_token	newcommentid.user.remember_token	string	remember_token
passwdstate	newcommentid.user.passwdstate	string	passwdstate
issiteadmin	newcommentid.user.issiteadmin	integer	issiteadmin
issuperadmin	newcommentid.user.issuperadmin	integer	issuperadmin
iscompanyadmin	newcommentid.user.iscompanyadmin	integer	iscompanyadmin
apienable	newcommentid.user.apienable	integer	apienable
portalenable	newcommentid.user.portalenable	integer	portalenable
connectenable	newcommentid.user.connectenable	integer	connectenable
emailok	newcommentid.user.emailok	integer	emailok
linkshare	newcommentid.user.linkshare	integer	linkshare
resource	newcommentid.user.resource	string	resource
resource_plunet_id	newcommentid.user.resource_plunet_id	string	resource_plunet_id
usergroup	newcommentid.user.usergroup	integer	User group
created	newcommentid.user.created	string	Date created
modified	newcommentid.user.modified	string	Date modified
role	newcommentid.user.role	string	role
is_reviewer	newcommentid.user.is_reviewer	integer	is_reviewer
plunet_status	newcommentid.user.plunet_status	integer	plunet_status
plunet_updated_at	newcommentid.user.plunet_updated_at	string	plunet_updated_at
notes	newcommentid.user.notes	string	notes
last_login_at	newcommentid.user.last_login_at	string	last_login_at
login_attempt_count	newcommentid.user.login_attempt_count	integer	login_attempt_count

Edit an order

Operation ID:: EditAnOrder

Updates an order, returns the new record. After an order has been create and is of status ‘new’, function can be used to modify name and delivery attributes only. Arguments are the same as described in create order(/orders). Although duedate, delivery, estwordcount, and type are optional, care should be taken to submit the previous values of these if you do not wish to change them, otherwise they will be reset to default values.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
name	name	True	string	Name of the order.
comment	comment		string	Summary of the order.
duedate	duedate		string	Due date in ISO8601 format, e.g. "2016-09-28T16:24:00-05:00".
delivery	delivery		string	Delivery refers to optional additional upload repositories for completed translations besides the Acclaro API and My Acclaro customer portal. Delivery defaults to a choice of "none", but supports "email", "box", "dropbox", "google", "zendesk" and "hubspot". Additional 3rd party cloud service options may be added at later dates.
estwordcount	estwordcount		string	The estimated total wordcount for the Order.
type	type		string	May be set to "strings" if the order will contain strings rather than files.
metadata	metadata		string	Additional metadata to add to the Order, takes a JSON object.

Returns

Name	Path	Type	Description
success	success	boolean	success
orderid	data.orderid	integer	The ID of the Order in My Acclaro
plunetid	data.user.plunetid	string	The ID of the item at Plunet
firstname	data.user.firstname	string	First name
lastname	data.user.lastname	string	Last name
company	data.user.company	string	Company
phone	data.user.phone	string	Phone number
email	data.user.email	string	Email address
created	data.user.created	string	Date created
modified	data.user.modified	string	Date modified
usergroup	data.usergroup	integer	User group
plunet-orderid	data.plunet-orderid	string	The ID of the Order at Plunet
plunet-requestid	data.plunet-requestid	string	The ID of the request at Plunet
plunet-quoteid	data.plunet-quoteid	integer	The ID of the Quote at Plunet
plunet-quotenum	data.plunet-quotenum	string	The number of the Quote at Plunet
name	data.name	string	Name
status	data.status	string	Status
process_type	data.process_type	string	Defines if Order will be processed using strings or files
ordertype	data.ordertype	string	Type of Order
referencefilecount	data.referencefilecount	integer	Count of reference files
targetfilecount	data.targetfilecount	integer	Count of translated files
requested_due_date	data.requested_due_date	string	Due date requested by client
duedate	data.duedate	string	Due date
clientref	data.clientref	string	Client Reference
delivery	data.delivery	string	Delivery
rating	data.rating	integer	Rating
review	data.review	string	Review
created	data.created	string	Date created
modified	data.modified	string	Date modified
sourcelang	data.sourcelang	array of	Source language
targetlang	data.targetlang	array of	Target language
ordertypecode	data.ordertypecode	integer	Order type code
emailaddress	data.emailaddress	string	Email address
emailquote	data.emailquote	integer	Email Quote to
emailfile	data.emailfile	integer	Email file to
emaildone	data.emaildone	integer	Email Done to
emailsubmit	data.emailsubmit	integer	Email submit to
emailcomment	data.emailcomment	integer	Email comment to
quoterequired	data.quoterequired	integer	Is Quote required?
autoapprove	data.autoapprove	integer	Auto approve quotes
autoapproveamt	data.autoapproveamt	integer	Auto approve MT quotes
tags	data.tags	array of	Order tags
estimatedwordcount	data.estimatedwordcount	integer	Estimated wordcount
lastdelivery	data.lastdelivery	string	Last delivery date
invoicedate	data.invoicedate	string	Invoice date
invoicedue	data.invoicedue	string	Invoice due date
in_preparation	data.in_preparation	string	“in_preparation” status
in_progress	data.in_progress	string	“in_progress” status
in_review	data.in_review	string	“in_review” status
completed	data.completed	string	“completed” status
canceled	data.canceled	string	“canceled” status
getting_quote	data.getting_quote	string	“getting_quote” status
needs_approval	data.needs_approval	string	“needs_approval” status
comments	data.comments	string	Comments
plunetid	data.account.plunetid	string	The ID of the item at Plunet
company	data.account.company	string	Company
phone	data.account.phone	string	Phone number
email	data.account.email	string	Email address
url	data.account.url	string	URL
created	data.account.created	string	Date created
modified	data.account.modified	string	Date modified
lastactivity	data.account.lastactivity	string	Date for last activity
callbacks	data.callbacks	array of	Callback URLs
emails	data.emails	array of	Notification emails
metadata	data.metadata	string	metadata

Get a file

Operation ID:: GetAFile

Returns the contents of a previously sent file. This is one of the few operations that does not return JSON data, instead directly returning the file contents. If an error occurs while processing the request, then the response will be JSON data, so the type of the response should always be checked.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
fileid	fileid	True	string	the unique identifier assigned to a source or target file, i.e. the file ID.

Returns

response: file

Get a quote document

Operation ID:: GetAQuoteDocument

This is expected to be performed on an order with status “needs approval“, but will succeed on an order which has been through the quote process. Returns the quote, as a PDF, Word file, or RTF file. The Content-type header of the response will indicate the file type. This is one of the few operations that does not return JSON data, instead directly returning the file contents. If an error occurs while processing the request, then the response will be JSON data, so the type of the response should always be checked.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.

Returns

Get account information

Operation ID:: GetAccountInformation

Returns profile information about the API user account in use.

Returns

Name	Path	Type	Description
success	success	boolean	success
plunetid	data.plunetid	string	The ID of the item at Plunet
type	data.type	string	Order type
company	data.company	string	Company
firstname	data.firstname	string	First name
lastname	data.lastname	string	Last name
email	data.email	string	Email address
phone	data.phone	string	Phone number
url	data.url	string	URL
created	data.created	string	Date created
modified	data.modified	string	Date modified
lastactivity	data.lastactivity	string	Date for last activity
team	data.team	array of object	team
title	data.team.title	string	title
firstname	data.team.firstname	string	First name
lastname	data.team.lastname	string	Last name
phone	data.team.phone	string	Phone number
email	data.team.email	string	Email address

Get all orders

Operation ID:: GetAllOrders

Returns all orders assigned to the current user, as an array of Order records. Note that older completed orders may be archived and removed from the active system . Can be filtered using status.

Parameters

Name	Key	Type	Description
status	status	string	Filter the Orders by status.
page	page	string	Defines the page you want to see results from.
perPage	perPage	string	Defines how many records you want to see per page.

Returns

Name	Path	Type	Description
success	success	boolean	success
data	data	array of object	data
orderid	data.orderid	integer	The ID of the Order in My Acclaro
plunetid	data.user.plunetid	string	The ID of the item at Plunet
firstname	data.user.firstname	string	First name
lastname	data.user.lastname	string	Last name
company	data.user.company	string	Company
phone	data.user.phone	string	Phone number
email	data.user.email	string	Email address
created	data.user.created	string	Date created
modified	data.user.modified	string	Date modified
usergroup	data.usergroup	integer	User group
plunet-orderid	data.plunet-orderid	string	The ID of the Order at Plunet
plunet-requestid	data.plunet-requestid	string	The ID of the request at Plunet
plunet-quoteid	data.plunet-quoteid	integer	The ID of the Quote at Plunet
plunet-quotenum	data.plunet-quotenum	string	The number of the Quote at Plunet
name	data.name	string	Name
status	data.status	string	Status
process_type	data.process_type	string	Defines if Order will be processed using strings or files
ordertype	data.ordertype	string	Type of Order
referencefilecount	data.referencefilecount	integer	Count of reference files
targetfilecount	data.targetfilecount	integer	Count of translated files
requested_due_date	data.requested_due_date	string	Due date requested by client
duedate	data.duedate	string	Due date
clientref	data.clientref	string	Client Reference
delivery	data.delivery	string	Delivery
rating	data.rating	integer	Rating
review	data.review	string	Review
created	data.created	string	Date created
modified	data.modified	string	Date modified
sourcelang	data.sourcelang	array of string	Source language
targetlang	data.targetlang	array of string	Target language
ordertypecode	data.ordertypecode	integer	Order type code
emailaddress	data.emailaddress	string	Email address
emailquote	data.emailquote	integer	Email Quote to
emailfile	data.emailfile	integer	Email file to
emaildone	data.emaildone	integer	Email Done to
emailsubmit	data.emailsubmit	integer	Email submit to
emailcomment	data.emailcomment	integer	Email comment to
quoterequired	data.quoterequired	integer	Is Quote required?
autoapprove	data.autoapprove	integer	Auto approve quotes
autoapproveamt	data.autoapproveamt	integer	Auto approve MT quotes
tags	data.tags	array of string	Order tags
estimatedwordcount	data.estimatedwordcount	integer	Estimated wordcount
lastdelivery	data.lastdelivery	string	Last delivery date
invoicedate	data.invoicedate	string	Invoice date
invoicedue	data.invoicedue	string	Invoice due date
in_preparation	data.in_preparation	string	“in_preparation” status
in_progress	data.in_progress	string	“in_progress” status
in_review	data.in_review	string	“in_review” status
completed	data.completed	string	“completed” status
canceled	data.canceled	string	“canceled” status
getting_quote	data.getting_quote	string	“getting_quote” status
needs_approval	data.needs_approval	string	“needs_approval” status
comments	data.comments	string	Comments
plunetid	data.account.plunetid	string	The ID of the item at Plunet
company	data.account.company	string	Company
phone	data.account.phone	string	Phone number
email	data.account.email	string	Email address
url	data.account.url	string	URL
created	data.account.created	string	Date created
modified	data.account.modified	string	Date modified
lastactivity	data.account.lastactivity	string	Date for last activity
callbacks	data.callbacks	array of string	Callback URLs
emails	data.emails	array of	Notification emails
current_page	pagination.current_page	integer	current_page
first_page_url	pagination.first_page_url	string
from	pagination.from	integer	from
last_page	pagination.last_page	integer	last_page
last_page_url	pagination.last_page_url	string
next_page_url	pagination.next_page_url	string
path	pagination.path	string
per_page	pagination.per_page	string
prev_page_url	pagination.prev_page_url	string
to	pagination.to	integer	to
total	pagination.total	integer	Total

Get all supported order types

Operation ID:: GetAllSupportedOrderTypes

Returns all order types available for the account as an array of Order Types, each order type consisting of a name and a flag “default” which will be zero or one, indicating which order type will be set when none is specified.

Returns

Get an order

Operation ID:: GetAnOrder

Returns order information based on the given id.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.

Returns

Name	Path	Type	Description
success	success	boolean	success
orderid	data.orderid	integer	The ID of the Order in My Acclaro
plunetid	data.user.plunetid	string	The ID of the item at Plunet
firstname	data.user.firstname	string	First name
lastname	data.user.lastname	string	Last name
company	data.user.company	string	Company
phone	data.user.phone	string	Phone number
email	data.user.email	string	Email address
created	data.user.created	string	Date created
modified	data.user.modified	string	Date modified
usergroup	data.usergroup	integer	User group
plunet-orderid	data.plunet-orderid	string	The ID of the Order at Plunet
plunet-requestid	data.plunet-requestid	string	The ID of the request at Plunet
plunet-quoteid	data.plunet-quoteid	integer	The ID of the Quote at Plunet
plunet-quotenum	data.plunet-quotenum	string	The number of the Quote at Plunet
name	data.name	string	Name
status	data.status	string	Status
process_type	data.process_type	string	Defines if Order will be processed using strings or files
ordertype	data.ordertype	string	Type of Order
referencefilecount	data.referencefilecount	integer	Count of reference files
targetfilecount	data.targetfilecount	integer	Count of translated files
requested_due_date	data.requested_due_date	string	Due date requested by client
duedate	data.duedate	string	Due date
clientref	data.clientref	string	Client Reference
delivery	data.delivery	string	Delivery
rating	data.rating	integer	Rating
review	data.review	string	Review
created	data.created	string	Date created
modified	data.modified	string	Date modified
sourcelang	data.sourcelang	array of	Source language
targetlang	data.targetlang	array of	Target language
ordertypecode	data.ordertypecode	integer	Order type code
emailaddress	data.emailaddress	string	Email address
emailquote	data.emailquote	integer	Email Quote to
emailfile	data.emailfile	integer	Email file to
emaildone	data.emaildone	integer	Email Done to
emailsubmit	data.emailsubmit	integer	Email submit to
emailcomment	data.emailcomment	integer	Email comment to
quoterequired	data.quoterequired	integer	Is Quote required?
autoapprove	data.autoapprove	integer	Auto approve quotes
autoapproveamt	data.autoapproveamt	integer	Auto approve MT quotes
tags	data.tags	array of	Order tags
estimatedwordcount	data.estimatedwordcount	integer	Estimated wordcount
lastdelivery	data.lastdelivery	string	Last delivery date
invoicedate	data.invoicedate	string	Invoice date
invoicedue	data.invoicedue	string	Invoice due date
in_preparation	data.in_preparation	string	“in_preparation” status
in_progress	data.in_progress	string	“in_progress” status
in_review	data.in_review	string	“in_review” status
completed	data.completed	string	“completed” status
canceled	data.canceled	string	“canceled” status
getting_quote	data.getting_quote	string	“getting_quote” status
needs_approval	data.needs_approval	string	“needs_approval” status
comments	data.comments	string	Comments
plunetid	data.account.plunetid	string	The ID of the item at Plunet
company	data.account.company	string	Company
phone	data.account.phone	string	Phone number
email	data.account.email	string	Email address
url	data.account.url	string	URL
created	data.account.created	string	Date created
modified	data.account.modified	string	Date modified
lastactivity	data.account.lastactivity	string	Date for last activity
callbacks	data.callbacks	array of	Callback URLs
emails	data.emails	array of	Notification emails
metadata	data.metadata	string	metadata
cost_items	data.cost_items	array of	Cost items

Get an order's comments

Operation ID:: GetAnOrdersComments

Returns information comments.

Parameters

Name	Key	Required	Type	Description
format	format	True	string	format can either be "text" or "html".
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
records	records		string	number of comments to be retrieved.
page	page		string	page number to retrieve if paginated.
after	after		string	A textual datetime value e.g 2021-12-09 12:00:00.

Returns

Name	Path	Type	Description
success	success	boolean	success
data	data	array of object	data
id	data.id	integer	id
author	data.author	string	author
comment	data.comment	string	comment
timestamp	data.timestamp	string	timestamp
edited	data.edited	string	edited
system	data.system	boolean	system
order	order	integer	order
total	total	integer	Total

Get an order's file information

Operation ID:: GetAnOrdersFileInformation

Returns information about all files in the order.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.

Returns

Name	Path	Type	Description
success	success	boolean	success
data	data	array of object	data
fileid	data.fileid	integer	The file ID in My Acclaro
id	data.id	integer	id
orderid	data.orderid	integer	The ID of the Order in My Acclaro
filetype	data.filetype	string	Type of file
originalfilename	data.originalfilename	string	The original filename
original-filename	data.original-filename	string	The original filename
filename	data.filename	string	The filename
plunet-filename	data.plunet-filename	string	The filename in Plunet
encoding	data.encoding	string	Encoding
mimetype	data.mimetype	string	Mimetype
size	data.size	integer	Size
clientref	data.clientref	string	Client Reference
comments	data.comments	string	Comments
reviewurl	data.reviewurl	string	The Review URL
rating	data.rating	integer	Rating
review	data.review	string	Review
status	data.status	string	Status
targetfile	data.targetfile	string	The translated file
previewfile	data.previewfile	string	The translated file ready for preview
uploaded	data.uploaded	string	Date when the item was uploaded
code	data.sourcelang.code	string	ISO 639-1 language code
code3	data.sourcelang.code3	string	ISO 639-2 language code
description	data.sourcelang.description	string	Description
code	data.targetlang.code	string	ISO 639-1 language code
code3	data.targetlang.code3	string	ISO 639-2 language code
description	data.targetlang.description	string	Description
callbacks	data.callbacks	array of	Callback URLs
emails	data.emails	array of	Notification emails

Get file information

Operation ID:: GetFileInformation

Retrieves information about the given file.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
fileid	fileid	True	string	the unique identifier assigned to a source or target file, i.e. the file ID.

Returns

Name	Path	Type	Description
success	success	boolean	success
fileid	data.fileid	integer	The file ID in My Acclaro
id	data.id	integer	id
orderid	data.orderid	integer	The ID of the Order in My Acclaro
filetype	data.filetype	string	Type of file
originalfilename	data.originalfilename	string	The original filename
original-filename	data.original-filename	string	The original filename
filename	data.filename	string	The filename
plunet-filename	data.plunet-filename	string	The filename in Plunet
encoding	data.encoding	string	Encoding
mimetype	data.mimetype	string	Mimetype
size	data.size	integer	Size
clientref	data.clientref	string	Client Reference
comments	data.comments	string	Comments
reviewurl	data.reviewurl	string	The Review URL
rating	data.rating	integer	Rating
review	data.review	string	Review
status	data.status	string	Status
targetfile	data.targetfile	string	The translated file
previewfile	data.previewfile	string	The translated file ready for preview
uploaded	data.uploaded	string	Date when the item was uploaded
code	data.sourcelang.code	string	ISO 639-1 language code
code3	data.sourcelang.code3	string	ISO 639-2 language code
description	data.sourcelang.description	string	Description
code	data.targetlang.code	string	ISO 639-1 language code
code3	data.targetlang.code3	string	ISO 639-2 language code
description	data.targetlang.description	string	Description
callbacks	data.callbacks	array of	Callback URLs
emails	data.emails	array of	Notification emails

Get language pairs

Operation ID:: GetLanguagePairs

Returns a list of source/target pairs that may be used for translations.

Parameters

Name	Key	Required	Type	Description
sourcelang	sourcelang		string	to filter for language pairs, input the source language in ISO format, e.g. "en-us".

Returns

Name	Path	Type	Description
success	success	boolean	success
data	data	array of object	data
code	data.source.code	string	ISO 639-1 language code
code3	data.source.code3	string	ISO 639-2 language code
description	data.source.description	string	Description
code	data.target.code	string	ISO 639-1 language code
code3	data.target.code3	string	ISO 639-2 language code
description	data.target.description	string	Description

Get order string by id

Operation ID:: GetOrderStringById

Get string for an order along with status and translated values if completed or preview ready.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
string_id	string_id	True	string	The unique identifier assigned to the String, i.e. String ID.

Returns

Name	Path	Type	Description
success	success	boolean	success
string_id	data.string_id	integer	The String ID
batch_id	data.batch_id	integer	The Batch ID
source_lang	data.source_lang	string	Source language
target_lang	data.target_lang	string	Target language
key	data.key	string	Key
value	data.value	string	value
translated_value	data.translated_value	string	Translated value
callback	data.callback	string	Callback
meta	data.meta	array of	Metadata
status	data.status	string	Status

Get order strings

Operation ID:: GetOrderStrings

Get all strings for an order along with their status and translated values if completed.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
string_ids	string_ids		string	string ids separated by comma.
key	key		string	Gets strings matching a specific key.
perPage	perPage		string	Set the number of string returned per page (default: 100).

Returns

Name	Path	Type	Description
success	success	boolean	success
data	data	array of object	data
string_id	data.string_id	integer	The String ID
batch_id	data.batch_id	integer	The Batch ID
source_lang	data.source_lang	string	Source language
target_lang	data.target_lang	string	Target language
key	data.key	string	Key
value	data.value	string	value
translated_value	data.translated_value	string	Translated value
callback	data.callback	string	Callback
meta	data.meta	array of	Metadata
status	data.status	string	Status
total	total	integer	Total

Get quote details

Operation ID:: GetQuoteDetails

This is expected to be performed on an order with status “needs approval“, but will succeed on an order which has been through the quote process. Returns the quote value and line item details.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.

Returns

Name	Path	Type	Description
success	success	boolean	success
total	data.total	integer	Total
lines	data.lines	array of object	lines
description	data.lines.description	string	Description
quantity	data.lines.quantity	integer	Quantity
unitprice	data.lines.unitprice	integer	Unit price
price	data.lines.price	integer	Total Price

Get supported languages

Operation ID:: GetSupportedLanguages

Returns a list of supported languages.

Returns

Name	Path	Type	Description
success	success	boolean	success
data	data	array of object	data
code	data.code	string	ISO 639-1 language code
code3	data.code3	string	ISO 639-2 language code
description	data.description	string	Description
visible	data.visible	integer	visible
last_updated	data.last_updated	string	Last time updated
updated_by	data.updated_by	string	User that made the update

Get system information

Operation ID:: GetSystemInformation

Returns a variety of helpful system information including version of API source code in use, service endpoint and last date of database synchronization.

Returns

Name	Path	Type	Description
success	success	boolean	success
version	data.version	string	version
endpoint	data.endpoint	string	endpoint
sitedescription	data.sitedescription	string	site description
backend	data.backend	string	backend
maxdocsize	data.maxdocsize	string	Maximum document size
lastsync	data.lastsync	string	Last time syncronized

Rate a file

Operation ID:: RateAFile

Submits rating information about files. Rating scale is 1-5 with 1 being poor quality and 5 being perfect quality. Review text strings are optional and can be included to explain the reasoning for the rating such as identified errors or areas of translation improvement classifications.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
fileid	fileid	True	string	the unique identifier assigned to a source or target file, i.e. the file ID.
rating	rating	True	string	rating scale is 1-5 with 1 being poor quality and 5 being perfect quality.
review	review		string	any other comment ragarind the score provided.

Returns

Name	Path	Type	Description
success	success	boolean	success
fileid	data.fileid	integer	The file ID in My Acclaro
id	data.id	integer	id
orderid	data.orderid	integer	The ID of the Order in My Acclaro
filetype	data.filetype	string	Type of file
originalfilename	data.originalfilename	string	The original filename
original-filename	data.original-filename	string	The original filename
filename	data.filename	string	The filename
plunet-filename	data.plunet-filename	string	The filename in Plunet
encoding	data.encoding	string	Encoding
mimetype	data.mimetype	string	Mimetype
size	data.size	integer	Size
clientref	data.clientref	string	Client Reference
comments	data.comments	string	Comments
reviewurl	data.reviewurl	string	The Review URL
rating	data.rating	integer	Rating
review	data.review	string	Review
status	data.status	string	Status
targetfile	data.targetfile	string	The translated file
previewfile	data.previewfile	string	The translated file ready for preview
uploaded	data.uploaded	string	Date when the item was uploaded
code	data.sourcelang.code	string	ISO 639-1 language code
code3	data.sourcelang.code3	string	ISO 639-2 language code
description	data.sourcelang.description	string	Description
code	data.targetlang.code	string	ISO 639-1 language code
code3	data.targetlang.code3	string	ISO 639-2 language code
description	data.targetlang.description	string	Description
callbacks	data.callbacks	array of	Callback URLs
emails	data.emails	array of	Notification emails

Rate an order

Operation ID:: RateAnOrder

Submits rating information about completed orders. Rating scale is 1-5 with 1 being poor quality and 5 being excellent quality.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
rate	rate	True	string	Rating scale is 1-5 with 1 being poor quality and 5 being excellent quality.

Returns

Name	Path	Type	Description
success	success	boolean	success
orderid	data.orderid	integer	The ID of the Order in My Acclaro
plunetid	data.user.plunetid	string	The ID of the item at Plunet
firstname	data.user.firstname	string	First name
lastname	data.user.lastname	string	Last name
company	data.user.company	string	Company
phone	data.user.phone	string	Phone number
email	data.user.email	string	Email address
created	data.user.created	string	Date created
modified	data.user.modified	string	Date modified
usergroup	data.usergroup	integer	User group
plunet-orderid	data.plunet-orderid	string	The ID of the Order at Plunet
plunet-requestid	data.plunet-requestid	string	The ID of the request at Plunet
plunet-quoteid	data.plunet-quoteid	integer	The ID of the Quote at Plunet
plunet-quotenum	data.plunet-quotenum	string	The number of the Quote at Plunet
name	data.name	string	Name
status	data.status	string	Status
process_type	data.process_type	string	Defines if Order will be processed using strings or files
ordertype	data.ordertype	string	Type of Order
referencefilecount	data.referencefilecount	integer	Count of reference files
targetfilecount	data.targetfilecount	integer	Count of translated files
requested_due_date	data.requested_due_date	string	Due date requested by client
duedate	data.duedate	string	Due date
clientref	data.clientref	string	Client Reference
delivery	data.delivery	string	Delivery
rating	data.rating	integer	Rating
review	data.review	string	Review
created	data.created	string	Date created
modified	data.modified	string	Date modified
sourcelang	data.sourcelang	array of string	Source language
targetlang	data.targetlang	array of string	Target language
ordertypecode	data.ordertypecode	integer	Order type code
emailaddress	data.emailaddress	string	Email address
emailquote	data.emailquote	integer	Email Quote to
emailfile	data.emailfile	integer	Email file to
emaildone	data.emaildone	integer	Email Done to
emailsubmit	data.emailsubmit	integer	Email submit to
emailcomment	data.emailcomment	integer	Email comment to
quoterequired	data.quoterequired	integer	Is Quote required?
autoapprove	data.autoapprove	integer	Auto approve quotes
autoapproveamt	data.autoapproveamt	integer	Auto approve MT quotes
tags	data.tags	array of	Order tags
estimatedwordcount	data.estimatedwordcount	integer	Estimated wordcount
lastdelivery	data.lastdelivery	string	Last delivery date
invoicedate	data.invoicedate	string	Invoice date
invoicedue	data.invoicedue	string	Invoice due date
in_preparation	data.in_preparation	string	“in_preparation” status
in_progress	data.in_progress	string	“in_progress” status
in_review	data.in_review	string	“in_review” status
completed	data.completed	string	“completed” status
canceled	data.canceled	string	“canceled” status
getting_quote	data.getting_quote	string	“getting_quote” status
needs_approval	data.needs_approval	string	“needs_approval” status
comments	data.comments	string	Comments
plunetid	data.account.plunetid	string	The ID of the item at Plunet
company	data.account.company	string	Company
phone	data.account.phone	string	Phone number
email	data.account.email	string	Email address
url	data.account.url	string	URL
created	data.account.created	string	Date created
modified	data.account.modified	string	Date modified
lastactivity	data.account.lastactivity	string	Date for last activity
callbacks	data.callbacks	array of	Callback URLs
emails	data.emails	array of	Notification emails

Remove a comment from order

Operation ID:: RemoveACommentFromOrder

Removes a comment from the order.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
commentid	commentid	True	string	The unique identifier assigned to the Comment, i.e. Comment ID.

Returns

Name	Path	Type	Description
success	success	boolean	success
orderid	data.orderid	integer	The ID of the Order in My Acclaro
plunetid	data.user.plunetid	string	The ID of the item at Plunet
firstname	data.user.firstname	string	First name
lastname	data.user.lastname	string	Last name
company	data.user.company	string	Company
phone	data.user.phone	string	Phone number
email	data.user.email	string	Email address
created	data.user.created	string	Date created
modified	data.user.modified	string	Date modified
usergroup	data.usergroup	integer	User group
plunet-orderid	data.plunet-orderid	string	The ID of the Order at Plunet
plunet-requestid	data.plunet-requestid	string	The ID of the request at Plunet
plunet-quoteid	data.plunet-quoteid	integer	The ID of the Quote at Plunet
plunet-quotenum	data.plunet-quotenum	string	The number of the Quote at Plunet
name	data.name	string	Name
status	data.status	string	Status
process_type	data.process_type	string	Defines if Order will be processed using strings or files
ordertype	data.ordertype	string	Type of Order
referencefilecount	data.referencefilecount	integer	Count of reference files
targetfilecount	data.targetfilecount	integer	Count of translated files
requested_due_date	data.requested_due_date	string	Due date requested by client
duedate	data.duedate	string	Due date
clientref	data.clientref	string	Client Reference
delivery	data.delivery	string	Delivery
rating	data.rating	integer	Rating
review	data.review	string	Review
created	data.created	string	Date created
modified	data.modified	string	Date modified
sourcelang	data.sourcelang	array of	Source language
targetlang	data.targetlang	array of	Target language
ordertypecode	data.ordertypecode	integer	Order type code
emailaddress	data.emailaddress	string	Email address
emailquote	data.emailquote	integer	Email Quote to
emailfile	data.emailfile	integer	Email file to
emaildone	data.emaildone	integer	Email Done to
emailsubmit	data.emailsubmit	integer	Email submit to
emailcomment	data.emailcomment	integer	Email comment to
quoterequired	data.quoterequired	integer	Is Quote required?
autoapprove	data.autoapprove	integer	Auto approve quotes
autoapproveamt	data.autoapproveamt	integer	Auto approve MT quotes
tags	data.tags	array of	Order tags
estimatedwordcount	data.estimatedwordcount	integer	Estimated wordcount
lastdelivery	data.lastdelivery	string	Last delivery date
invoicedate	data.invoicedate	string	Invoice date
invoicedue	data.invoicedue	string	Invoice due date
in_preparation	data.in_preparation	string	“in_preparation” status
in_progress	data.in_progress	string	“in_progress” status
in_review	data.in_review	string	“in_review” status
completed	data.completed	string	“completed” status
canceled	data.canceled	string	“canceled” status
getting_quote	data.getting_quote	string	“getting_quote” status
needs_approval	data.needs_approval	string	“needs_approval” status
comments	data.comments	string	Comments
plunetid	data.account.plunetid	string	The ID of the item at Plunet
company	data.account.company	string	Company
phone	data.account.phone	string	Phone number
email	data.account.email	string	Email address
url	data.account.url	string	URL
created	data.account.created	string	Date created
modified	data.account.modified	string	Date modified
lastactivity	data.account.lastactivity	string	Date for last activity
callbacks	data.callbacks	array of	Callback URLs
emails	data.emails	array of	Notification emails
id	order.id	integer	id
user_id	order.user_id	integer	user ID
account_id	order.account_id	integer	Account ID
program_id	order.program_id	string	Program ID
is_scheduled	order.is_scheduled	integer	Is scheduled
scheduler_id	order.scheduler_id	string	Scheduler ID
plunet_user_id	order.plunet_user_id	string	Plunet user ID
plunet_account_id	order.plunet_account_id	string	Plunet account ID
request_id	order.request_id	string	Request ID
quote_required	order.quote_required	integer	Quote required
auto_approve	order.auto_approve	integer	Auto approve
auto_approve_amount	order.auto_approve_amount	integer	Auto approve amount
quoteid	order.quoteid	string	Quote ID
quotenum	order.quotenum	string	Quote number
erp_order_id	order.erp_order_id	string	ERP Order ID
name	order.name	string	Name
status	order.status	string	Status
due_at	order.due_at	string	Due at
requested_due_at	order.requested_due_at	string	Requested due at
rating	order.rating	integer	Rating
review	order.review	string	Review
created	order.created	string	Date created
modified_at	order.modified_at	string	Date modified
po_number	order.po_number	string	PO number
delivery_method	order.delivery_method	string	Delivery method
quoteprice	order.quoteprice	string	Quote price
do_not_sync	order.do_not_sync	integer	Do not Sync
hide	order.hide	integer	Hide
review_done	order.review_done	integer	Review done
has_order_cost_pdf	order.has_order_cost_pdf	integer	Has Order cost PDF
show_order_cost	order.show_order_cost	integer	Show Order cost
estimated_word_count	order.estimated_word_count	integer	Estimated wordcount
total_words	order.total_words	string	Total words
source_file_count	order.source_file_count	integer	Count of source files
target_file_count	order.target_file_count	integer	Count of translated files
origin	order.origin	string	Order Origin
price	order.price	string	Total Price
review_url	order.review_url	string	Review URL
currency	order.currency	string	currency
order_type	order.order_type	integer	Type of Order
process_type	order.process_type	string	Defines if Order will be processed using strings or files
over_due_sent	order.over_due_sent	integer	Over due sent
submitter_user_id	order.submitter_user_id	string	Submitter user ID
quote_file	order.quote_file	string	Quote file
quote_file_size	order.quote_file_size	string	Quote file size
quote_file_date	order.quote_file_date	string	Quote file date
pm_user_id	order.pm_user_id	string	PM user ID
pm_plunet_resource	order.pm_plunet_resource	string	PM Plunet Resource
last_user_comment_at	order.last_user_comment_at	string	Last user comment date
last_pm_comment_at	order.last_pm_comment_at	string	Last PM comment date
last_user_comment_read_at	order.last_user_comment_read_at	string	Last user comment read date
last_pm_comment_read_at	order.last_pm_comment_read_at	string	Last PM comment read date
original_order_id	order.original_order_id	string	Original Order ID
has_comments	order.has_comments	integer	Has comments
properties	order.properties	string	Properties
has_system_comments	order.has_system_comments	integer	Has system comments
plunet_quote_template	order.plunet_quote_template	string	Plunet Quote template
plunet_order_template	order.plunet_order_template	string	Plunet Order template
erp_type	order.erp_type	string	ERP type
erp_last_sync_push	order.erp_last_sync_push	string	ERP last sync push
erp_last_sync_pull	order.erp_last_sync_pull	string	ERP last sync pull
erp_last_sync_pull_completed_at	order.erp_last_sync_pull_completed_at	string	ERP last sync pull completed at
erp_last_pull_status	order.erp_last_pull_status	string	ERP last sync pull status
sync_task	order.sync_task	string	Syncronization task
sync_event_id	order.sync_event_id	string	Syncronization event ID
created_at	order.created_at	string	Date created
updated_at	order.updated_at	string	Date updated
has_dirty_tags	order.has_dirty_tags	integer	Has dirty tags
has_dirty_comments	order.has_dirty_comments	integer	Has dirty comments
status_in_prep_at	order.status_in_prep_at	string	Date for “in_preparation” status transition
status_in_progress_at	order.status_in_progress_at	string	Date for “in_progress” status transition
status_in_review_at	order.status_in_review_at	string	Date for “in_review” status transition
status_completed_at	order.status_completed_at	string	Date for “complete” status transition
status_canceled_at	order.status_canceled_at	string	Date for “canceled” status transition
status_getting_quote_at	order.status_getting_quote_at	string	Date for “getting_quote” status transition
status_needs_approval_at	order.status_needs_approval_at	string	Date for “needs_approval” status transition
order_link	order.order_link	string	Order link
errorCode	errorCode	integer	Error Code

Request a quote

Operation ID:: RequestAQuote

This may only be performed on an order with status “new“. Immediately updates the order status to “getting quote” and returns the updated record. The assigned project manager will be sent the quote request. When a quote is generated, the order status will change to “needs approval“. At that time, the record returned from get order(/orders/{orderid} will include a “quoteprice“ and both /orders/{orderid}/quote-document and /orders/{orderid}/quote-details may be used.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.

Returns

Name	Path	Type	Description
success	success	boolean	success
orderid	data.orderid	integer	The ID of the Order in My Acclaro
plunetid	data.user.plunetid	string	The ID of the item at Plunet
firstname	data.user.firstname	string	First name
lastname	data.user.lastname	string	Last name
company	data.user.company	string	Company
phone	data.user.phone	string	Phone number
email	data.user.email	string	Email address
created	data.user.created	string	Date created
modified	data.user.modified	string	Date modified
usergroup	data.usergroup	integer	User group
plunet-orderid	data.plunet-orderid	string	The ID of the Order at Plunet
plunet-requestid	data.plunet-requestid	string	The ID of the request at Plunet
plunet-quoteid	data.plunet-quoteid	integer	The ID of the Quote at Plunet
plunet-quotenum	data.plunet-quotenum	string	The number of the Quote at Plunet
name	data.name	string	Name
status	data.status	string	Status
process_type	data.process_type	string	Defines if Order will be processed using strings or files
ordertype	data.ordertype	string	Type of Order
referencefilecount	data.referencefilecount	integer	Count of reference files
targetfilecount	data.targetfilecount	integer	Count of translated files
requested_due_date	data.requested_due_date	string	Due date requested by client
duedate	data.duedate	string	Due date
clientref	data.clientref	string	Client Reference
delivery	data.delivery	string	Delivery
rating	data.rating	integer	Rating
review	data.review	string	Review
created	data.created	string	Date created
modified	data.modified	string	Date modified
sourcelang	data.sourcelang	array of string	Source language
targetlang	data.targetlang	array of string	Target language
ordertypecode	data.ordertypecode	integer	Order type code
emailaddress	data.emailaddress	string	Email address
emailquote	data.emailquote	integer	Email Quote to
emailfile	data.emailfile	integer	Email file to
emaildone	data.emaildone	integer	Email Done to
emailsubmit	data.emailsubmit	integer	Email submit to
emailcomment	data.emailcomment	integer	Email comment to
quoterequired	data.quoterequired	integer	Is Quote required?
autoapprove	data.autoapprove	integer	Auto approve quotes
autoapproveamt	data.autoapproveamt	integer	Auto approve MT quotes
tags	data.tags	array of	Order tags
estimatedwordcount	data.estimatedwordcount	integer	Estimated wordcount
lastdelivery	data.lastdelivery	string	Last delivery date
invoicedate	data.invoicedate	string	Invoice date
invoicedue	data.invoicedue	string	Invoice due date
in_preparation	data.in_preparation	string	“in_preparation” status
in_progress	data.in_progress	string	“in_progress” status
in_review	data.in_review	string	“in_review” status
completed	data.completed	string	“completed” status
canceled	data.canceled	string	“canceled” status
getting_quote	data.getting_quote	string	“getting_quote” status
needs_approval	data.needs_approval	string	“needs_approval” status
comments	data.comments	string	Comments
plunetid	data.account.plunetid	string	The ID of the item at Plunet
company	data.account.company	string	Company
phone	data.account.phone	string	Phone number
email	data.account.email	string	Email address
url	data.account.url	string	URL
created	data.account.created	string	Date created
modified	data.account.modified	string	Date modified
lastactivity	data.account.lastactivity	string	Date for last activity
callbacks	data.callbacks	array of	Callback URLs
emails	data.emails	array of	Notification emails

Request an email on file changes

Operation ID:: RequestAnEmailOnFileChanges

Request that Acclaro send an email message to the provided address when the file changes in any way. For customer-friendly email messages, see the delivery options in the My Acclaro portal. This email is a simple message geared towards developers.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
fileid	fileid	True	string	the unique identifier assigned to a source or target file, i.e. the file ID.
email	email	True	string	The email to be added to the callback system.

Returns

Name	Path	Type	Description
success	success	boolean	success
data	data	array of	data

Request an email on order changes

Operation ID:: RequestAnEmailOnOrderChanges

Request that Acclaro send an email message to the provided address when the order changes in any way. For customer-friendly email messages, see the delivery options in the My Acclaro portal. This email is a simple message geared towards developers.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
email	email	True	string	the email address that will get the notifications.

Returns

Name	Path	Type	Description
success	success	boolean	success
data	data	array of	data

Send a reference file

Operation ID:: SendAReferenceFile

Adds a reference file to an order. Reference files are glossaries, style guides, or other supporting materials for the translator. The sourcelang is optional, and if supplied should be one of the language codes obtained from /info/languages. Targetlang is also optional, and if supplied should be one of the language codes obtained from /info/languages. Encoding is optional, and defaults to “UTF-8” if not specified. The filename and mime-type are taken from the file metadata. If a filename is supplied that duplicates the name of another file in this order, the system will make it unique by adding additional characters (i.e. “documentation.docx” may become “documentation2 .docx”). Returned file metadata includes both the originally supplied filename and the possibly-modified name that Acclaro will use. Individual file size is limited to 100MB maximum. In-progress orders may have new additional files added to them as long as the source and target languages match the original order’s files.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
file	file	True	file	The binary payload.
sourcelang	sourcelang		string	The language the file is in, in ISO format, e.g. "en-us".
targetlang	targetlang		string	The translation language the file refers to, in ISO format, e.g. "de-de".
encoding	encoding		string	Encoding of the reference file.

Returns

Name	Path	Type	Description
success	success	boolean	success
fileid	data.fileid	integer	The file ID in My Acclaro
id	data.id	integer	id
orderid	data.orderid	integer	The ID of the Order in My Acclaro
filetype	data.filetype	string	Type of file
originalfilename	data.originalfilename	string	The original filename
original-filename	data.original-filename	string	The original filename
filename	data.filename	string	The filename
plunet-filename	data.plunet-filename	string	The filename in Plunet
encoding	data.encoding	string	Encoding
mimetype	data.mimetype	string	Mimetype
size	data.size	integer	Size
clientref	data.clientref	string	Client Reference
comments	data.comments	string	Comments
reviewurl	data.reviewurl	string	The Review URL
rating	data.rating	integer	Rating
review	data.review	string	Review
status	data.status	string	Status
targetfile	data.targetfile	string	The translated file
previewfile	data.previewfile	string	The translated file ready for preview
uploaded	data.uploaded	string	Date when the item was uploaded
code	data.sourcelang.code	string	ISO 639-1 language code
code3	data.sourcelang.code3	string	ISO 639-2 language code
description	data.sourcelang.description	string	Description
code	data.targetlang.code	string	ISO 639-1 language code
code3	data.targetlang.code3	string	ISO 639-2 language code
description	data.targetlang.description	string	Description
callbacks	data.callbacks	array of	Callback URLs
emails	data.emails	array of	Notification emails
errorCode	errorCode	integer	Error Code

Send a source file

Operation ID:: SendASourceFile

Adds a file to an order, taking the filename and mime-type from the file metadata. If no orderid is provided, a new order is automatically created. The sourcelang should be one of the language codes obtained from /info/languages. Targetlangs can be a single language code or several language codes in a comma-separated list. Encoding is optional, and defaults to “UTF-8” if not specified. ClientRef is an optional value meaningful to the API user typically used for Purchase Order numbers but can be used for any relevant information; if supplied when the file is loaded, it will be returned in all future calls about this file. If a filename is supplied that duplicates the name of another file in this order, the system will make it unique by adding additional characters (i.e. “documentation.docx” may become “documentation-2.docx”). Returned file metadata includes both the originally supplied filename and the possibly modified name that Acclaro will use. Individual file size is limited to 100MB maximum . The API is file agnostic, as there are no file type limitations. XLIFF files are a common translation industry standard and are fully supported. In-progress orders may have new additional files added to them as long as the source and target languages match the original order’s files. For continuous programmatic orders, it is recommended that the /orders/{orderid}/files be used to build orders up with source files before submission via the SubmitOrder call, as this is the most efficient path for Acclaro translation services to receive orders with multiple files and then return subsequent translation files. If clients wish to maintain specific folder and file structures for their source files, they can upload zip files which will be returned with translations in desired folder and file structures within target delivery zip files.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.
sourcelang	sourcelang	True	string	The source language for the file, in iso format e.g. "en-us".
targetlang	targetlang	True	string	The desired language or languages that the file should be translated into, e.g. "de-de" or "de-de,fr-fr".
file	file	True	file	The binary payload.
enconding	enconding		string	The encoding of the file, defaults to "utf-8".
clientref	clientref		string	A referece ID to be used by the client if needed.

Returns

Name	Path	Type	Description
success	success	boolean	success
fileid	data.fileid	integer	The file ID in My Acclaro
id	data.id	integer	id
orderid	data.orderid	integer	The ID of the Order in My Acclaro
filetype	data.filetype	string	Type of file
originalfilename	data.originalfilename	string	The original filename
original-filename	data.original-filename	string	The original filename
filename	data.filename	string	The filename
plunet-filename	data.plunet-filename	string	The filename in Plunet
encoding	data.encoding	string	Encoding
mimetype	data.mimetype	string	Mimetype
size	data.size	integer	Size
clientref	data.clientref	string	Client Reference
comments	data.comments	string	Comments
reviewurl	data.reviewurl	string	The Review URL
rating	data.rating	integer	Rating
review	data.review	string	Review
status	data.status	string	Status
targetfile	data.targetfile	string	The translated file
previewfile	data.previewfile	string	The translated file ready for preview
uploaded	data.uploaded	string	Date when the item was uploaded
code	data.sourcelang.code	string	ISO 639-1 language code
code3	data.sourcelang.code3	string	ISO 639-2 language code
description	data.sourcelang.description	string	Description
targetlang	data.targetlang	array of object	Target language
code	data.targetlang.code	string	ISO 639-1 language code
code3	data.targetlang.code3	string	ISO 639-2 language code
description	data.targetlang.description	string	Description
callbacks	data.callbacks	array of	Callback URLs
emails	data.emails	array of	Notification emails
errorCode	errorCode	integer	Error Code

Stop an email from receiving order changes

Operation ID:: StopAnEmailFromReceivingOrderChanges

Request that Acclaro no longer email the supplied address when the order changes in any way.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.

Returns

Name	Path	Type	Description
success	success	boolean	success
data	data	array of	data

Submits the order for preparation

Operation ID:: SubmitsTheOrderForPreparation

Immediately updates the order status to “in preparation”, returns the updated record. Order status will soon change to ‘in progress’ once the Acclaro system confirms receipt of all order details and files.

Parameters

Name	Key	Required	Type	Description
orderid	orderid	True	string	The unique identifier assigned to the Order, i.e. Order ID.

Returns

Name	Path	Type	Description
success	success	boolean	success
orderid	data.orderid	integer	The ID of the Order in My Acclaro
plunetid	data.user.plunetid	string	The ID of the item at Plunet
firstname	data.user.firstname	string	First name
lastname	data.user.lastname	string	Last name
company	data.user.company	string	Company
phone	data.user.phone	string	Phone number
email	data.user.email	string	Email address
created	data.user.created	string	Date created
modified	data.user.modified	string	Date modified
usergroup	data.usergroup	integer	User group
plunet-orderid	data.plunet-orderid	string	The ID of the Order at Plunet
plunet-requestid	data.plunet-requestid	string	The ID of the request at Plunet
plunet-quoteid	data.plunet-quoteid	integer	The ID of the Quote at Plunet
plunet-quotenum	data.plunet-quotenum	string	The number of the Quote at Plunet
name	data.name	string	Name
status	data.status	string	Status
process_type	data.process_type	string	Defines if Order will be processed using strings or files
ordertype	data.ordertype	string	Type of Order
referencefilecount	data.referencefilecount	integer	Count of reference files
targetfilecount	data.targetfilecount	integer	Count of translated files
requested_due_date	data.requested_due_date	string	Due date requested by client
duedate	data.duedate	string	Due date
clientref	data.clientref	string	Client Reference
delivery	data.delivery	string	Delivery
rating	data.rating	integer	Rating
review	data.review	string	Review
created	data.created	string	Date created
modified	data.modified	string	Date modified
sourcelang	data.sourcelang	array of string	Source language
targetlang	data.targetlang	array of string	Target language
ordertypecode	data.ordertypecode	integer	Order type code
emailaddress	data.emailaddress	string	Email address
emailquote	data.emailquote	integer	Email Quote to
emailfile	data.emailfile	integer	Email file to
emaildone	data.emaildone	integer	Email Done to
emailsubmit	data.emailsubmit	integer	Email submit to
emailcomment	data.emailcomment	integer	Email comment to
quoterequired	data.quoterequired	integer	Is Quote required?
autoapprove	data.autoapprove	integer	Auto approve quotes
autoapproveamt	data.autoapproveamt	integer	Auto approve MT quotes
tags	data.tags	array of	Order tags
estimatedwordcount	data.estimatedwordcount	integer	Estimated wordcount
lastdelivery	data.lastdelivery	string	Last delivery date
invoicedate	data.invoicedate	string	Invoice date
invoicedue	data.invoicedue	string	Invoice due date
in_preparation	data.in_preparation	string	“in_preparation” status
in_progress	data.in_progress	string	“in_progress” status
in_review	data.in_review	string	“in_review” status
completed	data.completed	string	“completed” status
canceled	data.canceled	string	“canceled” status
getting_quote	data.getting_quote	string	“getting_quote” status
needs_approval	data.needs_approval	string	“needs_approval” status
comments	data.comments	string	Comments
plunetid	data.account.plunetid	string	The ID of the item at Plunet
company	data.account.company	string	Company
phone	data.account.phone	string	Phone number
email	data.account.email	string	Email address
url	data.account.url	string	URL
created	data.account.created	string	Date created
modified	data.account.modified	string	Date modified
lastactivity	data.account.lastactivity	string	Date for last activity
callbacks	data.callbacks	array of	Callback URLs
emails	data.emails	array of	Notification emails

Share via

My Acclaro (Preview)

Prerequisites

How to get credentials

Generate Tokens

Presenting Tokens with Requests

Token Revocation

Token Implementation Details

Header

Payload

Get started with your connector

Service URL Endpoints

Interactive Test Console

Order and File Status Summaries

Callbacks

Email Notifications

Due Dates

Data Synchronization

Error Codes

Known issues and limitations

Common errors and remedies

Creating an Order and not submititng it:

Date format

FAQ

Creating a connection

Default

Throttling Limits

Actions

Add a callback for file updates

Parameters

Returns

Add a callback for order string updates

Parameters

Returns

Add a callback for order updates

Parameters

Returns

Add a comment for a file

Parameters

Returns

Add a comment to order

Parameters

Returns

Add a language to order

Parameters

Returns

Add a review URL for a file

Parameters

Returns

Add a tag to order

Parameters

Returns

Add source and target language to the order

Parameters

Returns

Add strings

Parameters

Returns

Approve a quote

Parameters

Returns

Create an order

Parameters

Returns

Decline a quote

Parameters

Returns

Delete a callback added to order

Parameters

Returns

Delete a callback added to the file

Parameters

Returns

Delete a callback added to the file

Parameters

Returns

Delete a file from the order

Parameters

Returns

Delete a tag from order