POST
Create Order
Creates a new Order. An Order is a composed entity by a Case, a Company, a Company User, Invoice Items, an Invoice, a Payment. In order to simplify the creation of Orders we have this special endpoint.
Important
Calls to this method must include the cookie .LawPanel.AuthCookie in order to identify you at user level. For more details about authentication please check this link. To obtain the cookie you can use the method Login.
Request URL
Request headers
string
Subscription key which provides access to this API.
Request body
Payload with data about the new order to be created.
- string Required order_name: The name for the order. A little description about it.
- string Required order_number: A string/number to be used as a reference for the Order. You can use here your internal identifier for this order.
- string Required company_name: The name of the Company/Client who owns the order. The system is going to create a new Company with this name. To get a list of all Companies available, please check this link.
- string Required company_user_email: An email address to create a new account for the Company created. This new user will access to the order details using. To get a list of all Company Users available, please check this link.
- string Required company_user_password: The password for the Company User to be created.
- string Required file_template_id: The Case Template ID to be used with the Case creation for the order. To get a list of all Case Template available, please check this link.
- string Required company_user_password: The password for the Company User to be created.
-
array
Required
file_template_components: A list of object with the components values for the Case Template.
Each object should have these properties:
- string Required name: The name of the Case Template component.
- string Required value: The value for the Case Template component.
To get a list of all Case Template available (and its components), please check this link.
- string Required payment_currency_id: The Currency ID for the payment. To get a list of all Currency available, please check this link.
-
array
Required
payment_items: A list of object with the payment components for the Order.
Each object should have these properties:
- string Required description: A little description for the payment concept.
- number Required amount: The amount for the concept described on "description" property. If the concept has a tax, you should include it here.
- string Required tax_id: The Tax ID to be included with the payment item. If the item does not have a Tax, use "null". To get a list of all Tax available, please check this link.
- bool Optional do_not_create_payment: If you set this property to "true" the Payment for the Order will not be performed.
Loading...
{
"type": "object",
"properties": {
"order_name": {
"type": "string"
},
"order_number": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_user_email": {
"type": "string"
},
"company_user_password": {
"type": "string"
},
"file_template_id": {
"type": "string"
},
"file_template_components": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
]
}
},
"payment_currency_id": {
"type": "string"
},
"payment_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"amount": {
"type": "integer"
},
"tax_id": {
"type": "string"
}
},
"required": [
"description",
"amount",
"tax_id"
]
}
},
"do_not_create_payment": {
"type": "boolean"
}
},
"example": {
"order_name": "Order for trademark search \"lawpanel\".",
"order_number": "1",
"company_name": "Michael Jackson",
"company_user_email": "michael@jackson.com",
"company_user_password": "mj2020_",
"file_template_id": "96C4A417-7A0A-4241-AE84-AC3D011C40C8",
"file_template_components": [
{
"name": "Search result",
"value": "432db66d-467c-4835-bac6-ac3d00fa3af6"
},
{
"name": "Good and services",
"value": "Good and services contents"
},
{
"name": "Website",
"value": "https://www.site.com"
},
{
"name": "Are you already using the name",
"value": "1 - 3 years"
},
{
"name": "Series",
"value": "{\"option_id_selected\":\"PartOfSeriesTrademark\",\"description\":\"This is the content for Series, second option selected with a description.\"}"
},
{
"name": "Previously registered",
"value": "{\"option_id_selected\":\"PreviouslyRegistered\",\"description\":\"This is the contents for 'Previously registered', second option.\"}"
},
{
"name": "SMS Notifications",
"value": "{\"selected\":true,\"description\":\"+5493875333953\"}"
},
{
"name": "Order folder",
"value": "Abandoned"
},
{
"name": "Order status",
"value": "On hold awaiting client"
},
{
"name": "Country",
"value": "Argentina"
}
],
"payment_currency_id": "95CE88B2-3229-4DD7-A35A-A6B20003F63B",
"payment_items": [
{
"description": "Registration fees 1 trademark on UK",
"amount": 100,
"tax_id": "1DB77783-9E48-4DDC-A665-A6B4002671C1"
},
{
"description": "Our fees",
"amount": 30,
"tax_id": null
}
],
"do_not_create_payment": true
}
}
Response 201
Returns an object with details about the operation result.
- string id: The Case ID created for the order. To get details about this Case please check this link.
- bool success: "true" if the Order was created successfully, "false" if not.
- string message: A little message with some information about the operation result.
- string url_to_redirect: A five minutes valid URL to redirect the Company User created. This URL will allow the User access to the Company Area to show the Order created details.
Loading...
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"success": {
"type": "boolean"
},
"message": {
"type": "string"
},
"url_to_redirect": {
"type": "string"
}
}
}