Sign up Log in

Outgoing Delivery API

Manage outgoing deliveries — retrieval, creation, modification, closing and document download

Endpoints

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.

If you liked it, share it with others

Base URL

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

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

GET /api/outgoing/get

Retrieve a single outgoing delivery by identifier, with full details (items, serial numbers, project).

Query parameters

Parameter Type Required Description
id int Unique identifier of the outgoing delivery
item_params[include_pictures] int 1 = return product images for the items
item_params[include_items_stock_serial] int 1 = return serial number data
item_params[include_items_product_parts] int 1 = return product components
item_params[include_receipt_cr] int 1 = return linked documents

Example request

GET /api/outgoing/get?id=17&item_params[include_items_stock_serial]=1
X-API-KEY: {your_api_key}

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 17,
    "identify": "OUT-2024-0017",
    "date_create": "2024-05-03 11:20:00",
    "date_perform": "2024-05-10",
    "status_id": 1,
    "partner_company_name": "Minta Kft.",
    "price_brutto": 63500,
    "price_netto": 50000,
    "price_tax": 13500,
    "currency_name": "HUF",
    "item": [
      {
        "product_id": 5,
        "quantity": 2,
        "price": 25000,
        "price_brutto": 31750
      }
    ]
  }
}
GET /api/outgoing/list

Paginated retrieval of the outgoing delivery list with filtering and sorting options.

Query parameters

Parameter Type Required Description
list_offset int Pagination offset (default: 0)
list_count int Number of results per page (default: 10)
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 (1=open, 2=closed)
list_condition[status_ids] array Filter by multiple statuses at once
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[date_perform_from] date Fulfillment date — from (YYYY-MM-DD)
list_condition[date_perform_to] date Fulfillment date — to (YYYY-MM-DD)
list_condition[partner_id] int Filter by partner ID
list_condition[company_user_id] int Filter by responsible employee ID
list_condition[partnumber] string Filter by part number or barcode (LIKE)
list_condition[serial_number] string Filter by serial number
list_sort[field] string Name of the sort field
list_sort[sort] string ASC or DESC

Example request

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

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": [
    {
      "id": 17,
      "identify": "OUT-2024-0017",
      "date_create": "2024-05-03",
      "status_name": "Nyitott",
      "partner_company_name": "Minta Kft.",
      "price_brutto": 63500
    }
  ],
  "params": {
    "list_count": 10,
    "list_offset": 0,
    "list_all": 34
  }
}
POST /api/outgoing/save

Create or update an outgoing delivery. For a new delivery use data[id] = 0, for an update pass the existing ID.

POST fields — data object

Field Type Required Description
id int 0 = new outgoing delivery, >0 = update
company_id int Company identifier
company_user_id int Responsible employee ID
company_address_id int Company site ID
date_perform datetime Fulfillment date (YYYY-MM-DD HH:MM:SS)
currency_id int Currency identifier
partner_id int Partner/customer identifier
partner_user_id int Partner contact person ID
partner_shipping_id int Partner shipping address ID
currency_exchange decimal Currency exchange rate (default: 1)
comment_top string Comment visible to the customer
comment_bottom string Internal comment
jobnumber_id int Job number identifier
departmentnumber_id int Department number identifier
project_id int Project identifier
source_receipt_id int Source document identifier
source_receipt_type_id int Source document type identifier
item array Array of items — at least one item is required (see below)

Item fields — data[item][]

Field Type Required Description
id int 0 = new item, >0 = update existing item
product_id int Product identifier
store_id int Warehouse identifier
store_locality_id int Storage location identifier
quantity decimal Quantity
tax_id int VAT rate identifier
price decimal Net unit price
price_discount decimal Discount/surcharge percentage
stock_change int Stock movement flag
comment_top string Comment attached to the item
remove int 1 = delete the item during update

POST fields — params object (optional)

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

Example request

POST /api/outgoing/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,
    "date_perform": "2024-06-15 09:00:00",
    "partner_id": 12,
    "currency_id": 1,
    "item": [
      {
        "id": 0,
        "product_id": 5,
        "store_id": 1,
        "quantity": 2,
        "tax_id": 2,
        "price": 25000
      }
    ]
  },
  "params": {
    "close": 0,
    "download": 0
  }
}

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 18,
    "identify": "OUT-2024-0018"
  }
}
POST /api/outgoing/delete

Delete an outgoing delivery. Only a document with status_id = 1 (open) or status_id = 2 (closed) can be deleted.

POST fields — data object

Field Type Required Description
receipt_id int Identifier of the outgoing delivery to delete

Example request

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

{
  "data": {
    "receipt_id": 17
  }
}

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}
POST /api/outgoing/close

Close an open outgoing delivery. Performs a stock movement and quantity validation for products tracked in inventory. Only a document with status_id = 1 (open) can be closed.

POST fields — data object

Field Type Required Description
receipt_id int Identifier of the outgoing delivery to close

Example request

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

{
  "data": {
    "receipt_id": 17
  }
}

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}
GET /api/outgoing/download

Generate the outgoing delivery document in various formats (PDF, base64 string, stream).

Query parameters

Parameter Type Required Description
receipt_id int Identifier of the outgoing delivery
file_type string Output format (see below)
language string Template language folder name (e.g. hungarian)
language_id int Language identifier (default: 1)
template_id int Custom print template ID

file_type possible values

Value Description
pdf Return base64-encoded PDF with metadata
pdf-string Same as pdf — base64 string + metadata
pdf-string-sample Preview PDF generation
stream Direct file stream (browser download)

Example request

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

Example response (file_type=pdf)

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "name": "OUT-2024-0017.pdf",
    "content": "JVBERi0xLjQK...",
    "receipt": { ... }
  }
}

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!
Create an account
Register