iikoCloud API

Description of common data formats:

uuid - string in UUID(universally unique identifier).
Examples: 550e8400-e29b-41d4-a716-446655440000, b090de0b-8550-6e17-70b2-bbba152bcbd3

date-time - date and time string in custom string format yyyy-MM-dd HH:mm:ss.fff.
Examples: 2017-04-29 20:45:00.000, 2018-01-01 01:01:30.123
More information: https://helloreverb.com
Contact Info: hello@helloreverb.com
Version: 1.0.0
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

Addresses

Authorization

Banquetsreserves

CustomerCategories

Customers

DeliveriesCreateAndUpdate

DeliveriesRetrieve

DeliveryRestrictions

Deprecated

Dictionaries

DiscountsAndPromotions

Drafts

Employees

MarketingSources

Menu

Messages

Notifications

Operations

Orders

Organizations

Report

TerminalGroups

Webhooks

Addresses

Up
post /api/1/cities
Cities. (api1CitiesPost)

Restriction group: Data: geo.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Address.CitiesResponse

Example data

Content-Type: application/json
{
  "cities" : [ {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "items" : [ {
      "isDeleted" : true,
      "classifierId" : "classifierId",
      "name" : "name",
      "additionalInfo" : "additionalInfo",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalRevision" : 0
    }, {
      "isDeleted" : true,
      "classifierId" : "classifierId",
      "name" : "name",
      "additionalInfo" : "additionalInfo",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalRevision" : 0
    } ]
  }, {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "items" : [ {
      "isDeleted" : true,
      "classifierId" : "classifierId",
      "name" : "name",
      "additionalInfo" : "additionalInfo",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalRevision" : 0
    }, {
      "isDeleted" : true,
      "classifierId" : "classifierId",
      "name" : "name",
      "additionalInfo" : "additionalInfo",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalRevision" : 0
    } ]
  } ],
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Address.CitiesResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/regions
Regions. (api1RegionsPost)

Restriction group: Data: geo.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Address.RegionsResponse

Example data

Content-Type: application/json
{
  "regions" : [ {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "items" : [ {
      "isDeleted" : true,
      "name" : "name",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalRevision" : 0
    }, {
      "isDeleted" : true,
      "name" : "name",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalRevision" : 0
    } ]
  }, {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "items" : [ {
      "isDeleted" : true,
      "name" : "name",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalRevision" : 0
    }, {
      "isDeleted" : true,
      "name" : "name",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalRevision" : 0
    } ]
  } ],
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Address.RegionsResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/streets/by_city
Streets by city. (api1StreetsByCityPost)

Restriction group: Data: geo.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Address.StreetsResponse

Example data

Content-Type: application/json
{
  "streets" : [ {
    "isDeleted" : true,
    "classifierId" : "classifierId",
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "externalRevision" : 0
  }, {
    "isDeleted" : true,
    "classifierId" : "classifierId",
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "externalRevision" : 0
  } ],
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Address.StreetsResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/streets/by_id
Streets by id or by classifierId. (api1StreetsByIdPost)

Restriction group: Data: geo.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Address.StreetsByIdResponse

Example data

Content-Type: application/json
{
  "streets" : [ {
    "streetName" : "streetName",
    "cityName" : "cityName",
    "classifierId" : "classifierId",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "cityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "streetName" : "streetName",
    "cityName" : "cityName",
    "classifierId" : "classifierId",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "cityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ],
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Address.StreetsByIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Authorization

Up
post /api/1/access_token
Retrieve session key for API user. (api1AccessTokenPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Auth.GetAccessTokenResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "token" : "token"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Auth.GetAccessTokenResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Banquetsreserves

Up
post /api/1/reserve/add_items
Add order items. (api1ReserveAddItemsPost)

Available only for banquets.

Allowed from version 8.2.6.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Orders: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/reserve/add_payments
Add order payments. (api1ReserveAddPaymentsPost)

Available only for banquets.

Allowed from version 8.2.6.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Order payments: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/reserve/available_organizations
Returns all organizations of current account (determined by Authorization request header) for which banquet/reserve booking are available. (api1ReserveAvailableOrganizationsPost)

Allowed from version 7.1.5.

Restriction group: Orders: preparing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Organizations.GetOrganizationsResponse

Example data

Content-Type: application/json
{
  "organizations" : [ {
    "responseType" : "responseType",
    "code" : "code",
    "name" : "name",
    "externalData" : [ {
      "value" : "value",
      "key" : "key"
    }, {
      "value" : "value",
      "key" : "key"
    } ],
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "responseType" : "responseType",
    "code" : "code",
    "name" : "name",
    "externalData" : [ {
      "value" : "value",
      "key" : "key"
    }, {
      "value" : "value",
      "key" : "key"
    } ],
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ],
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Organizations.GetOrganizationsResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/reserve/available_restaurant_sections
Returns all restaurant sections of specified terminal groups, for which banquet/reserve booking are available. (api1ReserveAvailableRestaurantSectionsPost)

Allowed from version 7.1.5.

Restriction group: Orders: preparing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Reserves.GetRestaurantSectionsResponse

Example data

Content-Type: application/json
{
  "restaurantSections" : [ {
    "schema" : "",
    "tables" : [ {
      "number" : 0,
      "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "isDeleted" : true,
      "name" : "name",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "seatingCapacity" : 6,
      "revision" : 1
    }, {
      "number" : 0,
      "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "isDeleted" : true,
      "name" : "name",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "seatingCapacity" : 6,
      "revision" : 1
    } ],
    "name" : "name",
    "terminalGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "schema" : "",
    "tables" : [ {
      "number" : 0,
      "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "isDeleted" : true,
      "name" : "name",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "seatingCapacity" : 6,
      "revision" : 1
    }, {
      "number" : 0,
      "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "isDeleted" : true,
      "name" : "name",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "seatingCapacity" : 6,
      "revision" : 1
    } ],
    "name" : "name",
    "terminalGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ],
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "revision" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Reserves.GetRestaurantSectionsResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/reserve/available_terminal_groups
Returns all terminal groups of specified organizations, for which banquet/reserve booking are available. (api1ReserveAvailableTerminalGroupsPost)

Allowed from version 7.1.5.

Restriction group: Orders: preparing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Terminals.TerminalGroupsResponse

Example data

Content-Type: application/json
{
  "terminalGroupsInSleep" : [ null, null ],
  "terminalGroups" : [ {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "items" : [ {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "address" : "address",
      "name" : "name",
      "timeZone" : "timeZone",
      "externalData" : [ {
        "value" : "value",
        "key" : "key"
      }, {
        "value" : "value",
        "key" : "key"
      } ],
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    }, {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "address" : "address",
      "name" : "name",
      "timeZone" : "timeZone",
      "externalData" : [ {
        "value" : "value",
        "key" : "key"
      }, {
        "value" : "value",
        "key" : "key"
      } ],
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    } ]
  }, {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "items" : [ {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "address" : "address",
      "name" : "name",
      "timeZone" : "timeZone",
      "externalData" : [ {
        "value" : "value",
        "key" : "key"
      }, {
        "value" : "value",
        "key" : "key"
      } ],
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    }, {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "address" : "address",
      "name" : "name",
      "timeZone" : "timeZone",
      "externalData" : [ {
        "value" : "value",
        "key" : "key"
      }, {
        "value" : "value",
        "key" : "key"
      } ],
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    } ]
  } ],
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Terminals.TerminalGroupsResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/reserve/cancel
Cancel reservation due to some reason. (api1ReserveCancelPost)

Available only for reserves with status 'New'.

Allowed from version 8.2.6.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Order status: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/reserve/create
Create banquet/reserve. (api1ReserveCreatePost)

Allowed from version 7.1.5.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Orders: creating.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Reserves.ReserveResponse

Example data

Content-Type: application/json
{
  "reserveInfo" : "",
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Reserves.ReserveResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/reserve/restaurant_sections_workload
Returns all banquets/reserves for passed restaurant sections. (api1ReserveRestaurantSectionsWorkloadPost)

Allowed from version 7.1.5.

Restriction group: Data: dictionaries.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Reserves.GetRestaurantSectionsWorkloadResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "reserves" : [ {
    "guestsCount" : 6,
    "durationInMinutes" : 0,
    "tableIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "estimatedStartTime" : "2019-08-24 14:15:22.123",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "guestsCount" : 6,
    "durationInMinutes" : 0,
    "tableIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "estimatedStartTime" : "2019-08-24 14:15:22.123",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Reserves.GetRestaurantSectionsWorkloadResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/reserve/status_by_id
Retrieve banquets/reserves statuses by IDs. (api1ReserveStatusByIdPost)

Allowed from version 7.1.5.

Restriction group: Orders: receiving.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Reserves.ReservesResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "reserves" : [ {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "isDeleted" : true,
    "externalNumber" : "externalNumber",
    "creationStatus" : "",
    "reserve" : "",
    "errorInfo" : "",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "timestamp" : 0
  }, {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "isDeleted" : true,
    "externalNumber" : "externalNumber",
    "creationStatus" : "",
    "reserve" : "",
    "errorInfo" : "",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "timestamp" : 0
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Reserves.ReservesResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

CustomerCategories

Up
post /api/1/loyalty/iiko/customer_category/add
Add category for customer. (api1LoyaltyIikoCustomerCategoryAddPost)

Add specified category for customer.

Restriction group: Guests: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoNet.Service.Contracts.Api.iikoTransport.Customer.ChangeCategoryForCustomerResponse

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoNet.Service.Contracts.Api.iikoTransport.Customer.ChangeCategoryForCustomerResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/loyalty/iiko/customer_category
Get customer categories. (api1LoyaltyIikoCustomerCategoryPost)

Get all organization's customer categories.

Restriction group: Loyalty: dictionaries.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoNet.Service.Contracts.Api.iikoTransport.Customer.GetCategoriesResponse

Example data

Content-Type: application/json
{
  "guestCategories" : [ {
    "isDefaultForNewGuests" : true,
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "isActive" : true
  }, {
    "isDefaultForNewGuests" : true,
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "isActive" : true
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoNet.Service.Contracts.Api.iikoTransport.Customer.GetCategoriesResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/loyalty/iiko/customer_category/remove
Remove category for customer. (api1LoyaltyIikoCustomerCategoryRemovePost)

Remove specified category for customer.

Restriction group: Guests: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoNet.Service.Contracts.Api.iikoTransport.Customer.ChangeCategoryForCustomerResponse

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoNet.Service.Contracts.Api.iikoTransport.Customer.ChangeCategoryForCustomerResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Customers

Up
post /api/1/loyalty/iiko/customer/card/add
Add card. (api1LoyaltyIikoCustomerCardAddPost)

Add new card for customer.

Restriction group: Guests: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoNet.Service.Contracts.Api.iikoTransport.Customer.AddMagnetCardResponse

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoNet.Service.Contracts.Api.iikoTransport.Customer.AddMagnetCardResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/loyalty/iiko/customer/card/remove
Delete card. (api1LoyaltyIikoCustomerCardRemovePost)

Delete existing card for customer.

Restriction group: Guests: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoNet.Service.Contracts.Api.iikoTransport.Customer.DeleteMagnetCardResponse

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoNet.Service.Contracts.Api.iikoTransport.Customer.DeleteMagnetCardResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/loyalty/iiko/customer/create_or_update
Create or update customer. (api1LoyaltyIikoCustomerCreateOrUpdatePost)

Create or update customer info by id or phone or card track.

Restriction group: Guests: creating.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoNet.Service.Contracts.Api.iikoTransport.Customer.CreateOrUpdateCustomerResponse

Example data

Content-Type: application/json
{
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoNet.Service.Contracts.Api.iikoTransport.Customer.CreateOrUpdateCustomerResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/loyalty/iiko/customer/info
Get customer info. (api1LoyaltyIikoCustomerInfoPost)

Get customer info by specified criterion.

Restriction group: Guests: info.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoNet.Service.Contracts.Api.iikoTransport.Customer.GetCustomerInfoResponse

Example data

Content-Type: application/json
{
  "birthday" : "2019-08-24 14:15:22.123",
  "shouldReceiveLoyaltyInfo" : true,
  "cards" : [ {
    "number" : "number",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "track" : "track",
    "validToDate" : "2019-08-24 14:15:22.123"
  }, {
    "number" : "number",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "track" : "track",
    "validToDate" : "2019-08-24 14:15:22.123"
  } ],
  "userData" : "userData",
  "cultureName" : "cultureName",
  "anonymized" : true,
  "personalDataConsentTo" : "2019-08-24 14:15:22.123",
  "personalDataProcessingFrom" : "2019-08-24 14:15:22.123",
  "isDeleted" : true,
  "surname" : "surname",
  "consentStatus" : "",
  "personalDataProcessingTo" : "2019-08-24 14:15:22.123",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "categories" : [ {
    "isDefaultForNewGuests" : true,
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "isActive" : true
  }, {
    "isDefaultForNewGuests" : true,
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "isActive" : true
  } ],
  "shouldReceiveOrderStatusInfo" : true,
  "email" : "email",
  "referrerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "shouldReceivePromoActionsInfo" : true,
  "sex" : "",
  "phone" : "phone",
  "walletBalances" : [ {
    "balance" : 0.8008281904610115,
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "type" : ""
  }, {
    "balance" : 0.8008281904610115,
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "type" : ""
  } ],
  "personalDataConsentFrom" : "2019-08-24 14:15:22.123",
  "name" : "name",
  "middleName" : "middleName",
  "comment" : "comment"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoNet.Service.Contracts.Api.iikoTransport.Customer.GetCustomerInfoResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/loyalty/iiko/customer/program/add
Add customer to program. (api1LoyaltyIikoCustomerProgramAddPost)

Add new customer for program.

Restriction group: Guests: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoNet.Service.Contracts.Api.iikoTransport.Customer.AddCustomerToProgramResponse

Example data

Content-Type: application/json
{
  "userWalletId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoNet.Service.Contracts.Api.iikoTransport.Customer.AddCustomerToProgramResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/loyalty/iiko/customer/wallet/cancel_hold
Cancel hold money. (api1LoyaltyIikoCustomerWalletCancelHoldPost)

Cancel holding transaction that created earlier.

Restriction group: Loyalty: wallets.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoNet.Service.Contracts.Api.iikoTransport.Customer.CancelHoldMoneyResponse

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoNet.Service.Contracts.Api.iikoTransport.Customer.CancelHoldMoneyResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/loyalty/iiko/customer/wallet/chargeoff
Withdraw balance. (api1LoyaltyIikoCustomerWalletChargeoffPost)

Withdraw customer balance.

Restriction group: Loyalty: wallets.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoNet.Service.Contracts.Api.iikoTransport.Organization.WithdrawUserBalanceResponse

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoNet.Service.Contracts.Api.iikoTransport.Organization.WithdrawUserBalanceResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/loyalty/iiko/customer/wallet/hold
Hold money. (api1LoyaltyIikoCustomerWalletHoldPost)

Hold customer's money in loyalty program. Payment will be process on POS during processing of an order.

Restriction group: Loyalty: wallets.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoNet.Service.Contracts.Api.iikoTransport.Customer.HoldMoneyResponse

Example data

Content-Type: application/json
{
  "transactionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoNet.Service.Contracts.Api.iikoTransport.Customer.HoldMoneyResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/loyalty/iiko/customer/wallet/topup
Refill balance. (api1LoyaltyIikoCustomerWalletTopupPost)

Refill customer balance.

Restriction group: Loyalty: wallets.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoNet.Service.Contracts.Api.iikoTransport.Organization.RefillUserBalanceResponse

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoNet.Service.Contracts.Api.iikoTransport.Organization.RefillUserBalanceResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

DeliveriesCreateAndUpdate

Up
post /api/1/deliveries/add_items
Add order items. (api1DeliveriesAddItemsPost)

Allowed from version 7.4.6.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Orders: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/add_payments
Add order payments. (api1DeliveriesAddPaymentsPost)

Allowed from version 8.2.6.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Order payments: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/cancel_confirmation
Cancel delivery confirmation. (api1DeliveriesCancelConfirmationPost)

Allowed from version 7.6.1.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Order status: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/cancel
Cancel delivery order. (api1DeliveriesCancelPost)

Allowed from version 7.5.4.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Order status: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/change_comment
Change delivery comment. (api1DeliveriesChangeCommentPost)

Allowed from version 7.6.1.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Orders: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/change_complete_before
Change time when client wants the order to be delivered. (api1DeliveriesChangeCompleteBeforePost)

Allowed from version 7.5.4.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Orders: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/change_delivery_point
Change order's delivery point information. (api1DeliveriesChangeDeliveryPointPost)

Allowed from version 7.5.4.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Orders: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/change_driver_info
Change driver info. (api1DeliveriesChangeDriverInfoPost)

Allowed from version 8.6.6.

This method is a command. Use api/1/commands/status method to get the progress status.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/change_external_data
Change delivery external data. (api1DeliveriesChangeExternalDataPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/change_operator
Assign/change the order operator. (api1DeliveriesChangeOperatorPost)

Allowed from version 7.6.1.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Orders: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/change_payments
Change order's payments. (api1DeliveriesChangePaymentsPost)

Method will fail if there are any processed payments in the order. If all payments in the order are unprocessed they will be removed and replaced with new ones.

Allowed from version 7.6.3.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Order payments: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/change_service_type
Change order's delivery type. (api1DeliveriesChangeServiceTypePost)

Allowed from version 7.5.4.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Orders: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/close
Close order. (api1DeliveriesClosePost)

Before version 8.0.6 it's possible to close deliveries with DeliveryByClient orderServiceType only, starting from version 8.0.6 it's also possible to close DeliveryByCourier deiveries in the DeliveryStatus OnWay or Delivered .

Allowed from version 7.4.6.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Order status: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/confirm
Confirm delivery. (api1DeliveriesConfirmPost)

Allowed from version 7.6.1.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Order status: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/create
Create delivery. (api1DeliveriesCreatePost)

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Orders: creating.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Deliveries.Response.OrderResponse

Example data

Content-Type: application/json
{
  "orderInfo" : "",
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Deliveries.Response.OrderResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/print_delivery_bill
Print delivery bill. (api1DeliveriesPrintDeliveryBillPost)

Allowed from version 7.6.1.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Orders: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/update_order_courier
Update order courier. (api1DeliveriesUpdateOrderCourierPost)

Allowed from version 7.1.5.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Order driver: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/update_order_delivery_status
Update delivery status. (api1DeliveriesUpdateOrderDeliveryStatusPost)

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Order status: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/update_order_payments
Update order payment details. (api1DeliveriesUpdateOrderPaymentsPost)

Deprecated, use api/1/deliveries/change_payments method instead.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Deprecated.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/update_order_problem
Update order problem. (api1DeliveriesUpdateOrderProblemPost)

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Order status: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

DeliveriesRetrieve

Up
post /api/1/deliveries/by_delivery_date_and_phone
Retrieve list of orders by telephone number, dates and revision. (api1DeliveriesByDeliveryDateAndPhonePost)

Restriction group: Orders: receiving.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Deliveries.Response.OrdersWithRevisionResponse

Example data

Content-Type: application/json
{
  "maxRevision" : 0,
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "ordersByOrganizations" : [ {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "orders" : [ {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalNumber" : "externalNumber",
      "creationStatus" : "",
      "errorInfo" : "",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "timestamp" : 0,
      "order" : ""
    }, {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalNumber" : "externalNumber",
      "creationStatus" : "",
      "errorInfo" : "",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "timestamp" : 0,
      "order" : ""
    } ]
  }, {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "orders" : [ {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalNumber" : "externalNumber",
      "creationStatus" : "",
      "errorInfo" : "",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "timestamp" : 0,
      "order" : ""
    }, {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalNumber" : "externalNumber",
      "creationStatus" : "",
      "errorInfo" : "",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "timestamp" : 0,
      "order" : ""
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Deliveries.Response.OrdersWithRevisionResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/by_delivery_date_and_source_key_and_filter
Search orders by search text and additional filters (date, problem, statuses and other). (api1DeliveriesByDeliveryDateAndSourceKeyAndFilterPost)

Restriction group: Orders: receiving.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Deliveries.Response.OrdersWithRevisionResponse

Example data

Content-Type: application/json
{
  "maxRevision" : 0,
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "ordersByOrganizations" : [ {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "orders" : [ {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalNumber" : "externalNumber",
      "creationStatus" : "",
      "errorInfo" : "",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "timestamp" : 0,
      "order" : ""
    }, {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalNumber" : "externalNumber",
      "creationStatus" : "",
      "errorInfo" : "",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "timestamp" : 0,
      "order" : ""
    } ]
  }, {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "orders" : [ {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalNumber" : "externalNumber",
      "creationStatus" : "",
      "errorInfo" : "",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "timestamp" : 0,
      "order" : ""
    }, {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalNumber" : "externalNumber",
      "creationStatus" : "",
      "errorInfo" : "",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "timestamp" : 0,
      "order" : ""
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Deliveries.Response.OrdersWithRevisionResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/by_delivery_date_and_status
Retrieve list of orders by statuses and dates. (api1DeliveriesByDeliveryDateAndStatusPost)

Restriction group: Orders: receiving.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Deliveries.Response.OrdersWithRevisionResponse

Example data

Content-Type: application/json
{
  "maxRevision" : 0,
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "ordersByOrganizations" : [ {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "orders" : [ {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalNumber" : "externalNumber",
      "creationStatus" : "",
      "errorInfo" : "",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "timestamp" : 0,
      "order" : ""
    }, {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalNumber" : "externalNumber",
      "creationStatus" : "",
      "errorInfo" : "",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "timestamp" : 0,
      "order" : ""
    } ]
  }, {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "orders" : [ {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalNumber" : "externalNumber",
      "creationStatus" : "",
      "errorInfo" : "",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "timestamp" : 0,
      "order" : ""
    }, {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalNumber" : "externalNumber",
      "creationStatus" : "",
      "errorInfo" : "",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "timestamp" : 0,
      "order" : ""
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Deliveries.Response.OrdersWithRevisionResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/by_id
Retrieve orders by IDs. (api1DeliveriesByIdPost)

Restriction group: Orders: receiving.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Deliveries.Response.OrdersResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "orders" : [ {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "externalNumber" : "externalNumber",
    "creationStatus" : "",
    "errorInfo" : "",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "timestamp" : 0,
    "order" : ""
  }, {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "externalNumber" : "externalNumber",
    "creationStatus" : "",
    "errorInfo" : "",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "timestamp" : 0,
    "order" : ""
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Deliveries.Response.OrdersResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/by_revision
Retrieve list of orders changed from the time revision was passed. (api1DeliveriesByRevisionPost)

Restriction group: Orders: receiving by revision.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Deliveries.Response.OrdersWithRevisionResponse

Example data

Content-Type: application/json
{
  "maxRevision" : 0,
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "ordersByOrganizations" : [ {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "orders" : [ {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalNumber" : "externalNumber",
      "creationStatus" : "",
      "errorInfo" : "",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "timestamp" : 0,
      "order" : ""
    }, {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalNumber" : "externalNumber",
      "creationStatus" : "",
      "errorInfo" : "",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "timestamp" : 0,
      "order" : ""
    } ]
  }, {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "orders" : [ {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalNumber" : "externalNumber",
      "creationStatus" : "",
      "errorInfo" : "",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "timestamp" : 0,
      "order" : ""
    }, {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalNumber" : "externalNumber",
      "creationStatus" : "",
      "errorInfo" : "",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "timestamp" : 0,
      "order" : ""
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Deliveries.Response.OrdersWithRevisionResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/history/by_delivery_date_and_phone
Retrieve list of history orders by telephone number, dates and revision. (api1DeliveriesHistoryByDeliveryDateAndPhonePost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Deliveries.Response.OrdersWithRevisionResponse

Example data

Content-Type: application/json
{
  "maxRevision" : 0,
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "ordersByOrganizations" : [ {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "orders" : [ {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalNumber" : "externalNumber",
      "creationStatus" : "",
      "errorInfo" : "",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "timestamp" : 0,
      "order" : ""
    }, {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalNumber" : "externalNumber",
      "creationStatus" : "",
      "errorInfo" : "",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "timestamp" : 0,
      "order" : ""
    } ]
  }, {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "orders" : [ {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalNumber" : "externalNumber",
      "creationStatus" : "",
      "errorInfo" : "",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "timestamp" : 0,
      "order" : ""
    }, {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "externalNumber" : "externalNumber",
      "creationStatus" : "",
      "errorInfo" : "",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "timestamp" : 0,
      "order" : ""
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Deliveries.Response.OrdersWithRevisionResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

DeliveryRestrictions

Up
post /api/1/delivery_restrictions/allowed
Get suitable terminal groups for delivery restrictions. (api1DeliveryRestrictionsAllowedPost)

Allowed from version 6.4.16.

Restriction group: Orders: preparing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.DeliveryRestrictions.AllowedRestrictions.GetAllowedRestrictionsResponse

Example data

Content-Type: application/json
{
  "isAllowed" : true,
  "addressExternalId" : "addressExternalId",
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "location" : "",
  "allowedItems" : [ {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "deliveryDurationInMinutes" : 0,
    "zone" : "zone",
    "terminalGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "deliveryServiceProductId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "deliveryDurationInMinutes" : 0,
    "zone" : "zone",
    "terminalGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "deliveryServiceProductId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ],
  "rejectCause" : "rejectCause",
  "rejectedItems" : [ {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "rejectCode" : "",
    "zone" : "zone",
    "rejectItemData" : "",
    "terminalGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "rejectHint" : "rejectHint"
  }, {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "rejectCode" : "",
    "zone" : "zone",
    "rejectItemData" : "",
    "terminalGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "rejectHint" : "rejectHint"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.DeliveryRestrictions.AllowedRestrictions.GetAllowedRestrictionsResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/delivery_restrictions
Retrieve list of delivery restrictions. (api1DeliveryRestrictionsPost)

Allowed from version 6.4.16.

Restriction group: Data: dictionaries.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.DeliveryRestrictions.GetDeliveryRestrictionsResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "deliveryRestrictions" : [ {
    "deliveryGeocodeServiceType" : "",
    "useSameRestrictionsOnAllWeek" : true,
    "externalAssignationServiceUrl" : "externalAssignationServiceUrl",
    "defaultMinSum" : 1.4658129805029452,
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "deliveryRegionsMapUrl" : "deliveryRegionsMapUrl",
    "useSameDeliveryServiceProduct" : true,
    "rejectOnGeocodingError" : true,
    "actionOnValidationRejection" : "",
    "deliveryZones" : [ {
      "addresses" : [ {
        "postcode" : "postcode",
        "houses" : "",
        "streetId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      }, {
        "postcode" : "postcode",
        "houses" : "",
        "streetId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      } ],
      "name" : "name",
      "coordinates" : [ {
        "latitude" : 7.386281948385884,
        "longitude" : 1.2315135367772556
      }, {
        "latitude" : 7.386281948385884,
        "longitude" : 1.2315135367772556
      } ]
    }, {
      "addresses" : [ {
        "postcode" : "postcode",
        "houses" : "",
        "streetId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      }, {
        "postcode" : "postcode",
        "houses" : "",
        "streetId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      } ],
      "name" : "name",
      "coordinates" : [ {
        "latitude" : 7.386281948385884,
        "longitude" : 1.2315135367772556
      }, {
        "latitude" : 7.386281948385884,
        "longitude" : 1.2315135367772556
      } ]
    } ],
    "autoAssignExternalDeliveries" : true,
    "defaultDeliveryServiceProductId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "useSameWorkTimeInterval" : true,
    "defaultFrom" : 5,
    "requireExactAddressForGeocoding" : true,
    "restrictions" : [ {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "deliveryDurationInMinutes" : 4,
      "minSum" : 2.3021358869347655,
      "zone" : "zone",
      "weekMap" : 7,
      "terminalGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "from" : 9,
      "deliveryServiceProductId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "to" : 3,
      "priority" : 2
    }, {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "deliveryDurationInMinutes" : 4,
      "minSum" : 2.3021358869347655,
      "zone" : "zone",
      "weekMap" : 7,
      "terminalGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "from" : 9,
      "deliveryServiceProductId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "to" : 3,
      "priority" : 2
    } ],
    "defaultSelfServiceDurationInMinutes" : 6,
    "defaultTo" : 5,
    "useSameDeliveryDuration" : true,
    "zonesMode" : "",
    "addDeliveryServiceCost" : true,
    "frontTrustsCallCenterCheck" : true,
    "useSameMinSum" : true,
    "defaultDeliveryDurationInMinutes" : 0,
    "useExternalAssignationService" : true
  }, {
    "deliveryGeocodeServiceType" : "",
    "useSameRestrictionsOnAllWeek" : true,
    "externalAssignationServiceUrl" : "externalAssignationServiceUrl",
    "defaultMinSum" : 1.4658129805029452,
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "deliveryRegionsMapUrl" : "deliveryRegionsMapUrl",
    "useSameDeliveryServiceProduct" : true,
    "rejectOnGeocodingError" : true,
    "actionOnValidationRejection" : "",
    "deliveryZones" : [ {
      "addresses" : [ {
        "postcode" : "postcode",
        "houses" : "",
        "streetId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      }, {
        "postcode" : "postcode",
        "houses" : "",
        "streetId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      } ],
      "name" : "name",
      "coordinates" : [ {
        "latitude" : 7.386281948385884,
        "longitude" : 1.2315135367772556
      }, {
        "latitude" : 7.386281948385884,
        "longitude" : 1.2315135367772556
      } ]
    }, {
      "addresses" : [ {
        "postcode" : "postcode",
        "houses" : "",
        "streetId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      }, {
        "postcode" : "postcode",
        "houses" : "",
        "streetId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      } ],
      "name" : "name",
      "coordinates" : [ {
        "latitude" : 7.386281948385884,
        "longitude" : 1.2315135367772556
      }, {
        "latitude" : 7.386281948385884,
        "longitude" : 1.2315135367772556
      } ]
    } ],
    "autoAssignExternalDeliveries" : true,
    "defaultDeliveryServiceProductId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "useSameWorkTimeInterval" : true,
    "defaultFrom" : 5,
    "requireExactAddressForGeocoding" : true,
    "restrictions" : [ {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "deliveryDurationInMinutes" : 4,
      "minSum" : 2.3021358869347655,
      "zone" : "zone",
      "weekMap" : 7,
      "terminalGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "from" : 9,
      "deliveryServiceProductId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "to" : 3,
      "priority" : 2
    }, {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "deliveryDurationInMinutes" : 4,
      "minSum" : 2.3021358869347655,
      "zone" : "zone",
      "weekMap" : 7,
      "terminalGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "from" : 9,
      "deliveryServiceProductId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "to" : 3,
      "priority" : 2
    } ],
    "defaultSelfServiceDurationInMinutes" : 6,
    "defaultTo" : 5,
    "useSameDeliveryDuration" : true,
    "zonesMode" : "",
    "addDeliveryServiceCost" : true,
    "frontTrustsCallCenterCheck" : true,
    "useSameMinSum" : true,
    "defaultDeliveryDurationInMinutes" : 0,
    "useExternalAssignationService" : true
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.DeliveryRestrictions.GetDeliveryRestrictionsResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Deprecated

Up
post /api/1/deliveries/check_create
Check create delivery. (api1DeliveriesCheckCreatePost)

Deprecated, all checks are available in api/1/deliveries/create.

Restriction group: Deprecated.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Deliveries.Response.CheckCreateOrderResponse

Example data

Content-Type: application/json
{
  "errorInfo" : "",
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Deliveries.Response.CheckCreateOrderResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/update_order_payments
Update order payment details. (api1DeliveriesUpdateOrderPaymentsPost)

Deprecated, use api/1/deliveries/change_payments method instead.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Deprecated.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
get /api/1/organizations
Returns organizations available to api-login user. (api1OrganizationsGet)

Deprecated, use POST api/1/organizations.

Restriction group: Data: dictionaries.

Request headers

Return type

iikoTransport.PublicApi.Contracts.Organizations.GetSimpleOrganizationsResponse

Example data

Content-Type: application/json
{
  "organizations" : [ "", "" ],
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Organizations.GetSimpleOrganizationsResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Dictionaries

Up
post /api/1/cancel_causes
Delivery cancel causes. (api1CancelCausesPost)

Allowed from version 7.7.1.

Restriction group: Data: dictionaries.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.CancelCauses.CancelCausesResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "cancelCauses" : [ {
    "isDeleted" : true,
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "isDeleted" : true,
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.CancelCauses.CancelCausesResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/order_types
Order types. (api1DeliveriesOrderTypesPost)

Restriction group: Data: dictionaries.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.OrderTypes.OrderTypesResponse

Example data

Content-Type: application/json
{
  "orderTypes" : [ {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "items" : [ {
      "isDefault" : true,
      "isDeleted" : true,
      "name" : "name",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "orderServiceType" : "",
      "externalRevision" : 0
    }, {
      "isDefault" : true,
      "isDeleted" : true,
      "name" : "name",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "orderServiceType" : "",
      "externalRevision" : 0
    } ]
  }, {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "items" : [ {
      "isDefault" : true,
      "isDeleted" : true,
      "name" : "name",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "orderServiceType" : "",
      "externalRevision" : 0
    }, {
      "isDefault" : true,
      "isDeleted" : true,
      "name" : "name",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "orderServiceType" : "",
      "externalRevision" : 0
    } ]
  } ],
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.OrderTypes.OrderTypesResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/discounts
Discounts / surcharges. (api1DiscountsPost)

Restriction group: Data: dictionaries.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Discounts.DiscountsResponse

Example data

Content-Type: application/json
{
  "discounts" : [ {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "items" : [ {
      "canBeAppliedSelectively" : true,
      "productCategoryDiscounts" : [ {
        "categoryName" : "categoryName",
        "percent" : 6.027456183070403,
        "categoryId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      }, {
        "categoryName" : "categoryName",
        "percent" : 6.027456183070403,
        "categoryId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      } ],
      "isManual" : true,
      "sum" : 5.962133916683182,
      "canApplyByCardNumber" : true,
      "percent" : 0.8008281904610115,
      "mode" : "",
      "isCategorisedDiscount" : true,
      "isDeleted" : true,
      "name" : "name",
      "comment" : "comment",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "isCard" : true,
      "minOrderSum" : 1.4658129805029452,
      "isAutomatic" : true
    }, {
      "canBeAppliedSelectively" : true,
      "productCategoryDiscounts" : [ {
        "categoryName" : "categoryName",
        "percent" : 6.027456183070403,
        "categoryId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      }, {
        "categoryName" : "categoryName",
        "percent" : 6.027456183070403,
        "categoryId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      } ],
      "isManual" : true,
      "sum" : 5.962133916683182,
      "canApplyByCardNumber" : true,
      "percent" : 0.8008281904610115,
      "mode" : "",
      "isCategorisedDiscount" : true,
      "isDeleted" : true,
      "name" : "name",
      "comment" : "comment",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "isCard" : true,
      "minOrderSum" : 1.4658129805029452,
      "isAutomatic" : true
    } ]
  }, {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "items" : [ {
      "canBeAppliedSelectively" : true,
      "productCategoryDiscounts" : [ {
        "categoryName" : "categoryName",
        "percent" : 6.027456183070403,
        "categoryId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      }, {
        "categoryName" : "categoryName",
        "percent" : 6.027456183070403,
        "categoryId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      } ],
      "isManual" : true,
      "sum" : 5.962133916683182,
      "canApplyByCardNumber" : true,
      "percent" : 0.8008281904610115,
      "mode" : "",
      "isCategorisedDiscount" : true,
      "isDeleted" : true,
      "name" : "name",
      "comment" : "comment",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "isCard" : true,
      "minOrderSum" : 1.4658129805029452,
      "isAutomatic" : true
    }, {
      "canBeAppliedSelectively" : true,
      "productCategoryDiscounts" : [ {
        "categoryName" : "categoryName",
        "percent" : 6.027456183070403,
        "categoryId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      }, {
        "categoryName" : "categoryName",
        "percent" : 6.027456183070403,
        "categoryId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      } ],
      "isManual" : true,
      "sum" : 5.962133916683182,
      "canApplyByCardNumber" : true,
      "percent" : 0.8008281904610115,
      "mode" : "",
      "isCategorisedDiscount" : true,
      "isDeleted" : true,
      "name" : "name",
      "comment" : "comment",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "isCard" : true,
      "minOrderSum" : 1.4658129805029452,
      "isAutomatic" : true
    } ]
  } ],
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Discounts.DiscountsResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/payment_types
Payment types. (api1PaymentTypesPost)

Restriction group: Data: dictionaries.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.PaymentTypes.PaymentTypesResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "paymentTypes" : [ {
    "code" : "code",
    "isDeleted" : true,
    "applicableMarketingCampaigns" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "paymentProcessingType" : "",
    "name" : "name",
    "printCheque" : true,
    "terminalGroups" : [ {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "address" : "address",
      "name" : "name",
      "timeZone" : "timeZone",
      "externalData" : [ {
        "value" : "value",
        "key" : "key"
      }, {
        "value" : "value",
        "key" : "key"
      } ],
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    }, {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "address" : "address",
      "name" : "name",
      "timeZone" : "timeZone",
      "externalData" : [ {
        "value" : "value",
        "key" : "key"
      }, {
        "value" : "value",
        "key" : "key"
      } ],
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    } ],
    "comment" : "comment",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "combinable" : true,
    "externalRevision" : 0,
    "paymentTypeKind" : ""
  }, {
    "code" : "code",
    "isDeleted" : true,
    "applicableMarketingCampaigns" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "paymentProcessingType" : "",
    "name" : "name",
    "printCheque" : true,
    "terminalGroups" : [ {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "address" : "address",
      "name" : "name",
      "timeZone" : "timeZone",
      "externalData" : [ {
        "value" : "value",
        "key" : "key"
      }, {
        "value" : "value",
        "key" : "key"
      } ],
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    }, {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "address" : "address",
      "name" : "name",
      "timeZone" : "timeZone",
      "externalData" : [ {
        "value" : "value",
        "key" : "key"
      }, {
        "value" : "value",
        "key" : "key"
      } ],
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    } ],
    "comment" : "comment",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "combinable" : true,
    "externalRevision" : 0,
    "paymentTypeKind" : ""
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.PaymentTypes.PaymentTypesResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/removal_types
Removal types (reasons for deletion). (api1RemovalTypesPost)

Allowed from version 7.5.3.

Restriction group: Data: dictionaries.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.RemovalTypes.RemovalTypesResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "removalTypes" : [ {
    "isDeleted" : true,
    "name" : "name",
    "canWriteoffToCafe" : true,
    "comment" : "comment",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "canWriteoffToWaiter" : true,
    "manual" : true,
    "canWriteoffToUser" : true,
    "reasonRequired" : true
  }, {
    "isDeleted" : true,
    "name" : "name",
    "canWriteoffToCafe" : true,
    "comment" : "comment",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "canWriteoffToWaiter" : true,
    "manual" : true,
    "canWriteoffToUser" : true,
    "reasonRequired" : true
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.RemovalTypes.RemovalTypesResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/tips_types
Get tips types for api-login`s rms group. (api1TipsTypesPost)

Allowed from version 7.7.4.

Restriction group: Data: dictionaries.

Request headers

Return type

iikoTransport.PublicApi.Contracts.TipsTypes.TipsTypesResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "tipsTypes" : [ {
    "orderServiceTypes" : [ "Common", "Common" ],
    "organizationIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "name" : "name",
    "paymentTypesIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "orderServiceTypes" : [ "Common", "Common" ],
    "organizationIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "name" : "name",
    "paymentTypesIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.TipsTypes.TipsTypesResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

DiscountsAndPromotions

Up
post /api/1/loyalty/iiko/calculate
Calculate checkin. (api1LoyaltyIikoCalculatePost)

Calculate discounts and other loyalty items for an order.

Restriction group: Loyalty: order calculate.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.CalculateCheckinResponse

Example data

Content-Type: application/json
{
  "availablePayments" : [ {
    "maxSum" : 1.4658129805029452,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "walletInfos" : [ {
      "canHoldMoney" : true,
      "maxSum" : 5.637376656633329,
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    }, {
      "canHoldMoney" : true,
      "maxSum" : 5.637376656633329,
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    } ],
    "order" : 5
  }, {
    "maxSum" : 1.4658129805029452,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "walletInfos" : [ {
      "canHoldMoney" : true,
      "maxSum" : 5.637376656633329,
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    }, {
      "canHoldMoney" : true,
      "maxSum" : 5.637376656633329,
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    } ],
    "order" : 5
  } ],
  "validationWarnings" : [ "validationWarnings", "validationWarnings" ],
  "loyaltyProgramResults" : [ {
    "discounts" : [ {
      "amount" : 6.027456183070403,
      "code" : "",
      "positionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "orderItemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "comment" : "comment",
      "discountSum" : 0.8008281904610115
    }, {
      "amount" : 6.027456183070403,
      "code" : "",
      "positionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "orderItemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "comment" : "comment",
      "discountSum" : 0.8008281904610115
    } ],
    "availableCombos" : [ {
      "specificationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "groupMapping" : [ {
        "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "groupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      }, {
        "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "groupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      } ]
    }, {
      "specificationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "groupMapping" : [ {
        "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "groupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      }, {
        "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "groupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      } ]
    } ],
    "marketingCampaignId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "name" : "name",
    "upsales" : [ {
      "productCodes" : [ "productCodes", "productCodes" ],
      "sourceActionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "suggestionText" : "suggestionText"
    }, {
      "productCodes" : [ "productCodes", "productCodes" ],
      "sourceActionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "suggestionText" : "suggestionText"
    } ],
    "needToActivateCertificate" : true,
    "freeProducts" : [ {
      "descriptionForUser" : "descriptionForUser",
      "sourceActionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "products" : [ {
        "code" : "code",
        "size" : [ "size", "size" ],
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      }, {
        "code" : "code",
        "size" : [ "size", "size" ],
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      } ]
    }, {
      "descriptionForUser" : "descriptionForUser",
      "sourceActionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "products" : [ {
        "code" : "code",
        "size" : [ "size", "size" ],
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      }, {
        "code" : "code",
        "size" : [ "size", "size" ],
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      } ]
    } ],
    "availableComboSpecifications" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]
  }, {
    "discounts" : [ {
      "amount" : 6.027456183070403,
      "code" : "",
      "positionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "orderItemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "comment" : "comment",
      "discountSum" : 0.8008281904610115
    }, {
      "amount" : 6.027456183070403,
      "code" : "",
      "positionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "orderItemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "comment" : "comment",
      "discountSum" : 0.8008281904610115
    } ],
    "availableCombos" : [ {
      "specificationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "groupMapping" : [ {
        "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "groupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      }, {
        "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "groupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      } ]
    }, {
      "specificationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "groupMapping" : [ {
        "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "groupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      }, {
        "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "groupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      } ]
    } ],
    "marketingCampaignId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "name" : "name",
    "upsales" : [ {
      "productCodes" : [ "productCodes", "productCodes" ],
      "sourceActionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "suggestionText" : "suggestionText"
    }, {
      "productCodes" : [ "productCodes", "productCodes" ],
      "sourceActionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "suggestionText" : "suggestionText"
    } ],
    "needToActivateCertificate" : true,
    "freeProducts" : [ {
      "descriptionForUser" : "descriptionForUser",
      "sourceActionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "products" : [ {
        "code" : "code",
        "size" : [ "size", "size" ],
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      }, {
        "code" : "code",
        "size" : [ "size", "size" ],
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      } ]
    }, {
      "descriptionForUser" : "descriptionForUser",
      "sourceActionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "products" : [ {
        "code" : "code",
        "size" : [ "size", "size" ],
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      }, {
        "code" : "code",
        "size" : [ "size", "size" ],
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      } ]
    } ],
    "availableComboSpecifications" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]
  } ],
  "Warnings" : [ {
    "Message" : "Message",
    "ErrorCode" : "ErrorCode",
    "Code" : "Code"
  }, {
    "Message" : "Message",
    "ErrorCode" : "ErrorCode",
    "Code" : "Code"
  } ],
  "loyaltyTrace" : "loyaltyTrace"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.CalculateCheckinResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/loyalty/iiko/coupons/by_series
Get non-activated coupons (api1LoyaltyIikoCouponsBySeriesPost)

Get list of non-activated coupons.

Restriction group: Loyalty: coupons.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.NotActivatedCouponResponse

Example data

Content-Type: application/json
{
  "notActivatedCoupon" : [ {
    "number" : "number",
    "seriesName" : "seriesName",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "seriesId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "number" : "number",
    "seriesName" : "seriesName",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "seriesId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.NotActivatedCouponResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/loyalty/iiko/coupons/info
Get coupon info. (api1LoyaltyIikoCouponsInfoPost)

Get information about the specified coupon.

Restriction group: Loyalty: coupons.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.CouponInfoResponse

Example data

Content-Type: application/json
{
  "couponInfo" : [ {
    "number" : "number",
    "isDeleted" : true,
    "seriesName" : "seriesName",
    "whenActivated" : "2019-08-24 14:15:22.123",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "seriesId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "number" : "number",
    "isDeleted" : true,
    "seriesName" : "seriesName",
    "whenActivated" : "2019-08-24 14:15:22.123",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "seriesId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.CouponInfoResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/loyalty/iiko/coupons/series
Get coupon series with non-activated coupons. (api1LoyaltyIikoCouponsSeriesPost)

Get a list of coupon series in which there are not deleted and not activated coupons.

Restriction group: Loyalty: coupons.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.SeriesWithNotActivatedCouponsResponse

Example data

Content-Type: application/json
{
  "seriesWithNotActivatedCoupons" : [ {
    "number" : "number",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "number" : "number",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.SeriesWithNotActivatedCouponsResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/loyalty/iiko/manual_condition
Get manual conditions. (api1LoyaltyIikoManualConditionPost)

Get all organization's manual conditions.

Restriction group: Loyalty: dictionaries.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.GetManualConditionsResponse

Example data

Content-Type: application/json
{
  "manualConditions" : [ {
    "isDynamicDiscount" : true,
    "caption" : "caption",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "isDynamicDiscount" : true,
    "caption" : "caption",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.GetManualConditionsResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/loyalty/iiko/program
Get programs. (api1LoyaltyIikoProgramPost)

Get all loyalty programs for organization.

Restriction group: Loyalty: dictionaries.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoNet.Service.Contracts.Api.iikoTransport.Organization.GetProgramsResponse

Example data

Content-Type: application/json
{
  "Programs" : [ {
    "templateType" : "",
    "walletId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "programType" : "",
    "marketingCampaigns" : [ {
      "periodTo" : "2019-08-24 14:15:22.123",
      "overdraftActionConditionBindings" : [ null, null ],
      "name" : "name",
      "description" : "description",
      "periodFrom" : "2019-08-24 14:15:22.123",
      "guestRegistrationActionConditionBindings" : [ null, null ],
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "isActive" : true,
      "programId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "periodicActionConditionBindings" : [ null, null ],
      "orderActionConditionBindings" : [ {
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "conditions" : [ null, null ],
        "stopFurtherExecution" : true,
        "actions" : [ {
          "settings" : "settings",
          "typeName" : "typeName",
          "checkSum" : "checkSum",
          "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        }, {
          "settings" : "settings",
          "typeName" : "typeName",
          "checkSum" : "checkSum",
          "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        } ]
      }, {
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "conditions" : [ null, null ],
        "stopFurtherExecution" : true,
        "actions" : [ {
          "settings" : "settings",
          "typeName" : "typeName",
          "checkSum" : "checkSum",
          "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        }, {
          "settings" : "settings",
          "typeName" : "typeName",
          "checkSum" : "checkSum",
          "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        } ]
      } ]
    }, {
      "periodTo" : "2019-08-24 14:15:22.123",
      "overdraftActionConditionBindings" : [ null, null ],
      "name" : "name",
      "description" : "description",
      "periodFrom" : "2019-08-24 14:15:22.123",
      "guestRegistrationActionConditionBindings" : [ null, null ],
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "isActive" : true,
      "programId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "periodicActionConditionBindings" : [ null, null ],
      "orderActionConditionBindings" : [ {
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "conditions" : [ null, null ],
        "stopFurtherExecution" : true,
        "actions" : [ {
          "settings" : "settings",
          "typeName" : "typeName",
          "checkSum" : "checkSum",
          "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        }, {
          "settings" : "settings",
          "typeName" : "typeName",
          "checkSum" : "checkSum",
          "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        } ]
      }, {
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "conditions" : [ null, null ],
        "stopFurtherExecution" : true,
        "actions" : [ {
          "settings" : "settings",
          "typeName" : "typeName",
          "checkSum" : "checkSum",
          "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        }, {
          "settings" : "settings",
          "typeName" : "typeName",
          "checkSum" : "checkSum",
          "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        } ]
      } ]
    } ],
    "description" : "description",
    "isActive" : true,
    "welcomeBonusSum" : 0.8008281904610115,
    "refillType" : "",
    "isExchangeRateEnabled" : true,
    "serviceFrom" : "2019-08-24 14:15:22.123",
    "name" : "name",
    "hasWelcomeBonus" : true,
    "appliedOrganizations" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "serviceTo" : "2019-08-24 14:15:22.123",
    "notifyAboutBalanceChanges" : true
  }, {
    "templateType" : "",
    "walletId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "programType" : "",
    "marketingCampaigns" : [ {
      "periodTo" : "2019-08-24 14:15:22.123",
      "overdraftActionConditionBindings" : [ null, null ],
      "name" : "name",
      "description" : "description",
      "periodFrom" : "2019-08-24 14:15:22.123",
      "guestRegistrationActionConditionBindings" : [ null, null ],
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "isActive" : true,
      "programId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "periodicActionConditionBindings" : [ null, null ],
      "orderActionConditionBindings" : [ {
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "conditions" : [ null, null ],
        "stopFurtherExecution" : true,
        "actions" : [ {
          "settings" : "settings",
          "typeName" : "typeName",
          "checkSum" : "checkSum",
          "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        }, {
          "settings" : "settings",
          "typeName" : "typeName",
          "checkSum" : "checkSum",
          "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        } ]
      }, {
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "conditions" : [ null, null ],
        "stopFurtherExecution" : true,
        "actions" : [ {
          "settings" : "settings",
          "typeName" : "typeName",
          "checkSum" : "checkSum",
          "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        }, {
          "settings" : "settings",
          "typeName" : "typeName",
          "checkSum" : "checkSum",
          "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        } ]
      } ]
    }, {
      "periodTo" : "2019-08-24 14:15:22.123",
      "overdraftActionConditionBindings" : [ null, null ],
      "name" : "name",
      "description" : "description",
      "periodFrom" : "2019-08-24 14:15:22.123",
      "guestRegistrationActionConditionBindings" : [ null, null ],
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "isActive" : true,
      "programId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "periodicActionConditionBindings" : [ null, null ],
      "orderActionConditionBindings" : [ {
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "conditions" : [ null, null ],
        "stopFurtherExecution" : true,
        "actions" : [ {
          "settings" : "settings",
          "typeName" : "typeName",
          "checkSum" : "checkSum",
          "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        }, {
          "settings" : "settings",
          "typeName" : "typeName",
          "checkSum" : "checkSum",
          "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        } ]
      }, {
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "conditions" : [ null, null ],
        "stopFurtherExecution" : true,
        "actions" : [ {
          "settings" : "settings",
          "typeName" : "typeName",
          "checkSum" : "checkSum",
          "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        }, {
          "settings" : "settings",
          "typeName" : "typeName",
          "checkSum" : "checkSum",
          "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        } ]
      } ]
    } ],
    "description" : "description",
    "isActive" : true,
    "welcomeBonusSum" : 0.8008281904610115,
    "refillType" : "",
    "isExchangeRateEnabled" : true,
    "serviceFrom" : "2019-08-24 14:15:22.123",
    "name" : "name",
    "hasWelcomeBonus" : true,
    "appliedOrganizations" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "serviceTo" : "2019-08-24 14:15:22.123",
    "notifyAboutBalanceChanges" : true
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoNet.Service.Contracts.Api.iikoTransport.Organization.GetProgramsResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Drafts

Up
post /api/1/deliveries/drafts/by_filter
Retrieve order drafts list by parameters. (api1DeliveriesDraftsByFilterPost)

Restriction group: Drafts: receiving.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Deliveries.Drafts.FilterDraftsResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "drafts" : [ {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "createdAt" : "2019-08-24 14:15:22.123",
    "terminalGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "lockedByUser" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "order" : ""
  }, {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "createdAt" : "2019-08-24 14:15:22.123",
    "terminalGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "lockedByUser" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "order" : ""
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Deliveries.Drafts.FilterDraftsResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/drafts/by_id
Retrieve order draft by ID. (api1DeliveriesDraftsByIdPost)

Restriction group: Drafts: receiving.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Deliveries.Drafts.GetDraftResponse

Example data

Content-Type: application/json
{
  "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "createdAt" : "2019-08-24 14:15:22.123",
  "terminalGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "order" : "",
  "lockedByUser" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Deliveries.Drafts.GetDraftResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/drafts/commit
Admit order draft changes and send them to Front. (api1DeliveriesDraftsCommitPost)

Restriction group: Drafts: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Deliveries.Response.OrderResponse

Example data

Content-Type: application/json
{
  "orderInfo" : "",
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Deliveries.Response.OrderResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/drafts/create
Create delivery order draft. (api1DeliveriesDraftsCreatePost)

Restriction group: Drafts: creating.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Deliveries.Drafts.CreateOrSaveDraftResponse

Example data

Content-Type: application/json
{
  "orderId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Deliveries.Drafts.CreateOrSaveDraftResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/drafts/delete
Delete order draft. (api1DeliveriesDraftsDeletePost)

Restriction group: Drafts: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/drafts/lock
Lock order draft. (api1DeliveriesDraftsLockPost)

Restriction group: Drafts: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/drafts/save
Update existing delivery order draft. (api1DeliveriesDraftsSavePost)

Restriction group: Drafts: creating.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Deliveries.Drafts.CreateOrSaveDraftResponse

Example data

Content-Type: application/json
{
  "orderId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Deliveries.Drafts.CreateOrSaveDraftResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/deliveries/drafts/unlock
Unlock order draft. (api1DeliveriesDraftsUnlockPost)

Restriction group: Drafts: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Employees

Up
post /api/1/employees/couriers/active_location/by_terminal
Returns list of all active (courier session is opened) courier's locations which are delivery drivers in specified restaurant and are clocked in on specified delivery terminal. (api1EmployeesCouriersActiveLocationByTerminalPost)

Restriction group: Drivers: location.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Employees.ActiveCourierLocationsResponse

Example data

Content-Type: application/json
{
  "activeCourierLocations" : [ {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "items" : [ {
      "lastActiveClientDate" : "2019-08-24 14:15:22.123",
      "courierId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "lastActiveLatitude" : 0.8008281904610115,
      "lastActiveLongitude" : 6.027456183070403
    }, {
      "lastActiveClientDate" : "2019-08-24 14:15:22.123",
      "courierId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "lastActiveLatitude" : 0.8008281904610115,
      "lastActiveLongitude" : 6.027456183070403
    } ]
  }, {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "items" : [ {
      "lastActiveClientDate" : "2019-08-24 14:15:22.123",
      "courierId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "lastActiveLatitude" : 0.8008281904610115,
      "lastActiveLongitude" : 6.027456183070403
    }, {
      "lastActiveClientDate" : "2019-08-24 14:15:22.123",
      "courierId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "lastActiveLatitude" : 0.8008281904610115,
      "lastActiveLongitude" : 6.027456183070403
    } ]
  } ],
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Employees.ActiveCourierLocationsResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/employees/couriers/active_location
Returns list of all active (courier session is opened) courier's locations which are delivery drivers in specified restaurants. (api1EmployeesCouriersActiveLocationPost)

Restriction group: Drivers: location.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Employees.ActiveCourierLocationsResponse

Example data

Content-Type: application/json
{
  "activeCourierLocations" : [ {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "items" : [ {
      "lastActiveClientDate" : "2019-08-24 14:15:22.123",
      "courierId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "lastActiveLatitude" : 0.8008281904610115,
      "lastActiveLongitude" : 6.027456183070403
    }, {
      "lastActiveClientDate" : "2019-08-24 14:15:22.123",
      "courierId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "lastActiveLatitude" : 0.8008281904610115,
      "lastActiveLongitude" : 6.027456183070403
    } ]
  }, {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "items" : [ {
      "lastActiveClientDate" : "2019-08-24 14:15:22.123",
      "courierId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "lastActiveLatitude" : 0.8008281904610115,
      "lastActiveLongitude" : 6.027456183070403
    }, {
      "lastActiveClientDate" : "2019-08-24 14:15:22.123",
      "courierId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "lastActiveLatitude" : 0.8008281904610115,
      "lastActiveLongitude" : 6.027456183070403
    } ]
  } ],
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Employees.ActiveCourierLocationsResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/employees/couriers/by_role
Returns list of all employees which are delivery drivers in specified restaurants, and checks whether each employee has passed role. (api1EmployeesCouriersByRolePost)

Restriction group: Drivers: dictionaries.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Employees.EmployeesWithRoleSignResponse

Example data

Content-Type: application/json
{
  "employeesWithCheckRoles" : [ {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "items" : [ {
      "firstName" : "firstName",
      "lastName" : "lastName",
      "code" : "code",
      "checkRolesResult" : [ {
        "checkedRoleCode" : "checkedRoleCode",
        "employeeHasRole" : true
      }, {
        "checkedRoleCode" : "checkedRoleCode",
        "employeeHasRole" : true
      } ],
      "isDeleted" : true,
      "displayName" : "displayName",
      "middleName" : "middleName",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    }, {
      "firstName" : "firstName",
      "lastName" : "lastName",
      "code" : "code",
      "checkRolesResult" : [ {
        "checkedRoleCode" : "checkedRoleCode",
        "employeeHasRole" : true
      }, {
        "checkedRoleCode" : "checkedRoleCode",
        "employeeHasRole" : true
      } ],
      "isDeleted" : true,
      "displayName" : "displayName",
      "middleName" : "middleName",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    } ]
  }, {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "items" : [ {
      "firstName" : "firstName",
      "lastName" : "lastName",
      "code" : "code",
      "checkRolesResult" : [ {
        "checkedRoleCode" : "checkedRoleCode",
        "employeeHasRole" : true
      }, {
        "checkedRoleCode" : "checkedRoleCode",
        "employeeHasRole" : true
      } ],
      "isDeleted" : true,
      "displayName" : "displayName",
      "middleName" : "middleName",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    }, {
      "firstName" : "firstName",
      "lastName" : "lastName",
      "code" : "code",
      "checkRolesResult" : [ {
        "checkedRoleCode" : "checkedRoleCode",
        "employeeHasRole" : true
      }, {
        "checkedRoleCode" : "checkedRoleCode",
        "employeeHasRole" : true
      } ],
      "isDeleted" : true,
      "displayName" : "displayName",
      "middleName" : "middleName",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    } ]
  } ],
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Employees.EmployeesWithRoleSignResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/employees/couriers/locations/by_time_offset
Method of obtaining drivers' coordinates history. (api1EmployeesCouriersLocationsByTimeOffsetPost)

Restriction group: Drivers: location.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Employees.CourierLocationsByTimeOffsetResponse

Example data

Content-Type: application/json
{
  "courierLocations" : [ {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "items" : [ {
      "courierId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "locations" : [ {
        "serverTimestamp" : 1,
        "latitude" : 0.8008281904610115,
        "longitude" : 6.027456183070403
      }, {
        "serverTimestamp" : 1,
        "latitude" : 0.8008281904610115,
        "longitude" : 6.027456183070403
      } ]
    }, {
      "courierId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "locations" : [ {
        "serverTimestamp" : 1,
        "latitude" : 0.8008281904610115,
        "longitude" : 6.027456183070403
      }, {
        "serverTimestamp" : 1,
        "latitude" : 0.8008281904610115,
        "longitude" : 6.027456183070403
      } ]
    } ]
  }, {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "items" : [ {
      "courierId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "locations" : [ {
        "serverTimestamp" : 1,
        "latitude" : 0.8008281904610115,
        "longitude" : 6.027456183070403
      }, {
        "serverTimestamp" : 1,
        "latitude" : 0.8008281904610115,
        "longitude" : 6.027456183070403
      } ]
    }, {
      "courierId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "locations" : [ {
        "serverTimestamp" : 1,
        "latitude" : 0.8008281904610115,
        "longitude" : 6.027456183070403
      }, {
        "serverTimestamp" : 1,
        "latitude" : 0.8008281904610115,
        "longitude" : 6.027456183070403
      } ]
    } ]
  } ],
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Employees.CourierLocationsByTimeOffsetResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/employees/couriers
Returns list of all employees which are delivery drivers in specified restaurants. (api1EmployeesCouriersPost)

Restriction group: Drivers: dictionaries.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Employees.EmployeesResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "employees" : [ {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "items" : [ {
      "firstName" : "firstName",
      "lastName" : "lastName",
      "code" : "code",
      "isDeleted" : true,
      "displayName" : "displayName",
      "middleName" : "middleName",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    }, {
      "firstName" : "firstName",
      "lastName" : "lastName",
      "code" : "code",
      "isDeleted" : true,
      "displayName" : "displayName",
      "middleName" : "middleName",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    } ]
  }, {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "items" : [ {
      "firstName" : "firstName",
      "lastName" : "lastName",
      "code" : "code",
      "isDeleted" : true,
      "displayName" : "displayName",
      "middleName" : "middleName",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    }, {
      "firstName" : "firstName",
      "lastName" : "lastName",
      "code" : "code",
      "isDeleted" : true,
      "displayName" : "displayName",
      "middleName" : "middleName",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Employees.EmployeesResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/employees/info
Returns employee info. (api1EmployeesInfoPost)

Restriction group: Employees: dictionaries.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Employees.EmployeeInfoResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "employeeInfo" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Employees.EmployeeInfoResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/employees/shift/clockin
Open personal session. (api1EmployeesShiftClockinPost)

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Employees: shifts.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Employees.ChangePersonalSessionResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Employees.ChangePersonalSessionResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/employees/shift/clockout
Close personal session. (api1EmployeesShiftClockoutPost)

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Employees: shifts.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Employees.ChangePersonalSessionResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Employees.ChangePersonalSessionResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/employees/shift/is_open
Check if personal session is open. (api1EmployeesShiftIsOpenPost)

Restriction group: Employees: shifts.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Employees.GetPersonalSessionInfoResponse

Example data

Content-Type: application/json
{
  "isSessionOpened" : true,
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "error" : "error"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Employees.GetPersonalSessionInfoResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/employees/shifts/by_courier
Get terminal groups where employee session is opened. (api1EmployeesShiftsByCourierPost)

Restriction group: Employees: shifts.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Employees.GetTerminalGroupsOfEmployeeResponse

Example data

Content-Type: application/json
{
  "terminalGroupIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Employees.GetTerminalGroupsOfEmployeeResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

MarketingSources

Up
post /api/1/marketing_sources
Marketing sources. (api1MarketingSourcesPost)

Allowed from version 7.2.5.

Restriction group: Data: dictionaries.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.MarketingSources.MarketingSourcesResponse

Example data

Content-Type: application/json
{
  "marketingSources" : [ {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "isDeleted" : true,
    "attachedSources" : [ "attachedSources", "attachedSources" ],
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "externalRevision" : 0
  }, {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "isDeleted" : true,
    "attachedSources" : [ "attachedSources", "attachedSources" ],
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "externalRevision" : 0
  } ],
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.MarketingSources.MarketingSourcesResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Menu

Up
post /api/1/combo/calculate
Calculate combo price (api1ComboCalculatePost)

Make combo price calculation.

Restriction group: Loyalty: order calculate.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.CalculateComboPriceResponse

Example data

Content-Type: application/json
{
  "price" : 0.8008281904610115,
  "incorrectlyFilledGroups" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.CalculateComboPriceResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/combo
Get combos info (api1ComboPost)

Get all organization's combos.

Restriction group: Data: menu.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.GetCombosInfoResponse

Example data

Content-Type: application/json
{
  "comboCategories" : [ {
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ],
  "comboSpecifications" : [ {
    "name" : "name",
    "lackingGroupsToSuggest" : 6,
    "groups" : [ {
      "name" : "name",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "isMainGroup" : true,
      "products" : [ {
        "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "forbiddenModifiers" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
        "productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "priceModificationAmount" : 1.4658129805029452
      }, {
        "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "forbiddenModifiers" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
        "productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "priceModificationAmount" : 1.4658129805029452
      } ]
    }, {
      "name" : "name",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "isMainGroup" : true,
      "products" : [ {
        "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "forbiddenModifiers" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
        "productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "priceModificationAmount" : 1.4658129805029452
      }, {
        "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "forbiddenModifiers" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
        "productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "priceModificationAmount" : 1.4658129805029452
      } ]
    } ],
    "isActive" : true,
    "priceModification" : 0.8008281904610115,
    "includeModifiers" : true,
    "categoryId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "priceModificationType" : "",
    "startDate" : "2019-08-24 14:15:22.123",
    "sourceActionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "expirationDate" : "2019-08-24 14:15:22.123"
  }, {
    "name" : "name",
    "lackingGroupsToSuggest" : 6,
    "groups" : [ {
      "name" : "name",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "isMainGroup" : true,
      "products" : [ {
        "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "forbiddenModifiers" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
        "productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "priceModificationAmount" : 1.4658129805029452
      }, {
        "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "forbiddenModifiers" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
        "productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "priceModificationAmount" : 1.4658129805029452
      } ]
    }, {
      "name" : "name",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "isMainGroup" : true,
      "products" : [ {
        "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "forbiddenModifiers" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
        "productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "priceModificationAmount" : 1.4658129805029452
      }, {
        "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "forbiddenModifiers" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
        "productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "priceModificationAmount" : 1.4658129805029452
      } ]
    } ],
    "isActive" : true,
    "priceModification" : 0.8008281904610115,
    "includeModifiers" : true,
    "categoryId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "priceModificationType" : "",
    "startDate" : "2019-08-24 14:15:22.123",
    "sourceActionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "expirationDate" : "2019-08-24 14:15:22.123"
  } ],
  "Warnings" : [ {
    "Message" : "Message",
    "ErrorCode" : "ErrorCode",
    "Code" : "Code"
  }, {
    "Message" : "Message",
    "ErrorCode" : "ErrorCode",
    "Code" : "Code"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.GetCombosInfoResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/nomenclature
Menu. (api1NomenclaturePost)

Sourced from RMS Data Exchange Export menu.

Restriction group: Data: menu.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Nomenclature.NomenclatureResponse

Example data

Content-Type: application/json
{
  "productCategories" : [ {
    "isDeleted" : true,
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "isDeleted" : true,
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ],
  "sizes" : [ {
    "isDefault" : true,
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "priority" : 8
  }, {
    "isDefault" : true,
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "priority" : 8
  } ],
  "groups" : [ {
    "code" : "code",
    "seoText" : "seoText",
    "seoDescription" : "seoDescription",
    "description" : "description",
    "isGroupModifier" : true,
    "seoKeywords" : "seoKeywords",
    "seoTitle" : "seoTitle",
    "imageLinks" : [ "imageLinks", "imageLinks" ],
    "tags" : [ "tags", "tags" ],
    "isDeleted" : true,
    "name" : "name",
    "additionalInfo" : "additionalInfo",
    "parentGroup" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "isIncludedInMenu" : true,
    "order" : 0
  }, {
    "code" : "code",
    "seoText" : "seoText",
    "seoDescription" : "seoDescription",
    "description" : "description",
    "isGroupModifier" : true,
    "seoKeywords" : "seoKeywords",
    "seoTitle" : "seoTitle",
    "imageLinks" : [ "imageLinks", "imageLinks" ],
    "tags" : [ "tags", "tags" ],
    "isDeleted" : true,
    "name" : "name",
    "additionalInfo" : "additionalInfo",
    "parentGroup" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "isIncludedInMenu" : true,
    "order" : 0
  } ],
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "products" : [ {
    "fatFullAmount" : 2.3021358869347655,
    "code" : "code",
    "sizePrices" : [ {
      "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "price" : ""
    }, {
      "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "price" : ""
    } ],
    "groupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "fullNameEnglish" : "fullNameEnglish",
    "description" : "description",
    "type" : "type",
    "modifiers" : [ {
      "minAmount" : 7,
      "freeOfChargeAmount" : 1,
      "defaultAmount" : 4,
      "hideIfDefaultAmount" : true,
      "splittable" : true,
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "maxAmount" : 1,
      "required" : true
    }, {
      "minAmount" : 7,
      "freeOfChargeAmount" : 1,
      "defaultAmount" : 4,
      "hideIfDefaultAmount" : true,
      "splittable" : true,
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "maxAmount" : 1,
      "required" : true
    } ],
    "seoKeywords" : "seoKeywords",
    "seoTitle" : "seoTitle",
    "doNotPrintInCheque" : true,
    "productCategoryId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "isDeleted" : true,
    "carbohydratesFullAmount" : 9.301444243932576,
    "paymentSubject" : "paymentSubject",
    "energyAmount" : 5.637376656633329,
    "groupModifiers" : [ {
      "minAmount" : 1,
      "freeOfChargeAmount" : 9,
      "defaultAmount" : 9,
      "hideIfDefaultAmount" : true,
      "childModifiers" : [ {
        "minAmount" : 1,
        "freeOfChargeAmount" : 5,
        "defaultAmount" : 7,
        "hideIfDefaultAmount" : true,
        "splittable" : true,
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "maxAmount" : 4,
        "required" : true
      }, {
        "minAmount" : 1,
        "freeOfChargeAmount" : 5,
        "defaultAmount" : 7,
        "hideIfDefaultAmount" : true,
        "splittable" : true,
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "maxAmount" : 4,
        "required" : true
      } ],
      "splittable" : true,
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "childModifiersHaveMinMaxRestrictions" : true,
      "maxAmount" : 6,
      "required" : true
    }, {
      "minAmount" : 1,
      "freeOfChargeAmount" : 9,
      "defaultAmount" : 9,
      "hideIfDefaultAmount" : true,
      "childModifiers" : [ {
        "minAmount" : 1,
        "freeOfChargeAmount" : 5,
        "defaultAmount" : 7,
        "hideIfDefaultAmount" : true,
        "splittable" : true,
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "maxAmount" : 4,
        "required" : true
      }, {
        "minAmount" : 1,
        "freeOfChargeAmount" : 5,
        "defaultAmount" : 7,
        "hideIfDefaultAmount" : true,
        "splittable" : true,
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "maxAmount" : 4,
        "required" : true
      } ],
      "splittable" : true,
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "childModifiersHaveMinMaxRestrictions" : true,
      "maxAmount" : 6,
      "required" : true
    } ],
    "additionalInfo" : "additionalInfo",
    "fatAmount" : 6.027456183070403,
    "modifierSchemaName" : "modifierSchemaName",
    "parentGroup" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "canSetOpenPrice" : true,
    "carbohydratesAmount" : 5.962133916683182,
    "order" : 6,
    "seoText" : "seoText",
    "orderItemType" : "",
    "seoDescription" : "seoDescription",
    "proteinsAmount" : 1.4658129805029452,
    "weight" : 2.027123023002322,
    "useBalanceForSell" : true,
    "splittable" : true,
    "measureUnit" : "measureUnit",
    "imageLinks" : [ "imageLinks", "imageLinks" ],
    "tags" : [ "tags", "tags" ],
    "energyFullAmount" : 3.616076749251911,
    "modifierSchemaId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "name" : "name",
    "proteinsFullAmount" : 7.061401241503109
  }, {
    "fatFullAmount" : 2.3021358869347655,
    "code" : "code",
    "sizePrices" : [ {
      "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "price" : ""
    }, {
      "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "price" : ""
    } ],
    "groupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "fullNameEnglish" : "fullNameEnglish",
    "description" : "description",
    "type" : "type",
    "modifiers" : [ {
      "minAmount" : 7,
      "freeOfChargeAmount" : 1,
      "defaultAmount" : 4,
      "hideIfDefaultAmount" : true,
      "splittable" : true,
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "maxAmount" : 1,
      "required" : true
    }, {
      "minAmount" : 7,
      "freeOfChargeAmount" : 1,
      "defaultAmount" : 4,
      "hideIfDefaultAmount" : true,
      "splittable" : true,
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "maxAmount" : 1,
      "required" : true
    } ],
    "seoKeywords" : "seoKeywords",
    "seoTitle" : "seoTitle",
    "doNotPrintInCheque" : true,
    "productCategoryId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "isDeleted" : true,
    "carbohydratesFullAmount" : 9.301444243932576,
    "paymentSubject" : "paymentSubject",
    "energyAmount" : 5.637376656633329,
    "groupModifiers" : [ {
      "minAmount" : 1,
      "freeOfChargeAmount" : 9,
      "defaultAmount" : 9,
      "hideIfDefaultAmount" : true,
      "childModifiers" : [ {
        "minAmount" : 1,
        "freeOfChargeAmount" : 5,
        "defaultAmount" : 7,
        "hideIfDefaultAmount" : true,
        "splittable" : true,
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "maxAmount" : 4,
        "required" : true
      }, {
        "minAmount" : 1,
        "freeOfChargeAmount" : 5,
        "defaultAmount" : 7,
        "hideIfDefaultAmount" : true,
        "splittable" : true,
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "maxAmount" : 4,
        "required" : true
      } ],
      "splittable" : true,
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "childModifiersHaveMinMaxRestrictions" : true,
      "maxAmount" : 6,
      "required" : true
    }, {
      "minAmount" : 1,
      "freeOfChargeAmount" : 9,
      "defaultAmount" : 9,
      "hideIfDefaultAmount" : true,
      "childModifiers" : [ {
        "minAmount" : 1,
        "freeOfChargeAmount" : 5,
        "defaultAmount" : 7,
        "hideIfDefaultAmount" : true,
        "splittable" : true,
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "maxAmount" : 4,
        "required" : true
      }, {
        "minAmount" : 1,
        "freeOfChargeAmount" : 5,
        "defaultAmount" : 7,
        "hideIfDefaultAmount" : true,
        "splittable" : true,
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "maxAmount" : 4,
        "required" : true
      } ],
      "splittable" : true,
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "childModifiersHaveMinMaxRestrictions" : true,
      "maxAmount" : 6,
      "required" : true
    } ],
    "additionalInfo" : "additionalInfo",
    "fatAmount" : 6.027456183070403,
    "modifierSchemaName" : "modifierSchemaName",
    "parentGroup" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "canSetOpenPrice" : true,
    "carbohydratesAmount" : 5.962133916683182,
    "order" : 6,
    "seoText" : "seoText",
    "orderItemType" : "",
    "seoDescription" : "seoDescription",
    "proteinsAmount" : 1.4658129805029452,
    "weight" : 2.027123023002322,
    "useBalanceForSell" : true,
    "splittable" : true,
    "measureUnit" : "measureUnit",
    "imageLinks" : [ "imageLinks", "imageLinks" ],
    "tags" : [ "tags", "tags" ],
    "energyFullAmount" : 3.616076749251911,
    "modifierSchemaId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "name" : "name",
    "proteinsFullAmount" : 7.061401241503109
  } ],
  "revision" : 9
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Nomenclature.NomenclatureResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/stop_lists/add
Add items to out-of-stock list. (You should have extra rights to use this method). (api1StopListsAddPost)

Allowed from version 8.6.1.

Restriction group: Data: changing stoplists.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/stop_lists/check
Check items in out-of-stock list. (api1StopListsCheckPost)

Restriction group: Orders: creating.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.StopLists.CheckStopListResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "rejectedItems" : [ {
    "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "balance" : 0.8008281904610115,
    "productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "dateAdd" : "2019-08-24 14:15:22.123",
    "sku" : "sku"
  }, {
    "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "balance" : 0.8008281904610115,
    "productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "dateAdd" : "2019-08-24 14:15:22.123",
    "sku" : "sku"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.StopLists.CheckStopListResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/stop_lists/clear
Clear out-of-stock list. (You should have extra rights to use this method). (api1StopListsClearPost)

Allowed from version 8.6.1.

Restriction group: Data: changing stoplists.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/stop_lists
Out-of-stock items. (api1StopListsPost)

Restriction group: Data: stoplists.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.StopLists.StopListsResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "terminalGroupStopLists" : [ {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "items" : [ {
      "terminalGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "items" : [ {
        "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "balance" : 0.8008281904610115,
        "productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "dateAdd" : "2019-08-24 14:15:22.123",
        "sku" : "sku"
      }, {
        "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "balance" : 0.8008281904610115,
        "productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "dateAdd" : "2019-08-24 14:15:22.123",
        "sku" : "sku"
      } ]
    }, {
      "terminalGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "items" : [ {
        "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "balance" : 0.8008281904610115,
        "productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "dateAdd" : "2019-08-24 14:15:22.123",
        "sku" : "sku"
      }, {
        "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "balance" : 0.8008281904610115,
        "productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "dateAdd" : "2019-08-24 14:15:22.123",
        "sku" : "sku"
      } ]
    } ]
  }, {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "items" : [ {
      "terminalGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "items" : [ {
        "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "balance" : 0.8008281904610115,
        "productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "dateAdd" : "2019-08-24 14:15:22.123",
        "sku" : "sku"
      }, {
        "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "balance" : 0.8008281904610115,
        "productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "dateAdd" : "2019-08-24 14:15:22.123",
        "sku" : "sku"
      } ]
    }, {
      "terminalGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "items" : [ {
        "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "balance" : 0.8008281904610115,
        "productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "dateAdd" : "2019-08-24 14:15:22.123",
        "sku" : "sku"
      }, {
        "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "balance" : 0.8008281904610115,
        "productId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "dateAdd" : "2019-08-24 14:15:22.123",
        "sku" : "sku"
      } ]
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.StopLists.StopListsResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/stop_lists/remove
Remove items from out-of-stock list. (You should have extra rights to use this method). (api1StopListsRemovePost)

Allowed from version 8.6.1.

Restriction group: Data: changing stoplists.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/2/menu/by_id
Retrieve external menu by ID. (api2MenuByIdPost)

Sourced from Web External menu.

Restriction group: Data: menu.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

ExternalMenuPreset

Example data

Content-Type: application/json
{
  "name" : "name",
  "description" : "description",
  "itemCategories" : [ {
    "buttonImageUrl" : "https://102922.selcdn.ru/ecomm/someimage.png",
    "headerImageUrl" : "headerImageUrl",
    "name" : "name",
    "description" : "description",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "items" : [ {
      "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "orderItemType" : "Product",
      "allergenGroups" : [ null, null ],
      "name" : "Chicken Parmegiano",
      "modifierSchemaId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "description" : "Delicate taste, juicy chicken fillet, mushrooms, Cheddar cheese and Mozzarella cheese, oregano, Parmegiano sauce",
      "sku" : "002345-35cm",
      "itemSizes" : [ {
        "buttonImageUrl" : "https://102922.selcdn.ru/ecomm/someimage.png",
        "portionWeightGrams" : 0,
        "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "isDefault" : true,
        "sizeName" : "sizeName",
        "buttonImageCroppedUrl" : [ "https://102922.selcdn.ru/ecomm/someimage.png", "https://102922.selcdn.ru/ecomm/someimage.png" ],
        "sizeCode" : "sizeCode",
        "prices" : [ {
          "organizationId" : "organizationId",
          "price" : 20.5
        }, {
          "organizationId" : "organizationId",
          "price" : 20.5
        } ],
        "itemModifierGroups" : [ {
          "canBeDivided" : true,
          "name" : "name",
          "description" : "description",
          "childModifiersHaveMinMaxRestrictions" : true,
          "sku" : "sku",
          "items" : [ {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          }, {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          } ],
          "itemGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        }, {
          "canBeDivided" : true,
          "name" : "name",
          "description" : "description",
          "childModifiersHaveMinMaxRestrictions" : true,
          "sku" : "sku",
          "items" : [ {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          }, {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          } ],
          "itemGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        } ],
        "sku" : "sku"
      }, {
        "buttonImageUrl" : "https://102922.selcdn.ru/ecomm/someimage.png",
        "portionWeightGrams" : 0,
        "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "isDefault" : true,
        "sizeName" : "sizeName",
        "buttonImageCroppedUrl" : [ "https://102922.selcdn.ru/ecomm/someimage.png", "https://102922.selcdn.ru/ecomm/someimage.png" ],
        "sizeCode" : "sizeCode",
        "prices" : [ {
          "organizationId" : "organizationId",
          "price" : 20.5
        }, {
          "organizationId" : "organizationId",
          "price" : 20.5
        } ],
        "itemModifierGroups" : [ {
          "canBeDivided" : true,
          "name" : "name",
          "description" : "description",
          "childModifiersHaveMinMaxRestrictions" : true,
          "sku" : "sku",
          "items" : [ {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          }, {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          } ],
          "itemGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        }, {
          "canBeDivided" : true,
          "name" : "name",
          "description" : "description",
          "childModifiersHaveMinMaxRestrictions" : true,
          "sku" : "sku",
          "items" : [ {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          }, {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          } ],
          "itemGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        } ],
        "sku" : "sku"
      } ],
      "taxCategory" : {
        "percentage" : 2.302136,
        "name" : "name",
        "id" : "id"
      }
    }, {
      "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "orderItemType" : "Product",
      "allergenGroups" : [ null, null ],
      "name" : "Chicken Parmegiano",
      "modifierSchemaId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "description" : "Delicate taste, juicy chicken fillet, mushrooms, Cheddar cheese and Mozzarella cheese, oregano, Parmegiano sauce",
      "sku" : "002345-35cm",
      "itemSizes" : [ {
        "buttonImageUrl" : "https://102922.selcdn.ru/ecomm/someimage.png",
        "portionWeightGrams" : 0,
        "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "isDefault" : true,
        "sizeName" : "sizeName",
        "buttonImageCroppedUrl" : [ "https://102922.selcdn.ru/ecomm/someimage.png", "https://102922.selcdn.ru/ecomm/someimage.png" ],
        "sizeCode" : "sizeCode",
        "prices" : [ {
          "organizationId" : "organizationId",
          "price" : 20.5
        }, {
          "organizationId" : "organizationId",
          "price" : 20.5
        } ],
        "itemModifierGroups" : [ {
          "canBeDivided" : true,
          "name" : "name",
          "description" : "description",
          "childModifiersHaveMinMaxRestrictions" : true,
          "sku" : "sku",
          "items" : [ {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          }, {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          } ],
          "itemGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        }, {
          "canBeDivided" : true,
          "name" : "name",
          "description" : "description",
          "childModifiersHaveMinMaxRestrictions" : true,
          "sku" : "sku",
          "items" : [ {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          }, {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          } ],
          "itemGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        } ],
        "sku" : "sku"
      }, {
        "buttonImageUrl" : "https://102922.selcdn.ru/ecomm/someimage.png",
        "portionWeightGrams" : 0,
        "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "isDefault" : true,
        "sizeName" : "sizeName",
        "buttonImageCroppedUrl" : [ "https://102922.selcdn.ru/ecomm/someimage.png", "https://102922.selcdn.ru/ecomm/someimage.png" ],
        "sizeCode" : "sizeCode",
        "prices" : [ {
          "organizationId" : "organizationId",
          "price" : 20.5
        }, {
          "organizationId" : "organizationId",
          "price" : 20.5
        } ],
        "itemModifierGroups" : [ {
          "canBeDivided" : true,
          "name" : "name",
          "description" : "description",
          "childModifiersHaveMinMaxRestrictions" : true,
          "sku" : "sku",
          "items" : [ {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          }, {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          } ],
          "itemGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        }, {
          "canBeDivided" : true,
          "name" : "name",
          "description" : "description",
          "childModifiersHaveMinMaxRestrictions" : true,
          "sku" : "sku",
          "items" : [ {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          }, {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          } ],
          "itemGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        } ],
        "sku" : "sku"
      } ],
      "taxCategory" : {
        "percentage" : 2.302136,
        "name" : "name",
        "id" : "id"
      }
    } ]
  }, {
    "buttonImageUrl" : "https://102922.selcdn.ru/ecomm/someimage.png",
    "headerImageUrl" : "headerImageUrl",
    "name" : "name",
    "description" : "description",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "items" : [ {
      "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "orderItemType" : "Product",
      "allergenGroups" : [ null, null ],
      "name" : "Chicken Parmegiano",
      "modifierSchemaId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "description" : "Delicate taste, juicy chicken fillet, mushrooms, Cheddar cheese and Mozzarella cheese, oregano, Parmegiano sauce",
      "sku" : "002345-35cm",
      "itemSizes" : [ {
        "buttonImageUrl" : "https://102922.selcdn.ru/ecomm/someimage.png",
        "portionWeightGrams" : 0,
        "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "isDefault" : true,
        "sizeName" : "sizeName",
        "buttonImageCroppedUrl" : [ "https://102922.selcdn.ru/ecomm/someimage.png", "https://102922.selcdn.ru/ecomm/someimage.png" ],
        "sizeCode" : "sizeCode",
        "prices" : [ {
          "organizationId" : "organizationId",
          "price" : 20.5
        }, {
          "organizationId" : "organizationId",
          "price" : 20.5
        } ],
        "itemModifierGroups" : [ {
          "canBeDivided" : true,
          "name" : "name",
          "description" : "description",
          "childModifiersHaveMinMaxRestrictions" : true,
          "sku" : "sku",
          "items" : [ {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          }, {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          } ],
          "itemGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        }, {
          "canBeDivided" : true,
          "name" : "name",
          "description" : "description",
          "childModifiersHaveMinMaxRestrictions" : true,
          "sku" : "sku",
          "items" : [ {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          }, {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          } ],
          "itemGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        } ],
        "sku" : "sku"
      }, {
        "buttonImageUrl" : "https://102922.selcdn.ru/ecomm/someimage.png",
        "portionWeightGrams" : 0,
        "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "isDefault" : true,
        "sizeName" : "sizeName",
        "buttonImageCroppedUrl" : [ "https://102922.selcdn.ru/ecomm/someimage.png", "https://102922.selcdn.ru/ecomm/someimage.png" ],
        "sizeCode" : "sizeCode",
        "prices" : [ {
          "organizationId" : "organizationId",
          "price" : 20.5
        }, {
          "organizationId" : "organizationId",
          "price" : 20.5
        } ],
        "itemModifierGroups" : [ {
          "canBeDivided" : true,
          "name" : "name",
          "description" : "description",
          "childModifiersHaveMinMaxRestrictions" : true,
          "sku" : "sku",
          "items" : [ {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          }, {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          } ],
          "itemGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        }, {
          "canBeDivided" : true,
          "name" : "name",
          "description" : "description",
          "childModifiersHaveMinMaxRestrictions" : true,
          "sku" : "sku",
          "items" : [ {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          }, {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          } ],
          "itemGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        } ],
        "sku" : "sku"
      } ],
      "taxCategory" : {
        "percentage" : 2.302136,
        "name" : "name",
        "id" : "id"
      }
    }, {
      "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "orderItemType" : "Product",
      "allergenGroups" : [ null, null ],
      "name" : "Chicken Parmegiano",
      "modifierSchemaId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "description" : "Delicate taste, juicy chicken fillet, mushrooms, Cheddar cheese and Mozzarella cheese, oregano, Parmegiano sauce",
      "sku" : "002345-35cm",
      "itemSizes" : [ {
        "buttonImageUrl" : "https://102922.selcdn.ru/ecomm/someimage.png",
        "portionWeightGrams" : 0,
        "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "isDefault" : true,
        "sizeName" : "sizeName",
        "buttonImageCroppedUrl" : [ "https://102922.selcdn.ru/ecomm/someimage.png", "https://102922.selcdn.ru/ecomm/someimage.png" ],
        "sizeCode" : "sizeCode",
        "prices" : [ {
          "organizationId" : "organizationId",
          "price" : 20.5
        }, {
          "organizationId" : "organizationId",
          "price" : 20.5
        } ],
        "itemModifierGroups" : [ {
          "canBeDivided" : true,
          "name" : "name",
          "description" : "description",
          "childModifiersHaveMinMaxRestrictions" : true,
          "sku" : "sku",
          "items" : [ {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          }, {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          } ],
          "itemGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        }, {
          "canBeDivided" : true,
          "name" : "name",
          "description" : "description",
          "childModifiersHaveMinMaxRestrictions" : true,
          "sku" : "sku",
          "items" : [ {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          }, {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          } ],
          "itemGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        } ],
        "sku" : "sku"
      }, {
        "buttonImageUrl" : "https://102922.selcdn.ru/ecomm/someimage.png",
        "portionWeightGrams" : 0,
        "sizeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "isDefault" : true,
        "sizeName" : "sizeName",
        "buttonImageCroppedUrl" : [ "https://102922.selcdn.ru/ecomm/someimage.png", "https://102922.selcdn.ru/ecomm/someimage.png" ],
        "sizeCode" : "sizeCode",
        "prices" : [ {
          "organizationId" : "organizationId",
          "price" : 20.5
        }, {
          "organizationId" : "organizationId",
          "price" : 20.5
        } ],
        "itemModifierGroups" : [ {
          "canBeDivided" : true,
          "name" : "name",
          "description" : "description",
          "childModifiersHaveMinMaxRestrictions" : true,
          "sku" : "sku",
          "items" : [ {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          }, {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          } ],
          "itemGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        }, {
          "canBeDivided" : true,
          "name" : "name",
          "description" : "description",
          "childModifiersHaveMinMaxRestrictions" : true,
          "sku" : "sku",
          "items" : [ {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          }, {
            "buttonImage" : "buttonImage",
            "portionWeightGrams" : 0,
            "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "allergenGroups" : [ {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            }, {
              "code" : "code",
              "name" : "name",
              "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            } ],
            "name" : "name",
            "description" : "description",
            "restrictions" : {
              "minQuantity" : 6,
              "maxQuantity" : 1,
              "byDefault" : 5,
              "freeQuantity" : 5
            },
            "nutritionPerHundredGrams" : { },
            "prices" : [ null, null ],
            "sku" : "sku",
            "tags" : [ {
              "name" : "name",
              "id" : "id"
            }, {
              "name" : "name",
              "id" : "id"
            } ]
          } ],
          "itemGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        } ],
        "sku" : "sku"
      } ],
      "taxCategory" : {
        "percentage" : 2.302136,
        "name" : "name",
        "id" : "id"
      }
    } ]
  } ],
  "id" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ExternalMenuPreset

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/2/menu
External menus with price categories. (api2MenuPost)

Restriction group: Data: menu.

Request headers

Return type

iikoTransport.PublicApi.Contracts.Nomenclature.MenusDataResponse

Example data

Content-Type: application/json
{
  "priceCategories" : [ {
    "name" : "name",
    "id" : "id"
  }, {
    "name" : "name",
    "id" : "id"
  } ],
  "externalMenus" : [ {
    "name" : "name",
    "id" : "id"
  }, {
    "name" : "name",
    "id" : "id"
  } ],
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Nomenclature.MenusDataResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Messages

Up
post /api/1/loyalty/iiko/message/send_email
Send email. (api1LoyaltyIikoMessageSendEmailPost)

Send email message to specified email address. Sending proceed according iikoCard organization's settings.

Restriction group: Loyalty: messages.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoNet.Service.Contracts.Api.iikoTransport.Organization.SendEmailResponse

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoNet.Service.Contracts.Api.iikoTransport.Organization.SendEmailResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/loyalty/iiko/message/send_sms
Send sms. (api1LoyaltyIikoMessageSendSmsPost)

Send sms message to specified phone number. Sending proceed according iikoCard organization's settings.

Restriction group: Loyalty: messages.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoNet.Service.Contracts.Api.iikoTransport.Organization.SendSmsResponse

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoNet.Service.Contracts.Api.iikoTransport.Organization.SendSmsResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Notifications

Up
post /api/1/notifications/send
Send notification to external systems (iikoFront and iikoWeb). (api1NotificationsSendPost)

Restriction group: Notifications.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Operations

Up
post /api/1/commands/status
Get status of command. (api1CommandsStatusPost)

Restriction group: Commands.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Commands.GetCommandStatusResponse

Example data

Content-Type: application/json
{
  "state" : "state"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Commands.GetCommandStatusResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Orders

Up
post /api/1/order/add_customer
Add customer to order. (api1OrderAddCustomerPost)

Allowed from version 7.7.1.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Orders: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/order/add_items
Add order items. (api1OrderAddItemsPost)

Allowed from version 7.4.6.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Orders: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/order/add_payments
Add order payments. (api1OrderAddPaymentsPost)

Allowed from version 8.2.6.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Order payments: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/order/by_id
Retrieve orders by IDs. (api1OrderByIdPost)

Allowed from version 7.4.6.

Restriction group: Orders: receiving.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.TableOrders.Response.TableOrdersResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "orders" : [ {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "externalNumber" : "externalNumber",
    "creationStatus" : "",
    "errorInfo" : "",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "timestamp" : 0,
    "order" : ""
  }, {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "externalNumber" : "externalNumber",
    "creationStatus" : "",
    "errorInfo" : "",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "timestamp" : 0,
    "order" : ""
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.TableOrders.Response.TableOrdersResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/order/by_table
Retrieve orders by tables. (api1OrderByTablePost)

Allowed from version 7.4.6.

Restriction group: Orders: receiving.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.TableOrders.Response.TableOrdersResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "orders" : [ {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "externalNumber" : "externalNumber",
    "creationStatus" : "",
    "errorInfo" : "",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "timestamp" : 0,
    "order" : ""
  }, {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "posId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "externalNumber" : "externalNumber",
    "creationStatus" : "",
    "errorInfo" : "",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "timestamp" : 0,
    "order" : ""
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.TableOrders.Response.TableOrdersResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/order/change_external_data
Change table order external_data. (api1OrderChangeExternalDataPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/order/change_payments
Change table order's payments. (api1OrderChangePaymentsPost)

Method will fail if there are any processed payments in the order. If all payments in the order are unprocessed they will be removed and replaced with new ones.

Allowed from version 7.7.4.

Restriction group: Order payments: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/order/close
Close order. (api1OrderClosePost)

Allowed from version 7.4.6.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Order status: changing.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/order/create
Create order. (api1OrderCreatePost)

Allowed from version 7.4.6.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Orders: creating.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.TableOrders.Response.TableOrderResponse

Example data

Content-Type: application/json
{
  "orderInfo" : "",
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.TableOrders.Response.TableOrderResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/order/init_by_posOrder
Init orders, created on POS, by POS orders. (api1OrderInitByPosOrderPost)

Allowed from version 7.7.1.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Orders: loading data.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/order/init_by_table
Init orders, created on POS, by tables. (api1OrderInitByTablePost)

Allowed from version 7.7.1.

This method is a command. Use api/1/commands/status method to get the progress status.

Restriction group: Orders: loading data.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Organizations

Up
post /api/1/organizations
Returns organizations available to api-login user. (api1OrganizationsPost)

Restriction group: Data: dictionaries.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Organizations.GetOrganizationsResponse

Example data

Content-Type: application/json
{
  "organizations" : [ {
    "responseType" : "responseType",
    "code" : "code",
    "name" : "name",
    "externalData" : [ {
      "value" : "value",
      "key" : "key"
    }, {
      "value" : "value",
      "key" : "key"
    } ],
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "responseType" : "responseType",
    "code" : "code",
    "name" : "name",
    "externalData" : [ {
      "value" : "value",
      "key" : "key"
    }, {
      "value" : "value",
      "key" : "key"
    } ],
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ],
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Organizations.GetOrganizationsResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/organizations/settings
Returns available to api-login user organizations specified settings. (api1OrganizationsSettingsPost)

Restriction group: Organizations: settings.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Organizations.OrganizationsSettingsResponse

Example data

Content-Type: application/json
{
  "organizations" : [ {
    "country" : "country",
    "useBusinessHoursAndMapping" : true,
    "latitude" : 0.8008281904610115,
    "externalData" : [ {
      "value" : "value",
      "key" : "key"
    }, {
      "value" : "value",
      "key" : "key"
    } ],
    "defaultCallCenterPaymentTypeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "loyaltyDiscountAffectsVat" : true,
    "addressFormatType" : "",
    "isAnonymousGuestsAllowed" : true,
    "countryPhoneCode" : "countryPhoneCode",
    "deliveryCityIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "longitude" : 6.027456183070403,
    "orderItemCommentEnabled" : true,
    "defaultDeliveryCityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "useUaeAddressingSystem" : true,
    "addressLookup" : [ "DaData", "DaData" ],
    "version" : "version",
    "deliveryOrderPaymentSettings" : "",
    "pricesVatInclusive" : true,
    "restaurantAddress" : "restaurantAddress",
    "isConfirmationEnabled" : true,
    "name" : "name",
    "marketingSourceRequiredInDelivery" : true,
    "confirmAllowedIntervalInMinutes" : 1,
    "deliveryServiceType" : ""
  }, {
    "country" : "country",
    "useBusinessHoursAndMapping" : true,
    "latitude" : 0.8008281904610115,
    "externalData" : [ {
      "value" : "value",
      "key" : "key"
    }, {
      "value" : "value",
      "key" : "key"
    } ],
    "defaultCallCenterPaymentTypeId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "loyaltyDiscountAffectsVat" : true,
    "addressFormatType" : "",
    "isAnonymousGuestsAllowed" : true,
    "countryPhoneCode" : "countryPhoneCode",
    "deliveryCityIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "longitude" : 6.027456183070403,
    "orderItemCommentEnabled" : true,
    "defaultDeliveryCityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "useUaeAddressingSystem" : true,
    "addressLookup" : [ "DaData", "DaData" ],
    "version" : "version",
    "deliveryOrderPaymentSettings" : "",
    "pricesVatInclusive" : true,
    "restaurantAddress" : "restaurantAddress",
    "isConfirmationEnabled" : true,
    "name" : "name",
    "marketingSourceRequiredInDelivery" : true,
    "confirmAllowedIntervalInMinutes" : 1,
    "deliveryServiceType" : ""
  } ],
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Organizations.OrganizationsSettingsResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Report

Up
post /api/1/loyalty/iiko/customer/transactions/by_date
Get transaction report by period. (api1LoyaltyIikoCustomerTransactionsByDatePost)

Get transaction report for specified customer by provided date range.

Restriction group: Guests: info.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoNet.Service.Contracts.Api.iikoTransport.Report.GetTransactionsReportByPeriodResponse

Example data

Content-Type: application/json
{
  "pageNumber" : 6,
  "pageSize" : 0,
  "items" : [ {
    "balanceBefore" : 6.027456183070403,
    "orderNumber" : 5,
    "marketingCampaignId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "certificate" : "",
    "emitentName" : "emitentName",
    "typeName" : "typeName",
    "sum" : 7.061401241503109,
    "counteragent" : "counteragent",
    "orderSum" : 5.637376656633329,
    "type" : "",
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "loyaltyUser" : "loyaltyUser",
    "nominal" : 1.4658129805029452,
    "balanceAfter" : 0.8008281904610115,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "blockReason" : "blockReason",
    "counteragentType" : "",
    "apiClientLogin" : "apiClientLogin",
    "walletId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "whenCreated" : "2000-01-23T04:56:07.000+00:00",
    "coupon" : "",
    "posBalanceBefore" : 2.3021358869347655,
    "whenCreatedOrder" : "2000-01-23T04:56:07.000+00:00",
    "isIgnored" : true,
    "posOrderId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "revision" : 9,
    "counteragentTypeName" : "counteragentTypeName",
    "isDelivery" : true,
    "terminalGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "comment" : "comment",
    "programId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "balanceBefore" : 6.027456183070403,
    "orderNumber" : 5,
    "marketingCampaignId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "certificate" : "",
    "emitentName" : "emitentName",
    "typeName" : "typeName",
    "sum" : 7.061401241503109,
    "counteragent" : "counteragent",
    "orderSum" : 5.637376656633329,
    "type" : "",
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "loyaltyUser" : "loyaltyUser",
    "nominal" : 1.4658129805029452,
    "balanceAfter" : 0.8008281904610115,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "blockReason" : "blockReason",
    "counteragentType" : "",
    "apiClientLogin" : "apiClientLogin",
    "walletId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "whenCreated" : "2000-01-23T04:56:07.000+00:00",
    "coupon" : "",
    "posBalanceBefore" : 2.3021358869347655,
    "whenCreatedOrder" : "2000-01-23T04:56:07.000+00:00",
    "isIgnored" : true,
    "posOrderId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "revision" : 9,
    "counteragentTypeName" : "counteragentTypeName",
    "isDelivery" : true,
    "terminalGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "comment" : "comment",
    "programId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoNet.Service.Contracts.Api.iikoTransport.Report.GetTransactionsReportByPeriodResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/loyalty/iiko/customer/transactions/by_revision
Get transaction report by revision. (api1LoyaltyIikoCustomerTransactionsByRevisionPost)

Get transaction report for specified customer by provided revision.

Restriction group: Guests: info.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoNet.Service.Contracts.Api.iikoTransport.Report.GetTransactionsReportByRevisionResponse

Example data

Content-Type: application/json
{
  "lastTransactionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "lastRevision" : 3,
  "pageSize" : 2,
  "transactions" : [ {
    "balanceBefore" : 6.027456183070403,
    "orderNumber" : 5,
    "marketingCampaignId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "certificate" : "",
    "emitentName" : "emitentName",
    "typeName" : "typeName",
    "sum" : 7.061401241503109,
    "counteragent" : "counteragent",
    "orderSum" : 5.637376656633329,
    "type" : "",
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "loyaltyUser" : "loyaltyUser",
    "nominal" : 1.4658129805029452,
    "balanceAfter" : 0.8008281904610115,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "blockReason" : "blockReason",
    "counteragentType" : "",
    "apiClientLogin" : "apiClientLogin",
    "walletId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "whenCreated" : "2000-01-23T04:56:07.000+00:00",
    "coupon" : "",
    "posBalanceBefore" : 2.3021358869347655,
    "whenCreatedOrder" : "2000-01-23T04:56:07.000+00:00",
    "isIgnored" : true,
    "posOrderId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "revision" : 9,
    "counteragentTypeName" : "counteragentTypeName",
    "isDelivery" : true,
    "terminalGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "comment" : "comment",
    "programId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "balanceBefore" : 6.027456183070403,
    "orderNumber" : 5,
    "marketingCampaignId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "certificate" : "",
    "emitentName" : "emitentName",
    "typeName" : "typeName",
    "sum" : 7.061401241503109,
    "counteragent" : "counteragent",
    "orderSum" : 5.637376656633329,
    "type" : "",
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "loyaltyUser" : "loyaltyUser",
    "nominal" : 1.4658129805029452,
    "balanceAfter" : 0.8008281904610115,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "blockReason" : "blockReason",
    "counteragentType" : "",
    "apiClientLogin" : "apiClientLogin",
    "walletId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "whenCreated" : "2000-01-23T04:56:07.000+00:00",
    "coupon" : "",
    "posBalanceBefore" : 2.3021358869347655,
    "whenCreatedOrder" : "2000-01-23T04:56:07.000+00:00",
    "isIgnored" : true,
    "posOrderId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "revision" : 9,
    "counteragentTypeName" : "counteragentTypeName",
    "isDelivery" : true,
    "terminalGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "comment" : "comment",
    "programId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoNet.Service.Contracts.Api.iikoTransport.Report.GetTransactionsReportByRevisionResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

TerminalGroups

Up
post /api/1/terminal_groups/awake
Awake terminal groups from sleep mode. (api1TerminalGroupsAwakePost)

Restriction group: Organizations: settings.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Terminals.AwakeTerminalGroupsResponse

Example data

Content-Type: application/json
{
  "failedProcessed" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "successfullyProcessed" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Terminals.AwakeTerminalGroupsResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/terminal_groups/is_alive
Returns information on availability of group of terminals. (api1TerminalGroupsIsAlivePost)

Restriction group: POS: availability.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Terminals.TerminalGroupsIsAliveResponse

Example data

Content-Type: application/json
{
  "isAliveStatus" : [ {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "isAlive" : true,
    "terminalGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "isAlive" : true,
    "terminalGroupId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ],
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Terminals.TerminalGroupsIsAliveResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/terminal_groups
Method that returns information on groups of delivery terminals. (api1TerminalGroupsPost)

Restriction group: Data: dictionaries.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Terminals.TerminalGroupsResponse

Example data

Content-Type: application/json
{
  "terminalGroupsInSleep" : [ null, null ],
  "terminalGroups" : [ {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "items" : [ {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "address" : "address",
      "name" : "name",
      "timeZone" : "timeZone",
      "externalData" : [ {
        "value" : "value",
        "key" : "key"
      }, {
        "value" : "value",
        "key" : "key"
      } ],
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    }, {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "address" : "address",
      "name" : "name",
      "timeZone" : "timeZone",
      "externalData" : [ {
        "value" : "value",
        "key" : "key"
      }, {
        "value" : "value",
        "key" : "key"
      } ],
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    } ]
  }, {
    "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "items" : [ {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "address" : "address",
      "name" : "name",
      "timeZone" : "timeZone",
      "externalData" : [ {
        "value" : "value",
        "key" : "key"
      }, {
        "value" : "value",
        "key" : "key"
      } ],
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    }, {
      "organizationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "address" : "address",
      "name" : "name",
      "timeZone" : "timeZone",
      "externalData" : [ {
        "value" : "value",
        "key" : "key"
      }, {
        "value" : "value",
        "key" : "key"
      } ],
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    } ]
  } ],
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Terminals.TerminalGroupsResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Webhooks

Up
post /api/1/webhooks/settings
Get webhooks settings for specified organization and authorized API login. (api1WebhooksSettingsPost)

Restriction group: Organizations: settings.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.WebHooks.GetWebHookSettingsResponse

Example data

Content-Type: application/json
{
  "webHooksUri" : "webHooksUri",
  "authToken" : "authToken",
  "apiLoginName" : "apiLoginName",
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "webHooksFilter" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.WebHooks.GetWebHookSettingsResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Up
post /api/1/webhooks/update_settings
Update webhooks settings for specified organization and authorized API login. (api1WebhooksUpdateSettingsPost)

Restriction group: Organizations: settings.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

Example data

Content-Type: application/json
{
  "correlationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse

400

Bad Request iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

401

Unauthorized iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

408

Request Timeout iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

500

Server Error iikoTransport.PublicApi.Contracts.Errors.ErrorResponse

Models

[ Jump to Methods ]

Table of Contents

  1. AllergenGroupDto
  2. ExternalMenuPreset
  3. GetExternalMenuWithPriceSourceRequestDto
  4. ModifierRestrictionsDto
  5. NutritionInfoDto
  6. TagDto
  7. TaxCategoryDto
  8. TransportItemDto
  9. TransportItemSizeDto
  10. TransportMenuCategoryDto
  11. TransportModifierGroupDto
  12. TransportModifierItemDto
  13. TransportPriceDto
  14. iikoNet.Common.Enums.RefillType
  15. iikoNet.Common.Enums.TemplateType
  16. iikoNet.Service.Contracts.Api.iikoTransport.Common.GetByOrganizationIdRequest
  17. iikoNet.Service.Contracts.Api.iikoTransport.Customer.AddCustomerToProgramRequest
  18. iikoNet.Service.Contracts.Api.iikoTransport.Customer.AddCustomerToProgramResponse
  19. iikoNet.Service.Contracts.Api.iikoTransport.Customer.AddMagnetCardRequest
  20. iikoNet.Service.Contracts.Api.iikoTransport.Customer.AddMagnetCardResponse
  21. iikoNet.Service.Contracts.Api.iikoTransport.Customer.CancelHoldMoneyRequest
  22. iikoNet.Service.Contracts.Api.iikoTransport.Customer.CancelHoldMoneyResponse
  23. iikoNet.Service.Contracts.Api.iikoTransport.Customer.ChangeCategoryForCustomerRequest
  24. iikoNet.Service.Contracts.Api.iikoTransport.Customer.ChangeCategoryForCustomerResponse
  25. iikoNet.Service.Contracts.Api.iikoTransport.Customer.ChangeUserBalanceRequest
  26. iikoNet.Service.Contracts.Api.iikoTransport.Customer.CreateOrUpdateCustomerRequest
  27. iikoNet.Service.Contracts.Api.iikoTransport.Customer.CreateOrUpdateCustomerResponse
  28. iikoNet.Service.Contracts.Api.iikoTransport.Customer.DeleteMagnetCardRequest
  29. iikoNet.Service.Contracts.Api.iikoTransport.Customer.DeleteMagnetCardResponse
  30. iikoNet.Service.Contracts.Api.iikoTransport.Customer.GetCategoriesRequest
  31. iikoNet.Service.Contracts.Api.iikoTransport.Customer.GetCategoriesResponse
  32. iikoNet.Service.Contracts.Api.iikoTransport.Customer.GetCustomerInfoByCardNumberRequest
  33. iikoNet.Service.Contracts.Api.iikoTransport.Customer.GetCustomerInfoByCardTrackRequest
  34. iikoNet.Service.Contracts.Api.iikoTransport.Customer.GetCustomerInfoByEmailRequest
  35. iikoNet.Service.Contracts.Api.iikoTransport.Customer.GetCustomerInfoByIdRequest
  36. iikoNet.Service.Contracts.Api.iikoTransport.Customer.GetCustomerInfoByPhoneRequest
  37. iikoNet.Service.Contracts.Api.iikoTransport.Customer.GetCustomerInfoRequest
  38. iikoNet.Service.Contracts.Api.iikoTransport.Customer.GetCustomerInfoResponse
  39. iikoNet.Service.Contracts.Api.iikoTransport.Customer.GuestBalanceInfo
  40. iikoNet.Service.Contracts.Api.iikoTransport.Customer.GuestCardInfo
  41. iikoNet.Service.Contracts.Api.iikoTransport.Customer.GuestCategoryShortInfo
  42. iikoNet.Service.Contracts.Api.iikoTransport.Customer.HoldMoneyRequest
  43. iikoNet.Service.Contracts.Api.iikoTransport.Customer.HoldMoneyResponse
  44. iikoNet.Service.Contracts.Api.iikoTransport.Customer.IikoNetUserSex
  45. iikoNet.Service.Contracts.Api.iikoTransport.Customer.PersonalDataConsentStatus
  46. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.AvailableCombo
  47. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.AvailablePayment
  48. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.CalculateCheckinRequest
  49. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.CalculateCheckinResponse
  50. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.CalculateComboPriceRequest
  51. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.CalculateComboPriceResponse
  52. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.ComboCategory
  53. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.ComboGroup
  54. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.ComboGroupMapping
  55. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.ComboPriceModificationType
  56. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.ComboProduct
  57. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.ComboSpecification
  58. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.CouponInfo
  59. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.CouponInfoRequest
  60. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.CouponInfoResponse
  61. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.DiscountOperation
  62. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.DynamicDiscount
  63. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.FreeProduct
  64. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.FreeProductsGroup
  65. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.GetCombosInfoRequest
  66. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.GetCombosInfoResponse
  67. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.GetManualConditionsResponse
  68. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.LoyaltyProgramResult
  69. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.ManualConditionInfo
  70. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.NotActivatedCoupon
  71. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.NotActivatedCouponRequest
  72. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.NotActivatedCouponResponse
  73. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.OperationCode
  74. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.SeriesWithNotActivatedCoupons
  75. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.SeriesWithNotActivatedCouponsRequest
  76. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.SeriesWithNotActivatedCouponsResponse
  77. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.Upsale
  78. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.WalletInfo
  79. iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.WarningInfo
  80. iikoNet.Service.Contracts.Api.iikoTransport.Organization.GetProgramsRequest
  81. iikoNet.Service.Contracts.Api.iikoTransport.Organization.GetProgramsResponse
  82. iikoNet.Service.Contracts.Api.iikoTransport.Organization.LoyaltyProgram
  83. iikoNet.Service.Contracts.Api.iikoTransport.Organization.MarketingCampaignActionConditionBindingInfo
  84. iikoNet.Service.Contracts.Api.iikoTransport.Organization.MarketingCampaignInfo
  85. iikoNet.Service.Contracts.Api.iikoTransport.Organization.MarketingCampaignSettingsInfo
  86. iikoNet.Service.Contracts.Api.iikoTransport.Organization.RefillUserBalanceResponse
  87. iikoNet.Service.Contracts.Api.iikoTransport.Organization.SendEmailRequest
  88. iikoNet.Service.Contracts.Api.iikoTransport.Organization.SendEmailResponse
  89. iikoNet.Service.Contracts.Api.iikoTransport.Organization.SendSmsRequest
  90. iikoNet.Service.Contracts.Api.iikoTransport.Organization.SendSmsResponse
  91. iikoNet.Service.Contracts.Api.iikoTransport.Organization.WithdrawUserBalanceResponse
  92. iikoNet.Service.Contracts.Api.iikoTransport.ProgramType
  93. iikoNet.Service.Contracts.Api.iikoTransport.Report.CertificateCounteragentType
  94. iikoNet.Service.Contracts.Api.iikoTransport.Report.GetTransactionsReportByPeriodRequest
  95. iikoNet.Service.Contracts.Api.iikoTransport.Report.GetTransactionsReportByPeriodResponse
  96. iikoNet.Service.Contracts.Api.iikoTransport.Report.GetTransactionsReportByRevisionRequest
  97. iikoNet.Service.Contracts.Api.iikoTransport.Report.GetTransactionsReportByRevisionResponse
  98. iikoNet.Service.Contracts.Api.iikoTransport.Report.TransactionType
  99. iikoNet.Service.Contracts.Api.iikoTransport.Report.TransportTransactionsCertificateReportItem
  100. iikoNet.Service.Contracts.Api.iikoTransport.Report.TransportTransactionsCouponReportItem
  101. iikoNet.Service.Contracts.Api.iikoTransport.Report.TransportTransactionsReportItem
  102. iikoTransport.PublicApi.Contracts.Address.CitiesRequest
  103. iikoTransport.PublicApi.Contracts.Address.CitiesResponse
  104. iikoTransport.PublicApi.Contracts.Address.City
  105. iikoTransport.PublicApi.Contracts.Address.Region
  106. iikoTransport.PublicApi.Contracts.Address.RegionsRequest
  107. iikoTransport.PublicApi.Contracts.Address.RegionsResponse
  108. iikoTransport.PublicApi.Contracts.Address.Street
  109. iikoTransport.PublicApi.Contracts.Address.StreetById
  110. iikoTransport.PublicApi.Contracts.Address.StreetsByCityRequest
  111. iikoTransport.PublicApi.Contracts.Address.StreetsByIdRequest
  112. iikoTransport.PublicApi.Contracts.Address.StreetsByIdResponse
  113. iikoTransport.PublicApi.Contracts.Address.StreetsResponse
  114. iikoTransport.PublicApi.Contracts.AddressHints.AddressHintsServiceType
  115. iikoTransport.PublicApi.Contracts.Auth.GetAccessTokenRequest
  116. iikoTransport.PublicApi.Contracts.Auth.GetAccessTokenResponse
  117. iikoTransport.PublicApi.Contracts.CancelCauses.CancelCause
  118. iikoTransport.PublicApi.Contracts.CancelCauses.CancelCausesRequest
  119. iikoTransport.PublicApi.Contracts.CancelCauses.CancelCausesResponse
  120. iikoTransport.PublicApi.Contracts.Commands.ErrorCommandStatus
  121. iikoTransport.PublicApi.Contracts.Commands.GetCommandStatusRequest
  122. iikoTransport.PublicApi.Contracts.Commands.GetCommandStatusResponse
  123. iikoTransport.PublicApi.Contracts.Commands.InProgressCommandStatus
  124. iikoTransport.PublicApi.Contracts.Commands.SuccessCommandStatus
  125. iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse
  126. iikoTransport.PublicApi.Contracts.Common.ExternalData
  127. iikoTransport.PublicApi.Contracts.Common.RmsItemsResponseWrapper`1[[iikoTransport.PublicApi.Contracts.Address.City, iikoTransport.PublicApi.Contracts, Version=9.0.6.4, Culture=neutral, PublicKeyToken=null]]
  128. iikoTransport.PublicApi.Contracts.Common.RmsItemsResponseWrapper`1[[iikoTransport.PublicApi.Contracts.Address.Region, iikoTransport.PublicApi.Contracts, Version=9.0.6.4, Culture=neutral, PublicKeyToken=null]]
  129. iikoTransport.PublicApi.Contracts.Common.RmsItemsResponseWrapper`1[[iikoTransport.PublicApi.Contracts.Discounts.DiscountCardTypeInfo, iikoTransport.PublicApi.Contracts, Version=9.0.6.4, Culture=neutral, PublicKeyToken=null]]
  130. iikoTransport.PublicApi.Contracts.Common.RmsItemsResponseWrapper`1[[iikoTransport.PublicApi.Contracts.Employees.ActiveCourierLocation, iikoTransport.PublicApi.Contracts, Version=9.0.6.4, Culture=neutral, PublicKeyToken=null]]
  131. iikoTransport.PublicApi.Contracts.Common.RmsItemsResponseWrapper`1[[iikoTransport.PublicApi.Contracts.Employees.CourierLocations, iikoTransport.PublicApi.Contracts, Version=9.0.6.4, Culture=neutral, PublicKeyToken=null]]
  132. iikoTransport.PublicApi.Contracts.Common.RmsItemsResponseWrapper`1[[iikoTransport.PublicApi.Contracts.Employees.Employee, iikoTransport.PublicApi.Contracts, Version=9.0.6.4, Culture=neutral, PublicKeyToken=null]]
  133. iikoTransport.PublicApi.Contracts.Common.RmsItemsResponseWrapper`1[[iikoTransport.PublicApi.Contracts.Employees.EmployeeWithCheckedRole, iikoTransport.PublicApi.Contracts, Version=9.0.6.4, Culture=neutral, PublicKeyToken=null]]
  134. iikoTransport.PublicApi.Contracts.Common.RmsItemsResponseWrapper`1[[iikoTransport.PublicApi.Contracts.OrderTypes.OrderType, iikoTransport.PublicApi.Contracts, Version=9.0.6.4, Culture=neutral, PublicKeyToken=null]]
  135. iikoTransport.PublicApi.Contracts.Common.RmsItemsResponseWrapper`1[[iikoTransport.PublicApi.Contracts.StopLists.TerminalGroupStopList, iikoTransport.PublicApi.Contracts, Version=9.0.6.4, Culture=neutral, PublicKeyToken=null]]
  136. iikoTransport.PublicApi.Contracts.Common.RmsItemsResponseWrapper`1[[iikoTransport.PublicApi.Contracts.Terminals.TerminalGroup, iikoTransport.PublicApi.Contracts, Version=9.0.6.4, Culture=neutral, PublicKeyToken=null]]
  137. iikoTransport.PublicApi.Contracts.Common.SortDirection
  138. iikoTransport.PublicApi.Contracts.Deliveries.Common.CardPaymentAdditionalData
  139. iikoTransport.PublicApi.Contracts.Deliveries.Common.ChequeAdditionalInfo
  140. iikoTransport.PublicApi.Contracts.Deliveries.Common.Coordinates
  141. iikoTransport.PublicApi.Contracts.Deliveries.Common.DeliveryStatus
  142. iikoTransport.PublicApi.Contracts.Deliveries.Common.DeliveryStatusForUpdate
  143. iikoTransport.PublicApi.Contracts.Deliveries.Common.Gender
  144. iikoTransport.PublicApi.Contracts.Deliveries.Common.IikoCardSearchScope
  145. iikoTransport.PublicApi.Contracts.Deliveries.Common.LoyaltyCardPaymentAdditionalData
  146. iikoTransport.PublicApi.Contracts.Deliveries.Common.OrderServiceType
  147. iikoTransport.PublicApi.Contracts.Deliveries.Common.PaymentAdditionalData
  148. iikoTransport.PublicApi.Contracts.Deliveries.Common.PaymentTypeKind
  149. iikoTransport.PublicApi.Contracts.Deliveries.Drafts.CommitDraftRequest
  150. iikoTransport.PublicApi.Contracts.Deliveries.Drafts.CreateDraftRequest
  151. iikoTransport.PublicApi.Contracts.Deliveries.Drafts.CreateOrSaveDraftResponse
  152. iikoTransport.PublicApi.Contracts.Deliveries.Drafts.DeleteDraftRequest
  153. iikoTransport.PublicApi.Contracts.Deliveries.Drafts.DeliveryOrderDraft
  154. iikoTransport.PublicApi.Contracts.Deliveries.Drafts.FilterDraftsRequest
  155. iikoTransport.PublicApi.Contracts.Deliveries.Drafts.FilterDraftsResponse
  156. iikoTransport.PublicApi.Contracts.Deliveries.Drafts.GetDraftRequest
  157. iikoTransport.PublicApi.Contracts.Deliveries.Drafts.GetDraftResponse
  158. iikoTransport.PublicApi.Contracts.Deliveries.Drafts.LockOrUnlockDraftRequest
  159. iikoTransport.PublicApi.Contracts.Deliveries.Drafts.OrderDraft
  160. iikoTransport.PublicApi.Contracts.Deliveries.Drafts.OrderDraftSortProperty
  161. iikoTransport.PublicApi.Contracts.Deliveries.Drafts.SaveDraftRequest
  162. iikoTransport.PublicApi.Contracts.Deliveries.Request.AddOrderItemsRequest
  163. iikoTransport.PublicApi.Contracts.Deliveries.Request.CancelOrderRequest
  164. iikoTransport.PublicApi.Contracts.Deliveries.Request.ChangeDriverInfoRequest
  165. iikoTransport.PublicApi.Contracts.Deliveries.Request.CloseDeliveryOrderRequest
  166. iikoTransport.PublicApi.Contracts.Deliveries.Request.CloseTableOrderRequest
  167. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.Address
  168. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.AddressCity
  169. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.AddressLegacy
  170. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.AnonymousCustomer
  171. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.CardPayment
  172. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.CardTipsPayment
  173. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.CashPayment
  174. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.CashTipsPayment
  175. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.Combo
  176. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.ComboItemInformation
  177. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.CompoundOrderItem
  178. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.CompoundOrderItemComponent
  179. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.Customer
  180. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.DeliveryOrder
  181. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.DeliveryPoint
  182. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.Discount
  183. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.DiscountCard
  184. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.DiscountsInfo
  185. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.ExternalData
  186. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.ExternalPayment
  187. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.ExternalTipsPayment
  188. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.Guests
  189. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.IikoCardDiscount
  190. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.IikoCardDiscountItem
  191. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.LoyaltyCardPayment
  192. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.LoyaltyInfo
  193. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.Modifier
  194. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.Order
  195. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.OrderItem
  196. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.OrderServiceType
  197. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.Payment
  198. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.ProductOrderItem
  199. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.RegularCustomer
  200. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.RmsDiscount
  201. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.Street
  202. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.TipsPayment
  203. iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrderRequest
  204. iikoTransport.PublicApi.Contracts.Deliveries.Request.OrderSortProperty
  205. iikoTransport.PublicApi.Contracts.Deliveries.Request.OrdersByDeliveryDateAndFilterRequest
  206. iikoTransport.PublicApi.Contracts.Deliveries.Request.OrdersByDeliveryDateAndPhoneRequest
  207. iikoTransport.PublicApi.Contracts.Deliveries.Request.OrdersByDeliveryDateAndStatusRequest
  208. iikoTransport.PublicApi.Contracts.Deliveries.Request.OrdersByIdRequest
  209. iikoTransport.PublicApi.Contracts.Deliveries.Request.OrdersByRevisionRequest
  210. iikoTransport.PublicApi.Contracts.Deliveries.Request.OrdersHistoryByDeliveryDateAndPhoneRequest
  211. iikoTransport.PublicApi.Contracts.Deliveries.Request.PrintDeliveryBillRequest
  212. iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateDeliveryStatusRequest
  213. iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrder.CancelDeliveryConfirmationRequest
  214. iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrder.ChangeCompleteBeforeRequest
  215. iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrder.ChangeDeliveryCommentRequest
  216. iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrder.ChangeDeliveryOperatorRequest
  217. iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrder.ChangeDeliveryPointRequest
  218. iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrder.ChangeExternalDataRequest
  219. iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrder.ChangePaymentsRequest
  220. iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrder.ChangeServiceTypeDeliveryByClient
  221. iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrder.ChangeServiceTypeDeliveryByCourier
  222. iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrder.ChangeServiceTypeRequest
  223. iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrder.ConfirmDeliveryRequest
  224. iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrder.OrderPaymentItem
  225. iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrderCourierRequest
  226. iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrderPaymentsRequest
  227. iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrderProblemRequest
  228. iikoTransport.PublicApi.Contracts.Deliveries.Response.CheckCreateOrderResponse
  229. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.Address
  230. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.AnonymousCustomer
  231. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.CancelCause
  232. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.CancelInfo
  233. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.City
  234. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.ComboItemInformation
  235. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.CompoundItemTemplate
  236. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.CompoundOrderItem
  237. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.CompoundOrderItemComponent
  238. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.Conception
  239. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.CourierInfo
  240. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.CreationStatus
  241. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.Customer
  242. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.DeletionMethod
  243. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.DeliveryPoint
  244. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.DiscountItem
  245. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.DiscountType
  246. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.Employee
  247. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.ExternalCourierService
  248. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.ExternalData
  249. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.GuestsInfo
  250. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.ItemDeletedInfo
  251. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.LoyaltyInfo
  252. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.MarketingSource
  253. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.Order
  254. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.OrderCombo
  255. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.OrderInfo
  256. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.OrderItem
  257. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.OrderItemModifier
  258. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.OrderItemStatus
  259. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.OrderStatus
  260. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.OrderType
  261. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.PaymentItem
  262. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.PaymentType
  263. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.PositionWithSum
  264. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.Problem
  265. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.Product
  266. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.ProductGroup
  267. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.ProductOrderItem
  268. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.ProductSize
  269. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.Region
  270. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.RegularCustomer
  271. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.RemovalType
  272. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.ServiceOrderItem
  273. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.Street
  274. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.TipsPaymentItem
  275. iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.TipsType
  276. iikoTransport.PublicApi.Contracts.Deliveries.Response.OrderResponse
  277. iikoTransport.PublicApi.Contracts.Deliveries.Response.OrdersByOrganization
  278. iikoTransport.PublicApi.Contracts.Deliveries.Response.OrdersResponse
  279. iikoTransport.PublicApi.Contracts.Deliveries.Response.OrdersWithRevisionResponse
  280. iikoTransport.PublicApi.Contracts.DeliveryRestrictions.ActionOnValidationRejection
  281. iikoTransport.PublicApi.Contracts.DeliveryRestrictions.AllowedRestrictions.AllowedItemWithDuration
  282. iikoTransport.PublicApi.Contracts.DeliveryRestrictions.AllowedRestrictions.DeliveryRestrictionRejectCode
  283. iikoTransport.PublicApi.Contracts.DeliveryRestrictions.AllowedRestrictions.GetAllowedRestrictionsRequest
  284. iikoTransport.PublicApi.Contracts.DeliveryRestrictions.AllowedRestrictions.GetAllowedRestrictionsResponse
  285. iikoTransport.PublicApi.Contracts.DeliveryRestrictions.AllowedRestrictions.OrderLocation
  286. iikoTransport.PublicApi.Contracts.DeliveryRestrictions.AllowedRestrictions.RejectItem
  287. iikoTransport.PublicApi.Contracts.DeliveryRestrictions.AllowedRestrictions.RejectItemData
  288. iikoTransport.PublicApi.Contracts.DeliveryRestrictions.AllowedRestrictions.RestrictionsAddress
  289. iikoTransport.PublicApi.Contracts.DeliveryRestrictions.AllowedRestrictions.RestrictionsOrderItem
  290. iikoTransport.PublicApi.Contracts.DeliveryRestrictions.AllowedRestrictions.RestrictionsOrderItemModifier
  291. iikoTransport.PublicApi.Contracts.DeliveryRestrictions.Coordinates
  292. iikoTransport.PublicApi.Contracts.DeliveryRestrictions.DeliveryGeocodeServiceType
  293. iikoTransport.PublicApi.Contracts.DeliveryRestrictions.DeliveryRestrictionItem
  294. iikoTransport.PublicApi.Contracts.DeliveryRestrictions.DeliveryRestrictions
  295. iikoTransport.PublicApi.Contracts.DeliveryRestrictions.DeliveryRestrictionsMode
  296. iikoTransport.PublicApi.Contracts.DeliveryRestrictions.DeliveryZone
  297. iikoTransport.PublicApi.Contracts.DeliveryRestrictions.DeliveryZoneAddressBinding
  298. iikoTransport.PublicApi.Contracts.DeliveryRestrictions.GetDeliveryRestrictionsRequest
  299. iikoTransport.PublicApi.Contracts.DeliveryRestrictions.GetDeliveryRestrictionsResponse
  300. iikoTransport.PublicApi.Contracts.DeliveryRestrictions.HousesRange
  301. iikoTransport.PublicApi.Contracts.DeliveryRestrictions.HousesRangeType
  302. iikoTransport.PublicApi.Contracts.Discounts.DiscountCardMode
  303. iikoTransport.PublicApi.Contracts.Discounts.DiscountCardTypeInfo
  304. iikoTransport.PublicApi.Contracts.Discounts.DiscountsRequest
  305. iikoTransport.PublicApi.Contracts.Discounts.DiscountsResponse
  306. iikoTransport.PublicApi.Contracts.Discounts.ProductCategoryDiscount
  307. iikoTransport.PublicApi.Contracts.Employees.ActiveCourierLocation
  308. iikoTransport.PublicApi.Contracts.Employees.ActiveCourierLocationsByTerminalGroupRequest
  309. iikoTransport.PublicApi.Contracts.Employees.ActiveCourierLocationsResponse
  310. iikoTransport.PublicApi.Contracts.Employees.ChangePersonalSessionResponse
  311. iikoTransport.PublicApi.Contracts.Employees.ClosePersonalSessionRequest
  312. iikoTransport.PublicApi.Contracts.Employees.CoordinateInfo
  313. iikoTransport.PublicApi.Contracts.Employees.CourierLocations
  314. iikoTransport.PublicApi.Contracts.Employees.CourierLocationsByTimeOffsetRequest
  315. iikoTransport.PublicApi.Contracts.Employees.CourierLocationsByTimeOffsetResponse
  316. iikoTransport.PublicApi.Contracts.Employees.CouriersAndCheckRoleRequest
  317. iikoTransport.PublicApi.Contracts.Employees.CouriersRequest
  318. iikoTransport.PublicApi.Contracts.Employees.Employee
  319. iikoTransport.PublicApi.Contracts.Employees.EmployeeInfo
  320. iikoTransport.PublicApi.Contracts.Employees.EmployeeInfoRequest
  321. iikoTransport.PublicApi.Contracts.Employees.EmployeeInfoResponse
  322. iikoTransport.PublicApi.Contracts.Employees.EmployeeWithCheckedRole
  323. iikoTransport.PublicApi.Contracts.Employees.EmployeesResponse
  324. iikoTransport.PublicApi.Contracts.Employees.EmployeesWithRoleSignResponse
  325. iikoTransport.PublicApi.Contracts.Employees.GetPersonalSessionInfoRequest
  326. iikoTransport.PublicApi.Contracts.Employees.GetPersonalSessionInfoResponse
  327. iikoTransport.PublicApi.Contracts.Employees.GetTerminalGroupsOfEmployeeRequest
  328. iikoTransport.PublicApi.Contracts.Employees.GetTerminalGroupsOfEmployeeResponse
  329. iikoTransport.PublicApi.Contracts.Employees.OpenPersonalSessionRequest
  330. iikoTransport.PublicApi.Contracts.Employees.PersonalShift
  331. iikoTransport.PublicApi.Contracts.Employees.RoleCheckResult
  332. iikoTransport.PublicApi.Contracts.Errors.ErrorCode
  333. iikoTransport.PublicApi.Contracts.Errors.ErrorInfo
  334. iikoTransport.PublicApi.Contracts.Errors.ErrorResponse
  335. iikoTransport.PublicApi.Contracts.Integration.WebHooksFilters.DeliveryOrderWebHooksFilter
  336. iikoTransport.PublicApi.Contracts.Integration.WebHooksFilters.ReserveWebHookFilter
  337. iikoTransport.PublicApi.Contracts.Integration.WebHooksFilters.TableOrderWebHookFilter
  338. iikoTransport.PublicApi.Contracts.Integration.WebHooksFilters.WebHookShortFilter
  339. iikoTransport.PublicApi.Contracts.Integration.WebHooksFilters.WebHooksFilter
  340. iikoTransport.PublicApi.Contracts.MarketingSources.MarketingSource
  341. iikoTransport.PublicApi.Contracts.MarketingSources.MarketingSourcesRequest
  342. iikoTransport.PublicApi.Contracts.MarketingSources.MarketingSourcesResponse
  343. iikoTransport.PublicApi.Contracts.Metrics.ActionType
  344. iikoTransport.PublicApi.Contracts.Metrics.CallCenterAction
  345. iikoTransport.PublicApi.Contracts.Metrics.CallCenterTelemetry
  346. iikoTransport.PublicApi.Contracts.Nomenclature.ChildModifierInfo
  347. iikoTransport.PublicApi.Contracts.Nomenclature.ExternalMenu
  348. iikoTransport.PublicApi.Contracts.Nomenclature.GroupModifierInfo
  349. iikoTransport.PublicApi.Contracts.Nomenclature.MenuRequest
  350. iikoTransport.PublicApi.Contracts.Nomenclature.MenusDataResponse
  351. iikoTransport.PublicApi.Contracts.Nomenclature.NomenclatureRequest
  352. iikoTransport.PublicApi.Contracts.Nomenclature.NomenclatureResponse
  353. iikoTransport.PublicApi.Contracts.Nomenclature.OrderItemType
  354. iikoTransport.PublicApi.Contracts.Nomenclature.Price
  355. iikoTransport.PublicApi.Contracts.Nomenclature.PriceCategory
  356. iikoTransport.PublicApi.Contracts.Nomenclature.ProductCategoryInfo
  357. iikoTransport.PublicApi.Contracts.Nomenclature.ProductInfo
  358. iikoTransport.PublicApi.Contracts.Nomenclature.ProductsGroupInfo
  359. iikoTransport.PublicApi.Contracts.Nomenclature.SimpleModifierInfo
  360. iikoTransport.PublicApi.Contracts.Nomenclature.Size
  361. iikoTransport.PublicApi.Contracts.Nomenclature.SizePrice
  362. iikoTransport.PublicApi.Contracts.Notifications.DeliveryAttentionNotificationRequest
  363. iikoTransport.PublicApi.Contracts.Notifications.ExternalCourierArrivedNotificationRequest
  364. iikoTransport.PublicApi.Contracts.Notifications.ExternalCourierAssignedNotificationRequest
  365. iikoTransport.PublicApi.Contracts.Notifications.OrderAttentionNotificationRequest
  366. iikoTransport.PublicApi.Contracts.Notifications.SendNotificationRequest
  367. iikoTransport.PublicApi.Contracts.OrderTypes.OrderServiceType
  368. iikoTransport.PublicApi.Contracts.OrderTypes.OrderType
  369. iikoTransport.PublicApi.Contracts.OrderTypes.OrderTypesRequest
  370. iikoTransport.PublicApi.Contracts.OrderTypes.OrderTypesResponse
  371. iikoTransport.PublicApi.Contracts.Orders.Common.AddOrderPaymentsRequest
  372. iikoTransport.PublicApi.Contracts.Orders.Common.CreateOrderSettings
  373. iikoTransport.PublicApi.Contracts.Orders.Common.OrderStatus
  374. iikoTransport.PublicApi.Contracts.Organizations.AddressFormatType
  375. iikoTransport.PublicApi.Contracts.Organizations.DeliveryOrderPaymentSettings
  376. iikoTransport.PublicApi.Contracts.Organizations.DeliverySettingsServiceType
  377. iikoTransport.PublicApi.Contracts.Organizations.ExtendedOrganizationInfo
  378. iikoTransport.PublicApi.Contracts.Organizations.GetOrganizationsRequest
  379. iikoTransport.PublicApi.Contracts.Organizations.GetOrganizationsResponse
  380. iikoTransport.PublicApi.Contracts.Organizations.GetSimpleOrganizationsResponse
  381. iikoTransport.PublicApi.Contracts.Organizations.OrganizationInfo
  382. iikoTransport.PublicApi.Contracts.Organizations.OrganizationSettings
  383. iikoTransport.PublicApi.Contracts.Organizations.OrganizationSettingsParameters
  384. iikoTransport.PublicApi.Contracts.Organizations.OrganizationSettingsType
  385. iikoTransport.PublicApi.Contracts.Organizations.OrganizationsSettingsRequest
  386. iikoTransport.PublicApi.Contracts.Organizations.OrganizationsSettingsResponse
  387. iikoTransport.PublicApi.Contracts.Organizations.SimpleOrganizationInfo
  388. iikoTransport.PublicApi.Contracts.PaymentTypes.PaymentProcessingType
  389. iikoTransport.PublicApi.Contracts.PaymentTypes.PaymentType
  390. iikoTransport.PublicApi.Contracts.PaymentTypes.PaymentTypeKind
  391. iikoTransport.PublicApi.Contracts.PaymentTypes.PaymentTypesRequest
  392. iikoTransport.PublicApi.Contracts.PaymentTypes.PaymentTypesResponse
  393. iikoTransport.PublicApi.Contracts.RemovalTypes.RemovalType
  394. iikoTransport.PublicApi.Contracts.RemovalTypes.RemovalTypesRequest
  395. iikoTransport.PublicApi.Contracts.RemovalTypes.RemovalTypesResponse
  396. iikoTransport.PublicApi.Contracts.Reserves.AddOrderItemsToBanquetRequest
  397. iikoTransport.PublicApi.Contracts.Reserves.AddOrderPaymentsToBanquetRequest
  398. iikoTransport.PublicApi.Contracts.Reserves.CancelReserveRequest
  399. iikoTransport.PublicApi.Contracts.Reserves.Color
  400. iikoTransport.PublicApi.Contracts.Reserves.CreateReserveRequest
  401. iikoTransport.PublicApi.Contracts.Reserves.Font
  402. iikoTransport.PublicApi.Contracts.Reserves.FontStyle
  403. iikoTransport.PublicApi.Contracts.Reserves.GetRestaurantSectionsRequest
  404. iikoTransport.PublicApi.Contracts.Reserves.GetRestaurantSectionsResponse
  405. iikoTransport.PublicApi.Contracts.Reserves.GetRestaurantSectionsWorkloadRequest
  406. iikoTransport.PublicApi.Contracts.Reserves.GetRestaurantSectionsWorkloadResponse
  407. iikoTransport.PublicApi.Contracts.Reserves.GuestsInfo
  408. iikoTransport.PublicApi.Contracts.Reserves.Request.ReserveOrder
  409. iikoTransport.PublicApi.Contracts.Reserves.Reserve
  410. iikoTransport.PublicApi.Contracts.Reserves.ReserveCancelReason
  411. iikoTransport.PublicApi.Contracts.Reserves.ReserveInWorkload
  412. iikoTransport.PublicApi.Contracts.Reserves.ReserveInfo
  413. iikoTransport.PublicApi.Contracts.Reserves.ReserveResponse
  414. iikoTransport.PublicApi.Contracts.Reserves.ReserveStatus
  415. iikoTransport.PublicApi.Contracts.Reserves.ReservesByIdRequest
  416. iikoTransport.PublicApi.Contracts.Reserves.ReservesResponse
  417. iikoTransport.PublicApi.Contracts.Reserves.Response.ReserveOrder
  418. iikoTransport.PublicApi.Contracts.Reserves.RestaurantSection
  419. iikoTransport.PublicApi.Contracts.Reserves.RestaurantSectionEllipse
  420. iikoTransport.PublicApi.Contracts.Reserves.RestaurantSectionMark
  421. iikoTransport.PublicApi.Contracts.Reserves.RestaurantSectionRectangle
  422. iikoTransport.PublicApi.Contracts.Reserves.RestaurantSectionTable
  423. iikoTransport.PublicApi.Contracts.Reserves.SectionSchema
  424. iikoTransport.PublicApi.Contracts.Reserves.Table
  425. iikoTransport.PublicApi.Contracts.StopLists.AddProductsToStopListItem
  426. iikoTransport.PublicApi.Contracts.StopLists.AddProductsToStopListRequest
  427. iikoTransport.PublicApi.Contracts.StopLists.CheckStopListRequest
  428. iikoTransport.PublicApi.Contracts.StopLists.CheckStopListResponse
  429. iikoTransport.PublicApi.Contracts.StopLists.ClearStopListRequest
  430. iikoTransport.PublicApi.Contracts.StopLists.RemoveProductsFromStopListItem
  431. iikoTransport.PublicApi.Contracts.StopLists.RemoveProductsFromStopListRequest
  432. iikoTransport.PublicApi.Contracts.StopLists.StopListItem
  433. iikoTransport.PublicApi.Contracts.StopLists.StopListsRequest
  434. iikoTransport.PublicApi.Contracts.StopLists.StopListsResponse
  435. iikoTransport.PublicApi.Contracts.StopLists.TerminalGroupStopList
  436. iikoTransport.PublicApi.Contracts.StopLists.TerminalGroupStopListUpdate
  437. iikoTransport.PublicApi.Contracts.StopLists.WebHookOnStopListChangeData
  438. iikoTransport.PublicApi.Contracts.TableOrders.Request.AddCustomerToTableOrderRequest
  439. iikoTransport.PublicApi.Contracts.TableOrders.Request.AddItemsToTableOrderRequest
  440. iikoTransport.PublicApi.Contracts.TableOrders.Request.AddTableOrderItemsSettings
  441. iikoTransport.PublicApi.Contracts.TableOrders.Request.CreateTableOrderRequest
  442. iikoTransport.PublicApi.Contracts.TableOrders.Request.CreateTableOrderSettings
  443. iikoTransport.PublicApi.Contracts.TableOrders.Request.GetTableOrdersByIdRequest
  444. iikoTransport.PublicApi.Contracts.TableOrders.Request.GetTableOrdersByTableRequest
  445. iikoTransport.PublicApi.Contracts.TableOrders.Request.GuestsInfo
  446. iikoTransport.PublicApi.Contracts.TableOrders.Request.InitTableOrderByPosOrderRequest
  447. iikoTransport.PublicApi.Contracts.TableOrders.Request.InitTableOrderRequest
  448. iikoTransport.PublicApi.Contracts.TableOrders.Request.TableOrder
  449. iikoTransport.PublicApi.Contracts.TableOrders.Request.TableOrderCustomer
  450. iikoTransport.PublicApi.Contracts.TableOrders.Response.SplitOrderBetweenCashRegisters
  451. iikoTransport.PublicApi.Contracts.TableOrders.Response.TableOrder
  452. iikoTransport.PublicApi.Contracts.TableOrders.Response.TableOrderInfo
  453. iikoTransport.PublicApi.Contracts.TableOrders.Response.TableOrderResponse
  454. iikoTransport.PublicApi.Contracts.TableOrders.Response.TableOrdersResponse
  455. iikoTransport.PublicApi.Contracts.Terminals.AwakeTerminalGroupsRequest
  456. iikoTransport.PublicApi.Contracts.Terminals.AwakeTerminalGroupsResponse
  457. iikoTransport.PublicApi.Contracts.Terminals.GetTerminalGroupsByOrganizationsRequest
  458. iikoTransport.PublicApi.Contracts.Terminals.TerminalGroup
  459. iikoTransport.PublicApi.Contracts.Terminals.TerminalGroupAliveInfo
  460. iikoTransport.PublicApi.Contracts.Terminals.TerminalGroupsIsAliveRequest
  461. iikoTransport.PublicApi.Contracts.Terminals.TerminalGroupsIsAliveResponse
  462. iikoTransport.PublicApi.Contracts.Terminals.TerminalGroupsRequest
  463. iikoTransport.PublicApi.Contracts.Terminals.TerminalGroupsResponse
  464. iikoTransport.PublicApi.Contracts.TipsTypes.TipsType
  465. iikoTransport.PublicApi.Contracts.TipsTypes.TipsTypesResponse
  466. iikoTransport.PublicApi.Contracts.WebHooks.DeliveryOrderErrorWebHookEventInfo
  467. iikoTransport.PublicApi.Contracts.WebHooks.DeliveryOrderUpdateWebHookEventInfo
  468. iikoTransport.PublicApi.Contracts.WebHooks.GetWebHookSettingsRequest
  469. iikoTransport.PublicApi.Contracts.WebHooks.GetWebHookSettingsResponse
  470. iikoTransport.PublicApi.Contracts.WebHooks.PersonalShiftWebHookEventInfo
  471. iikoTransport.PublicApi.Contracts.WebHooks.ReserveErrorWebHookEventInfo
  472. iikoTransport.PublicApi.Contracts.WebHooks.ReserveUpdateWebHookEventInfo
  473. iikoTransport.PublicApi.Contracts.WebHooks.StopListUpdateWebHookEventInfo
  474. iikoTransport.PublicApi.Contracts.WebHooks.TableOrderErrorWebHookEventInfo
  475. iikoTransport.PublicApi.Contracts.WebHooks.TableOrderUpdateWebHookEventInfo
  476. iikoTransport.PublicApi.Contracts.WebHooks.UpdateWebHookSettingsRequest
  477. iikoTransport.PublicApi.Contracts.WebHooks.WebHookEventType

AllergenGroupDto Up

id (optional)
UUID format: uuid
code (optional)
String Allergen's code
name (optional)
String Allergen's name

ExternalMenuPreset Up

id (optional)
Integer ID of the external menu
name (optional)
String External menu name
description (optional)
String External menu description
itemCategories (optional)

GetExternalMenuWithPriceSourceRequestDto Up

id (optional)
Integer id of the requested menu
priceSource (optional)
String Price from the external menu or price category format: enum
Enum:
CONFIGURED_IN_MENU
PRICE_CATEGORY
organizations (optional)
priceCategoryId (optional)

ModifierRestrictionsDto Up

minQuantity (optional)
Integer Minimum amount
maxQuantity (optional)
Integer Maximum amount
freeQuantity (optional)
Integer Amount free of charge
byDefault (optional)
Integer Default amount

NutritionInfoDto Up

TagDto Up

id (optional)
name (optional)

TaxCategoryDto Up

id (optional)
name (optional)
percentage (optional)
Float format: float

TransportItemDto Up

itemSizes (optional)
sku (optional)
String Product code
example: 002345-35cm
name (optional)
String Product name
example: Chicken Parmegiano
description (optional)
String Product description
example: Delicate taste, juicy chicken fillet, mushrooms, Cheddar cheese and Mozzarella cheese, oregano, Parmegiano sauce
allergenGroups (optional)
itemId (optional)
UUID Product ID format: uuid
modifierSchemaId (optional)
UUID Modifier schema ID format: uuid
taxCategory (optional)
orderItemType (optional)
String Product or compound. Depends on modifiers scheme existence format: enum
Enum:
Product
Compound

TransportItemSizeDto Up

prices (optional)
itemModifierGroups (optional)
sku (optional)
String Unique size code, consists of the product code and the name of the size, if the product has one size, then the size code will be equal to the product code
sizeCode (optional)
sizeName (optional)
String Name of the product size, the name can be empty if there is only one size in the list
isDefault (optional)
Boolean Whether it is a default size of the product. If the product has one size, then the parameter will be true, if the product has several sizes, none of them can be default.
portionWeightGrams (optional)
Float Size's weight format: float
example: 0
sizeId (optional)
UUID ID size, can be empty if the default size is selected and it is the only size in the list format: uuid
nutritionPerHundredGrams (optional)
buttonImageUrl (optional)
String links to images
example: https://102922.selcdn.ru/ecomm/someimage.png
buttonImageCroppedUrl (optional)

TransportMenuCategoryDto Up

items (optional)
id (optional)
UUID ID of the category of the external menu format: uuid
name (optional)
String Category name of the external menu
description (optional)
String Category description
buttonImageUrl (optional)
String Links to images
example: https://102922.selcdn.ru/ecomm/someimage.png
headerImageUrl (optional)
String Description header for the images

TransportModifierGroupDto Up

items (optional)
name (optional)
String Modifiers group name
description (optional)
String Modifiers group description
restrictions (optional)
canBeDivided (optional)
Boolean Whether the modifier can be splitted
itemGroupId (optional)
UUID Modifiers group id format: uuid
childModifiersHaveMinMaxRestrictions (optional)
Boolean Whether child modifiers can have their own restrictions, or only group ones
sku (optional)
String Modifiers group code

TransportModifierItemDto Up

prices (optional)
sku (optional)
String Modifier's code
name (optional)
String Modifier's name
description (optional)
String Modifier's description
buttonImage (optional)
String Links to images
restrictions (optional)
allergenGroups (optional)
nutritionPerHundredGrams (optional)
portionWeightGrams (optional)
Float Modifier's weight in gramms format: float
example: 0
tags (optional)
itemId (optional)
UUID Modifier's Id format: uuid

TransportPriceDto Up

organizationId (optional)
String Organization id
price (optional)
Float Product size prices for the organization, if the value is null, then the product/size is not for sale, the price always belongs to the price category that was selected at the time of the request format: float
example: 20.5

iikoNet.Common.Enums.RefillType Up

iikoNet.Common.Enums.TemplateType Up

iikoNet.Service.Contracts.Api.iikoTransport.Common.GetByOrganizationIdRequest Up

Get request only by organization id
organizationId (optional)
UUID Organization id. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.Customer.AddCustomerToProgramRequest Up

Add customer to program request.
customerId (optional)
UUID Customer id. format: uuid
programId (optional)
UUID Program id. format: uuid
organizationId
UUID Organization id. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.Customer.AddCustomerToProgramResponse Up

Add customer to program response.
userWalletId (optional)
UUID User wallet id. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.Customer.AddMagnetCardRequest Up

Add magnet card request.
customerId
UUID Customer id. format: uuid
cardTrack
String Card track. Can be null.
cardNumber
String Card number. Can be null.
organizationId
UUID Organization id. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.Customer.AddMagnetCardResponse Up

Add magnet card response.

iikoNet.Service.Contracts.Api.iikoTransport.Customer.CancelHoldMoneyRequest Up

Cancel hold money request.
transactionId
UUID Transaction id. format: uuid
organizationId
UUID Organization id. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.Customer.CancelHoldMoneyResponse Up

Cancel hold money response.

iikoNet.Service.Contracts.Api.iikoTransport.Customer.ChangeCategoryForCustomerRequest Up

Change category for customer request.
customerId
UUID Customer id. format: uuid
categoryId
UUID Guest category id. format: uuid
organizationId
UUID Organization id. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.Customer.ChangeCategoryForCustomerResponse Up

Change category for customer response.

iikoNet.Service.Contracts.Api.iikoTransport.Customer.ChangeUserBalanceRequest Up

Change user balance request.
customerId (optional)
UUID Customer id. format: uuid
walletId (optional)
UUID Wallet id. format: uuid
sum (optional)
Double Sum of balance change. Must be possible. format: double
comment (optional)
String Comment. Can be null.
organizationId
UUID Organization id. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.Customer.CreateOrUpdateCustomerRequest Up

Not empty <code>phone</code> or <code>magnetCardTrack</code> or <code>id</code> is required for successful import.
id (optional)
UUID Customer id. format: uuid
phone (optional)
String Customer phone. Can be null.
cardTrack (optional)
String Card track. Required if cardNumber set. Can be null.
cardNumber (optional)
String Card number. Required if cardTrack set. Can be null.
name (optional)
String Customer name. Can be null.
middleName (optional)
String Customer middle name. Can be null.
surName (optional)
String Customer surname. Can be null.
birthday (optional)
String Customer birthday. format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
email (optional)
String Customer email. Can be null.
sex (optional)
Customer sex. <br>0 - not specified,<br />1 - male,<br />2 - female.
consentStatus (optional)
Customer consent status. <br>0 - unknown,<br />1 - given,<br />2 - revoked.
shouldReceivePromoActionsInfo (optional)
Boolean Customer get promo messages (email, sms). If null - unknown.
referrerId (optional)
String Id for referrer guest. Null for old integrations, Guid.Empty - for referrer deletion. Can be null.
userData (optional)
String Customer user data. Can be null.
organizationId
UUID Customer organization id. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.Customer.CreateOrUpdateCustomerResponse Up

Create or update customer response.
id (optional)
UUID Customer id. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.Customer.DeleteMagnetCardRequest Up

Delete magnet card request.
customerId
UUID Customer id. format: uuid
cardTrack
String Card track. Can be null.
organizationId
UUID Organization id. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.Customer.DeleteMagnetCardResponse Up

Delete magnet card response.

iikoNet.Service.Contracts.Api.iikoTransport.Customer.GetCategoriesRequest Up

Get categories request.
organizationId
UUID Organization id. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.Customer.GetCategoriesResponse Up

Get categories response.
guestCategories (optional)

iikoNet.Service.Contracts.Api.iikoTransport.Customer.GetCustomerInfoByCardNumberRequest Up

Request to get customer by card number.
type
organizationId (optional)
UUID Organization id. format: uuid
cardNumber (optional)
String Customer card number.

iikoNet.Service.Contracts.Api.iikoTransport.Customer.GetCustomerInfoByCardTrackRequest Up

Request to get customer by card track.
type
organizationId (optional)
UUID Organization id. format: uuid
cardTrack (optional)
String Customer card track.

iikoNet.Service.Contracts.Api.iikoTransport.Customer.GetCustomerInfoByEmailRequest Up

Request to get customer by email.
type
organizationId (optional)
UUID Organization id. format: uuid
email (optional)
String Customer email.

iikoNet.Service.Contracts.Api.iikoTransport.Customer.GetCustomerInfoByIdRequest Up

Request to get customer by Id.
type
organizationId (optional)
UUID Organization id. format: uuid
id (optional)
String Customer id.

iikoNet.Service.Contracts.Api.iikoTransport.Customer.GetCustomerInfoByPhoneRequest Up

Request to get customer by phone number.
type
organizationId (optional)
UUID Organization id. format: uuid
phone (optional)
String Customer phone number.

iikoNet.Service.Contracts.Api.iikoTransport.Customer.GetCustomerInfoRequest Up

Base class for customer info request.
type
organizationId (optional)
UUID Organization id. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.Customer.GetCustomerInfoResponse Up

Get customer info response.
id (optional)
UUID Guest id. format: uuid
referrerId (optional)
UUID Guest referrer id. format: uuid
name (optional)
String Guest name. Can be null.
surname (optional)
String Guest surname. Can be null.
middleName (optional)
String Guest middle name. Can be null.
comment (optional)
String Guest comment. Can be null.
phone (optional)
String Main customer's phone. Can be null.
cultureName (optional)
String Guest culture name. Can be null.
birthday (optional)
String Guest birthday. format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
email (optional)
String Guest email. Can be null.
sex (optional)
Sex. <br>0 - not specified,<br />1 - male,<br />2 - female.
consentStatus (optional)
Guest consent status. <br>0 - unknown,<br />1 - given,<br />2 - revoked.
anonymized (optional)
Boolean Guest anonymized.
cards (optional)
categories (optional)
walletBalances (optional)
array[iikoNet.Service.Contracts.Api.iikoTransport.Customer.GuestBalanceInfo] Customer's user wallets. Contains bonus balances of different loyalty programs.
userData (optional)
String Technical user data, customizable by restaurateur. Can be null.
shouldReceivePromoActionsInfo (optional)
Boolean Customer get promo messages (email, sms). If null - unknown.
shouldReceiveLoyaltyInfo (optional)
Boolean Guest should receive loyalty info.
shouldReceiveOrderStatusInfo (optional)
Boolean Guest should receive order status info.
personalDataConsentFrom (optional)
String Guest personal data consent from. format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
personalDataConsentTo (optional)
String Guest personal data consent to. format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
personalDataProcessingFrom (optional)
String Guest personal data processing from. format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
personalDataProcessingTo (optional)
String Guest personal data processing to. format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
isDeleted (optional)
Boolean Customer marked as deleted.

iikoNet.Service.Contracts.Api.iikoTransport.Customer.GuestBalanceInfo Up

Information about guest balance.
id (optional)
UUID Wallet id. format: uuid
name (optional)
String Wallet name.
type (optional)
Wallet type. <br>0 - deposit or corporate nutrition,<br />1 - bonus program,<br />2 - products program,<br />3 - discount program,<br />4 - certificate program.
balance (optional)
Double Wallet balance. format: double

iikoNet.Service.Contracts.Api.iikoTransport.Customer.GuestCardInfo Up

Guest card info.
id (optional)
UUID Card id. format: uuid
track (optional)
String Card track.
number (optional)
String Card number.
validToDate (optional)
String Card valid to date. format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123

iikoNet.Service.Contracts.Api.iikoTransport.Customer.GuestCategoryShortInfo Up

Guest category info.
id (optional)
UUID Category id. format: uuid
name (optional)
String Category name.
isActive (optional)
Boolean Is category active or not.
isDefaultForNewGuests (optional)
Boolean Is category default for new guests or not.

iikoNet.Service.Contracts.Api.iikoTransport.Customer.HoldMoneyRequest Up

Hold money request.
transactionId (optional)
UUID Predefined transaction id. Random if empty. format: uuid
customerId
UUID Customer id. format: uuid
walletId
UUID Wallet id. format: uuid
sum
Double Sum. format: double
comment (optional)
String Additional information about holding. Can be null.
organizationId
UUID Organization id. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.Customer.HoldMoneyResponse Up

Hold money response.
transactionId (optional)
UUID Holding money transaction id. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.Customer.IikoNetUserSex Up

iikoNet.Service.Contracts.Api.iikoTransport.Customer.PersonalDataConsentStatus Up

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.AvailableCombo Up

Available combo.
specificationId (optional)
UUID Id of combo specification, describing combo content. format: uuid
groupMapping (optional)
array[iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.ComboGroupMapping] Groups contained in combo. If null - there is no suitable product in order yet for that group.

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.AvailablePayment Up

Available payment.
id (optional)
UUID Marketing campaign id. format: uuid
maxSum (optional)
Double Max sum. format: double
order (optional)
Integer Payment order. In case of partial payment, payments with lesser order should be filled first. format: int32
walletInfos (optional)

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.CalculateCheckinRequest Up

Request to calculate loyalty operations for order.
order
Order.
coupon (optional)
String Number of applied coupon. Can be null.
referrerId (optional)
UUID Referrer id. format: uuid
terminalGroupId (optional)
UUID Identifier of a target terminal. Should be used only when auto distribution is off and no call center operator is available. format: uuid
availablePaymentMarketingCampaignIds (optional)
array[UUID] List of identifiers of applied campaigns. Should be empty if no payment method is used. format: uuid
applicableManualConditions (optional)
array[UUID] List of manually applied to order conditions. format: uuid
dynamicDiscounts (optional)
isLoyaltyTraceEnabled (optional)
Boolean Loyalty trace is enabled.
organizationId
UUID Organization id. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.CalculateCheckinResponse Up

Loyalty result for order.
loyaltyProgramResults (optional)
availablePayments (optional)
validationWarnings (optional)
array[String] Warnings about errors, not blocking loyalty calculation.
Warnings (optional)
array[iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.WarningInfo] Warnings about errors, not blocking loyalty calculation.
loyaltyTrace (optional)
String Loyalty trace. Can be null.

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.CalculateComboPriceRequest Up

Calculate combo price request.
items
organizationId
UUID Organization id. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.CalculateComboPriceResponse Up

Calculate combo price response.
price (optional)
Double Calculated price of combo item. format: double
incorrectlyFilledGroups (optional)
array[UUID] Ids of incorrectly filled groups. If not empty - price will be 0. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.ComboCategory Up

Information about combos of organization.
id (optional)
UUID Category id. format: uuid
name (optional)
String Category name.

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.ComboGroup Up

Information about combos group.
id (optional)
UUID Id. format: uuid
name (optional)
String Name.
isMainGroup (optional)
Boolean Is main group.
products (optional)

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.ComboGroupMapping Up

Mapping combo's group to OrderItem.
groupId (optional)
UUID Id of combo group. format: uuid
itemId (optional)
UUID Id of item, suitable for group. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.ComboPriceModificationType Up

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.ComboProduct Up

Combo product.
productId (optional)
UUID Product id. format: uuid
sizeId (optional)
UUID Size id. format: uuid
forbiddenModifiers (optional)
array[UUID] Forbidden modifiers. format: uuid
priceModificationAmount (optional)
Double Price modification amount. format: double

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.ComboSpecification Up

Information about combos of organization.
sourceActionId (optional)
UUID Id of action that added the combo. format: uuid
categoryId (optional)
UUID Combo's category id. format: uuid
name (optional)
String Name. Can be null.
priceModificationType (optional)
Price modification type. <br>0 - fixed combo price,<br />1 - fixed position price,<br />2 - cheapest position discount,<br />3 - most expensive position discount,<br />4 - percentage discount for each position.
priceModification (optional)
Double Price modification. format: double
isActive (optional)
Boolean Is active.
startDate (optional)
String Start date. format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
expirationDate (optional)
String Expiration date. format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
lackingGroupsToSuggest (optional)
Integer Lacking groups to suggest. format: int32
includeModifiers (optional)
Boolean Include modifiers.
groups (optional)

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.CouponInfo Up

Coupon info.
id (optional)
UUID Id. format: uuid
number (optional)
String Number. Can be null.
seriesName (optional)
String Series name. Can be null.
seriesId (optional)
UUID Series id. format: uuid
whenActivated (optional)
String When activated. format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
isDeleted (optional)
Boolean Is deleted.

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.CouponInfoRequest Up

Coupon info request.
number
String Number. Can be null.
series (optional)
String Series. Can be null.
organizationId
UUID Organization id. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.CouponInfoResponse Up

Coupon info response.
couponInfo (optional)

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.DiscountOperation Up

Discount operation.
code (optional)
Operation Type Code. <br>0 - fixed discount for the entire order,<br />1 - fixed discount for the item,<br />2 - free product,<br />3 - other type of discounts.
orderItemId (optional)
UUID Deprecated, use positionId. format: uuid
positionId (optional)
UUID Id of item the discount is applied to. If null - discount applied to whole orders. format: uuid
discountSum (optional)
Double Discount sum. format: double
amount (optional)
Double Amount. format: double
comment (optional)
String Comment. Can be null.

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.DynamicDiscount Up

Manual discount.
manualConditionId (optional)
UUID Manual discount condition identifier. format: uuid
Sum (optional)
Double Discount amount. format: double

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.FreeProduct Up

Free item to be added to order.
id (optional)
UUID Id of product. format: uuid
code (optional)
String Code of product. Can be null.
size (optional)
array[String] Sizes available for that product.

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.FreeProductsGroup Up

Free item to be added to order.
sourceActionId (optional)
UUID Id of action that caused the suggestion. format: uuid
descriptionForUser (optional)
String Description for user. Can be null.
products (optional)

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.GetCombosInfoRequest Up

Get combos info request.
extraData (optional)
Boolean Extra data.
organizationId
UUID Organization id. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.GetCombosInfoResponse Up

Information about combos of organization.
comboSpecifications (optional)
comboCategories (optional)
Warnings (optional)
array[iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.WarningInfo] Warnings about errors, not blocking loyalty calculation.

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.GetManualConditionsResponse Up

Get manual conditions response.
manualConditions (optional)

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.LoyaltyProgramResult Up

Loyalty result for order.
marketingCampaignId (optional)
UUID Program marketing campaign id. format: uuid
name (optional)
String Program name.
discounts (optional)
upsales (optional)
array[iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.Upsale] Suggested items to add or advices for customer.
freeProducts (optional)
availableComboSpecifications (optional)
array[UUID] Ids of combo specification available in current order. format: uuid
availableCombos (optional)
needToActivateCertificate (optional)
Boolean Certificate number is required for activation.

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.ManualConditionInfo Up

Manual condition.
id (optional)
UUID Id. format: uuid
caption (optional)
String Name of manual condition.
isDynamicDiscount (optional)
Boolean Arbitrary discount attribute.

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.NotActivatedCoupon Up

Not activated coupon.
id (optional)
UUID Id. format: uuid
number (optional)
String Number. Can be null.
seriesName (optional)
String Series name. Can be null.
seriesId (optional)
UUID Series id. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.NotActivatedCouponRequest Up

Not activated coupon request.
series
String Series. Can be null.
pageSize (optional)
Integer Page size. format: int32
page (optional)
Integer Page. format: int32
organizationId
UUID Organization id. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.NotActivatedCouponResponse Up

Not activated coupon response.
notActivatedCoupon (optional)

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.OperationCode Up

Operation's code.

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.SeriesWithNotActivatedCoupons Up

Series with not activated coupons.
id (optional)
UUID Id. format: uuid
number (optional)
String Number. Can be null.

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.SeriesWithNotActivatedCouponsRequest Up

Series with not activated coupons request.
organizationId
UUID Organization id. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.SeriesWithNotActivatedCouponsResponse Up

Series with not activated coupons response.
seriesWithNotActivatedCoupons (optional)

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.Upsale Up

user tip.
sourceActionId (optional)
UUID Id of action that caused the suggestion. format: uuid
suggestionText (optional)
String Suggestion text.
productCodes (optional)
array[String] Codes of products that suggested to be added to order.

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.WalletInfo Up

Wallet info.
id (optional)
UUID Wallet id. format: uuid
maxSum (optional)
Double Max sum for payment from the wallet. format: double
canHoldMoney (optional)
Boolean Can hold money.

iikoNet.Service.Contracts.Api.iikoTransport.LoyaltyResult.WarningInfo Up

Warning info.
Code (optional)
String Code of an error. Can be null.
ErrorCode (optional)
String Error code. Can be null.
Message (optional)
String Description of an error. Can be null.

iikoNet.Service.Contracts.Api.iikoTransport.Organization.GetProgramsRequest Up

Get programs request.
withoutMarketingCampaigns (optional)
Boolean Determines if marketing campaigns not required.
organizationId
UUID Organization id. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.Organization.GetProgramsResponse Up

Get programs response.
Programs (optional)

iikoNet.Service.Contracts.Api.iikoTransport.Organization.LoyaltyProgram Up

Loyalty program.
id (optional)
UUID Program id. format: uuid
name (optional)
String Program name. Can be null.
description (optional)
String Program description. Can be null.
serviceFrom (optional)
String Program works since date. format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
serviceTo (optional)
String Program works till date. format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
notifyAboutBalanceChanges (optional)
Boolean Notify customer when balance has changed (sms/push).
programType (optional)
Program type. <br>0 - deposit or corporate nutrition,<br />1 - bonus program,<br />2 - products program,<br />3 - discount program,<br />4 - certificate program.
isActive (optional)
Boolean Program is active.
walletId (optional)
UUID Wallet id. Program has only wallet that means global payment type for customers. format: uuid
marketingCampaigns (optional)
appliedOrganizations (optional)
array[UUID] Program applied organizations. format: uuid
templateType (optional)
Program template type. <br>0 - None,<br />1 - BonusProgram,<br />2 - DiscountProgram,<br />3 - NthDishProgram,<br />4 - ManualOrderAnonymousDiscount,<br />5 - AutoOrderAnonymousDiscount,<br />6 - AutoDishAnonymousDiscount,<br />7 - PromotionsProgram,<br />8 - NthDishPromotionsProgram.
hasWelcomeBonus (optional)
Boolean Program has welcome bonus.
welcomeBonusSum (optional)
Double All new customers will get bonus. format: double
isExchangeRateEnabled (optional)
Boolean Exchange rate for bonuses and real currency.
refillType (optional)
Refill type with payment.

iikoNet.Service.Contracts.Api.iikoTransport.Organization.MarketingCampaignActionConditionBindingInfo Up

Marketing campaign binding info.
id (optional)
UUID Id. format: uuid
stopFurtherExecution (optional)
Boolean Loyalty processing stop after successful execution of binding. So means order of bindings affects.
actions (optional)
conditions (optional)

iikoNet.Service.Contracts.Api.iikoTransport.Organization.MarketingCampaignInfo Up

Marketing campaign info.
id (optional)
UUID Marketing campaign id. format: uuid
programId (optional)
UUID Loyalty program id. format: uuid
name (optional)
String Loyalty program name. Can be null.
description (optional)
String Marketing campaign description. Can be null.
isActive (optional)
Boolean Marketing campaign is active.
periodFrom (optional)
String Marketing campaign works since date. format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
periodTo (optional)
String Marketing campaign works till date. Null means limitless. format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
orderActionConditionBindings (optional)
periodicActionConditionBindings (optional)
overdraftActionConditionBindings (optional)
guestRegistrationActionConditionBindings (optional)

iikoNet.Service.Contracts.Api.iikoTransport.Organization.MarketingCampaignSettingsInfo Up

Marketing campaign settings info.
id (optional)
UUID Id. format: uuid
settings (optional)
String Action/condition settings. Stored as Json. Can be null.
typeName (optional)
String Action/condition type name. Can be null.
checkSum (optional)
String Hash value of checksum. Can be null.

iikoNet.Service.Contracts.Api.iikoTransport.Organization.RefillUserBalanceResponse Up

Refill user balance response.

iikoNet.Service.Contracts.Api.iikoTransport.Organization.SendEmailRequest Up

Send email request.
receiver
String Email address. Can be null.
subject
String Message subject. Can be null.
body
String Message body. Can be null.
organizationId
UUID Organization id. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.Organization.SendEmailResponse Up

Send email response.

iikoNet.Service.Contracts.Api.iikoTransport.Organization.SendSmsRequest Up

Send sms request.
phone
String Customer's phone number. Can be null.
text
String Message text. Can be null.
organizationId
UUID Organization id. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.Organization.SendSmsResponse Up

Send sms response.

iikoNet.Service.Contracts.Api.iikoTransport.Organization.WithdrawUserBalanceResponse Up

Withdraw user balance response.

iikoNet.Service.Contracts.Api.iikoTransport.ProgramType Up

Corporate program type.

iikoNet.Service.Contracts.Api.iikoTransport.Report.CertificateCounteragentType Up

Certificate counteragent type

iikoNet.Service.Contracts.Api.iikoTransport.Report.GetTransactionsReportByPeriodRequest Up

Report request.
customerId
UUID Customer id. format: uuid
dateFrom
String Report since date in UTC. Included. format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
dateTo
String Report till date in UTC. Included. format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
pageNumber
Integer Page number. Zero based. Previous pages will be skipped. format: int32
pageSize
Integer Page size. Ignored if more than max page size on server. format: int32
organizationId
UUID Organization id. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.Report.GetTransactionsReportByPeriodResponse Up

Get transactions report by period response.
items (optional)
pageSize (optional)
Integer Page size. format: int32
pageNumber (optional)
Integer Page number. Zero based. format: int32

iikoNet.Service.Contracts.Api.iikoTransport.Report.GetTransactionsReportByRevisionRequest Up

Report request.
customerId
UUID Customer id. format: uuid
revision (optional)
Long Report since revision. Included if LastTransactionId set.. format: int64
lastTransactionId (optional)
UUID Report since transaction. Excluded. Can't be used without revision.. format: uuid
pageSize
Integer Page size. Ignored if more than max size on server.. format: int32
organizationId
UUID Organization id. format: uuid

iikoNet.Service.Contracts.Api.iikoTransport.Report.GetTransactionsReportByRevisionResponse Up

Get transactions report by revision response.
transactions (optional)
lastRevision (optional)
Long Last known transaction revision. format: int64
lastTransactionId (optional)
UUID Last known transaction id. format: uuid
pageSize (optional)
Integer Page size. format: int32

iikoNet.Service.Contracts.Api.iikoTransport.Report.TransactionType Up

iikoNet.Service.Contracts.Api.iikoTransport.Report.TransportTransactionsCertificateReportItem Up

Transactions report item.
number (optional)
String Number. Can be null.
series (optional)
String Series. Can be null.
statusName (optional)
String Status name. Can be null.
typeName (optional)
String Type name. Can be null.

iikoNet.Service.Contracts.Api.iikoTransport.Report.TransportTransactionsCouponReportItem Up

Transactions report item.
number (optional)
String Number. Can be null.
series (optional)
String Series. Can be null.

iikoNet.Service.Contracts.Api.iikoTransport.Report.TransportTransactionsReportItem Up

Transactions report item.
apiClientLogin (optional)
String Api client login. Can be null.
balanceAfter (optional)
Double Balance after. format: double
balanceBefore (optional)
Double Balance before. format: double
blockReason (optional)
String Block reason. Can be null.
certificate (optional)
Certificate.
comment (optional)
String Comment. Can be null.
counteragent (optional)
String Counteragent. Can be null.
counteragentType (optional)
Counteragent type.
counteragentTypeName (optional)
String Counteragent type name. Can be null.
coupon (optional)
Coupon.
emitentName (optional)
String Emitent name. Can be null.
loyaltyUser (optional)
String Loyalty user. Can be null.
marketingCampaignId (optional)
UUID Marketing campaign id. format: uuid
nominal (optional)
Double Nominal. format: double
orderNumber (optional)
Integer Order number. format: int32
orderSum (optional)
Double Order sum. format: double
organizationId
UUID Organization id. format: uuid
posBalanceBefore (optional)
Double Pos balance before. format: double
programId (optional)
UUID Program id. format: uuid
sum (optional)
Double Sum. format: double
type (optional)
Type.
typeName (optional)
String Type name. Can be null.
walletId (optional)
UUID Wallet id. format: uuid
whenCreated (optional)
Date When created. format: date-time
whenCreatedOrder (optional)
Date When created order. format: date-time
id
UUID Id. format: uuid
isDelivery (optional)
Boolean Is delivery.
isIgnored (optional)
Boolean Is ignored.
posOrderId (optional)
UUID Pos order id. format: uuid
revision
Long Revision. format: int64
terminalGroupId (optional)
UUID Terminal group id. format: uuid

iikoTransport.PublicApi.Contracts.Address.CitiesRequest Up

Organization request DTO.
organizationIds
array[UUID] <p>IDs of organizations that require data return.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
includeDeleted (optional)
Boolean Include deleted cities in response.
example: false

iikoTransport.PublicApi.Contracts.Address.CitiesResponse Up

Service response with list of cities.
correlationId
UUID Operation ID. format: uuid
cities

iikoTransport.PublicApi.Contracts.Address.City Up

City DTO.
id
UUID City ID in RMS. format: uuid
name
String Name.
externalRevision (optional)
Long External revision. format: int64
isDeleted
Boolean Is-Deleted attribute.
classifierId (optional)
String ID in classifier, e.g., address database.
additionalInfo (optional)
String City additional information.

iikoTransport.PublicApi.Contracts.Address.Region Up

Delivery district DTO.
id
UUID Region ID in RMS. format: uuid
name
String Name.
externalRevision (optional)
Long External revision. format: int64
isDeleted
Boolean Is-Deleted attribute.

iikoTransport.PublicApi.Contracts.Address.RegionsRequest Up

Organization request DTO.
organizationIds
array[UUID] <p>IDs of organizations that require data return.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid

iikoTransport.PublicApi.Contracts.Address.RegionsResponse Up

Service response with list of districts.
correlationId
UUID Operation ID. format: uuid
regions

iikoTransport.PublicApi.Contracts.Address.Street Up

Street DTO in iikoRMS
id
UUID ID. format: uuid
name
String Name.
externalRevision (optional)
Long External system revision No. format: int64
classifierId (optional)
String ID in classifier, e.g., address database.
isDeleted
Boolean Is-Deleted attribute.

iikoTransport.PublicApi.Contracts.Address.StreetById Up

Street by id response.
id
UUID Street id. format: uuid
classifierId (optional)
String Street classifierId.
cityId
UUID City id. format: uuid
cityName
String City name.
streetName
String Street name.

iikoTransport.PublicApi.Contracts.Address.StreetsByCityRequest Up

Organization and city request DTO.
organizationId
UUID <p>Organization ID details of which have to be returned.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
cityId
UUID City ID. format: uuid
includeDeleted (optional)
Boolean Include deleted streets in response.
example: false

iikoTransport.PublicApi.Contracts.Address.StreetsByIdRequest Up

Organization and city request DTO.
organizationId
UUID Organization Id. format: uuid
ids (optional)
array[UUID] Street Ids. format: uuid
classifierIds (optional)
array[String] Street classifierIds.

iikoTransport.PublicApi.Contracts.Address.StreetsByIdResponse Up

Streets by ids response.
streets (optional)
correlationId (optional)
UUID Operation ID. format: uuid

iikoTransport.PublicApi.Contracts.Address.StreetsResponse Up

Service response with list of streets.
correlationId
UUID Operation ID. format: uuid
streets

iikoTransport.PublicApi.Contracts.AddressHints.AddressHintsServiceType Up

Address hints service type.

iikoTransport.PublicApi.Contracts.Auth.GetAccessTokenRequest Up

Authentication token request.
apiLogin
String API key. It is set in iikoWeb.

iikoTransport.PublicApi.Contracts.Auth.GetAccessTokenResponse Up

Response to authentication token request.
correlationId
UUID Operation ID. format: uuid
token
String Authentication token. The standard token lifetime is 1 hour.

iikoTransport.PublicApi.Contracts.CancelCauses.CancelCause Up

Delivery cancel cause.
id
UUID Identifier. format: uuid
name
String Name.
isDeleted (optional)
Boolean Is deleted sign.

iikoTransport.PublicApi.Contracts.CancelCauses.CancelCausesRequest Up

Request for organization's delivery cancel causes.
organizationIds
array[UUID] <p>Organizations ids which delivery cancel causes needs to be returned.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid

iikoTransport.PublicApi.Contracts.CancelCauses.CancelCausesResponse Up

Response with delivery cancel causes (reasons for deletion) list.
correlationId
UUID Operation ID. format: uuid
cancelCauses

iikoTransport.PublicApi.Contracts.Commands.ErrorCommandStatus Up

Command completed with error.
state
exception (optional)
Occured exception details.

iikoTransport.PublicApi.Contracts.Commands.GetCommandStatusRequest Up

Request for command status obtaining.
organizationId
UUID <p>Organization id which &quot;correlationId&quot; belongs to.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
correlationId
UUID Operation ID obtained from any command supporting operations. format: uuid

iikoTransport.PublicApi.Contracts.Commands.GetCommandStatusResponse Up

Class containing information about command status.
state

iikoTransport.PublicApi.Contracts.Commands.InProgressCommandStatus Up

Command is in progress.
state

iikoTransport.PublicApi.Contracts.Commands.SuccessCommandStatus Up

Command completed successfully.
state

iikoTransport.PublicApi.Contracts.Common.CorrelationIdResponse Up

Wrapping object (external) for CorrelationId return.
correlationId
UUID Operation ID. format: uuid

iikoTransport.PublicApi.Contracts.Common.ExternalData Up

External data key and value pair.
key
String External data key.
value
String External data value.

iikoTransport.PublicApi.Contracts.Common.RmsItemsResponseWrapper`1[[iikoTransport.PublicApi.Contracts.Address.City, iikoTransport.PublicApi.Contracts, Version=9.0.6.4, Culture=neutral, PublicKeyToken=null]] Up

RMS pair wrapping - list of response items that belong to this RMS.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
items

iikoTransport.PublicApi.Contracts.Common.RmsItemsResponseWrapper`1[[iikoTransport.PublicApi.Contracts.Address.Region, iikoTransport.PublicApi.Contracts, Version=9.0.6.4, Culture=neutral, PublicKeyToken=null]] Up

RMS pair wrapping - list of response items that belong to this RMS.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
items

iikoTransport.PublicApi.Contracts.Common.RmsItemsResponseWrapper`1[[iikoTransport.PublicApi.Contracts.Discounts.DiscountCardTypeInfo, iikoTransport.PublicApi.Contracts, Version=9.0.6.4, Culture=neutral, PublicKeyToken=null]] Up

RMS pair wrapping - list of response items that belong to this RMS.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
items

iikoTransport.PublicApi.Contracts.Common.RmsItemsResponseWrapper`1[[iikoTransport.PublicApi.Contracts.Employees.ActiveCourierLocation, iikoTransport.PublicApi.Contracts, Version=9.0.6.4, Culture=neutral, PublicKeyToken=null]] Up

RMS pair wrapping - list of response items that belong to this RMS.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
items

iikoTransport.PublicApi.Contracts.Common.RmsItemsResponseWrapper`1[[iikoTransport.PublicApi.Contracts.Employees.CourierLocations, iikoTransport.PublicApi.Contracts, Version=9.0.6.4, Culture=neutral, PublicKeyToken=null]] Up

RMS pair wrapping - list of response items that belong to this RMS.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
items

iikoTransport.PublicApi.Contracts.Common.RmsItemsResponseWrapper`1[[iikoTransport.PublicApi.Contracts.Employees.Employee, iikoTransport.PublicApi.Contracts, Version=9.0.6.4, Culture=neutral, PublicKeyToken=null]] Up

RMS pair wrapping - list of response items that belong to this RMS.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
items

iikoTransport.PublicApi.Contracts.Common.RmsItemsResponseWrapper`1[[iikoTransport.PublicApi.Contracts.Employees.EmployeeWithCheckedRole, iikoTransport.PublicApi.Contracts, Version=9.0.6.4, Culture=neutral, PublicKeyToken=null]] Up

RMS pair wrapping - list of response items that belong to this RMS.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
items

iikoTransport.PublicApi.Contracts.Common.RmsItemsResponseWrapper`1[[iikoTransport.PublicApi.Contracts.OrderTypes.OrderType, iikoTransport.PublicApi.Contracts, Version=9.0.6.4, Culture=neutral, PublicKeyToken=null]] Up

RMS pair wrapping - list of response items that belong to this RMS.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
items

iikoTransport.PublicApi.Contracts.Common.RmsItemsResponseWrapper`1[[iikoTransport.PublicApi.Contracts.StopLists.TerminalGroupStopList, iikoTransport.PublicApi.Contracts, Version=9.0.6.4, Culture=neutral, PublicKeyToken=null]] Up

RMS pair wrapping - list of response items that belong to this RMS.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
items

iikoTransport.PublicApi.Contracts.Common.RmsItemsResponseWrapper`1[[iikoTransport.PublicApi.Contracts.Terminals.TerminalGroup, iikoTransport.PublicApi.Contracts, Version=9.0.6.4, Culture=neutral, PublicKeyToken=null]] Up

RMS pair wrapping - list of response items that belong to this RMS.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
items

iikoTransport.PublicApi.Contracts.Common.SortDirection Up

Sorting direction.

iikoTransport.PublicApi.Contracts.Deliveries.Common.CardPaymentAdditionalData Up

Additional data for Card payment item.
type
customData
String <p>Custom data.</p> <blockquote> <p>If this property is set, the above <code>number</code> property is ignored.</p> </blockquote> <blockquote> <p>Allowed from version <code>8.8.6</code>.</p> </blockquote>

iikoTransport.PublicApi.Contracts.Deliveries.Common.ChequeAdditionalInfo Up

Cheque additional information according to russian federal law #54.
needReceipt
Boolean Whether paper cheque should be printed.
email (optional)
String Email to send cheque information or null if the cheque shouldn't be sent by email.
settlementPlace (optional)
String Settlement place.
phone (optional)
String Phone to send cheque information (by sms) or null if the cheque shouldn't be sent by sms.

iikoTransport.PublicApi.Contracts.Deliveries.Common.Coordinates Up

Coordinate details.
latitude
Double Latitude. format: double
longitude
Double Longitude. format: double

iikoTransport.PublicApi.Contracts.Deliveries.Common.DeliveryStatus Up

Delivery order statuses.

iikoTransport.PublicApi.Contracts.Deliveries.Common.DeliveryStatusForUpdate Up

Delivery order statuses for update requests.

iikoTransport.PublicApi.Contracts.Deliveries.Common.Gender Up

Sex.

iikoTransport.PublicApi.Contracts.Deliveries.Common.IikoCardSearchScope Up

iikoTransport.PublicApi.Contracts.Deliveries.Common.LoyaltyCardPaymentAdditionalData Up

Additional data for LoyaltyApp payment item.
type
credential
String Guest credential, authorizing payment.
searchScope
Guest credential search scope.

iikoTransport.PublicApi.Contracts.Deliveries.Common.OrderServiceType Up

Order type.

iikoTransport.PublicApi.Contracts.Deliveries.Common.PaymentAdditionalData Up

Additional payment data.
type

iikoTransport.PublicApi.Contracts.Deliveries.Common.PaymentTypeKind Up

Payment type kind.

iikoTransport.PublicApi.Contracts.Deliveries.Drafts.CommitDraftRequest Up

Delivery order draft commitment request.
organizationId
UUID <p>Organization ID of the new order.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
terminalGroupId (optional)
UUID <p>Front group ID the order must be sent to.</p> <p>Can be obtained by <code>/api/1/terminal_groups</code> operation.</p> format: uuid
createOrderSettings (optional)
Order creation parameters.
orderId
UUID ID of the order. format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Drafts.CreateDraftRequest Up

Draft creation model.
organizationId
UUID <p>Organization ID of the new order.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
order
Order item.
terminalGroupId (optional)
UUID <p>Front group ID the order must be sent to.</p> <p>Can be obtained by <code>/api/1/terminal_groups</code> operation.</p> format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Drafts.CreateOrSaveDraftResponse Up

Wrapping object (external) for a delivery order draft creation/update return.
correlationId
UUID Operation ID. format: uuid
orderId
UUID Order draft order ID. format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Drafts.DeleteDraftRequest Up

Delivery order draft deletion request.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
orderId
UUID ID of the order. format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Drafts.DeliveryOrderDraft Up

Delivery order draft.
menuId
String External menu ID.
id (optional)
UUID <p>Order ID. Must be unique.</p> <blockquote> <p>If sent null, it generates automatically on iikoTransport side.</p> </blockquote> format: uuid
externalNumber (optional)
String <p>Order external number.</p> <blockquote> <p>Allowed from version <code>8.0.6</code>.</p> </blockquote>
completeBefore (optional)
String <p>Order fulfillment date.</p> <blockquote> <p>Date and time must be local for delivery terminal, without time zone (take a look at example). If null, order is urgent and time is calculated based on customer settings, i.e. the shortest delivery time possible. Permissible values: from current day and 60 days on.</p> </blockquote> format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
phone
String <p>Telephone number.</p> <blockquote> <p>Must begin with symbol &quot;+&quot; and must be at least 8 digits.</p> </blockquote>
orderTypeId (optional)
UUID <p>Order type ID.</p> <p>Can be obtained by <code>/api/1/deliveries/order_types</code> operation.</p> <blockquote> <p>Only one of the fields must be defined: <strong>orderTypeId</strong> or <strong>orderServiceType</strong>.</p> </blockquote> format: uuid
orderServiceType (optional)
<p>Order service type.</p> <blockquote> <p>Only one of the fields must be defined: <strong>orderTypeId</strong> or <strong>orderServiceType</strong>.</p> </blockquote> <blockquote> <p>Allowed from version <code>7.0.3</code>.</p> </blockquote>
deliveryPoint (optional)
<p>Delivery point details.</p> <blockquote> <p>Not required in case of customer pickup. Otherwise, required.</p> </blockquote>
comment (optional)
String Order comment.
customer (optional)
<p>Customer.</p> <p>'Regular' customer:</p> <ul> <li>can be used only if a customer agrees to take part in the store's loyalty programs</li> <li>customer details will be added (updated) to the store's customer database</li> <li>benefits (accumulation of rewards, etc.) of active loyalty programs will be made available to the customer</li> </ul> <p>'One-time' customer:</p> <ul> <li>should be used if a customer does not agree to take part in the store's loyalty programs or an aggregator (external system) does not provide customer details</li> <li>customer details will NOT be added to the store's customer database and will be used ONLY to complete the current order</li> </ul>
guests (optional)
Guest details. Not equal to the customer who makes an order.
marketingSourceId (optional)
UUID <p>Marketing source (advertisement) ID.</p> <p>Can be obtained by <code>/api/1/marketing_sources</code> operation.</p> format: uuid
operatorId (optional)
UUID <p>Operator ID.</p> <blockquote> <p>Allowed from version <code>7.6.3</code>.</p> </blockquote> format: uuid
deliveryDuration (optional)
Integer <p>Delivery duration.</p> <blockquote> <p>Allowed from version <code>8.8.6</code>.</p> </blockquote> format: int32
deliveryZone (optional)
String <p>Name of delivery zone.</p> <blockquote> <p>Allowed from version <code>8.8.6</code>.</p> </blockquote>
items
combos (optional)
payments (optional)
array[iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.Payment] <p>Order payment components.</p> <blockquote> <p>Type <strong>LoyaltyCard</strong> allowed from version <code>7.1.5</code>.</p> </blockquote>
tips (optional)
sourceKey (optional)
String The string key (marker) of the source (partner - api user) that created the order. Needed to limit the visibility of orders for external integration.
discountsInfo (optional)
Discounts/surcharges.
loyaltyInfo (optional)
Information about Loyalty app.
chequeAdditionalInfo (optional)
Cheque additional information.
externalData (optional)
array[iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.ExternalData] <p>Order external data.</p> <blockquote> <p>Allowed from version <code>8.0.6</code>.</p> </blockquote>

iikoTransport.PublicApi.Contracts.Deliveries.Drafts.FilterDraftsRequest Up

Request for the list of order drafts by several filters.
organizationIds
array[UUID] <p>Organization ID for which the order drafts search will be performed.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
dateFrom (optional)
String Draft creation time (UTC). Lower limit. format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
dateTo (optional)
String Draft creation time (UTC). Upper limit. format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
phone (optional)
String Phone number.
limit (optional)
Integer Desirable size of result set (50 by default). format: int32
offset (optional)
Integer Offset from the beginning of full result set for paging. format: int32
sourceKeys (optional)
array[String] Delivery sources (DeliveryClub, PH and etc.)
terminalGroupIds (optional)
array[UUID] List of terminal groups IDs. format: uuid
searchText (optional)
String Value for search. Used for prefix search.
sortProperty (optional)
Sorting property.
sortDirection (optional)
Sorting direction.
operatorIds (optional)
array[UUID] List of drafts operator IDs. format: uuid
orderTypeIds (optional)
array[UUID] List of drafts order type IDs. format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Drafts.FilterDraftsResponse Up

Wrapping object (external) for a delivery order drafts return.
correlationId
UUID Operation ID. format: uuid
drafts

iikoTransport.PublicApi.Contracts.Deliveries.Drafts.GetDraftRequest Up

Request for an order draft by ID.
organizationId
UUID <p>Organization ID for which the order search will be performed.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
orderId
UUID Order ID. format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Drafts.GetDraftResponse Up

Wrapping object (external) for an order draft.
correlationId
UUID Operation ID. format: uuid
order
Order draft object.
lockedByUser
UUID ID of the employee who is currently editing this draft. format: uuid
organizationId
UUID Organization ID. format: uuid
terminalGroupId (optional)
UUID Terminal group ID. format: uuid
createdAt
String Draft creation time (UTC). format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123

iikoTransport.PublicApi.Contracts.Deliveries.Drafts.LockOrUnlockDraftRequest Up

Delivery order draft lock or unlock request.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
orderId
UUID ID of the order. format: uuid
employeeId
UUID ID of the employee. format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Drafts.OrderDraft Up

Order draft object.
id
UUID Order ID. format: uuid
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
lockedByUser (optional)
UUID ID of the employee, who is editing this draft. format: uuid
order
Order.
terminalGroupId (optional)
UUID Terminal group ID. format: uuid
createdAt
String Draft creation time (UTC). format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123

iikoTransport.PublicApi.Contracts.Deliveries.Drafts.OrderDraftSortProperty Up

OrderDraft sorting property.

iikoTransport.PublicApi.Contracts.Deliveries.Drafts.SaveDraftRequest Up

Draft editing model.
employeeId
UUID ID of the employee who wants to update order draft. format: uuid
organizationId
UUID <p>Organization ID of the new order.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
order
Order item.
terminalGroupId (optional)
UUID <p>Front group ID the order must be sent to.</p> <p>Can be obtained by <code>/api/1/terminal_groups</code> operation.</p> format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Request.AddOrderItemsRequest Up

Request for add order items.
orderId
UUID Order ID. format: uuid
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
items
array[iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.OrderItem] Order items (may include ProductOrderItem or CompoundOrderItem).
combos (optional)
array[iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.Combo] <p>Combos.</p> <blockquote> <p>Allowed from version <code>7.6.1</code>.</p> </blockquote>

iikoTransport.PublicApi.Contracts.Deliveries.Request.CancelOrderRequest Up

Request for cancel the order.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
orderId
UUID Order ID. format: uuid
movedOrderId (optional)
UUID Fill this field with id of the new order if current order has been moved to the new RMS/terminal group. format: uuid
cancelCauseId (optional)
UUID <p>Cancel order dictionary item id.</p> <blockquote> <p>Allowed from version <code>7.7.1</code>.</p> </blockquote> format: uuid
removalTypeId (optional)
UUID <p>Removal type (for delete printed order items).</p> <blockquote> <p>Allowed from version <code>7.7.1</code>.</p> </blockquote> format: uuid
userIdForWriteoff (optional)
UUID <p>User for writeoff (for delete printed order items).</p> <blockquote> <p>Allowed from version <code>7.7.1</code>.</p> </blockquote> format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Request.ChangeDriverInfoRequest Up

Request for change driver info.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
orderId
UUID Order ID. format: uuid
driverId (optional)
UUID <p>Driver ID.</p> <p>Can be obtained by <code>/api/1/employees/couriers</code> operation.</p> format: uuid
estimatedTime (optional)
String Delivery estimated time. format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123

iikoTransport.PublicApi.Contracts.Deliveries.Request.CloseDeliveryOrderRequest Up

Request for close table order.
deliveryDate (optional)
String <p>Actual delivery time. If empty local iikoFront time will used.</p> <blockquote> <p>Allowed from version <code>8.0.6</code>.</p> </blockquote> format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
orderId
UUID Order ID. format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Request.CloseTableOrderRequest Up

Request for close table order.
chequeAdditionalInfo (optional)
Cheque additional information according to russian federal law #54.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
orderId
UUID Order ID. format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.Address Up

Order delivery address
type

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.AddressCity Up

Order delivery address.
type
line1
String <p>Address line 1. Contains the primary address information.</p> <blockquote> <p>Allowed from version <code>8.7.6</code>.</p> </blockquote>
flat (optional)
String Apartment.
entrance (optional)
String Entrance.
floor (optional)
String Floor.
doorphone (optional)
String Intercom.
regionId (optional)
UUID Delivery area ID. format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.AddressLegacy Up

Order delivery legacy address.
type
street
Street.
index (optional)
String Postcode.
house
String House.
building (optional)
String Building.
flat (optional)
String <p>Apartment.</p> <blockquote> <p>In case useUaeAddressingSystem enabled max length - 100, otherwise - 10</p> </blockquote>
entrance (optional)
String Entrance.
floor (optional)
String Floor.
doorphone (optional)
String Intercom.
regionId (optional)
UUID Delivery area ID. format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.AnonymousCustomer Up

<p>'One-time' customer:</p> <ul> <li>should be used if a customer does not agree to take part in the store's loyalty programs or an aggregator (external system) does not provide customer details</li> <li>customer details will NOT be added to the store's customer database and will be used ONLY to complete the current order</li> </ul>
type
name
String Customer name.

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.CardPayment Up

Bank card payment.
paymentTypeKind
sum
Double Amount due. format: double
paymentTypeId
UUID <p>Payment type.</p> <p>Can be obtained by <code>/api/1/payment_types</code> operation.</p> format: uuid
isProcessedExternally (optional)
Boolean Whether payment item is processed by external payment system (made from outside).
paymentAdditionalData (optional)
Additional payment parameters.
isFiscalizedExternally (optional)
Boolean <p>Whether the payment item is externally fiscalized.</p> <blockquote> <p>Allowed from version <code>7.6.3</code>.</p> </blockquote>
isPrepay (optional)
Boolean <p>Whether the payment item is prepay. Unavailable for <code>paymentKindType.LoyaltyCard</code>.</p> <blockquote> <p>Allowed from version <code>8.2.6</code>.</p> </blockquote>
number (optional)
String <p>Card No.</p> <blockquote> <p>In iikoFront, it is possible to make card payment without card No.</p> </blockquote>

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.CardTipsPayment Up

Bank card tips payment.
paymentTypeKind
tipsTypeId (optional)
UUID <p>Tips type ID.</p> <p>Can be obtained by <code>/api/1/tips_types</code> operation.</p> format: uuid
sum
Double Amount due. format: double
paymentTypeId
UUID <p>Payment type.</p> <p>Can be obtained by <code>/api/1/payment_types</code> operation.</p> format: uuid
isProcessedExternally (optional)
Boolean Whether payment item is processed by external payment system (made from outside).
paymentAdditionalData (optional)
Additional payment parameters.
isFiscalizedExternally (optional)
Boolean <p>Whether the payment item is externally fiscalized.</p> <blockquote> <p>Allowed from version <code>7.6.3</code>.</p> </blockquote>
isPrepay (optional)
Boolean <p>Whether the payment item is prepay. Unavailable for <code>paymentKindType.LoyaltyCard</code>.</p> <blockquote> <p>Allowed from version <code>8.2.6</code>.</p> </blockquote>
number (optional)
String <p>Card No.</p> <blockquote> <p>In iikoFront, it is possible to make card payment without card No.</p> </blockquote>

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.CashPayment Up

Cash payment. <remarks> No additional fields for base class. </remarks>
paymentTypeKind
sum
Double Amount due. format: double
paymentTypeId
UUID <p>Payment type.</p> <p>Can be obtained by <code>/api/1/payment_types</code> operation.</p> format: uuid
isProcessedExternally (optional)
Boolean Whether payment item is processed by external payment system (made from outside).
paymentAdditionalData (optional)
Additional payment parameters.
isFiscalizedExternally (optional)
Boolean <p>Whether the payment item is externally fiscalized.</p> <blockquote> <p>Allowed from version <code>7.6.3</code>.</p> </blockquote>
isPrepay (optional)
Boolean <p>Whether the payment item is prepay. Unavailable for <code>paymentKindType.LoyaltyCard</code>.</p> <blockquote> <p>Allowed from version <code>8.2.6</code>.</p> </blockquote>

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.CashTipsPayment Up

Cash tips payment. <remarks> No additional fields for base class. </remarks>
paymentTypeKind
tipsTypeId (optional)
UUID <p>Tips type ID.</p> <p>Can be obtained by <code>/api/1/tips_types</code> operation.</p> format: uuid
sum
Double Amount due. format: double
paymentTypeId
UUID <p>Payment type.</p> <p>Can be obtained by <code>/api/1/payment_types</code> operation.</p> format: uuid
isProcessedExternally (optional)
Boolean Whether payment item is processed by external payment system (made from outside).
paymentAdditionalData (optional)
Additional payment parameters.
isFiscalizedExternally (optional)
Boolean <p>Whether the payment item is externally fiscalized.</p> <blockquote> <p>Allowed from version <code>7.6.3</code>.</p> </blockquote>
isPrepay (optional)
Boolean <p>Whether the payment item is prepay. Unavailable for <code>paymentKindType.LoyaltyCard</code>.</p> <blockquote> <p>Allowed from version <code>8.2.6</code>.</p> </blockquote>

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.Combo Up

Combo in order.
id
UUID Combo ID. MUST be unique for the whole system. Therefore it must be generated with Guid.NewGuid(). format: uuid
name
String Name of combo.
amount
Integer Quantity. format: int32
price
Double Price of one combo. format: double
sourceId
UUID Combo validity ID. format: uuid
programId (optional)
UUID <p>Card program ID.</p> <blockquote> <p>Allowed from version <code>7.6.1</code>.</p> </blockquote> format: uuid
sizeId (optional)
UUID <p>Size ID. Required if combo has a size scale.</p> <blockquote> <p>Allowed from version <code>8.5.6</code>.</p> </blockquote> format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.ComboItemInformation Up

Combo details if order item belongs to combo
comboId
UUID Created combo ID. Must be one of combos.id generated values. format: uuid
comboSourceId
UUID Action ID that defines combo. format: uuid
comboGroupId
UUID Combo group ID to which item belongs. format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.CompoundOrderItem Up

Order item: composite item.
type
amount
Double Quantity. format: double
productSizeId (optional)
UUID Size ID. Required if a stock list item has a size scale. format: uuid
comboInformation (optional)
Combo details if combo includes order item.
comment (optional)
String Comment.
primaryComponent
Main component.
secondaryComponent (optional)
Minor component.
commonModifiers (optional)

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.CompoundOrderItemComponent Up

Item component
productId
UUID Item ID. format: uuid
modifiers (optional)
price (optional)
Double Price. format: double
positionId (optional)
UUID <p>Unique identifier of the item in the order. MUST be unique for the whole system. Therefore it must be generated with Guid.NewGuid().</p> <blockquote> <p>If sent null, it generates automatically on iikoTransport side.</p> </blockquote> format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.Customer Up

Customer base info.
type

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.DeliveryOrder Up

Delivery order.
menuId (optional)
String External menu ID.
id (optional)
UUID <p>Order ID. Must be unique.</p> <blockquote> <p>If sent null, it generates automatically on iikoTransport side.</p> </blockquote> format: uuid
externalNumber (optional)
String <p>Order external number.</p> <blockquote> <p>Allowed from version <code>8.0.6</code>.</p> </blockquote>
completeBefore (optional)
String <p>Order fulfillment date.</p> <blockquote> <p>Date and time must be local for delivery terminal, without time zone (take a look at example). If null, order is urgent and time is calculated based on customer settings, i.e. the shortest delivery time possible. Permissible values: from current day and 60 days on.</p> </blockquote> format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
phone
String <p>Telephone number.</p> <blockquote> <p>Must begin with symbol &quot;+&quot; and must be at least 8 digits.</p> </blockquote>
orderTypeId (optional)
UUID <p>Order type ID.</p> <p>Can be obtained by <code>/api/1/deliveries/order_types</code> operation.</p> <blockquote> <p>Only one of the fields must be defined: <strong>orderTypeId</strong> or <strong>orderServiceType</strong>.</p> </blockquote> format: uuid
orderServiceType (optional)
<p>Order service type.</p> <blockquote> <p>Only one of the fields must be defined: <strong>orderTypeId</strong> or <strong>orderServiceType</strong>.</p> </blockquote> <blockquote> <p>Allowed from version <code>7.0.3</code>.</p> </blockquote>
deliveryPoint (optional)
<p>Delivery point details.</p> <blockquote> <p>Not required in case of customer pickup. Otherwise, required.</p> </blockquote>
comment (optional)
String Order comment.
customer (optional)
<p>Customer.</p> <p>'Regular' customer:</p> <ul> <li>can be used only if a customer agrees to take part in the store's loyalty programs</li> <li>customer details will be added (updated) to the store's customer database</li> <li>benefits (accumulation of rewards, etc.) of active loyalty programs will be made available to the customer</li> </ul> <p>'One-time' customer:</p> <ul> <li>should be used if a customer does not agree to take part in the store's loyalty programs or an aggregator (external system) does not provide customer details</li> <li>customer details will NOT be added to the store's customer database and will be used ONLY to complete the current order</li> </ul>
guests (optional)
Guest details. Not equal to the customer who makes an order.
marketingSourceId (optional)
UUID <p>Marketing source (advertisement) ID.</p> <p>Can be obtained by <code>/api/1/marketing_sources</code> operation.</p> format: uuid
operatorId (optional)
UUID <p>Operator ID.</p> <blockquote> <p>Allowed from version <code>7.6.3</code>.</p> </blockquote> format: uuid
deliveryDuration (optional)
Integer <p>Delivery duration.</p> <blockquote> <p>Allowed from version <code>8.8.6</code>.</p> </blockquote> format: int32
deliveryZone (optional)
String <p>Name of delivery zone.</p> <blockquote> <p>Allowed from version <code>8.8.6</code>.</p> </blockquote>
items
combos (optional)
payments (optional)
array[iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.Payment] <p>Order payment components.</p> <blockquote> <p>Type <strong>LoyaltyCard</strong> allowed from version <code>7.1.5</code>.</p> </blockquote>
tips (optional)
sourceKey (optional)
String The string key (marker) of the source (partner - api user) that created the order. Needed to limit the visibility of orders for external integration.
discountsInfo (optional)
Discounts/surcharges.
loyaltyInfo (optional)
Information about Loyalty app.
chequeAdditionalInfo (optional)
Cheque additional information.
externalData (optional)
array[iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.ExternalData] <p>Order external data.</p> <blockquote> <p>Allowed from version <code>8.0.6</code>.</p> </blockquote>

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.DeliveryPoint Up

Delivery location details.
coordinates (optional)
<p>Delivery address coordinates.</p> <blockquote> <p>Allowed from version <code>7.7.3</code>.</p> </blockquote>
address (optional)
<p>Order delivery address.</p> <blockquote> <p>The use of type <strong>City</strong> is allowed if the parameter <strong>addressFormatType == City</strong>.</p> </blockquote> <blockquote> <p>Can be obtained by <code>/api/1/organizations</code> or <code>/api/1/organizations/settings</code> operations (<code>addressFormatType</code> parameter).</p> </blockquote>
externalCartographyId (optional)
String Delivery location custom code in customer's API system.
comment (optional)
String Additional information.

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.Discount Up

Discount/surcharge.
type

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.DiscountCard Up

Discount card.
track
String Track of discount card to be applied to order.

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.DiscountsInfo Up

Information on discounts/surcharges to be applied to order. <remarks> Whether map or non-blank list of discounts must be set. </remarks>
card (optional)
Track of discount card to be applied to order.
discounts (optional)
array[iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.Discount] <p>Discounts/surcharges.</p> <blockquote> <p>Type <strong>iikoCard</strong> allowed from version <code>7.4.4</code>.</p> </blockquote>

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.ExternalData Up

Order external data.
key
String Key.
value
String Value.
isPublic (optional)
Boolean Is this external data public (for RMS OLAP-reports).

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.ExternalPayment Up

External payment type
paymentTypeKind
sum
Double Amount due. format: double
paymentTypeId
UUID <p>Payment type.</p> <p>Can be obtained by <code>/api/1/payment_types</code> operation.</p> format: uuid
isProcessedExternally (optional)
Boolean Whether payment item is processed by external payment system (made from outside).
paymentAdditionalData (optional)
Additional payment parameters.
isFiscalizedExternally (optional)
Boolean <p>Whether the payment item is externally fiscalized.</p> <blockquote> <p>Allowed from version <code>7.6.3</code>.</p> </blockquote>
isPrepay (optional)
Boolean <p>Whether the payment item is prepay. Unavailable for <code>paymentKindType.LoyaltyCard</code>.</p> <blockquote> <p>Allowed from version <code>8.2.6</code>.</p> </blockquote>

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.ExternalTipsPayment Up

External tips payment type
paymentTypeKind
tipsTypeId (optional)
UUID <p>Tips type ID.</p> <p>Can be obtained by <code>/api/1/tips_types</code> operation.</p> format: uuid
sum
Double Amount due. format: double
paymentTypeId
UUID <p>Payment type.</p> <p>Can be obtained by <code>/api/1/payment_types</code> operation.</p> format: uuid
isProcessedExternally (optional)
Boolean Whether payment item is processed by external payment system (made from outside).
paymentAdditionalData (optional)
Additional payment parameters.
isFiscalizedExternally (optional)
Boolean <p>Whether the payment item is externally fiscalized.</p> <blockquote> <p>Allowed from version <code>7.6.3</code>.</p> </blockquote>
isPrepay (optional)
Boolean <p>Whether the payment item is prepay. Unavailable for <code>paymentKindType.LoyaltyCard</code>.</p> <blockquote> <p>Allowed from version <code>8.2.6</code>.</p> </blockquote>

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.Guests Up

Information on guests.
count
Integer Number of persons in order. This field defines the number of cutlery sets format: int32
splitBetweenPersons (optional)
Boolean Attribute that shows whether order must be split among guests.

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.IikoCardDiscount Up

Card discount/surcharge.
type
programId
UUID Card program ID. format: uuid
programName
String Card program name.
discountItems

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.IikoCardDiscountItem Up

Card discount/surcharge item.
positionId
UUID Position ID of order item. format: uuid
sum
Double Discount/surcharge sum. format: double
amount
Double Amount. format: double

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.LoyaltyCardPayment Up

Payment with Card loyalty system.
paymentTypeKind
sum
Double Amount due. format: double
paymentTypeId
UUID <p>Payment type.</p> <p>Can be obtained by <code>/api/1/payment_types</code> operation.</p> format: uuid
isProcessedExternally (optional)
Boolean Whether payment item is processed by external payment system (made from outside).
paymentAdditionalData (optional)
Additional payment parameters.
isFiscalizedExternally (optional)
Boolean <p>Whether the payment item is externally fiscalized.</p> <blockquote> <p>Allowed from version <code>7.6.3</code>.</p> </blockquote>
isPrepay (optional)
Boolean <p>Whether the payment item is prepay. Unavailable for <code>paymentKindType.LoyaltyCard</code>.</p> <blockquote> <p>Allowed from version <code>8.2.6</code>.</p> </blockquote>

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.LoyaltyInfo Up

Information about Loyalty app.
coupon (optional)
String Coupon No. that was considered when calculating loyalty program.
applicableManualConditions (optional)
array[UUID] Information about applied manual conditions. format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.Modifier Up

Modifier.
productId
UUID <p>Modifier item ID.</p> <p>Can be obtained by <code>/api/1/nomenclature</code> operation.</p> format: uuid
amount
Double Quantity. format: double
productGroupId (optional)
UUID <p>Modifiers group ID (for group modifier). Required for a group modifier.</p> <p>Can be obtained by <code>/api/1/nomenclature</code> operation.</p> format: uuid
price (optional)
Double Unit price. format: double
positionId (optional)
UUID <p>Unique identifier of the item in the order. MUST be unique for the whole system. Therefore it must be generated with Guid.NewGuid().</p> <blockquote> <p>If sent null, it generates automatically on iikoTransport side.</p> </blockquote> format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.Order Up

Order.
id (optional)
UUID <p>Order ID. Must be unique.</p> <blockquote> <p>If sent null, it generates automatically on iikoTransport side.</p> </blockquote> format: uuid
externalNumber (optional)
String <p>Order external number.</p> <blockquote> <p>Allowed from version <code>8.0.6</code>.</p> </blockquote>
completeBefore (optional)
String <p>Order fulfillment date.</p> <blockquote> <p>Date and time must be local for delivery terminal, without time zone (take a look at example). If null, order is urgent and time is calculated based on customer settings, i.e. the shortest delivery time possible. Permissible values: from current day and 60 days on.</p> </blockquote> format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
phone
String <p>Telephone number.</p> <blockquote> <p>Must begin with symbol &quot;+&quot; and must be at least 8 digits.</p> </blockquote>
orderTypeId (optional)
UUID <p>Order type ID.</p> <p>Can be obtained by <code>/api/1/deliveries/order_types</code> operation.</p> <blockquote> <p>Only one of the fields must be defined: <strong>orderTypeId</strong> or <strong>orderServiceType</strong>.</p> </blockquote> format: uuid
orderServiceType (optional)
<p>Order service type.</p> <blockquote> <p>Only one of the fields must be defined: <strong>orderTypeId</strong> or <strong>orderServiceType</strong>.</p> </blockquote> <blockquote> <p>Allowed from version <code>7.0.3</code>.</p> </blockquote>
deliveryPoint (optional)
<p>Delivery point details.</p> <blockquote> <p>Not required in case of customer pickup. Otherwise, required.</p> </blockquote>
comment (optional)
String Order comment.
customer (optional)
<p>Customer.</p> <p>'Regular' customer:</p> <ul> <li>can be used only if a customer agrees to take part in the store's loyalty programs</li> <li>customer details will be added (updated) to the store's customer database</li> <li>benefits (accumulation of rewards, etc.) of active loyalty programs will be made available to the customer</li> </ul> <p>'One-time' customer:</p> <ul> <li>should be used if a customer does not agree to take part in the store's loyalty programs or an aggregator (external system) does not provide customer details</li> <li>customer details will NOT be added to the store's customer database and will be used ONLY to complete the current order</li> </ul>
guests (optional)
Guest details. Not equal to the customer who makes an order.
marketingSourceId (optional)
UUID <p>Marketing source (advertisement) ID.</p> <p>Can be obtained by <code>/api/1/marketing_sources</code> operation.</p> format: uuid
operatorId (optional)
UUID <p>Operator ID.</p> <blockquote> <p>Allowed from version <code>7.6.3</code>.</p> </blockquote> format: uuid
deliveryDuration (optional)
Integer <p>Delivery duration.</p> <blockquote> <p>Allowed from version <code>8.8.6</code>.</p> </blockquote> format: int32
deliveryZone (optional)
String <p>Name of delivery zone.</p> <blockquote> <p>Allowed from version <code>8.8.6</code>.</p> </blockquote>
items
combos (optional)
payments (optional)
array[iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.Payment] <p>Order payment components.</p> <blockquote> <p>Type <strong>LoyaltyCard</strong> allowed from version <code>7.1.5</code>.</p> </blockquote>
tips (optional)
sourceKey (optional)
String The string key (marker) of the source (partner - api user) that created the order. Needed to limit the visibility of orders for external integration.
discountsInfo (optional)
Discounts/surcharges.
loyaltyInfo (optional)
Information about Loyalty app.
chequeAdditionalInfo (optional)
Cheque additional information.
externalData (optional)
array[iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.ExternalData] <p>Order external data.</p> <blockquote> <p>Allowed from version <code>8.0.6</code>.</p> </blockquote>

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.OrderItem Up

Order item.
type
amount
Double Quantity. format: double
productSizeId (optional)
UUID Size ID. Required if a stock list item has a size scale. format: uuid
comboInformation (optional)
Combo details if combo includes order item.
comment (optional)
String Comment.

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.OrderServiceType Up

Order type.

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.Payment Up

Base class of delivery order payment item.
paymentTypeKind
sum
Double Amount due. format: double
paymentTypeId
UUID <p>Payment type.</p> <p>Can be obtained by <code>/api/1/payment_types</code> operation.</p> format: uuid
isProcessedExternally (optional)
Boolean Whether payment item is processed by external payment system (made from outside).
paymentAdditionalData (optional)
Additional payment parameters.
isFiscalizedExternally (optional)
Boolean <p>Whether the payment item is externally fiscalized.</p> <blockquote> <p>Allowed from version <code>7.6.3</code>.</p> </blockquote>
isPrepay (optional)
Boolean <p>Whether the payment item is prepay. Unavailable for <code>paymentKindType.LoyaltyCard</code>.</p> <blockquote> <p>Allowed from version <code>8.2.6</code>.</p> </blockquote>

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.ProductOrderItem Up

Order item: item.
type
amount
Double Quantity. format: double
productSizeId (optional)
UUID Size ID. Required if a stock list item has a size scale. format: uuid
comboInformation (optional)
Combo details if combo includes order item.
comment (optional)
String Comment.
productId
UUID <p>ID of menu item.</p> <p>Can be obtained by <code>/api/1/nomenclature</code> operation.</p> format: uuid
modifiers (optional)
price
Double Price per item unit. Can be sent different from the price in the base menu. format: double
positionId (optional)
UUID <p>Unique identifier of the item in the order. MUST be unique for the whole system. Therefore it must be generated with Guid.NewGuid().</p> <blockquote> <p>If sent null, it generates automatically on iikoTransport side.</p> </blockquote> format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.RegularCustomer Up

<p>'Regular' customer:</p> <ul> <li>can be used only if a customer agrees to take part in the store's loyalty programs</li> <li>customer details will be added (updated) to the store's customer database</li> <li>benefits (accumulation of rewards, etc.) of active loyalty programs will be made available to the customer</li> </ul>
type
id (optional)
UUID <p>Existing customer ID in RMS.</p> <blockquote> <p>If null - the phone number is searched in database, otherwise the new customer is created in RMS.</p> </blockquote> format: uuid
name (optional)
String <p>Name of customer.</p> <blockquote> <p>Required for new customers (i.e. if &quot;id&quot; == null) Not required if &quot;id&quot; specified.</p> </blockquote>
surname (optional)
String Last name.
comment (optional)
String Comment.
birthdate (optional)
String Date of birth. format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
email (optional)
String Email.
shouldReceivePromoActionsInfo (optional)
Boolean Deprecated, use &quot;shouldReceiveOrderStatusNotifications&quot; instead.
shouldReceiveOrderStatusNotifications (optional)
Boolean Whether customer receives order status notification messages.
gender (optional)
Gender.

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.RmsDiscount Up

RMS discount/surcharge. <remarks> Amount must be specified only if discount has &quot;assign amount&quot; setting enabled. In any other case, amount must not be specified. </remarks>
type
discountTypeId
UUID <p>Discount type.</p> <p>Can be obtained by <code>/api/1/discounts</code> operation.</p> format: uuid
sum (optional)
Double Discount/surcharge sum. format: double
selectivePositions (optional)
array[UUID] Order item positions. format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.Street Up

Street.
classifierId (optional)
String Street ID in classifier, e.g., address database. \n &gt; For using in the Russian Federation only.
id (optional)
UUID <p>ID.</p> <p>Can be obtained by <code>/api/1/streets/by_city</code> operation.</p> format: uuid
name (optional)
String Name.
city (optional)
String City name.

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrder.TipsPayment Up

Base class of delivery order payment item.
paymentTypeKind
tipsTypeId (optional)
UUID <p>Tips type ID.</p> <p>Can be obtained by <code>/api/1/tips_types</code> operation.</p> format: uuid
sum
Double Amount due. format: double
paymentTypeId
UUID <p>Payment type.</p> <p>Can be obtained by <code>/api/1/payment_types</code> operation.</p> format: uuid
isProcessedExternally (optional)
Boolean Whether payment item is processed by external payment system (made from outside).
paymentAdditionalData (optional)
Additional payment parameters.
isFiscalizedExternally (optional)
Boolean <p>Whether the payment item is externally fiscalized.</p> <blockquote> <p>Allowed from version <code>7.6.3</code>.</p> </blockquote>
isPrepay (optional)
Boolean <p>Whether the payment item is prepay. Unavailable for <code>paymentKindType.LoyaltyCard</code>.</p> <blockquote> <p>Allowed from version <code>8.2.6</code>.</p> </blockquote>

iikoTransport.PublicApi.Contracts.Deliveries.Request.CreateOrderRequest Up

Order creation model.
organizationId
UUID <p>Organization ID of the new order.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
terminalGroupId (optional)
UUID <p>Front group ID the order must be sent to.</p> <p>Can be obtained by <code>/api/1/terminal_groups</code> operation.</p> format: uuid
createOrderSettings (optional)
Order creation parameters.
order
Order.

iikoTransport.PublicApi.Contracts.Deliveries.Request.OrderSortProperty Up

Order sorting property.

iikoTransport.PublicApi.Contracts.Deliveries.Request.OrdersByDeliveryDateAndFilterRequest Up

Request for information about orders from external source and based on additional filters.
organizationIds
array[UUID] <p>Organization ID for which an order search will be performed.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
terminalGroupIds (optional)
array[UUID] List of terminal groups IDs. format: uuid
deliveryDateFrom (optional)
String <p>Order delivery date (Local for delivery terminal). Lower limit.</p> <p>Order details are stored for 90 days.</p> format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
deliveryDateTo (optional)
String Order delivery date (Local for delivery terminal). Upper limit. format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
statuses (optional)
hasProblem (optional)
Boolean <p>If true, delivery has a problem.</p> <blockquote> <p>Conditions under which the order has a problem:</p> <ul> <li>order.problem.hasProblem is true;</li> <li>order status is Unconfirmed and CookingStartTime before now;</li> <li>order status is ReadyForCooking and (CookingStartTime + timeToCookingErrorTimeout) before now;</li> <li>order status is CookingCompleted or Waiting and (CookingStartTime + cookingTimeout) before now.</li> </ul> </blockquote>
orderServiceType (optional)
Order service type.
searchText (optional)
String Value for search. Used for prefix search.
timeToCookingErrorTimeout (optional)
Integer Error timeout for status time to cooking, in seconds. format: int32
cookingTimeout (optional)
Integer Expected cooking time, in seconds. format: int32
sortProperty (optional)
Sorting property.
sortDirection (optional)
Sorting direction.
rowsCount (optional)
Integer Maximum number of items returned. format: int32
sourceKeys (optional)
array[String] Source keys.
orderIds (optional)
array[UUID] <p>Order IDs.</p> <blockquote> <p>Must be null if &quot;posOrderIds&quot; is not null.</p> </blockquote> format: uuid
posOrderIds (optional)
array[UUID] <p>POS order IDs.</p> <blockquote> <p>Must be null if &quot;orderIds&quot; is not null.</p> </blockquote> format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Request.OrdersByDeliveryDateAndPhoneRequest Up

Request for a list of orders by phone number.
phone
String Delivery order phone number.
deliveryDateFrom (optional)
String <p>Order delivery date (Local for delivery terminal). Lower limit.</p> <p>Order details are stored for 90 days.</p> format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
deliveryDateTo (optional)
String Order delivery date (Local for delivery terminal). Upper limit. format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
organizationIds
array[UUID] <p>Organization ID for which an order search will be performed.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
startRevision (optional)
Long Revision start number beginning from which (but not including) new/edited orders will be returned. format: int64
sourceKeys (optional)
array[String] Source keys.
rowsCount (optional)
Integer Maximum number of items returned. <remarks> If null, all items will be returned. </remarks> format: int32

iikoTransport.PublicApi.Contracts.Deliveries.Request.OrdersByDeliveryDateAndStatusRequest Up

Request for information about orders.
organizationIds
array[UUID] <p>Organization ID for which an order search will be performed.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
deliveryDateFrom
String <p>Order delivery date (Local for delivery terminal). Lower limit.</p> <p>Order details are stored for 90 days.</p> format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
deliveryDateTo (optional)
String Order delivery date (Local for delivery terminal). Upper limit. format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
statuses (optional)
sourceKeys (optional)
array[String] Source keys.
courierIds (optional)
array[UUID] List of driver IDs. format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Request.OrdersByIdRequest Up

Request for information about orders using IDs.
organizationId
UUID <p>Organization ID for which an order search will be performed.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
orderIds (optional)
array[UUID] <p>IDs of orders information on which is required.</p> <blockquote> <p>Required if &quot;posOrderIds&quot; is null. Must be null if &quot;posOrderIds&quot; is not null.</p> </blockquote> <blockquote> <p>Maximum allowed &quot;orderIds&quot; to request - <code>200</code>.</p> </blockquote> format: uuid
sourceKeys (optional)
array[String] Source keys.
posOrderIds (optional)
array[UUID] <p>POS order IDs information on which is required.</p> <blockquote> <p>Required if &quot;orderIds&quot; is null. Must be null if &quot;orderIds&quot; is not null.</p> </blockquote> <blockquote> <p>Maximum allowed &quot;posOrderIds&quot; to request - <code>200</code>.</p> </blockquote> format: uuid
returnExternalDataKeys (optional)
array[String] Keys for retrun external data information.
returnLockedByUser (optional)
Boolean Whether to check and return LockedByUser property (see FullOrderUpdateRequest.EmployeeId).

iikoTransport.PublicApi.Contracts.Deliveries.Request.OrdersByRevisionRequest Up

Request for a list of edited orders starting from specified revision number.
startRevision
Long <p>Revision start number beginning from which (but not including) new/edited orders will be returned.</p> <blockquote> <p>Maximum revision offset to request - <code>3 hours</code>.</p> </blockquote> format: int64
organizationIds
array[UUID] <p>Organization ID for which an order search will be performed.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
sourceKeys (optional)
array[String] Source keys.

iikoTransport.PublicApi.Contracts.Deliveries.Request.OrdersHistoryByDeliveryDateAndPhoneRequest Up

Request for a list of historical orders by phone number.
phone
String Delivery order phone number.
deliveryDateFrom (optional)
String <p>Order delivery date (Local for delivery terminal). Lower limit.</p> <p>Order details are stored for 90 days.</p> format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
deliveryDateTo (optional)
String <p>Order delivery date (Local for delivery terminal). Upper limit.</p> <p>Order details are stored for 90 days.</p> format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
organizationIds
array[UUID] <p>Organization ID for which an order search will be performed.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
startRevision (optional)
Long <p>Revision start number beginning from which (but not including) orders will be returned.</p> <blockquote> <p>Maximum revision offset to request - <code>3 hours</code>.</p> </blockquote> format: int64
sourceKeys (optional)
array[String] Source keys.
rowsCount
Integer <p>Maximum number of items returned.</p> <blockquote> <p>Maximum numbers of items to request - <code>200</code>.</p> </blockquote> format: int32

iikoTransport.PublicApi.Contracts.Deliveries.Request.PrintDeliveryBillRequest Up

Request to print delivery bill.
organizationId
UUID Organization ID. format: uuid
orderId
UUID Order ID. format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateDeliveryStatusRequest Up

Request for delivery status update.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
orderId
UUID Order ID. format: uuid
deliveryStatus
Delivery status. Can be only switched between these three statuses.
deliveryDate (optional)
String The date and time when the order was received by the guest (Local for delivery terminal). format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123

iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrder.CancelDeliveryConfirmationRequest Up

Request for cancel delivery confirmation.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
orderId
UUID Order ID. format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrder.ChangeCompleteBeforeRequest Up

Request for change time when client wants the order to be delivered.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
orderId
UUID Order ID. format: uuid
newCompleteBefore
String New time when client wants the order to be delivered (Local for delivery terminal). format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123

iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrder.ChangeDeliveryCommentRequest Up

Request for change delivery comment.
organizationId
UUID Organization ID. format: uuid
orderId
UUID Order ID. format: uuid
comment
String New delivery comment.

iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrder.ChangeDeliveryOperatorRequest Up

Request for assign/change the order operator.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
orderId
UUID Order ID. format: uuid
operatorId
UUID Operator to assign the order to. format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrder.ChangeDeliveryPointRequest Up

Request for change order's delivery point information.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
orderId
UUID Order ID. format: uuid
newDeliveryPoint
New address of delivery.

iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrder.ChangeExternalDataRequest Up

Request for change of delivery or table order external data.
organizationId
UUID Organization ID. format: uuid
orderId
UUID Order ID. format: uuid
externalData

iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrder.ChangePaymentsRequest Up

Change order's payments request.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
orderId
UUID Order ID. format: uuid
payments
tips (optional)

iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrder.ChangeServiceTypeDeliveryByClient Up

Change order's delivery type to DeliveryByClient.
newServiceType
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
orderId
UUID Order ID. format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrder.ChangeServiceTypeDeliveryByCourier Up

Change order's delivery type to DeliveryByCourier.
newServiceType
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
orderId
UUID Order ID. format: uuid
deliveryPoint
Address of delivery.

iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrder.ChangeServiceTypeRequest Up

Request for change order's delivery type.
newServiceType
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
orderId
UUID Order ID. format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrder.ConfirmDeliveryRequest Up

Request for confirm delivery.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
orderId
UUID Order ID. format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrder.OrderPaymentItem Up

Payments details.
sum
Double Amount due format: double
paymentTypeId
UUID Payment type ID. format: uuid
isProcessedExternally
Boolean Payment item is processed by external payment system.

iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrderCourierRequest Up

Request for order courier update.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
orderId
UUID Order ID. format: uuid
employeeId
UUID <p>Courier ID.</p> <p>Can be obtained by <code>/api/1/employees/couriers</code> operation.</p> format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrderPaymentsRequest Up

Request for order payment update.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
orderId
UUID Order ID. format: uuid
paymentItems (optional)

iikoTransport.PublicApi.Contracts.Deliveries.Request.UpdateOrderProblemRequest Up

Request for order problem update.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
orderId
UUID Order ID. format: uuid
hasProblem
Boolean Problem flag.
problem
String Problem text.

iikoTransport.PublicApi.Contracts.Deliveries.Response.CheckCreateOrderResponse Up

Wrapping object (external) for a delivery check create order return.
correlationId
UUID Operation ID. format: uuid
errorInfo
Order check creation error details.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.Address Up

Address details.
street (optional)
Street.
index (optional)
String Postcode.
house (optional)
String House.
building (optional)
String Building.
flat (optional)
String Apartment.
entrance (optional)
String Entrance.
floor (optional)
String Floor.
doorphone (optional)
String Intercom.
region
Region
line1 (optional)
String Address line 1. Contains the primary address information.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.AnonymousCustomer Up

<p>'One-time' customer:</p> <ul> <li>should be used if a customer does not agree to take part in the store's loyalty programs or an aggregator (external system) does not provide customer details</li> <li>customer details will NOT be added to the store's customer database and will be used ONLY to complete the current order</li> </ul>
type
name
String Customer name.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.CancelCause Up

Delivery cancellation reason.
id
UUID ID. format: uuid
name
String Description.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.CancelInfo Up

Order cancellation details
whenCancelled
String Cancellation time (Local for delivery terminal). format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
cause
Delivery cancellation reason.
comment (optional)
String Delivery cancellation comment.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.City Up

City.
id
UUID ID. format: uuid
name
String Name.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.ComboItemInformation Up

Information on order item to combo relation.
comboId
UUID New combo ID. format: uuid
comboSourceId
UUID Action ID that defines combo. format: uuid
groupId
UUID Combo group ID to which item belongs. format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.CompoundItemTemplate Up

Modifier scheme information.
id
UUID ID. format: uuid
name
String Name.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.CompoundOrderItem Up

Order item: composite item.
type
status
Item cooking status.
deleted (optional)
Item deletion details. If filled up, item is deleted.
amount
Double Quantity. format: double
comment (optional)
String Comment.
whenPrinted (optional)
String Printing time (Local for the terminal). format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
size (optional)
Size.
comboInformation (optional)
Combo details, if order item is part of combo.
primaryComponent
Main component.
secondaryComponent (optional)
Additional component.
commonModifiers (optional)
template (optional)
Modifier scheme.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.CompoundOrderItemComponent Up

Part of composite item.
product
Item.
modifiers (optional)
price
Double Price per item unit. Can be sent different from the price in the base menu. format: double
cost
Double Item total including tax, discounts/surcharges. format: double
pricePredefined
Boolean Whether price is predefined.
positionId (optional)
UUID Unique identifier of the item in the order and for the whole system. format: uuid
taxPercent (optional)
Double Tax rate. format: double
resultSum (optional)
Double Total amount per item including tax, discounts/surcharges. format: double

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.Conception Up

Concept.
id
UUID ID. format: uuid
name
String Name.
code
String Code.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.CourierInfo Up

Driver information.
courier
Order driver.
isCourierSelectedManually
Boolean Whether driver is selected manually.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.CreationStatus Up

Order creation status.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.Customer Up

Delivery customer.
type

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.DeletionMethod Up

Deletion method.
id
String ID.
comment (optional)
String Comment.
removalType
Write-off type.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.DeliveryPoint Up

Delivery address coordinates.
coordinates (optional)
Delivery address coordinates.
address (optional)
Delivery address details.
externalCartographyId (optional)
String Address ID in external mapping system.
comment (optional)
String Comment.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.DiscountItem Up

Discount.
discountType
<p>Discount type.</p> <p>Can be obtained by <code>/api/1/discounts</code> operation.</p>
sum
Double Total. format: double
selectivePositions (optional)
array[UUID] Order item positions. format: uuid
selectivePositionsWithSum (optional)
array[iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.PositionWithSum] <p>Order item positions with position discount sum.</p> <blockquote> <p>Allowed from version <code>8.5.6</code>.</p> </blockquote>

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.DiscountType Up

Discount type.
id
UUID ID. format: uuid
name
String Name.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.Employee Up

Employee.
id
UUID ID. format: uuid
name
String Name.
phone (optional)
String Phone.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.ExternalCourierService Up

ECS info (external courier service).
id
UUID ECS setting record id. Unique through all organizations. format: uuid
name
String ECS name.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.ExternalData Up

Order external data.
key
String Key.
value
String Public.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.GuestsInfo Up

Information about order guests.
count
Integer Number of persons. format: int32
splitBetweenPersons
Boolean Attribute that shows whether order must be split among guests.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.ItemDeletedInfo Up

Order cancellation details.
deletionMethod
Deletion method.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.LoyaltyInfo Up

Information about Loyalty app.
coupon (optional)
String Coupon No. that was considered when calculating loyalty program.
appliedManualConditions (optional)
array[UUID] Information about applied manual conditions. format: uuid

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.MarketingSource Up

Marketing source.
id
UUID ID. format: uuid
name
String Name.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.Order Up

Order details.
parentDeliveryId (optional)
UUID ID of delivery serving as source for splitting by FCRs. format: uuid
customer (optional)
Delivery customer.
phone
String Delivery phone number.
deliveryPoint (optional)
Delivery point details. <remarks> Not required if order type is customer pickup. Otherwise, required. </remarks>
status
Delivery status.
cancelInfo (optional)
Delivery cancellation details. <remarks> Required only if delivery is canceled, i.e. status=Canceled. </remarks>
courierInfo (optional)
Driver information.
completeBefore
String Order fulfillment time (Local for the terminal). format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
whenCreated
String Delivery creation time in iikoFront (Local for the terminal). format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
whenConfirmed (optional)
String Delivery confirmation time (Local for the terminal). format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
whenPrinted (optional)
String Service printing time (Local for the terminal). format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
whenCookingCompleted (optional)
String Cooking completion time (Local for the terminal). format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
whenSended (optional)
String Delivery dispatch time (Local for the terminal). format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
whenDelivered (optional)
String Actual delivery time (Local for delivery terminal). format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
comment (optional)
String Order comment.
problem (optional)
Problem flag.
operator (optional)
Operator that took order.
marketingSource (optional)
Marketing source.
deliveryDuration (optional)
Long Duration of delivery (in minutes). format: int64
indexInCourierRoute (optional)
Integer Ordinal number in route list. <remarks> Field is filled up at the time of delivery allocation by logistics in iikoFront. If logistics is not in use, the field is not filled up. </remarks> format: int32
cookingStartTime
String The time when you need to start cooking an order (Local for the terminal). format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
isDeleted (optional)
Boolean Order is deleted.
whenReceivedByApi (optional)
String Moment of time when CloudAPI received the request to create the order (UTC). format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
whenReceivedFromFront (optional)
String Moment of time when the order first received and saved from iikoFront (UTC). format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
movedFromDeliveryId (optional)
UUID <p>Tells that this delivery has been moved from terminal group with id <em>MovedFromTerminalGroupId</em> by cancelling delivery with deliveryId <em>MovedFromDeliveryId</em>.</p> <blockquote> <p>Allowed from version <code>7.5.4</code>.</p> </blockquote> format: uuid
movedFromTerminalGroupId (optional)
UUID <p>Tells that this delivery has been moved from terminal group with id <em>MovedFromTerminalGroupId</em> by cancelling delivery with deliveryId <em>MovedFromDeliveryId</em>.</p> <blockquote> <p>Allowed from version <code>7.5.4</code>.</p> </blockquote> format: uuid
movedFromOrganizationId (optional)
UUID <p>Tells that this delivery has been moved from terminal group with id <em>MovedFromTerminalGroupId</em> by cancelling delivery with deliveryId <em>MovedFromDeliveryId</em>.</p> <blockquote> <p>Allowed from version <code>7.5.4</code>.</p> </blockquote> format: uuid
externalCourierService (optional)
<p>ECS info.</p> <blockquote> <p>Allowed from version <code>7.7.7</code>.</p> </blockquote>
movedToDeliveryId (optional)
UUID Tells that this delivery has been canceled and moved to terminal group with id <em>MovedToTerminalGroupId</em>. format: uuid
movedToTerminalGroupId (optional)
UUID format: uuid
movedToOrganizationId (optional)
UUID format: uuid
menuId (optional)
String External menu ID.
deliveryZone (optional)
String Name of delivery zone.
estimatedTime (optional)
String Delivery estimated time. format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
sum
Double Order amount (after discount or surcharge). format: double
number
Integer Delivery No. format: int32
sourceKey (optional)
String Delivery source.
whenBillPrinted (optional)
String Invoice printing time (guest bill time). format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
whenClosed (optional)
String Delivery closing time (Local for delivery terminal). format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
conception (optional)
Concept.
guestsInfo
Information about order guests.
items
combos (optional)
payments (optional)
tips (optional)
discounts (optional)
orderType
Order type.
terminalGroupId
UUID ID of the terminal group where the order is located. format: uuid
processedPaymentsSum
Double <p>The amount of processed payments. <remarks> null - only for unsupported POS versions. </remarks></p> <blockquote> <p>Allowed from version <code>7.6.0</code>.</p> </blockquote> format: double
loyaltyInfo (optional)
Information about Loyalty app. <remarks> null - only for unsupported POS versions. </remarks>
externalData (optional)
array[iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.ExternalData] <p>Order external data.</p> <blockquote> <p>Allowed from version <code>8.0.6</code>.</p> </blockquote>

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.OrderCombo Up

Combo in order.
id
UUID Combo ID. format: uuid
name
String Name of combo.
amount
Integer Number of combos. format: int32
price
Double Price of combo. Given for 1 combo, without regard to amount. format: double
sourceId
UUID Combo action ID. format: uuid
size (optional)
Size.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.OrderInfo Up

Order.
id
UUID Delivery order ID. format: uuid
posId (optional)
UUID POS delivery order ID. format: uuid
externalNumber (optional)
String Order external number.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
timestamp
Long Timestamp of most recent order change that took place on iikoTransport server. format: int64
creationStatus
Order creation status. In case of asynchronous creation, it allows to track the instance an order was validated/created in iikoFront.
errorInfo (optional)
<p>Order creation error details.</p> <blockquote> <p>Required only if &quot;creationStatus&quot;=&quot;Error&quot;.</p> </blockquote>
order (optional)
<p>Order creation details.</p> <blockquote> <p>Field is filled up if &quot;creationStatus&quot;=&quot;Success&quot;.</p> </blockquote>

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.OrderItem Up

Order item.
type
status
Item cooking status.
deleted (optional)
Item deletion details. If filled up, item is deleted.
amount
Double Quantity. format: double
comment (optional)
String Comment.
whenPrinted (optional)
String Printing time (Local for the terminal). format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
size (optional)
Size.
comboInformation (optional)
Combo details, if order item is part of combo.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.OrderItemModifier Up

Order item modifier.
product
Item.
amount
Double Quantity. format: double
amountIndependentOfParentAmount
Boolean Whether quantity of modifier depends on quantity of item.
productGroup (optional)
Group of modifiers (in case of a group modifier).
price
Double Price per item unit. Can be sent different from the price in RMS. format: double
pricePredefined
Boolean Whether price is predefined.
resultSum
Double Total amount per item including tax, discounts/surcharges. format: double
deleted (optional)
Item deletion details. If specified, the item is deleted.
positionId (optional)
UUID Unique identifier of the item in the order and for the whole system. format: uuid
defaultAmount (optional)
Integer Default amount. format: int32
hideIfDefaultAmount (optional)
Boolean Hide modifier in UI if &quot;amount&quot; equals &quot;defaultAmount&quot;.
taxPercent (optional)
Double Tax rate. format: double
freeOfChargeAmount (optional)
Integer Free of charge amount. format: int32

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.OrderItemStatus Up

Order item status.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.OrderStatus Up

Describes the status of an order.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.OrderType Up

Order type.
id
UUID ID. format: uuid
name
String Name.
orderServiceType
Order type.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.PaymentItem Up

Delivery order payment component.
paymentType
<p>Payment type.</p> <p>Can be obtained by <code>/api/1/payment_types</code> operation.</p>
sum
Double Amount due. format: double
isPreliminary
Boolean Whether payment item is preliminary.
isExternal
Boolean Payment item is external (created via biz.API).
isProcessedExternally
Boolean Payment item is processed by external payment system.
isFiscalizedExternally (optional)
Boolean <p>Whether the payment item is externally fiscalized.</p> <blockquote> <p>Allowed from version <code>7.6.3</code>.</p> </blockquote>
isPrepay
Boolean <p>Whether the payment item is prepay.</p> <blockquote> <p>Allowed from version <code>7.7.6</code>.</p> </blockquote>

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.PaymentType Up

<p>Payment type.</p> <p>Can be obtained by <code>/api/1/payment_types</code> operation.</p>
id
UUID ID. format: uuid
name
String Name.
kind
Payment type classifier.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.PositionWithSum Up

Order item positions with position discount sum.
positionId
UUID Order item position ID. format: uuid
sum
Double Position discount sum. format: double

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.Problem Up

Order problem details.
hasProblem
Boolean Has problem.
description (optional)
String Problem description.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.Product Up

Item.
id
UUID ID. format: uuid
name
String Name.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.ProductGroup Up

Item category.
id
UUID ID. format: uuid
name
String Name.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.ProductOrderItem Up

Order item: item.
type
status
Item cooking status.
deleted (optional)
Item deletion details. If filled up, item is deleted.
amount
Double Quantity. format: double
comment (optional)
String Comment.
whenPrinted (optional)
String Printing time (Local for the terminal). format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
size (optional)
Size.
comboInformation (optional)
Combo details, if order item is part of combo.
product
Item.
modifiers (optional)
price
Double Price per item unit. Can be sent different from the price in the base menu. format: double
cost
Double Total cost per item without tax, discounts/surcharges. format: double
pricePredefined
Boolean Whether price is predefined.
positionId (optional)
UUID Unique identifier of the item in the order and for the whole system. format: uuid
taxPercent (optional)
Double Tax rate. format: double
resultSum (optional)
Double Total amount per item including tax, discounts/surcharges. format: double

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.ProductSize Up

Item size.
id
UUID ID. format: uuid
name
String Name.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.Region Up

Delivery district (part of delivery address).
id
UUID ID. format: uuid
name
String Name.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.RegularCustomer Up

type
id
UUID Customer ID. format: uuid
name
String Name.
surname (optional)
String Last name.
comment (optional)
String Comment.
gender (optional)
Sex.
inBlacklist (optional)
Boolean Is client in blacklist.
blacklistReason (optional)
String Reason why client was added to blacklist.
birthdate (optional)
String <p>Date of birth.</p> <blockquote> <p>Allowed from version <code>7.6.1</code>.</p> </blockquote> format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.RemovalType Up

Write-off type.
id
UUID ID. format: uuid
name
String Name.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.ServiceOrderItem Up

Order item: service.
type
status
Item cooking status.
deleted (optional)
Item deletion details. If filled up, item is deleted.
amount
Double Quantity. format: double
comment (optional)
String Comment.
whenPrinted (optional)
String Printing time (Local for the terminal). format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
size (optional)
Size.
comboInformation (optional)
Combo details, if order item is part of combo.
service
Item.
cost
Double Total cost per item without tax, discounts/surcharges. format: double

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.Street Up

Street.
id
UUID ID. format: uuid
name
String Name.
city
City.

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.TipsPaymentItem Up

Delivery order tips payment component.
tipsType (optional)
Tips type.
paymentType
<p>Payment type.</p> <p>Can be obtained by <code>/api/1/payment_types</code> operation.</p>
sum
Double Amount due. format: double
isPreliminary
Boolean Whether payment item is preliminary.
isExternal
Boolean Payment item is external (created via biz.API).
isProcessedExternally
Boolean Payment item is processed by external payment system.
isFiscalizedExternally (optional)
Boolean <p>Whether the payment item is externally fiscalized.</p> <blockquote> <p>Allowed from version <code>7.6.3</code>.</p> </blockquote>
isPrepay
Boolean <p>Whether the payment item is prepay.</p> <blockquote> <p>Allowed from version <code>7.7.6</code>.</p> </blockquote>

iikoTransport.PublicApi.Contracts.Deliveries.Response.Order.TipsType Up

The tips type.
id
UUID <p>Tips type ID.</p> <p>Can be obtained by <code>/api/1/tips_types</code> operation.</p> format: uuid
name
String Tips type name.

iikoTransport.PublicApi.Contracts.Deliveries.Response.OrderResponse Up

Wrapping object (external) for a delivery order return.
correlationId
UUID Operation ID. format: uuid
orderInfo
Delivery order.

iikoTransport.PublicApi.Contracts.Deliveries.Response.OrdersByOrganization Up

Orders grouped by organization.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
orders

iikoTransport.PublicApi.Contracts.Deliveries.Response.OrdersResponse Up

Wrapping object (external) for return of delivery orders.
correlationId
UUID format: uuid
orders

iikoTransport.PublicApi.Contracts.Deliveries.Response.OrdersWithRevisionResponse Up

Wrapping object (external) for return of delivery orders.
correlationId
UUID Operation ID. format: uuid
maxRevision
Long Maximum revision value per all orders. format: int64
ordersByOrganizations

iikoTransport.PublicApi.Contracts.DeliveryRestrictions.ActionOnValidationRejection Up

Actions on problems with auto-assignment.

iikoTransport.PublicApi.Contracts.DeliveryRestrictions.AllowedRestrictions.AllowedItemWithDuration Up

Suitable terminal group with delivery duration and other parameters.
terminalGroupId
UUID <p>Terminal group ID.</p> <p>Can be obtained by <code>/api/1/terminal_groups</code> operation.</p> format: uuid
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
deliveryDurationInMinutes
Long Delivery duration in minutes. format: int64
zone
String Delivery zone name which this TerminalGroupId belongs to.
deliveryServiceProductId
UUID Link to &quot;delivery service payment&quot;. format: uuid

iikoTransport.PublicApi.Contracts.DeliveryRestrictions.AllowedRestrictions.DeliveryRestrictionRejectCode Up

Delivery restrictions reject cause code.

iikoTransport.PublicApi.Contracts.DeliveryRestrictions.AllowedRestrictions.GetAllowedRestrictionsRequest Up

Request to identify suitable terminal groups.
organizationId (optional)
UUID Organization ID. Deprecated, use &quot;organizationIds&quot;. format: uuid
organizationIds (optional)
array[UUID] <p>Organization IDs.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
deliveryAddress (optional)
Delivery address.
orderLocation (optional)
Order location.
orderItems (optional)
isCourierDelivery
Boolean Type of delivery service.
deliveryDate (optional)
String Delivery date (Local for delivery terminal). format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123
deliverySum (optional)
Double Sum. format: double
discountSum (optional)
Double Discounts sum. format: double

iikoTransport.PublicApi.Contracts.DeliveryRestrictions.AllowedRestrictions.GetAllowedRestrictionsResponse Up

Response for a request to identify suitable terminal groups.
correlationId
UUID Operation ID. format: uuid
isAllowed
Boolean A sign of successful verification.
rejectCause
String Reject cause.
addressExternalId
String Delivery address ID in external mapping system.
location
Coordinates returned by geocoding service.
allowedItems
rejectedItems

iikoTransport.PublicApi.Contracts.DeliveryRestrictions.AllowedRestrictions.OrderLocation Up

Order location.
latitude
Double Latitude. format: double
longitude
Double Longitude. format: double

iikoTransport.PublicApi.Contracts.DeliveryRestrictions.AllowedRestrictions.RejectItem Up

Rejected item info.
terminalGroupId
UUID <p>Terminal group ID.</p> <p>Can be obtained by <code>/api/1/terminal_groups</code> operation.</p> format: uuid
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
zone (optional)
String Delivery zone name which this TerminalGroupId belongs to.
rejectCode
Reject cause code.
rejectHint
String Reject hint.
rejectItemData (optional)
Reject additional information.

iikoTransport.PublicApi.Contracts.DeliveryRestrictions.AllowedRestrictions.RejectItemData Up

Reject additional information.
dateFrom (optional)
String Point work time start. format: date-span
dateTo (optional)
String Point work time end. format: date-span
allowedWeekDays (optional)
array[String] Allowed week days.
minSum (optional)
Double Order min sum. format: double

iikoTransport.PublicApi.Contracts.DeliveryRestrictions.AllowedRestrictions.RestrictionsAddress Up

Address.
city (optional)
String City.
streetName (optional)
String Street.
streetId (optional)
UUID Street ID. format: uuid
house (optional)
String House.
building (optional)
String Building.
index (optional)
String Post index.
line1 (optional)
String Address line 1. Contains the primary address information.
entrance (optional)
String Entrance.

iikoTransport.PublicApi.Contracts.DeliveryRestrictions.AllowedRestrictions.RestrictionsOrderItem Up

Order item.
id
UUID Product ID. format: uuid
product
String Product.
amount
Double Amount. format: double
modifiers (optional)

iikoTransport.PublicApi.Contracts.DeliveryRestrictions.AllowedRestrictions.RestrictionsOrderItemModifier Up

Order item modifier.
id
UUID Product ID. format: uuid
product (optional)
String Product.
amount
Double Amount. format: double

iikoTransport.PublicApi.Contracts.DeliveryRestrictions.Coordinates Up

Coordinate details.
latitude
Double Latitude. format: double
longitude
Double Longitude. format: double

iikoTransport.PublicApi.Contracts.DeliveryRestrictions.DeliveryGeocodeServiceType Up

Geocoding service.

iikoTransport.PublicApi.Contracts.DeliveryRestrictions.DeliveryRestrictionItem Up

Item of delivery restrictions.
minSum
Double The minimum order amount for a given point in a given time interval in this delivery zone. format: double
terminalGroupId
UUID <p>Terminal group ID.</p> <p>Can be obtained by <code>/api/1/terminal_groups</code> operation.</p> format: uuid
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
zone
String Name of delivery zone from cartography.
weekMap
Integer Days of the week. format: int32
from
Integer The time from which the point can process orders from the selected zone, in minutes from the beginning of the day. format: int32
to
Integer The maximum time at which a point can carry an order to a given zone, in minutes from the beginning of the day. format: int32
priority
Integer Priority of point in delivery zone. format: int32
deliveryDurationInMinutes
Long Delivery duration in delivery zone. format: int64
deliveryServiceProductId
UUID Link to &quot;delivery service payment&quot;. format: uuid

iikoTransport.PublicApi.Contracts.DeliveryRestrictions.DeliveryRestrictions Up

Delivery restrictions.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
deliveryGeocodeServiceType
Geocoding service type.
deliveryRegionsMapUrl
String Link to the map of delivery service regions.
defaultDeliveryDurationInMinutes
Long General standard of delivery time. format: int64
defaultSelfServiceDurationInMinutes
Long Default pickup time. format: int64
useSameDeliveryDuration
Boolean Indication that all delivery points in all delivery zones use common delivery time limits.
useSameMinSum
Boolean Indication that all delivery points for all delivery zones use the total minimum order amount.
defaultMinSum
Double Total minimum order amount. format: double
useSameWorkTimeInterval
Boolean Indication that all delivery points in all zones use common time limits.
defaultFrom
Integer The beginning of the interval of the total work time for all points and delivery zones, in minutes from the beginning of the day. format: int32
defaultTo
Integer End of the total work time interval for all points and delivery zones, in minutes from the beginning of the day. format: int32
useSameRestrictionsOnAllWeek
Boolean Indication that all delivery points in all zones use the same schedule for all days of the week.
restrictions
deliveryZones
rejectOnGeocodingError
Boolean Reject delivery if we could not geocode the address.
addDeliveryServiceCost
Boolean Add shipping cost to order.
useSameDeliveryServiceProduct
Boolean Indication that the cost is the same for all points of delivery.
defaultDeliveryServiceProductId
UUID Link to &quot;delivery service payment&quot;. format: uuid
useExternalAssignationService
Boolean Use external delivery distribution service.
frontTrustsCallCenterCheck
Boolean Indication whether or not to trust on the fronts the call center mapping restrictions from the call center if the composition of the order has not changed since the last check. If true, then trust.
externalAssignationServiceUrl
String Address of external delivery distribution service.
requireExactAddressForGeocoding
Boolean Require an exact geocoding address.
zonesMode
Delivery restrictions mode.
autoAssignExternalDeliveries
Boolean Automatically assigned delivery method based on cartography.
actionOnValidationRejection
Action on problems with auto-assignment.

iikoTransport.PublicApi.Contracts.DeliveryRestrictions.DeliveryRestrictionsMode Up

Delivery restrictions mode.

iikoTransport.PublicApi.Contracts.DeliveryRestrictions.DeliveryZone Up

Delivery zone.
name
String Polygon name.
coordinates
addresses
array[iikoTransport.PublicApi.Contracts.DeliveryRestrictions.DeliveryZoneAddressBinding] <p>A set of addresses describing a polygon.</p> <blockquote> <p>Available only for manual delivery zones.</p> </blockquote>

iikoTransport.PublicApi.Contracts.DeliveryRestrictions.DeliveryZoneAddressBinding Up

Delivery zone polygon, defined by the combination of street, index and house numbers.
streetId
UUID ID of the delivery zone's street. format: uuid
postcode
String Postcode.
houses
Range of house numbers in the delivery zone.

iikoTransport.PublicApi.Contracts.DeliveryRestrictions.GetDeliveryRestrictionsRequest Up

Request for delivery restrictions.
organizationIds
array[UUID] <p>Organizations IDs which delivery restrictions have to be returned.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid

iikoTransport.PublicApi.Contracts.DeliveryRestrictions.GetDeliveryRestrictionsResponse Up

Response for delivery restrictions.
correlationId
UUID Operation ID. format: uuid
deliveryRestrictions

iikoTransport.PublicApi.Contracts.DeliveryRestrictions.HousesRange Up

Range of house numbers in the delivery zone. It can work in two modes: a) HousesRangeType.SpecificNumbers - list of house numbers. If the house is on this list - it is in the range b) Rest HousesRangeType. Defines a range of numbers from StartingNumber to MaxNumber. Since it is necessary to compare numbers - only supports numeric house numbers. Type determines the admissibility of even/odd numbers.
type
Type of house number range.
startingNumber
Integer Starting house number. format: int32
maxNumber
Integer Maximum house number. format: int32
isUnlimitedRange
Boolean Unlimited range.
specificNumbers
array[String] Specific numbers.

iikoTransport.PublicApi.Contracts.DeliveryRestrictions.HousesRangeType Up

Type of house number range.

iikoTransport.PublicApi.Contracts.Discounts.DiscountCardMode Up

Discount type.

iikoTransport.PublicApi.Contracts.Discounts.DiscountCardTypeInfo Up

Discount/surcharge DTO.
id
UUID Discount ID in RMS. format: uuid
name
String Discount name.
percent
Double <p>Total discount rate.</p> <blockquote> <p>Ignored if &quot;isCategorisedDiscount&quot; specified.</p> </blockquote> format: double
isCategorisedDiscount
Boolean <p>Whether it is category discount or not.</p> <blockquote> <p>If true, &quot;productCategoryDiscounts&quot; discounts will apply.</p> </blockquote>
productCategoryDiscounts
comment (optional)
String Comment.
canBeAppliedSelectively
Boolean Whether discount allows for selected application to individual items at user's discretion.
minOrderSum (optional)
Double Minimum order amount required for discount application. If order amount is less than specified threshold, discount does not apply. format: double
mode
<p>Discount type.</p> <p>Can be obtained by <code>/api/1/discounts</code> operation.</p>
sum
Double <p>Fixed amount.</p> <blockquote> <p>Triggers if fixed amount has been specified.</p> </blockquote> format: double
canApplyByCardNumber
Boolean <p>Can be applied by card No.</p> <blockquote> <p>If true, it's enough to enter discount card No. (card swiping not required)</p> </blockquote>
isManual
Boolean Created manually.
isCard
Boolean Executed by card.
isAutomatic
Boolean Created automatically.
isDeleted (optional)
Boolean IsDeleted.

iikoTransport.PublicApi.Contracts.Discounts.DiscountsRequest Up

Request of discounts/surcharges.
organizationIds
array[UUID] <p>Organization IDs that require discounts return.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid

iikoTransport.PublicApi.Contracts.Discounts.DiscountsResponse Up

Response with list of discounts/surcharges.
correlationId
UUID Operation ID. format: uuid
discounts

iikoTransport.PublicApi.Contracts.Discounts.ProductCategoryDiscount Up

Product category discount details.
categoryId
UUID Category ID. format: uuid
categoryName
String Category name.
percent
Double This category discount %. format: double

iikoTransport.PublicApi.Contracts.Employees.ActiveCourierLocation Up

Courier's location.
courierId (optional)
UUID Employee ID. format: uuid
lastActiveLatitude (optional)
Double Latitude. format: double
lastActiveLongitude (optional)
Double Longitude. format: double
lastActiveClientDate (optional)
String Client date and time. format: yyyy-MM-dd HH:mm:ss.fff
example: 2019-08-24 14:15:22.123

iikoTransport.PublicApi.Contracts.Employees.ActiveCourierLocationsByTerminalGroupRequest Up

Request for list of active drivers for front group with ID = <em>TerminalGroupId</em>.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
terminalGroupId
UUID <p>iikoFront terminals group ID.</p> <p>Can be obtained by <code>/api/1/terminal_groups</code> operation.</p> format: uuid

iikoTransport.PublicApi.Contracts.Employees.ActiveCourierLocationsResponse Up

Wrapping object to retrieve list of active courier locations.
correlationId
UUID Operation ID. format: uuid
activeCourierLocations

iikoTransport.PublicApi.Contracts.Employees.ChangePersonalSessionResponse Up

Personal session change response.
correlationId
UUID Operation ID. format: uuid
error (optional)
String Error details.

iikoTransport.PublicApi.Contracts.Employees.ClosePersonalSessionRequest Up

Close personal session request.
organizationId
UUID <p>Organization ID.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
terminalGroupId
UUID <p>Delivery group ID.</p> <p>Can be obtained by <code>/api/1/terminal_groups</code> operation.</p> format: uuid
employeeId
UUID Employee ID. format: uuid

iikoTransport.PublicApi.Contracts.Employees.CoordinateInfo Up

DTO of map coordinates.
latitude
Double Latitude. format: double
longitude
Double Longitude. format: double
serverTimestamp
Long Time of coordinate saving on server in the Unix timestamp format. format: int64

iikoTransport.PublicApi.Contracts.Employees.CourierLocations Up

Driver location details.
courierId
UUID Driver ID. format: uuid
locations

iikoTransport.PublicApi.Contracts.Employees.CourierLocationsByTimeOffsetRequest Up

Request for coordinates history of drivers in OrganizationIds organizations. If driver coordinates were recorded in server storage within interval: [&quot;current server time&quot; - OffsetInSeconds, &quot;current server time&quot;), driver and their coordinates will be retrieved.
organizationIds
array[UUID] List of organizations for drivers coordinates of which will be retrieved. format: uuid
offsetInSeconds (optional)
Integer Interval in seconds from current server time. If driver coordinates were recorded in server storage within interval: (&quot;current server time&quot; - <em>OffsetInSeconds</em>, &quot;current server time&quot;], driver and their coordinates will be retrieved. format: int32

iikoTransport.PublicApi.Contracts.Employees.CourierLocationsByTimeOffsetResponse Up

DTO containing driver coordinates details for the last N seconds.
correlationId
UUID Operation ID. format: uuid
courierLocations

iikoTransport.PublicApi.Contracts.Employees.CouriersAndCheckRoleRequest Up

Request for list of drivers for organizations in OrganizationIds.
organizationIds
array[UUID] <p>List of organizations.</p> <p>Can be obtained by <code>/api/1/organizations</code> operation.</p> format: uuid
rolesToCheck
array[String] Employee's roles for check. The short name of employee's position.

iikoTransport.PublicApi.Contracts.Employees.CouriersRequest Up

Request for list