Order API

Manage customer orders — retrieval, creation, modification, closing, marking as fulfilled, and document download

Endpoints

GET Get single record
GET Get list
POST Save / create
POST Delete
POST Close
POST Mark as fulfilled
GET Download
POST Change customer status
POST Change shipping method

Authentication

Every API request requires sending the X-API-KEY header.

X-API-KEY: {your_api_key}

Still have questions?

Open a ticket with us, or browse our help center.

Base URL

https://{tenant}.logzi.com/api/order_in/

Every request returns a JSON response. On success result.code == 1, on error result.code == 0.

GET /api/order_in/get

Retrieve a single customer order by identifier, with full details.

Query parameters

Parameter	Type	Required	Description
`id`	int		Unique identifier of the order

Example request

GET /api/order_in/get?id=45
X-API-KEY: {your_api_key}

GET /api/order_in/list

Paginated retrieval of the customer order list with filtering and sorting options.

Query parameters

Parameter	Type	Description
`list_offset`	int	Pagination offset (default: 0)
`list_count`	int	Number of records per page
`list_sort[field]`	string	Name of the field to sort by
`list_sort[sort]`	string	Sort direction: `ASC` or `DESC`
`list_condition[identify]`	string	Filter by identifier (LIKE)
`list_condition[company_name]`	string	Filter by partner name (LIKE)
`list_condition[status_id]`	int	Filter by status
`list_condition[date_create_from]`	date	Creation date — from (YYYY-MM-DD)
`list_condition[date_create_to]`	date	Creation date — to (YYYY-MM-DD)
`list_condition[partner_id]`	int	Filter by partner identifier

Example request

GET /api/order_in/list?list_offset=0&list_condition[status_id]=1
X-API-KEY: {your_api_key}

POST /api/order_in/save

Create or update a customer order. Use data[id] = 0 for a new record.

POST fields — data object

Field	Type	Description
`id`	int	0 = new order, >0 = update
`company_id`	int	Company identifier
`company_user_id`	int	Responsible employee ID
`company_address_id`	int	Company site ID
`currency_id`	int	Currency identifier
`partner_id`	int	Partner/customer identifier
`partner_shipping_id`	int	Partner shipping address ID
`date_perform`	date	Performance date (YYYY-MM-DD)
`comment_top`	string	Comment visible to the customer
`comment_bottom`	string	Internal comment
`jobnumber_id`	int	Job number identifier
`project_id`	int	Project identifier
`item`	array	Array of items (see below)

Item fields — data[item][]

Field	Type	Description
`product_id`	int	Product identifier
`quantity`	float	Quantity
`price`	float	Net unit price
`tax_id`	int	VAT rate identifier
`price_discount`	float	Discount percentage
`remove`	int	1 = delete the item on update

POST fields — params object (optional)

Field	Type	Required	Description
`close`	int		1 = automatically close after saving
`download`	int		1 = generate PDF after saving

Example request

POST /api/order_in/save
X-API-KEY: {your_api_key}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "company_id": 1,
    "company_user_id": 3,
    "company_address_id": 1,
    "currency_id": 1,
    "partner_id": 12,
    "date_perform": "2024-07-15",
    "comment_top": "Kérjük sürgős kezelést.",
    "item": [
      { "product_id": 5, "quantity": 10, "price": 8000, "tax_id": 2 }
    ]
  },
  "params": { "close": 0, "download": 0 }
}

POST /api/order_in/delete

Delete a customer order. Only an order with open status can be deleted.

POST fields — data object

Field	Type	Required	Description
`receipt_id`	int		Identifier of the order to delete

Example request

POST /api/order_in/delete
X-API-KEY: {your_api_key}
Content-Type: application/json

{ "data": { "receipt_id": 45 } }

POST /api/order_in/close

Close a customer order. Only an order that is open (status_id = 1) can be closed.

POST fields — data object

Field	Type	Required	Description
`receipt_id`	int		Identifier of the order to close

Example request

POST /api/order_in/close
X-API-KEY: {your_api_key}
Content-Type: application/json

{ "data": { "receipt_id": 45 } }

POST /api/order_in/success

Mark a closed customer order as fulfilled. Can only be called on an order with closed status.

POST fields — data object

Field	Type	Required	Description
`receipt_id`	int		Identifier of the order to fulfill (closed status only)

Example request

POST /api/order_in/success
X-API-KEY: {your_api_key}
Content-Type: application/json

{ "data": { "receipt_id": 45 } }

GET /api/order_in/download

Download the customer order document in various formats.

Query parameters

Parameter	Type	Description
`receipt_id`	int	Identifier of the order
`file_type`	string	`pdf`, `pdf-string`, `pdf-string-sample`, `stream`
`language`	string	Template language folder name
`template_id`	int	Custom print template ID

Example request

GET /api/order_in/download?receipt_id=45&file_type=pdf
X-API-KEY: {your_api_key}

POST /api/order_in/change_customer_status

Change the customer status of a customer order. An integration webhook is triggered automatically unless disabled.

POST fields — data object

Field	Type	Description
`receipt_id`	int	Identifier of the order
`customer_status_id`	int	Identifier of the new customer status
`no_integration_event`	int	1 = do not trigger the integration webhook event

Example request

POST /api/order_in/change_customer_status
X-API-KEY: {your_api_key}
Content-Type: application/json

{ "data": { "receipt_id": 45, "customer_status_id": 3 } }

POST /api/order_in/save_shipping

Change an order's shipping method and payment method. Optionally also updates the shipping address details if partner_address_id is provided.

POST fields — data object

Field	Type	Description
`receipt_id`	int	Identifier of the order
`shipping_id`	int	Identifier of the new shipping method (`db_shipping.id`)
`paymod_id`	int	Identifier of the new payment method
`partner_address_id`	int	If > 0, updates the partner address record with the address fields below
`country_id`	int	Country identifier
`zip`	string	Postal code
`city`	string	City
`address`	string	Street name
`address_number`	string	House number — dots are automatically removed
`address_building`	string	Building — dots are automatically removed
`address_floor`	string	Floor — dots are automatically removed
`address_door`	string	Door — dots are automatically removed
`address_stairwell`	string	Stairwell — dots are automatically removed
`district`	string	District — dots are automatically removed
`address_user_name`	string	Name of the address owner
`address_comment`	string	Address comment

Example request — shipping and payment method change only

POST /api/order_in/save_shipping
X-API-KEY: {your_api_key}
Content-Type: application/json

{ "data": { "receipt_id": 45, "shipping_id": 3, "paymod_id": 2 } }

Example request — shipping method change + address update

POST /api/order_in/save_shipping
X-API-KEY: {your_api_key}
Content-Type: application/json

{ "data": { "receipt_id": 45, "shipping_id": 3, "paymod_id": 2, "partner_address_id": 12, "country_id": 1, "zip": "1051", "city": "Budapest", "address": "Vörösmarty tér", "address_number": "7", "district": "V" } }

Get in touch with us

Interested in our software? Feel free to write to us!

Send an inquiry

Need help?

If you can't find the answer and need assistance

Browse the help center

Create your account now,
pay later!

Try it free for 3 days, no risk, no obligation!