Orders

Orders

Creating new order

You can use the API to create a new order in the system. You need to fill in order information such as customer information and order currency.

Endpoint [POST] /System/Orders on the API you can easily try.

You can find more information about the endpoint and its parameters in our API documentation

Loading one specific order

Using the API, one specific order can be retrieved using its identifier, this action is used when manipulating orders, for example at payment gateways. We receive information that is stored on orders, such as its value, the items contained in it, the price of the order, its status, information about the customer, etc.

Endpoint [GET] /System/Orders/{id} on the API you can easily try.

You can find more information about the endpoint and its parameters in our API documentation

Loading orders according to parameters

You can also use the API to load orders according to various parameters. For example, we can only retrieve orders from a specific customer.

Endpoint [GET] /System/Orders on the API you can easily try.

You can find more information about the endpoint and its parameters in our API documentation

Order items

Create a new item

You can use the API to create a new item for a specific order.

Endpoint [POST] /System/Orders/{id}/item on the API you can easily try.

You can find more information about the endpoint and its parameters in our API documentation

Edit an item

You can use the API to edit a specific item for a specific order.

Endpoint [PUT] /System/Orders/{id}/item on the API you can easily try.

You can find more information about the endpoint and its parameters in our API documentation

Delete an item

You can use the API to delete a specific item for a specific order.

Endpoint [DELETE] /System/Orders/{id}/item/{itemId} on the API you can easily try.

You can find more information about the endpoint and its parameters in our API documentation

Retrieve all order statuses for the instance

You can use the API to retrieve all order statuses that are set on a given instance. These statuses can be assigned, for example, to notifications.

Endpoint [GET] /System/Orders/Statuses on the API you can easily try.

You can find more information about the endpoint and its parameters in our API documentation

Status settings for the order

Using the API, you can assign any status to an order as long as we know its identifier. For example, we can retrieve it using the endpoint for all statuses on a given instance.

Endpoint [PATCH] /System/Orders/{id}/status on the API you can easily try.

You can find more information about the endpoint and its parameters in our API documentation

Add a tracking number to your order

You can use the API to add a tracking number to your order.

Endpoint [POST] /System/Orders/{id}/tracking on the API you can easily try.

You can find more information about the endpoint and its parameters in our API documentation

Add history to the order

Using the API, you can create a new record in the order history for a specific order, for example, when it is paid for, canceled or otherwise changed.

Endpoint [POST] /System/Orders/{id}/history on the API you can easily try.

You can find more information about the endpoint and its parameters in our API documentation

Orders states

You can use the API to change the status of an order. For example, after paying for the order, its cancellation, completion, etc.

Paid

Endpoint [PATCH] /System/Orders/{id}/paid on the API you can easily try.

You can find more information about the endpoint and its parameters in our API documentation

Done

Endpoint [PATCH] /System/Orders/{id}/done on the API you can easily try.

You can find more information about the endpoint and its parameters in our API documentation

Canceled

Endpoint [PATCH] /System/Orders/{id}/cancel on the API you can easily try.

You can find more information about the endpoint and its parameters in our API documentation

Sent

Endpoint [PATCH] /System/Orders/{id}/sent on the API you can easily try.

You can find more information about the endpoint and its parameters in our API documentation

Delivered

Endpoint [PATCH] /System/Orders/{id}/delivered on the API you can easily try.

You can find more information about the endpoint and its parameters in our API documentation