[POST] .../v1/docorderdelivery/get
Returns retail order documents. Use this method to retrieve retail order delivery documents for order management, delivery dispatching, POS handoff, integrations and support workflows. The request requires the retail order select permission and supports filters such as id, code, status_id, stock_id, customer_id, operating_cash_id, from_id, external_code, date/start_date/end_date, search, deleted_mark and blocked, plus sort_orders and pagination. The response returns a paged result with retail order headers, resolved stock, customer, retail card, source, delivery type, courier, price type, payment type, status, lock, deletion mark, next_offset and total; stock visibility is limited by the current request user's allowed stocks. Business errors such as a missing request body, denied access, disabled retail-orders tariff, invalid filters, database errors or persistent lookup failures are returned as HTTP 200 ErrorResult.
Request Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| filters | Array of Filter | Optional | Optional filters by fields available for this API method. |
| limit | Int32 | Optional | Maximum number of records to return. |
| offset | Int32 | Optional | Offset from the beginning of the result set. |
| search | String | Optional | Search string. |
| sort_orders | Array of DocOrderDeliveryColumn | Optional | Output parameter sorting. |
Filterable Fields
| Field | Type | Description |
|---|---|---|
| blocked | bool | Document lock: true - locked, false - not locked. |
| code | string | Retail order document code. |
| customer_id | int | Customer IDs. |
| date | int | |
| deleted_mark | bool | Deletion mark: true - marked for deletion, false - not marked. |
| end_date | int | Period end date as Unix time in seconds. |
| external_code | string | Order code in the external system. |
| from_id | int | Retail order source ID array. |
| id | int | Retail order document ID array. |
| operating_cash_id | int | Operating cash ID array. |
| start_date | int | Period start date as Unix time in seconds. |
| status_id | int | Document status ID array. |
| stock_id | int | Stock IDs. |
Sortable Fields
| Field |
|---|
| amount |
| blocked |
| card.barcode_value |
| code |
| courier.name |
| customer.name |
| date |
| deleted_mark |
| delivery_date |
| delivery_type.name |
| external_code |
| from.name |
| id |
| last_update |
| operating_cash_id |
| payment_type.name |
| price_type.currency.name |
| price_type.name |
| status.name |
| stock.name |
Request Example
{
"filters": [
{
"Field": "blocked",
"Operator": "Equal",
"Value": "string"
}
],
"limit": 1,
"offset": 1,
"search": "string",
"sort_orders": [
{
"column": "date",
"direction": "ASC"
}
]
}Response Parameters
| Name | Type | Description |
|---|---|---|
| next_offset | Int32 | Offset for the next data page. |
| ok | Boolean | Indicates whether the request completed successfully. |
| result | Array of DocOrderDelivery | Result array. |
| total | Int64 | Total number of result items. |
Response Example
{
"next_offset": 1,
"ok": true,
"result": [
{
"address": "string",
"amount": 1.0,
"blocked": true,
"card": {
"barcode_type": {
"id": 1,
"last_update": 1,
"name": "string"
},
"barcode_value": "string",
"bonus_amount": 1.0,
"customer": {
"address": "string",
"date_of_birth": "string",
"debt": 1.0,
"deleted_mark": true,
"description": "string",
"email": "string",
"fields": [
{
"data_type": "string",
"is_custom": true,
"key": "string",
"metadata": "string",
"name": "string",
"required": true,
"value": "string"
}
],
"first_name": "string",
"full_name": "string",
"group": {
"child_count": 1,
"id": 1,
"last_update": 1,
"name": "string",
"parent_id": 1
},
"id": 1,
"last_name": "string",
"last_purchase": 1,
"last_update": 1,
"main_phone": "string",
"middle_name": "string",
"phones": "string",
"refer_id": 1,
"region": {
"id": 1,
"last_update": 1,
"name": "string",
"parent_id": 1
},
"sex": "none"
},
"date": 1,
"enabled": true,
"expiry_date": "string",
"group": {
"child_count": 1,
"id": 1,
"last_update": 1,
"name": "string",
"parent_id": 1
},
"id": 1,
"last_purchase": 1,
"last_update": 1,
"promo": {
"active": true,
"days": [
1
],
"description": "string",
"end_date": "string",
"end_time": "string",
"id": 1,
"last_update": 1,
"name": "string",
"priority": 1,
"start_date": "string",
"start_time": "string",
"sub_type": 1,
"type": {
"id": 1,
"last_update": 1,
"name": "string"
}
},
"unlimited": true
},
"code": "string",
"courier": {
"description": "string",
"id": 1,
"last_update": 1,
"name": "string"
},
"current_user_blocked": true,
"customer": {
"address": "string",
"date_of_birth": "string",
"debt": 1.0,
"deleted_mark": true,
"description": "string",
"email": "string",
"fields": [
{
"data_type": "string",
"is_custom": true,
"key": "string",
"metadata": "string",
"name": "string",
"required": true,
"value": "string"
}
],
"first_name": "string",
"full_name": "string",
"group": {
"child_count": 1,
"id": 1,
"last_update": 1,
"name": "string",
"parent_id": 1
},
"id": 1,
"last_name": "string",
"last_purchase": 1,
"last_update": 1,
"main_phone": "string",
"middle_name": "string",
"phones": "string",
"refer_id": 1,
"region": {
"id": 1,
"last_update": 1,
"name": "string",
"parent_id": 1
},
"sex": "none"
},
"date": 1,
"deleted_mark": true,
"delivery_date": 1,
"delivery_type": {
"id": 1,
"last_update": 1,
"name": "string"
},
"description": "string",
"external_code": "string",
"from": {
"deleted": true,
"id": 1,
"last_update": 1,
"name": "string"
},
"id": 1,
"last_update": 1,
"location": {
"latitude": 1.0,
"longitude": 1.0
},
"operating_cash_id": 1,
"payment_type": {
"account": {
"code": "string",
"currency": {
"code_chr": "string",
"code_num": 1,
"deleted": true,
"exchange_rate": 1.0,
"id": 1,
"is_base": true,
"last_update": 1,
"name": "string"
},
"id": 1,
"last_update": 1,
"name": "string"
},
"enabled": "True",
"id": 1,
"image_url": "string",
"is_cash": true,
"kkm_code": 1,
"last_update": 1,
"name": "string",
"shortkey": 1
},
"phone": "string",
"price_type": {
"currency": {
"code_chr": "string",
"code_num": 1,
"deleted": true,
"exchange_rate": 1.0,
"id": 1,
"is_base": true,
"last_update": 1,
"name": "string"
},
"currency_additional": {
"code_chr": "string",
"code_num": 1,
"deleted": true,
"exchange_rate": 1.0,
"id": 1,
"is_base": true,
"last_update": 1,
"name": "string"
},
"id": 1,
"last_update": 1,
"markup": 1.0,
"max_discount": 1.0,
"name": "string",
"round_to": 1.0
},
"qrcodeurl": "string",
"status": {
"document_type_id": 1,
"id": 1,
"last_update": 1,
"name": "string",
"name_var": "string",
"order": 1
},
"stock": {
"address": "string",
"area": 1.0,
"deleted_mark": true,
"description": "string",
"firm": {
"address": "string",
"bank_name": "string",
"boss_name": "string",
"deleted_mark": true,
"description": "string",
"fullname": "string",
"group": {
"child_count": 1,
"id": 1,
"last_update": 1,
"name": "string",
"parent_id": 1
},
"id": 1,
"inn": "string",
"last_update": 1,
"mfo": "string",
"name": "string",
"oked": "string",
"phones": "string",
"rs": "string",
"vat_index": "string"
},
"id": 1,
"last_update": 1,
"name": "string"
}
}
],
"total": 1
}[POST] .../v1/pos/docorderdelivery/get
Returns retail order documents. Use this POS method to retrieve approved retail order delivery documents that can be picked up by the current cashier's accepted operating cash register. The request requires the retail order select permission and a valid accepted cashier binding for the current request user; the method loads the accepted operating cash register, narrows stock_ids to that register stock, narrows status_ids to Approved and then applies the remaining filters, sort_orders and paging fields from the request. The response returns a paged retail order list with next_offset and total, using the same document schema as DocOrderDelivery/Get. Business errors such as a missing request body, denied access, missing accepted cashier, missing operating cash register, disabled retail-orders tariff, invalid filters, database errors or persistent lookup failures are returned as HTTP 200 ErrorResult.
Request Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| filters | Array of Filter | Optional | Optional filters by fields available for this API method. |
| limit | Int32 | Optional | Maximum number of records to return. |
| offset | Int32 | Optional | Offset from the beginning of the result set. |
| search | String | Optional | Search string. |
| sort_orders | Array of DocOrderDeliveryColumn | Optional | Output parameter sorting. |
Filterable Fields
| Field | Type | Description |
|---|---|---|
| blocked | bool | Document lock: true - locked, false - not locked. |
| code | string | Retail order document code. |
| customer_ids | int | Customer IDs. |
| deleted_mark | bool | Deletion mark: true - marked for deletion, false - not marked. |
| end_date | int | Period end date as Unix time in seconds. |
| external_code | string | Order code in the external system. |
| from_ids | int | Retail order source ID array. |
| ids | int | Retail order document ID array. |
| operating_cash_ids | int | Operating cash ID array. |
| start_date | int | Period start date as Unix time in seconds. |
| status_ids | int | Document status ID array. |
| stock_ids | int | Stock IDs. |
Sortable Fields
| Field |
|---|
| amount |
| blocked |
| card.barcode_value |
| code |
| courier.name |
| customer.name |
| date |
| deleted_mark |
| delivery_date |
| delivery_type.name |
| external_code |
| from.name |
| id |
| last_update |
| operating_cash_id |
| payment_type.name |
| price_type.currency.name |
| price_type.name |
| status.name |
| stock.name |
Request Example
{
"filters": [
{
"Field": "blocked",
"Operator": "Equal",
"Value": "string"
}
],
"limit": 1,
"offset": 1,
"search": "string",
"sort_orders": [
{
"column": "date",
"direction": "ASC"
}
]
}Response Parameters
| Name | Type | Description |
|---|---|---|
| next_offset | Int32 | Offset for the next data page. |
| ok | Boolean | Indicates whether the request completed successfully. |
| result | Array of DocOrderDelivery | Result array. |
| total | Int64 | Total number of result items. |
Response Example
{
"next_offset": 1,
"ok": true,
"result": [
{
"address": "string",
"amount": 1.0,
"blocked": true,
"card": {
"barcode_type": {
"id": 1,
"last_update": 1,
"name": "string"
},
"barcode_value": "string",
"bonus_amount": 1.0,
"customer": {
"address": "string",
"date_of_birth": "string",
"debt": 1.0,
"deleted_mark": true,
"description": "string",
"email": "string",
"fields": [
{
"data_type": "string",
"is_custom": true,
"key": "string",
"metadata": "string",
"name": "string",
"required": true,
"value": "string"
}
],
"first_name": "string",
"full_name": "string",
"group": {
"child_count": 1,
"id": 1,
"last_update": 1,
"name": "string",
"parent_id": 1
},
"id": 1,
"last_name": "string",
"last_purchase": 1,
"last_update": 1,
"main_phone": "string",
"middle_name": "string",
"phones": "string",
"refer_id": 1,
"region": {
"id": 1,
"last_update": 1,
"name": "string",
"parent_id": 1
},
"sex": "none"
},
"date": 1,
"enabled": true,
"expiry_date": "string",
"group": {
"child_count": 1,
"id": 1,
"last_update": 1,
"name": "string",
"parent_id": 1
},
"id": 1,
"last_purchase": 1,
"last_update": 1,
"promo": {
"active": true,
"days": [
1
],
"description": "string",
"end_date": "string",
"end_time": "string",
"id": 1,
"last_update": 1,
"name": "string",
"priority": 1,
"start_date": "string",
"start_time": "string",
"sub_type": 1,
"type": {
"id": 1,
"last_update": 1,
"name": "string"
}
},
"unlimited": true
},
"code": "string",
"courier": {
"description": "string",
"id": 1,
"last_update": 1,
"name": "string"
},
"current_user_blocked": true,
"customer": {
"address": "string",
"date_of_birth": "string",
"debt": 1.0,
"deleted_mark": true,
"description": "string",
"email": "string",
"fields": [
{
"data_type": "string",
"is_custom": true,
"key": "string",
"metadata": "string",
"name": "string",
"required": true,
"value": "string"
}
],
"first_name": "string",
"full_name": "string",
"group": {
"child_count": 1,
"id": 1,
"last_update": 1,
"name": "string",
"parent_id": 1
},
"id": 1,
"last_name": "string",
"last_purchase": 1,
"last_update": 1,
"main_phone": "string",
"middle_name": "string",
"phones": "string",
"refer_id": 1,
"region": {
"id": 1,
"last_update": 1,
"name": "string",
"parent_id": 1
},
"sex": "none"
},
"date": 1,
"deleted_mark": true,
"delivery_date": 1,
"delivery_type": {
"id": 1,
"last_update": 1,
"name": "string"
},
"description": "string",
"external_code": "string",
"from": {
"deleted": true,
"id": 1,
"last_update": 1,
"name": "string"
},
"id": 1,
"last_update": 1,
"location": {
"latitude": 1.0,
"longitude": 1.0
},
"operating_cash_id": 1,
"payment_type": {
"account": {
"code": "string",
"currency": {
"code_chr": "string",
"code_num": 1,
"deleted": true,
"exchange_rate": 1.0,
"id": 1,
"is_base": true,
"last_update": 1,
"name": "string"
},
"id": 1,
"last_update": 1,
"name": "string"
},
"enabled": "True",
"id": 1,
"image_url": "string",
"is_cash": true,
"kkm_code": 1,
"last_update": 1,
"name": "string",
"shortkey": 1
},
"phone": "string",
"price_type": {
"currency": {
"code_chr": "string",
"code_num": 1,
"deleted": true,
"exchange_rate": 1.0,
"id": 1,
"is_base": true,
"last_update": 1,
"name": "string"
},
"currency_additional": {
"code_chr": "string",
"code_num": 1,
"deleted": true,
"exchange_rate": 1.0,
"id": 1,
"is_base": true,
"last_update": 1,
"name": "string"
},
"id": 1,
"last_update": 1,
"markup": 1.0,
"max_discount": 1.0,
"name": "string",
"round_to": 1.0
},
"qrcodeurl": "string",
"status": {
"document_type_id": 1,
"id": 1,
"last_update": 1,
"name": "string",
"name_var": "string",
"order": 1
},
"stock": {
"address": "string",
"area": 1.0,
"deleted_mark": true,
"description": "string",
"firm": {
"address": "string",
"bank_name": "string",
"boss_name": "string",
"deleted_mark": true,
"description": "string",
"fullname": "string",
"group": {
"child_count": 1,
"id": 1,
"last_update": 1,
"name": "string",
"parent_id": 1
},
"id": 1,
"inn": "string",
"last_update": 1,
"mfo": "string",
"name": "string",
"oked": "string",
"phones": "string",
"rs": "string",
"vat_index": "string"
},
"id": 1,
"last_update": 1,
"name": "string"
}
}
],
"total": 1
}