API Integration
API integration allows you to receive orders from external systems into Controlata.
Setting up API integration requires technical knowledge in programming and experience working with API interfaces. If
you are not a developer, you will need assistance from a technical specialist to implement the integration. The
integration involves writing code that will interact with the Controlata API according to the documentation below.
Go to Controlata settings, find the “Integrations” section and click “Connect” next to “General API”.
- The API key will be needed to authorize requests.
- The order number prefix will be added to the beginning of all orders received through the API.
- The products location is the storage location from which products will be deducted for the order.
Request Format
The request must be sent via POST method in JSON format. The API key must be included in the request body in the “key”
field.
API endpoint:
- https://api.controlata.com/connect/general/new_order.php
Required Parameters
- key — API key
- name — customer name
- num — order number
- products — array of products, each product represented as an object with parameters:
- sku — must match the SKU in the product details in Controlata
- amount — quantity
- sum — total price (price × quantity)
Optional Parameters
- email — customer email
- phone — customer phone
- address — customer address
- delivery_price — delivery cost
- discount — discount amount
- notes — order notes
- production — if true, a dedicated production run will be created for this order; if false or missing, products will
be deducted from inventory
Response Format
The response will also be returned in JSON format and will contain the following parameters:
- success — true / false
- num — order number
- error — error message if something went wrong
Product Matching
Products are matched by the SKU field. If a product with the corresponding SKU is not found in the system, it won't be
added to the order, but this will not cause an error. A note will be added to the order comments indicating which
product could not be matched. However, if none of the products in the order can be matched, this will result in an error
and the order will not be created.
Request Example
{
"key": "45c932581f5f6d2c0d21",
"num": "1237",
"name": "Bob",
"email": "hi@controlata.com",
"phone": "123456789",
"address": "221B, Baker street",
"delivery_price": 50,
"discount": "10",
"notes": "Test notes",
"production": false,
"products": [
{
"sku": "A001",
"amount": 2,
"sum": 180
},
{
"sku": "A002",
"amount": 1,
"sum": 100
}
]
}
Successful Response Example
{
"success": true,
"num": "A-1237"
}
Error Response Example
{
"success": false,
"error": "No products in input"
}
