Track and Trace Government Information System API v18žписание+API.+Release_16.2_en.pdf · 4 1 General Provisions 1.1 Principles of Interaction with API Interaction of goods

TT GIS v21 API Description

Contents Revision History ......................................................................................................................... 5 List of Acronyms and Abbreviations .......................................................................................... 9 1. General provisions ................................................................................................................ 11

1.1. Principles of Interaction with API ................................................................................. 11 1.1.1. Requirements for Exchange Files ........................................................................... 13

1.1.1.1. Responses from TT GIS REST API may contain additional utility json attributes which are not specified in documentation. Unknown attributes shall be ignored. ......................................................................................................................... 14 1.1.1.2. Maximum size of the document to be transmitted via API shall not exceed 30 megabytes. .................................................................................................................... 14 1.1.1.3. All attribute values in JSON and CSV formats expressed in money terms (prices, taxes etc.) are set in kopecks without delimiters. ............................................. 14

1.1.2. Screening................................................................................................................. 14 1.1.3. Type of Content to be Returned by API Methods .................................................. 15

1.2. Authentication ................................................................................................................ 15 1.2.1. Request for Authorisation ....................................................................................... 16 1.2.2. Receiving an Authentication Token ........................................................................ 16

2. Methods................................................................................................................................. 18 2.1. General Methods ............................................................................................................ 18

2.1.1. Method of receiving the MC list with detailed information on MC using set filter 18 2.1.2. Method of receiving detailed information on a certain MC (GET) ........................ 27 2.1.3. Method of receiving the list of goods using set filter ............................................. 33 2.1.4. Method of receiving brief information on IC\IC list (public) ................................. 42 2.1.5. Method of receiving the IC list by identifier .......................................................... 47 2.1.6. Method of receiving information on goods item by Goods code ........................... 50 2.1.7. Catalog on CMG ..................................................................................................... 53 2.1.8. Catalog on CMG with additional parameters from TT GIS and FCS .................... 57 2.1.9. Method of receiving the list of documents pre-loaded in TT GIS .......................... 60 2.1.10. Method for searching a receipt by identifier ......................................................... 64 2.1.11. Method for searching a receipt body by identifier ................................................ 68 2.1.12. Method of receiving the list of receipts pre-loaded in TT GIS ............................. 72

2

2.1.13. Method of receiving the content of document pre-loaded in TT GIS ................... 76 2.1.14. Method of receiving the list of goods using document number ............................ 80 2.1.15. Method of receiving the list of 10-digit FEACN codes ........................................ 83 2.1.16. Method of generating consent to provision of information on marking codes for non-owners ........................................................................................................................ 84 2.1.17. Method of document cancellation based on the current published consent document ........................................................................................................................... 85 2.1.18. Method of receiving the information on MC according to the MC list with prior consent .............................................................................................................................. 86 2.1.19. Method of receiving the information on marked goods ........................................ 88 2.1.20. Method of receiving the information on marked goods by MC beginning .......... 94 2.1.21. Method of receiving the list of goods using document number .......................... 101 2.1.22. Method of receiving the list of obtained MC with filter option .......................... 104 2.1.23. Method of receiving the number obtained MC with filter option ....................... 110 2.1.24. Method of receiving the list of transferred MC with filter option ...................... 112 2.1.25. Method of receiving the number of transferred MC with filter option ............... 118 2.1.26. Requesting information on goods circulation participant by INN ...................... 120 2.1.27. Method of receiving the information on identification means by MC beginning......................................................................................................................... 122 2.1.28. Method of receiving MC and all internal MC .................................................... 128 2.1.29. Method of receiving the information on identification tool (POST) .................. 130 Method of receiving the number of MC with filter option ............................................. 136 2.1.31. Method of receiving IC by identifier .................................................................. 139 2.1.32. Method of receiving the number of MC with filter option ................................. 142 2.1.33. Method of receiving the list of MC using document number ............................. 144 2.1.34. Method of searching document content by document identifier ........................ 144

2.2. Document Methods ...................................................................................................... 145 2.2.1. Single method of document creation .................................................................... 145 2.2.2. Description of remains .......................................................................................... 147 2.2.3. Aggregation........................................................................................................... 149

2.2.3.1. Aggregation .................................................................................................... 149 2.2.3.2. Reaggregation ................................................................................................ 151 2.2.3.3. Disaggregation ............................................................................................... 152

2.2.4. Introduction into circulation ................................................................................. 154 2.2.4.1. Introduction into circulation. Manufacture in the Russian Federation .......... 154

3

2.2.4.2. Introduction into circulation. Received from individuals. ............................. 157 2.2.4.3. Introduction into circulation. Manufacturing outside of EEU ....................... 158 2.2.4.4. Introduction into circulation. Cross-border trading ....................................... 161 2.2.4.5. Introduction into circulation. In the territory of EEU countries (contract manufacturing) ............................................................................................................ 164 2.2.4.6. Introduction into circulation. Remains marking ............................................ 167 2.2.4.7. Introduction into circulation. Contract manufacturing in the Russian Federation..................................................................................................................................... 169 2.2.4.8. Introduction into circulation. Import with FCS ............................................. 171

2.2.5. ACC aggregation .................................................................................................. 174 2.2.6. ACC reaggregation ............................................................................................... 176 2.2.7. ACC disaggregation .............................................................................................. 177 2.2.8. Return into circulation .......................................................................................... 178 2.2.9. Shipping ................................................................................................................ 182 2.2.10. Shipping with withdrawal from circulation ........................................................ 183 2.2.11. Shipment at cross-border trading ........................................................................ 186 2.2.12. Cancelling shipment ............................................................................................ 188 2.2.13. Cancelling shipment at cross-border trading ...................................................... 188 2.2.14. Acceptance .......................................................................................................... 189 2.2.15. Withdrawal from circulation ............................................................................... 192 2.2.16. Writing off MC ................................................................................................... 197

2.2.16.1. Writing off not applied MCs ........................................................................ 197 2.2.16.2. Writing off applied MCs .............................................................................. 199

2.2.17. Remarking ........................................................................................................... 201 2.2.18. UTD for shipment ............................................................................................... 205 2.2.19. Automatic introduction into circulation. OMS ................................................... 205 2.2.20. MC order. OMS .................................................................................................. 205

3. Reference books .................................................................................................................. 206 3.1. Catalogue - List of supported product groups.............................................................. 206 3.2. Catalogue - Types of documents .................................................................................. 206 3.3. Catalogue - MC statuses .............................................................................................. 211 3.4. Catalogue - Types of production .................................................................................. 212 3.5. Catalogue - Types of packing ...................................................................................... 212 3.6. Catalogue - Order statuses ........................................................................................... 213 3.7. Catalogue - Document statuses .................................................................................... 213

4

3.8. Catalogue - Response statuses ..................................................................................... 213 3.9. Catalogue - Types of organisations .............................................................................. 215 3.10. Catalogue - GCP statuses ........................................................................................... 215 3.11. Catalogue - Statuses of request for GCP registration ................................................ 216 3.12. Catalogue - Document statuses in SD life cycle ........................................................ 216 3.13. Catalogue - Status model ........................................................................................... 216 3.14. Catalogue - Additional parameters for PG ................................................................. 217

3.14.1. Additional parameters for PG ’Footwear’ .......................................................... 217 3.14.2. Additional parameters for PG ‘Clothing, bed linen, table linen, bath and kitchen linen’ ............................................................................................................................... 218 3.14.3. Additional parameters for PG ‘Photo cameras (except for cine cameras), flash lights and flash bulbs’ ..................................................................................................... 218 3.14.4. Additional parameters for PG ‘Bicycles and bicycle frames’ ............................ 218 3.14.5. Additional parameters for PG ’Wheelchairs’ ..................................................... 219 3.14.6. Additional parameters for PG ‘Perfume and eau de toilette’ .............................. 219 3.14.7. Additional parameters for PG ‘New pneumatic rubber tires and tire casings’ ... 219 3.14.8. Additional parameters for PG ‘Dairy products’ .................................................. 220

4. Examples of authentication with EQES / Signing of documents ....................................... 221 4.1. Example of token receiving during authorisation with attached signature / signing of documents with detached signature in 1C .......................................................................... 221 4.2. Example of token receiving during authorisation via REACT JS. .............................. 222 4.3. Example of token receiving during authorisation with attached signature / signing of documents with detached signature via Java. ..................................................................... 222 4.4. Description of plug-in methods: .................................................................................. 223

5

Revision History Date Version Changes

20.03.2020 17 Initial version

13.04.2020 18 Mandatory status was changed for the ’cancelling shipment’ document

Method of obtaining the list of receipts pre-loaded in TT GIS (para. 2.1.10);

Obtaining the IC list by identifier (para. 2.1.6);

Introduction into circulation. Cross-border trading (contract manufacturing) (para. 2.2.5.5).

Changed Remarking method.

Added Drinking Water PG.

Added packings: package.

Added reason of withdrawal from circulation: ‘Errors in goods description found’.

Described types of primary document.

24.04.2020 18.1 Added the following methods:

Method of consent document creation (para. 2.1.13);

Method of cancellation document creation based on the current published consent document (para. 2.1.14);

Method of obtaining information on the MC according to MC list (para. 2.1.15).

Renamed method Introduction into circulation. ‘Cross-border trade’ (contract production) to ‘Introduction into circulation’. In the territory of EEU countries (contract production) cl.2.2.5.5

Added List of Acronyms and Abbreviations Used in Description of TT GIS API Documentation.

10.06.2020 18.2 productGroup parameter is added to the reply for the following methods: - Method of receiving the MC list with detailed information on MC using set filter; - [Method of receiving detailed information on a certain MC]; - Method of receiving brief information on IC\IC list (public); - Method of receiving the IC list by identifier; - Method of receiving the information on marked goods.

The following methods are added: - Method of receiving the information on MC according to the MC list with prior consent; - Method of receiving the information on marked goods; - Method of receiving the information on marked goods by MC beginning; - Method of receiving the list of obtained MC with filter option; - Method of receiving the number obtained MC with filter option; - Method of receiving the list of transferred MC with filter option; - Method of receiving the number of transferred MC with filter option; - Shipment at cross-border trading; - Cancelling shipment at cross-border trading; - Introduction into circulation. Import with FCS; - ACC Generation; - Disaggregation of ACC; - ACC reaggregation.

Added ‘DISAGGREGATION’ status for method Method of receiving the MC list with detailed information on MC using set filter.

6

Date Version Changes

Added ‘lastDocType’ parameter for method Method of receiving detailed information on a certain MC. Added ‘CONFORMITY_CERTIFICATE_OR_DECLARATION’ value for ‘certificateType’ parameter. Deleted recursion for ‘childrenMap’ and ‘childrenDetails’ parameters. Added description ‘Method is available only for EEU operators’ for methods with cross-border trading description. Added ‘TurnoverType’ parameter for method Method of receiving the IC list by identifier. Added Catalogue - List of supported product groups. Added link to the catalog in description for ‘productGroup’ parameter. Deleted ‘offset’ parameter for method Method of receiving the list of 10-digit FEACN codes. Added parameters for method Method of receiving the content of document pre-loaded in TT GIS. Added ‘name’ parameter for document type ’Reaggregation’. Added PG restriction for document type ’Remarking’. cisChildren parameter added for the following methods: Method of receiving the MC list with detailed information on MC using set filter; Method of receiving the list of goods by the set filter; Method of receiving the list of obtained MC with filter option; Method of receiving the list of transferred MC with filter option.

Changed response parameters for method Method of receiving the information on marked goods. Added Examples of authentication with EQES / Signing of documents. Added request parameters for method Method of receiving the MC list with detailed information on MC using set filter. Replaced ‘clothes’ designation with ‘lp’ designation for ‘Clothing, bed linen, table linen, bath and kitchen linen’ product group in Catalogue - List of supported product groups. Added nested parameters for childs in method Method of receiving the information on MC according to the MC list with prior consent. Added ‘DISAGGREGATION’ parameter for ‘status’ and ‘cisStatus’ parameters. Added package type: aggregated customs code (ACC). Added values for ’StatusExt’ and ’cisStatus’: FTS_RESPOND_NOT_OK - negative resolution of FCS; FTS_RESPOND_WAITING - awaiting acknowledgement from FCS; FTS_CONTROL - controlled by FCS. Added return option for goods with damaged/missing IM at retail and remote trading for document type Remarking

30.06.2020 18.3 Introduction into circulation. Manufacturing outside of EEUmethod shall be considered deprecated and will be supported for 3 months. In place of deprecated Introduction into circulation. Manufacturing outside of EEU method, Introduction into circulation. Import with FCS method is used. In Introduction into circulation. Import with FCS method, colour and productSize fields are now optional.

06.07.2020 19 Added the following methods: Method for searching a receipt by identifier; Method for searching a receipt body by identifier; [Method of receiving the list of available requests with filter option]; Requesting information on goods circulation participant by INN; Method of receiving the information on identification means by MC beginning; Method of receiving the list of MC and all internal MC;

7


Method of receiving the information on identification tool (POST); Method of receiving the number of MC with filter option; [Method of receiving a list of participants by specified organisation name]; Method of receiving IC by identifier; Method of receiving the number of MC with filter option; Method of receiving the list of MC by document number; Method of searching document content by document identifier. For ’status’ parameter, ‘MC written off’ value is added (WRITTEN_OFF). ‘Withdrawal of a goods item from circulation when selling it to end consumers’ document is renamed <withdrawal>. Added description of ’orderedColumnValue’ parameter. Added v4 endpoints for the following methods: Method of receiving the MC list with detailed information on MC using set filter; Catalog on CMG; Method of receiving information in goods item by Goods code; Method of receiving the IC list by identifier; Method of receiving detailed information on a certain MC (GET). The following methods shall be considered deprecated: Method of receiving the MC list with detailed information on MC using set filter; Method of receiving the IC list by identifier; Method of receiving detailed information on a certain MC (GET). Reply parameters for Method of receiving the list of goods by the set filter are updated. For ‘Method of receiving the content of document pre-loaded in TT GIS’, the following parameters are added: ‘Number of ICs in reply’, ‘Identifier of state contract’, ‘reason for withdrawal’. For ’orderColumn’ parameter, valid value is changed from ’docDate’ to ’receivedAt’. List of abbreviations used in the documents is updated. Changed ’Acceptance’ document creation. For IC status, wrong parameter ‘WAIT_FOR_CONTINUATION’ is eliminated. For Introduction into circulation. In the territory of EEU countries (Contract manufacturing) document type, a notice is added that this only applies to ‘Dairy products’ GG. A mandatory ‘Shipping number’ field is added for ’Acceptance’ document types

17.07.2020 20 For Searching a receipt body by identifier and Searching a receipt by identifier methods, ‘Identifier of state contract’ and ‘Reason for withdrawal’ parameters are added. Removed error values for ‘cisStatus’: FTS_RESPOND_NOT_OK - negative resolution of FCS; FTS_RESPOND_WAITING - awaiting acknowledgement from FCS; FTS_CONTROL - controlled by FCS. ]Receiving the list of available requests with filter option] method is deprecated, ]Search in action log] method shall be used instead. URL of stands is modified, URL for v4 stands is added. Added notes describing the logic of Introduction into circulation Manufacturing outside of EEU and Introduction into circulation. Import with FCS methods. For Introduction into circulation. Import with FCS method, description of cis parameter is updated in JSON (IC or SPIC or ATC is specified). Drinking Water GG is renamed as ‘Bottled water’. For Receiving the IC list by identifier method, FEACN parameter (tnVed10) is added. For Introduction into circulation. In the territory of EEU countries (Contract manufacturing) method, ‘VAT amount’ and ‘Price per unit’ parameters are removed. For IC (ki) parameter of ACC Generation method, the following restriction is added: ‘Only IC numbers are specified. Entering SPIC or IC included in SPIC or other ATC is not allowed in this field’.

8


In Receiving the list of goods by the set filter method, values of ‘Additional goods item status’ (statusExt) parameter are modified. For ‘Document download status’ (downloadStatus) parameter, a reference to ‘Document statuses’ catalogue is added. ‘Method of receiving a list of participants by specified organisation name’ is deleted.

31.07.2020 21 For Method of receiving the list of obtained MC with filter option, Method of receiving the number of MC with filter option, Method of receiving the list of transferred MC with filter option, Method of receiving the number of transferred MC with filter option methods, values of ‘Additional goods item status’ (statusExt) parameter are modified. Possible accepted values of ‘Reason for withdrawal’ (withdrawReason) parameter are modified. For Single method of docunets creation ‘Goods Group’ (pg) parameter required to be filled. The following methods are deleted: Search in action log method; Method of receiving the list of available requests with filter option. For Remarking method the restriction on product groups has been removed. For ‘Dairy products’ and ‘Bottled water’ PG, Code of reason for repeated marking (remarking_cause) shall only have the following values: KM_SPOILED – IM with MC spoiled or lost; DESCRIPTION_ERRORS - Errors in goods description found. For Return into circulation method, restriction on mandatory initial documents provision is added. For Description of remains method, limitation on creating document types for’Footwear’ PG is added. For Introduction into circulation. Import with FCS method, the minimum declaration date for the products has been changed from 2020-07-01 to 2020-08-01.

9

List of Acronyms and Abbreviations Abbreviation Description

API Application Programming Interface

Base64 standard for binary data coding using only 64 ASCII symbols

CSV Comma-Separated Values (text format for presentation of table data)

gtin Goods code

JSON JavaScript Object Notation (text format of data exchange based on JavaScript)

MIME Multipurpose Internet Mail Extensions (standard describing transmission of various types of data by e-mail)

pdf Portable Document Format (cross platform open format of electronic documents)

RFC Request for Comments (document from the series of numbered information documents of Internet containing specifications and standards widely used in world wide web)

SGTIN Serialised Global Trade Item Number used for tracking in (GTIN + individual serial number of the secondary (user) packing or initial packing, in case of absence of the secondary)

URL Uniform Resource Locator

UTF-8 Unicode Transformation Format, 8-bit

XML eXtensible Markup Language

XSD XML Schema definition (language describing the document XML structure)

ACC Aggregated Customs Code

ATP Alternative tobacco products

DB Database

AVD Accompanying veterinary documents (transport accompanying document)

TT GIS Track and Trace Government Information System

CD Customs declaration

EEU Eurasian Economic Union

INN Tax Identification Number

IC Identification code

SPIC Shipping Package Identification Code

MC Marking code

VAT Value Added Tax

OKSM All-Russian Classifier of Countries of the World

PG Goods Group

EEU FEACN Foreign Economic Activity Commodity Nomenclature of the Eurasian Economic Union

EQES Enhanced Qualified Electronic Signature

GCP Goods circulation participant

10

Abbreviation Description

UTD Universal transfer document

UTD(c) Universal transfer document (corrected)

FCS Federal Customs Service

EDM Electronic Document Management

11

1. General provisions

1.1. Principles of Interaction with API

Interaction of goods circulation participants (hereinafter referred to as GCP) with the Track and Trace Government Information System (hereinafter referred to as TT GIS) is carried out in electronic format. Exchange of documents in hard copy is not provided.

Electronic interaction is arranged in one of the two ways:

1. Submission of information, i.e. exchange of electronic documents, based on which the information may be entered in TT GIS registers. Submission of information is defined as responsibility of GCP.

2. Request of information, i.e. exchange, when the information from TT GIS registers is provided to GCP in compliance with the established permits to receive the information. This does not lead to changes in registers. Request and further provision of information from TT GIS are initiated by GCP at their discretion and applied, for example, to check the MC statuses or GCP registration status.

Electronic interaction is performed through exchange of electronic documents according to the established procedure. Enhanced qualified electronic signature (EQES) is used for legally binding electronic documents. The EQES is submitted together with the electronic document. Electronic interaction is carried out using the TT GIS application programming interfaces (API) and the information systems of goods circulation participants.

In case of interaction via API, the following requirements are met:

1. GCP authentication and authorisation (assigning permissions for electronic interaction) are carried out by means of EQES.

2. When providing and requesting information, the data transmitted are protected by TLS/HTTPS (GOST 28147-89) by encoding the data transmission channel to the Operator’s address by CIP certified in the Russian Federation (GOST R 34.10-2012).

API does not provide for categorization of goods circulation participants.

ATTENTION: when displaying data on non-residents, INN will be replaced with its equivalent in EEU country.

Information on nested parameters

The parameter is considered nested if it is not aligned along the left margin of the table.

Nest example:

Parameter Description

results:

12

Parameter Description

agentInn

*children:

**brand

Read as:

’*’ - nesting level of parameter. The ’results’ parameter contains ’agentInn’ and ’children’ parameters, while ’children’ parameter contains ’brand’ parameter.

Information on stands:

1. https://ismp.crpt.ru/api/v3 – base address of production environment of TT GIS (hereinafter referred to as <stand url>);

2. https://demo.lp.crpt.tech/api/v3 – base address of demonstration environment of TT GIS (hereinafter referred to as <stand url>);

3. https://ismp.crpt.ru/api/v4 – base address of production environment of TT GIS (hereinafter referred to as <stand url>);

4. https://demo.lp.crpt.tech/api/v4 – base address of demonstration environment of TT GIS (hereinafter referred to as <v4 stand url>)

Information on errors occurring when requesting API methods has the following format:

(for details, see Catalogue - Response statuses)

Error example:

Status code: 403 Content-Type: application/json

{ ‘error_message’: ‘<No access to resource >‘ }

Status code: 401

error information returns in XML format

Methods of National catalogue return messages on errors that can be in both XML and JSON formats depending on the request format selected

Country codes are provided as per ISO 3166.

https://ismp.crpt.ru/api/v3

https://demo.lp.crpt.tech/api/v3

https://ismp.crpt.ru/api/v4

https://demo.lp.crpt.tech/api/v4

https://www.iso.org/ru/iso-3166-country-codes.html

13

1.1.1. Requirements for Exchange Files

The exchange file shall be signed with EQES of a person authorised to act on behalf of the goods circulation participant without the power of attorney and comply with the following requirements:

1. File in JSON format:

– exchange with TT GIS uses json of RFC 7159 standard (https://tools.ietf.org/html/rfc7159);

– uses UTF-8 coding;

– resulting JSON can also contain a set of fields specific for a certain goods item.

2. Exchange file in CSV format:

– meets RFC 4180 standard;

– uses UTF-8 coding

– contains ’,’ symbol in the file content as a delimiter.

3. Exchange file in XML format:

– XML format is described in xsd schemes. For updated xsd schemes, refer to Help section;

– contains information that is fully included in the block with ’File’ XML-tag;

– contains a single copy of electronic document;

– uses UTF-8 coding;

– contains the first string of type <?xml version=‘1.0’ encoding=‘utf-8’?>;

– determines standard types of data as per ISO (for the standard description, refer to ISO https://www.w3schools.com/xml/schema_dtypes_date.asp);

– is checked for correctness based on XSD scheme - a logic model for data exchange describing logical elements and attributes of XML files.

ATTENTION: the ’curl’ requests in the examples are executed and checked in UNIX systems; to ensure correct operation in other operating systems, replacement of individual symbols may be required.

https://tools.ietf.org/html/rfc7159

https://tools.ietf.org/html/rfc4180

https://www.w3schools.com/xml/schema_dtypes_date.asp

14

1.1.1.1. Responses from TT GIS REST API may contain additional utility json attributes which are not specified in documentation. Unknown attributes shall be ignored. 1.1.1.2. Maximum size of the document to be transmitted via API shall not exceed 30 megabytes. 1.1.1.3. All attribute values in JSON and CSV formats expressed in money terms (prices, taxes etc.) are set in kopecks without delimiters.

1.1.2. Screening

Screening is replacement of control symbols in the text with relevant text substitutions. Screening is intended to separate text from code and control symbols. Screening is used when transferring parameters of API method requests according to the following standards:

• when parameters are transmitted in the Uniform Resource Locator (URL), i.e. request URL, screening shall be applied according to the standard rfc3986 (for description of the standard, refer to para. 2.1 https://www.protocols.ru/WP/rfc3986/);

• when parameters are transmitted in the JSON string of the URL request body, screening shall be applied according to the standard rfc8259 (for description of the standard, refer to para. 7 https://www.protocols.ru/WP/rfc8259/);

• when CSV files are used for screening the symbol ' (apostrophe), the symbol '' (double apostrophe) is used;

• when parameters are transmitted in the XML string of the URL request body, screening shall be applied according to the standard W3C (for description of the standard, refer to https://www.w3.org/TR/xml/).

Example:

• screening for JSON according to rfc8259 standard:

0104650117240408211dmfcZNcM’4=> 0104650117240408211dmfcZNcM\’4

• screening for URL according to rfc3986 standard:

:../cises/aggregated/list?codes=0104650117240408211dmfcZNcM’4 => ./cises/aggregated/list?codes=0104650117240408211dmfcZNcM%224

• screening for CSV:

‘010481097886269421’’LLRY<%’JZTVZ’

• screening for XML according to W3C standard:

<cis>0104650117240408211dmfcZNcM<4</cis> <cis>0104650117240408211dmfcZNcM<4</cis> <cis><![CDATA[0104650117240408211dmfcZNcM<4]]></cis>

https://www.protocols.ru/WP/rfc3986/

https://www.protocols.ru/WP/rfc8259/

https://www.w3.org/TR/xml/

15

1.1.3. Type of Content to be Returned by API Methods

API methods return mainly responses in JSON format, i. e. MIME‑type application/json. Some methods return the binary content (e.g. documents in zip): MIME-type application/zip or application/octet-stream in case of correct response, or an error description in JSON format in case of error. Thus, the same method can return different types of content depending on the situation.

For correct operation of API methods, ’Accept’ parameter of request heading shall be set so that all possible server responses were taken into account, i. e. both application/zip and application/json. The simplest option is to use a universal template:

Accept: /

To limit the set of returned types of content, you can specify more than one request headings of methods:

Accept: application/octet-stream

Accept: application/json

If the list of request headings of API methods appears to have none meeting the response generated by the server, then API will return a response with code = 406 (Not Acceptable) with empty response body.

1.2. Authentication

To use API interface, register in TT GIS SUA: at the production stand (https://markirovka.crpt.ru/) or integration (demo) stand (https://markirovka.demo.crpt.tech) and have a user account with at least one TT GIS goods group connected (see Catalogue - Types of documents).

Function of this method is to receive the authentication token for the EQES:

• As a result of this method, the user receives the ‘uuid – data’ pair, where ’uuid’ is an identifier of the current authentication, and ’data’ is a string to be signed by the user

• The server responds to the request with either a message with code 200 (OK) and a token, or an error message (for details, see Catalogue - Response statuses).

IMPORTANT!

All API methods of interaction with TT GIS require transmission in the parameter heading

'Authorisation: Bearer <token>'

where token is an authentication token received as a result of method of receiving the token.

Token is valid for 10 hours.

https://markirovka.crpt.ru/

https://markirovka.demo.crpt.tech/

16

1.2.1. Request for Authorisation

URL: /auth/cert/key

Method: GET

Request example: curl -v <stand url>/auth/cert/key

Response: < HTTP/1.1 200 < Content-Type: application/json;charset=UTF-8 < {‘uuid’:’b7b1abc9-f4ee-47db-8a20-f80ac83504e8’, ‘data’:’QNRPNPFGJZFUXCERQMTWLRMBRNRAAP’}

Response parameters:

Parameter Type Mandatory Access Description

uuid string + Read only Unique identifier of generated random data

data string + Read only Random data string

1.2.2. Receiving an Authentication Token

URL: /auth/cert/

Method: POST

Request example: curl -X POST -v '<stand url>/auth/cert/' -H 'content-type: application/json;charset=UTF-8' --data-binary '{ ’uuid’:’ b7b1abc9-f4ee-47db-8a20-f80ac83504e8’, ‘data’:’<Signed data in base64>‘'}

Request body parameters:

Parameter Type Mandatory Description

uuid string + Unique identifier of signed random data

data string + Random data signed with EQES of registered GCP in the base64 (attached ES)

Response: < HTTP/2 200 < content-type: application/json;charset=UTF-8 < {‘token’: ‘eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…’}

17


Parameter Type Mandatory Description Comment

token string - Authentication token

Parameter is mandatory in case of successful response

code string - Error code Parameter is mandatory in case of non-successful response

error_message string - Error message

description string - Error description

IMPORTANT!

All API methods of interaction with TT GIS require transmission in the parameter heading

'Authorisation: Bearer <token>',

where token is an authentication token received as a result of method of receiving the authentication token.

18

2. Methods Set of attributes which is unique for different product groups is given in Catalogue - Additional parameters for PG.

2.1. General Methods

This section describes the methods applicable for goods of all types.

2.1.1. Method of receiving the MC list with detailed information on MC using set filter

This method returns the list of MC with details currently available to the goods circulation participant (INN will be determined by the token), according to the set filter.

URL: /api/v3/facade/identifytools/listV2 - a deprecated option, from now use: /api/v4/facade/identifytools/listV2

Method: GET

Request example: curl -X GET '<v4 stand url>/facade/identifytools/listV2?\ limit=10&order=DESC&orderColumn=emd&\ uit=010469022978096621qSF7qjA3aRIqM2406402&\ orderedColumnValue=2019-01-23T08:42:17.593Z&pageDir=NEXT' \ -H 'Authorisation: Bearer <TOKEN>'

This request will return next ('pageDir’ parameter) 10 ('limit’ parameter) entries starting from the emission date 2019-01-23T08:42:17.593Z ('orderedColumnValue’ parameter) and marking code 010469022978096621qSF7qjA3aRIqM2406402 ('uit’ parameter). Sorting will be performed by emission date ('orderColumn' parameter) and (always) by marking code itself (regardless of transmitted parameters) using DESC ('order' parameter). Values of emission date and marking code shall be taken from the last string (for 'pageDir NEXT') or from the first string (for 'pageDir PREV') in order to transfer between pages.

Request header parameters: Authorisation: Bearer <token>

Request parameters:


filter object + request filter

*pg [string] - Goods group: the parameter must be specified for the following goods groups: milk – ‘Dairy products’; water – ’Bottled water’

*cis string - Identification code used to filter the MC list

*cisMatchMode string - Filtering by MC mode: EQ - equal to; LIKE - contains;

19


Start_with - starts with

*emissionDateFrom string (date-time)

- Date of emission from Specified in yyyy-MM-ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z format. Example 2019-01-01T03:00:00.000Z

*emissionDateTo string (date-time)

- Date of emission to Specified in yyyy-MM-ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z format. Example 2019-01-01T03:00:00.000Z

*gtin string - Goods code

*sn string - Marking code serial number

*producerInn string - INN of manufacturer

*ownerInn string - INN of goods owner

*cisPackageType enum - Packing type see Catalogue - Types of packing

*tnVed10 string - Goods nomenclature code (10 digits)

*emissionType string - Emission type: LOCAL – manufactured in RF; FOREIGN – imported into RF; REMAINS – remains marking; CROSSBORDER – imported from EEU countries

*pageDir - Pagination direction selection: PREV – previous section; NEXT – next section

*uit string - IC value – a reference point (record where sampling starts) used to sort records. Only to be used together with orderedColumnValue parameter

*order string - Sorting order: ASC – ascending; DESC – descending

*orderColumn string - Name of column used to sort records. Acceptable value of emd - emission date

*orderedColumnValue string - Column value, a reference point (record where sampling starts) used to sort records. Only to be used together with uit parameter

*limit integer - The value sets the number of records in a reply (maximum is 10000 records, default is 10)

*cisAggregationState enum - IC/SPIN: PACKED- in aggregate (aggregated); NOT_PACKED – not in aggregate (disaggregated); ANY – any state (default value)

*packs string - Filtering by goods groups: ALL – goods and packings; UNIT – goods only; PACK – packings only

20


*aggregation boolean - Displaying goods and goods packings with the same status for aggregation

*countChildren integer (int32)

- Number of children ICs

*tree string - IC/SPIN list tree output method: NO_TREE – do not return nested ICs; ONE_LEVEL – return only the first nesting level; ALL_TREE – return the entire tree

*uituStatus string - SPIC status

*cache boolean - Cache flag. If the flag is enabled, the GCP receives a response with not more than the set limit of marking code of 1524

*prVetDocument string - Accompanying production veterinary document

*docType string - see Catalogue - Types of documents

*statusExt enum - Additional status of IC: CANCELLATION_APPLIED – Written off after application on goods; REMARK_RETIRED – Remarked; RETIRED_CANCELLATION – Written off; DONATION – Gratuitous transfer of goods; STATE_ENTERPRISE – Acquisition by a state enterprise; NO_RETAIL_USE – Use for purposes of buyer; BEYOND_EEC_EXPORT – Export outside EEU countries; REMOTE_SALE – Sale by sample, remote sale; EEC_EXPORT – Export to EEU countries; RETURN – Return to individual; DAMAGE_LOSS – Loss or damage; DESTRUCTION – Destruction; CONFISCATION – Confiscation; LIQUIDATION – Liquidation of business; FTS_RESPOND_NOT_OK - Unfavorable decision by FCS; FTS_RESPOND_WAITING - Awaiting confirmation by FCS; FTS_CONTROL - Controlled by FCS

*cisStatus string - Current IC status: APPLIED – emitted. Received; EMITTED – emitted. Released; INTRODUCED – in circulation; RETIRED – dropped off; DISAGGREGATION – disaggregated (for packings only)

*withdrawReason string - Reason for withdrawal: KM_SPOILED – Spoiled; LOST - IM KM_LOST – Lost; KM_DESTROYED – Destroyed; DESCRIPTION_ERRORS - Errors in goods description found; RETAIL – Retail sale; EEC_EXPORT – Export to EEU countries; BEYOND_EEC_EXPORT – Export outside EEU countries; RETURN – Return to individual;

21


REMOTE_SALE – Sale by sample, remote sale; DAMAGE_LOSS – Loss or damage; DESTRUCTION – Destruction; CONFISCATION – Confiscation; LIQUIDATION – Liquidation of business; DONATION – Gratuitous transfer; STATE_ENTERPRISE – Acquisition by a state enterprise; NO_RETAIL_USE – Use for purposes of buyer; ENTERPRISE_USE – Use for purposes of enterprise; KM_SPOILED_OR_LOST - IM with MC spoiled or lost; KM_CANCELLATION - cancellation of MCs not converted in IM due to expiration of time period; KM_CANCELLATION_BY_TERM - cancellation of unconverted MC (labeling) due to expiration of established shelf life; RETAIL_RETURN - Return of goods with damaged/missing IM at retail; REMOTE_SALE_RETURN - Return of goods with damaged/missing IM at remote sales

*documentId string - Document registration number. Shall be specified when searching IC in the document

Response example: { ‘results’: [ { ‘uit’: ‘string’, ‘cis’: ‘string’, ‘gtin’: ‘string’, ‘sgtin’: ‘string’, ‘tnVedEaes’: ‘string’, ‘tnVedEaesGroup’: ‘string’, ‘productName’: ‘string’, ‘emissionDate’: 0, ‘producedDate’: 0, ‘participantName’: ‘string’, ‘participantInn’: ‘string’, ‘producerName’: ‘string’, ‘producerInn’: ‘string’, ‘ownerName’: ‘string’, ‘ownerInn’: ‘string’, ‘statusEx’: ‘EMPTY’, ‘lastDocId’: ‘string’, ‘lastDocType’: ‘UNKNOWN’, ‘emissionType’: ‘string’, ‘receiptDate’: 0, ‘withdrawReason’: ‘string’, ‘prevCises’: [ ‘string’ ], ‘nextCises’: [ ‘string’

22

], ‘status’: ‘EMITTED’, ‘packType’: ‘UNIT’, ‘children’: [ null ], ‘countChildren’: 0, ‘cisChildren’: [ ‘string’ ], ‘uitu’: ‘string’, ‘dateChange’: 0, ‘parent’: ‘string’, ‘expireDate’: 0, ‘prVetDocument’: ‘string’, ‘introducedDate’: 0, ‘agentName’: ‘string’, ‘agentInn’: ‘string’, ‘previousAgentName’: ‘string’, ‘previousAgentInn’: ‘string’, ‘exporterName’: ‘string’, ‘exporterTaxpayerId’: ‘string’, ‘turnoverType’: ‘SELLING’, ‘lastStatusChangeDate’: 0, ‘productGroup’: ‘string’ } ], ‘total’: 0, ‘docErrors’: [ { ‘additionalProp1’: {}, ‘additionalProp2’: {}, ‘additionalProp3’: {} } ] }



results array + Request result

*uit string - IC, Mandatory if uitu is not specified

*cis string + Identification code used to filter the MC list


*sgtin string - Goods code and IC serial number

*tnVedEaes string - Goods nomenclature code (10 digits)

*tnVedEaesGroup string - EEU FEACN code of goods item

*productName string - Goods name on the label

23


*emissionDate string (date-time)

+ IC emission date. Is returned in yyyy-MM-ddTHH:mm:ss.SSS’Z format

*producedDate string (date-time)

- Date of introduction of goods with IC into circulation. Is returned in yyyy-MM-ddTHH:mm:ss.SSS’Z format

*participantInn string - INN of goods circulation participant

*participantName string - Name of goods circulation participant

*producerInn string - INN of goods manufacturer

*producerName string - Goods manufacturer


*ownerName string - Name of goods owner

*statusEx enum - Extended IC status: EMPTY – None; WAIT_SHIPMENT – Awaiting acceptance; WAIT_TRANSFER_TO_OWNER – Awaiting transfer to owner (contract manufacturing); REMARK_RETIRED – Remarked; RETIRED_CANCELLATION – Writing off; WAIT_REMARK – IC written off after application on goods (Goods awaiting remarking)

*lastDocId string - Latest registration number of the document recorded in TT GIS by this IC

*lastDocType string + Type of the last document. See Catalogue - Types of documents

*emissionType string + Emission type: LOCAL – manufactured in RF; FOREIGN – imported into RF; REMAINS – remains marking; CROSSBORDER – imported from EEU countries

*receiptDate string (date-time)

- Date of withdrawal from circulation. Is returned in yyyy-MM-ddTHH:mm:ss.SSS’Z format

*withdrawReason string - Reason for withdrawal: KM_SPOILED – spoiled; LOST - IM KM_LOST – lost; KM_DESTROYED – destroyed; DESCRIPTION_ERRORS - errors in goods description found; RETAIL – retail sale; EEC_EXPORT – export to EEU countries; BEYOND_EEC_EXPORT – export outside EEU countries; RETURN – return to individual; REMOTE_SALE – sale by sample, remote sale; DAMAGE_LOSS – loss or damage;

24


DESTRUCTION – destruction; CONFISCATION – confiscation; LIQUIDATION – liquidation of business; DONATION – gratuitous transfer; STATE_ENTERPRISE – acquisition by a state enterprise; NO_RETAIL_USE – use for purposes of buyer; ENTERPRISE_USE – use for purposes of enterprise; KM_SPOILED_OR_LOST - IM with MC spoiled or lost; KM_CANCELLATION - cancellation of MCs not converted in IM due to expiration of time period; KM_CANCELLATION_BY_TERM - cancellation of unconverted MC (labeling) due to expiration of established shelf life; RETAIL_RETURN - Return of goods with damaged/missing IM at retail; REMOTE_SALE_RETURN - Return of goods with damaged/missing IM at remote sales

*prevCises string - Previous IС numbers. In case of goods remarking

*nextCises [string] - Next IС numbers. In case of goods remarking

*status enum + Type of goods/IC status: EMITTED – emitted. Released; APPLIED – emitted. Received; INTRODUCED – in circulation; WRITTEN_OFF – MC written off; RETIRED – dropped out; DISAGGREGATION – disaggregated (for packings only)

*packType string + Packing type see Catalogue - Types of packing

*children: - IC in aggregate

**cis string + Goods IC

**gtin string - Goods code

**producerName string - Goods manufacturer

**status enum + Type of goods/IC status: EMITTED – emitted. Released; APPLIED – emitted. Received; INTRODUCED – in circulation; WRITTEN_OFF – MC written off; RETIRED – dropped out; DISAGGREGATION – disaggregated (for packings only)

**emissionDate string (date-time)

+ Emission date. In yyyy-MM-ddTHH:mm:ss.SSS’Z format

**producedDate string (date-time)

- Date of application. Is returned in yyyy-MM-ddTHH:mm:ss.SSS’Z format

**packageType string + Packing type see Catalogue - Types of packing

25


**ownerInn string - INN of goods owner

**ownerName string - Name of goods owner

**productName string - Goods name

**brand string - Brand

**prevCises [string] - Previous IСs. In case of goods remarking

**nextCises [string] - Next IС numbers. In case of goods remarking

**statusEx enum - Extended IC status: EMPTY – None; WAIT_SHIPMENT – Awaiting acceptance; WAIT_TRANSFER_TO_OWNER – Awaiting transfer to owner (contract manufacturing); REMARK_RETIRED – Remarked; RETIRED_CANCELLATION – Writing off; WAIT_REMARK – IC written off after application on goods (Goods awaiting remarking)

**children: [string] - All children ICs. Looks like a JSON array

**childrenMap [string] - Brief information on children ICs

**countChildren integer - Number of children ICs

**parent string - Identification code of the packing where the goods are aggregated

**lastDocId string - Latest registration number of the document recorded in TT GIS by this IC

**expireDate string (date-time)

- Date of shelf life expiration. Returned in yyyy-MM-ddTHH:mm:ss.SSS’Z format (mandatory for PG ‘Dairy products’)

**prVetDocument string - Accompanying production veterinary document (mandatory for PG ‘Dairy products’)

**introducedDate string (date-time)

- Date of introduction into circulation. Is returned in yyyy-MM-ddTHH:mm:ss.SSS’Z format

**exporterName string - Name of the exporter

**exporterTaxpayerId string - Unique identifier of the exporter in the national taxpayer accounting system

**agentInn string - INN of the current goods owner

**agentName string - Name of the current goods owner

**lastStatusChangeDate string (date-time)

+ Date of the last status change. Is returned in yyyy-MM-ddTHH:mm:ss.SSS’Z format

**sgtin string - Goods code and IC serial number

**turnoverType enum - Goods circulation type: SELLING - selling;

26


COMMISSION - commission; AGENT - agent

**productGroup string + Goods group. see Catalogue - List of supported product groups



*cisChildren [string] - List of children ICs

*uitu string - SPIC, Mandatory if uit is not specified

*dateChange string (date-time)

- Date of changing SPIC. Is returned in yyyy-MM-ddTHH:mm:ss.SSS’Z format

*parent string - SPIC of the upper level

*expireDate string (date-time)


*prVetDocument string - Accompanying production veterinary document (mandatory for PG ‘Dairy products’)

*introducedDate string (date-time)


*agentInn string - INN of the current goods owner

*agentName string - Name of the current goods owner

*previousAgentInn string - INN of the previous goods owner

*previousAgentName string - Name of the previous goods owner

*exporterName string - Name of the exporter

*exporterTaxpayerId string - Unique identifier of the exporter in the national taxpayer accounting system

*turnoverType enum - Goods circulation type: SELLING - selling; COMMISSION - commission; AGENT - agent

*lastStatusChangeDate string (date-time)


*productGroup string + Goods group. see Catalogue - List of supported product groups

total string + Number of returned responses

docErrors [string] - List of errors of document processing. Is returned in case of an error

27

2.1.2. Method of receiving detailed information on a certain MC (GET)

URL: /api/v3/facade/identifytools/info - a deprecated option, from now use: /api/v4/facade/identifytools/info

Method: GET

The method returns detailed information about the requested MC (1 MC per 1 request) which is currently available to the goods circulation participant (INN of the organisation is specified in the token).

Request example: curl -X GET '<v4 stand url>/facade/identifytools/info?cis=010405915570452921HXRNJW15asPkB2406405' -H 'Authorisation: Bearer <TOKEN>'

Request parameters:


cis string + Identification code

Response examples: { ‘uit’: ‘string’, ‘cis’: ‘string’, ‘gtin’: ‘string’, ‘sgtin’: ‘string’, ‘tnVedEaes’: ‘string’, ‘tnVedEaesGroup’: ‘string’, ‘productName’: ‘string’, ‘emissionDate’: ‘2020-05-06T12:46:30.098Z’, ‘producedDate’: ‘2020-05-06T12:46:30.098Z’, ‘participantName’: ‘string’, ‘participantInn’: ‘string’, ‘producerName’: ‘string’, ‘producerInn’: ‘string’, ‘ownerName’: ‘string’, ‘ownerInn’: ‘string’, ‘statusEx’: ‘EMPTY’, ‘lastDocId’: ‘string’, ‘lastDocType’: ‘UNKNOWN’, ‘emissionType’: ‘string’, ‘receiptDate’: 0, ‘withdrawReason’: ‘string’, ‘prevCises’: [ ‘string’ ], ‘nextCises’: [ ‘string’ ], ‘status’: ‘EMITTED’,

28

‘packType’: ‘UNIT’, ‘children’: [ { ‘cis’: ‘string’, ‘gtin’: ‘string’, ‘producerName’: ‘string’, ‘status’: ‘EMITTED’, ‘emissionDate’: ‘2020-05-06T12:46:30.098Z’, ‘producedDate’: ‘2020-05-06T12:46:30.098Z’, ‘packageType’: ‘UNIT’, ‘ownerName’: ‘string’, ‘ownerInn’: ‘string’, ‘productName’: ‘string’, ‘brand’: ‘string’, ‘prevCises’: [ ‘string’ ], ‘nextCises’: [ ‘string’ ], ‘statusEx’: ‘EMPTY’, ‘children’: [ ‘string’ ], ‘childrenMap’: {}, ‘countChildren’: 0, ‘parent’: ‘string’, ‘lastDocId’: ‘string’, ‘expireDate’: 0, ‘prVetDocument’: ‘string’, ‘introducedDate’: 0, ‘exporterName’: ‘string’, ‘exporterTaxpayerId’: ‘string’, ‘agentName’: ‘string’, ‘agentInn’: ‘string’, ‘lastStatusChangeDate’: 0, ‘turnoverType’: ‘SELLING’, ‘productGroup’: ‘string’ } ], ‘countChildren’: 0, ‘cisChildren’: [ ‘string’ ], ‘uitu’: ‘string’, ‘dateChange’: 0, ‘parent’: ‘string’, ‘expireDate’: 0, ‘prVetDocument’: ‘string’, ‘introducedDate’: 0, ‘agentName’: ‘string’, ‘agentInn’: ‘string’, ‘previousAgentName’: ‘string’, ‘previousAgentInn’: ‘string’, ‘exporterName’: ‘string’, ‘exporterTaxpayerId’: ‘string’,

29

‘turnoverType’: ‘SELLING’, ‘lastStatusChangeDate’: 0, ‘productGroup’: ‘string’ }




uit string - IC, Mandatory if uitu is not specified

cis string + Identification code used to filter the MC list

gtin string - Goods code

sgtin string - Goods code and IC serial number

tnVedEaes string - Goods nomenclature code (10 digits)

tnVedEaesGroup string - EEU FEACN code of goods item

productName string - Goods name on the label

emissionDate string (date-time)


producedDate string (date-time)


participantInn string - INN of goods circulation participant

participantName string - Name of goods circulation participant

producerInn string - INN of goods manufacturer

producerName string - Goods manufacturer

ownerInn string - INN of goods owner

ownerName string - Name of goods owner

statusEx enum - Extended IC status: EMPTY – None; WAIT_SHIPMENT – Awaiting acceptance; WAIT_TRANSFER_TO_OWNER – Awaiting transfer to owner (contract manufacturing); REMARK_RETIRED – Remarked; RETIRED_CANCELLATION – Writing off; WAIT_REMARK – IC written off after application on goods (Goods awaiting remarking)

lastDocId string - Latest registration number of the document recorded in TT GIS by this IC

lastDocType string + Type of the last document. See Catalogue - Types of documents

emissionType string + Emission type: LOCAL – manufactured in RF; FOREIGN – imported into RF;

30


REMAINS – remains marking; CROSSBORDER – imported from EEU countries

receiptDate string (date-time)


withdrawReason string - Reason for withdrawal: KM_SPOILED – spoiled; LOST - IM KM_LOST – lost; KM_DESTROYED – destroyed; DESCRIPTION_ERRORS - errors in goods description found; RETAIL – retail sale; EEC_EXPORT – export to EEU countries; BEYOND_EEC_EXPORT – export outside EEU countries; RETURN – return to individual; REMOTE_SALE – sale by sample, remote sale; DAMAGE_LOSS – loss or damage; DESTRUCTION – destruction; CONFISCATION – confiscation; LIQUIDATION – liquidation of business; DONATION – gratuitous transfer; STATE_ENTERPRISE – acquisition by a state enterprise; NO_RETAIL_USE – use for purposes of buyer; ENTERPRISE_USE – use for purposes of enterprise; KM_SPOILED_OR_LOST - IM with MC spoiled or lost; KM_CANCELLATION - cancellation of MCs not converted in IM due to expiration of time period; KM_CANCELLATION_BY_TERM - cancellation of unconverted MC (labeling) due to expiration of established shelf life; RETAIL_RETURN - Return of goods with damaged/missing IM at retail; REMOTE_SALE_RETURN - Return of goods with damaged/missing IM at remote sales

prevCises string - Previous IС numbers. In case of goods remarking

nextCises [string] - Next IС numbers. In case of goods remarking

status enum + Type of goods/IC status: EMITTED – emitted. Released; APPLIED – emitted. Received; INTRODUCED – in circulation; WRITTEN_OFF – MC written off; RETIRED – dropped out; DISAGGREGATION – disaggregated (for packings only)

packType string + Packing type see Catalogue - Types of packing

children: - IC in aggregate

*cis string + Goods IC


31








*packageType string + Packing type see Catalogue - Types of packing



*productName string - Goods name

*brand string - Brand

*prevCises [string] - Previous IСs. In case of goods remarking



*children: [string] - All children ICs. Looks like a JSON array

*childrenMap [string] - Brief information on children ICs

*countChildren integer - Number of children ICs

*parent string - Identification code of the packing where the goods are aggregated





32













countChildren integer (int32)


cisChildren [string] - List of children ICs

uitu string - SPIC, Mandatory if uit is not specified

dateChange string (date-time)


parent string - SPIC of the upper level

expireDate string (date-time)


prVetDocument string - Accompanying production veterinary document (mandatory for PG ‘Dairy products’)

introducedDate string (date-time)


agentInn string - INN of the current goods owner

agentName string - Name of the current goods owner

previousAgentInn string - INN of the previous goods owner

previousAgentName string - Name of the previous goods owner

exporterName string - Name of the exporter

exporterTaxpayerId string - Unique identifier of the exporter in the national taxpayer accounting system

33


turnoverType enum - Goods circulation type: SELLING - selling; COMMISSION - commission; AGENT - agent

lastStatusChangeDate string (date-time)


productGroup string + Goods group. see Catalogue - List of supported product groups

2.1.3. Method of receiving the list of goods using set filter

The method returns a list of goods with details currently available to the goods circulation participant (INN of organisation is in the token), according to the set filter.

URL: /facade/marked_products/listV2

Method: GET

Request example: curl -X GET '<stand url>/facade/marked_products/listV2?\ limit=10&order=DESC&orderColumn=emd&\ uit=010469022978096621qSF7qjA3aRIqM2406402&\ orderedColumnValue=2019-01-23T08:42:17.593Z&pageDir=NEXT' \ -H 'Authorisation: Bearer <TOKEN>'


Request parameters:



*pg array - Goods group: the parameter must be specified for the following goods groups: milk – ‘Dairy products’; water – ’Bottled water’



*cisMatchMode string - Filtering by MC mode: EQ - equal to; LIKE - contains; Start_with - starts with

*emissionDateFrom date-time - Date of emission from Specified in yyyy-MM-ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z format. Example 2019-01-01T03:00:00.000Z

34


*emissionDateTo date-time - Date of emission to Specified in yyyy-MM-ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z format. Example 2019-01-01T03:00:00.000Z





*cisPackageType enum - Packing type. Catalogue - Types of packing



*pageDir enum - Pagination direction selection: PREV – previous section; NEXT – next section






*cisAggregationState enum - IC state: PACKED- in aggregate (aggregated); NOT_PACKED – not in aggregate (disaggregated); ANY – any state





*tree string - IC/SPIN list tree output method: NO_TREE – do not return nested ICs;

35


ONE_LEVEL – return only the first nesting level; ALL_TREE – return the entire tree



*doctype string - Type of document. See Catalogue - Types of documents

*cisStatus string - Current IC status: APPLIED – emitted. Received; EMITTED – emitted. Released; INTRODUCED – In circulation; RETIRED – Dropped off

*statusExt enum - Extended goods item status: WAIT_SHIPMENT – Awaiting acceptance; WAIT_TRANSFER_TO_OWNER – Awaiting transfer to owner (contract manufacturing); WAIT_REMARK – IC written off after application on goods (Goods awaiting remarking); WITHDRAW – withdrawal; REMARK_RETIRED – Remarked


*registryType string - Registry type: RECEIVED – received; GIVEN - transmitted

*agentInn string - INN of the goods owner


Response example: { ‘results’: [ { ‘cis’: ‘string’, ‘gtin’: ‘string’, ‘sgtin’: ‘string’, ‘tnvd’: ‘string’, ‘tnvedGroup’: ‘string’, ‘productName’: ‘string’, ‘producerName’: ‘string’, ‘producerInn’: ‘string’, ‘ownerName’: ‘string’, ‘ownerInn’: ‘string’, ‘agentName’: ‘string’, ‘agentInn’: ‘string’, ‘previousAgentName’: ‘string’, ‘previousAgentInn’: ‘string’,

36

‘turnoverType’: ‘SELLING’, ‘statusEx’: ‘EMPTY’, ‘docNum’: ‘string’, ‘emissionDate’: 0, ‘producedDate’: 0, ‘introducedDate’: 0, ‘emissionType’: ‘string’, ‘prodOrderType’: ‘SELF_MADE’, ‘lastDocId’: ‘string’, ‘name’: ‘string’, ‘brand’: ‘string’, ‘model’: ‘string’, ‘certDoc’: { ‘type’: ‘string’, ‘number’: ‘string’, ‘date’: ‘string’ }, ‘prevCises’: [ ‘string’ ], ‘nextCises’: [ ‘string’ ], ‘status’: ‘EMITTED’, ‘remarks’: [ { ‘curr’: ‘string’, ‘prev’: ‘string’, ‘date’: ‘string’ } ], ‘cisChildren’: [ ‘string’ ], ‘children’: [ { ‘cis’: ‘string’, ‘gtin’: ‘string’, ‘producerName’: ‘string’, ‘status’: ‘EMITTED’, ‘emissionDate’: 0, ‘producedDate’: 0, ‘packageType’: ‘UNIT’, ‘ownerName’: ‘string’, ‘ownerInn’: ‘string’, ‘productName’: ‘string’, ‘brand’: ‘string’, ‘prevCises’: [ ‘string’ ], ‘nextCises’: [ ‘string’ ], ‘statusEx’: ‘EMPTY’, ‘children’: [ ‘string’

37

], ‘childrenMap’: {}, ‘countChildren’: 0, ‘parent’: ‘string’, ‘lastDocId’: ‘string’, ‘expireDate’: 0, ‘prVetDocument’: ‘string’, ‘introducedDate’: 0, ‘exporterName’: ‘string’, ‘exporterTaxpayerId’: ‘string’, ‘agentName’: ‘string’, ‘agentInn’: ‘string’, ‘lastStatusChangeDate’: 0, ‘turnoverType’: ‘SELLING’, ‘productGroup’: ‘string’ } ], ‘childrenDetails’: [ null ], ‘countChildren’: 0, ‘uitu’: ‘string’, ‘parent’: ‘string’, ‘packType’: ‘UNIT’, ‘withdrawReason’: ‘string’, ‘receiptDate’: 0, ‘expireDate’: 0, ‘prVetDocument’: ‘string’, ‘exporterName’: ‘string’, ‘exporterTaxpayerId’: ‘string’, ‘certificateType’: ‘CONFORMITY_CERT’, ‘certificateNumber’: ‘string’, ‘certificateDate’: ‘string’, ‘productGroup’: ‘string’ } ], ‘total’: 0, ‘docErrors’: [ { ‘additionalProp1’: {}, ‘additionalProp2’: {}, ‘additionalProp3’: {} } ] }




*cis string + Identification code used to filter the MC list



38


*tnvd string - Goods nomenclature code (10 digits)

*tnvedGroup string - EEU FEACN code of goods item (initial 4 symbols)



*producerInn string - INN of goods manufacturer / importer







*turnoverType enum - Goods circulation type: SELLING – selling; COMMISSION – commission; AGENT – agent


*docNum string - Document registration number








*prodOrderType enum - Type of production order: SELF_MADE - home manufacturing; OPERATOR - contract manufacturing

39



*name string - Goods name


*model string - Goods manufacturer

*certDoc - Certificate

**date string - Date of certificate. Is returned in yyyy-MM-ddTHH:mm:ss.SSS’Z format

**number string - Number of certificate

**type string - Type of certificate




*remarks - List of the goods remarking processes

**curr string - Current goods IC

**date string - Date of remarking. Is returned in yyyy-MM-ddTHH:mm:ss.SSS’Z format

**prev string - Previous goods ICs

*cisChildren [string] - List of children ICs

*children: - IC in aggregate

**cis string + Goods IC



**status enum + Type of goods/IC status: EMITTED – emitted. Released; APPLIED – emitted. Received; INTRODUCED – in circulation; RETIRED – dropped off; DISAGGREGATION – disaggregated (for packings only)


+ Emission date. Set in yyyy-MM-ddTHH:mm:ss.SSS’Z format

**producedDate string (date-


40


time)

**packageType string + Packing type. Catalogue - Types of packing



**productName string - Goods name on the label


**nextCises [string] - Next IС numbers. In case of goods remarking

**prevCises string - Previous IС numbers. In case of goods remarking


**children: [string] - All ICs in aggregate. Looks like a JSON array


**countChildren integer (int32)






**prVetDocument string - Accompanying production veterinary document (mandatory for PG ‘Dairy products’)





**agentName string - INN of the current goods owner

**agentInn string - Name of the current goods owner

**lastStatusChangeDate string (date-time)


41


**turnoverType enum - Goods circulation type: SELLING – selling; COMMISSION – commission; AGENT – agent

**productGroup string + Goods group. see Catalogue - List of supported product groups

*childrenDetails [array] - Marked goods



*uitu string - SPIC of the upper level


*packType string + Packing type. Catalogue - Types of packing

*withdrawReason string - Reason for withdrawal: KM_SPOILED – spoiled; LOST - IM KM_LOST – lost; KM_DESTROYED – destroyed; DESCRIPTION_ERRORS - errors in goods description found; RETAIL – retail sale; EEC_EXPORT – export to EEU countries; BEYOND_EEC_EXPORT – export outside EEU countries; RETURN – return to individual; REMOTE_SALE – sale by sample, remote sale; DAMAGE_LOSS – loss or damage; DESTRUCTION – destruction; CONFISCATION – confiscation; LIQUIDATION – liquidation of business; DONATION – gratuitous transfer; STATE_ENTERPRISE – acquisition by a state enterprise; NO_RETAIL_USE – use for purposes of buyer; ENTERPRISE_USE – use for purposes of enterprise; KM_SPOILED_OR_LOST - IM with MC spoiled or lost; KM_CANCELLATION - cancellation of MCs not converted in IM due to expiration of time period; KM_CANCELLATION_BY_TERM - cancellation of unconverted MC (labeling) due to expiration of established shelf life; RETAIL_RETURN - Return of goods with damaged/missing IM at retail; REMOTE_SALE_RETURN - Return of goods with damaged/missing IM at remote sales

*receiptDate string (date-time)




42





*certificateType string - Type of the document that confirms the conformity: Possible values: CONFORMITY_CERTIFICATE – conformity certificate); CONFORMITY_DECLARATION – conformity declaration); CONFORMITY_CERTIFICATE_OR_DECLARATION - conformity certificate or declaration)

*certificateNumber string - Number of document confirming compliance

*certificateDate string - Date of document confirming compliance. Is returned in yyyy-MM-ddTHH:mm:ss.SSS’Z format


*colour string - Colour. Mandatory for PG ’Footwear’

*productSize string - Size. Mandatory for PG ’Footwear’



2.1.4. Method of receiving brief information on IC\IC list (public)

URL: /facade/cis/cis_list

Method: GET

Request example: curl -X GET ’<stand url>/facade/cis/cis_list?cis=010463003407002921wskg1E44R1qym2406401&cis=010469022978096621qSF7qjA3aRIqM2406402’ -H 'content-type: application/json' -H 'Authorisation: Bearer <TOKEN>'

Request parameters:


cis string + Unique identifier of goods item (IC)

Request header parameters: Authorisation: Bearer <token>Response example: { ‘cis’: ‘string’ , ‘gtin’: ‘string’ ,

43

‘producerName’: ‘string’ , ‘status’: ‘EMITTED’ , ‘emissionDate’: ‘2020-05-06T12:46:30.098Z’ , ‘producedDate’: ‘2020-05-06T12:46:30.098Z’ , ‘packageType’: ‘UNIT’ , ‘ownerName’: ‘string’ , ‘ownerInn’: ‘string’ , ‘productName’: ‘string’ , ‘brand’: ‘string’ , ‘prevCises’: [ ‘string’ ] , ‘nextCises’: [ ‘string’ ] , ‘statusEx’: ‘EMPTY’ , ‘children’: [ ‘string’ ] , ‘childrenMap’: { ‘brand’: ‘string’ , ‘children’: [ ‘string’ ] , ‘childrenMap’: [ null ] , ‘cis’: ‘string’ , ‘countChildren’: 0 , ‘emissionDate’: ‘2020-01-23T16:17:48Z’ , ‘expireDate’: ‘2020-01-23T16:17:48Z’ , ‘exporterName’: ‘string’ , ‘exporterTaxpayerId’: ‘string’ , ‘sgtin’: ‘string’ , ‘introducedDate’: ‘2020-01-23T16:17:48Z’ , ‘lastDocId’: ‘string’ , ‘nextCises’: [ ‘string’ ] , ‘ownerInn’: ‘string’ , ‘ownerName’: ‘string’ , ‘packageType’: ‘string’ , ‘parent’: ‘string’ , ‘prVetDocument’: ‘string’ , ‘prevCises’: [ ‘string’ ] , ‘producedDate’: ‘2020-01-23T16:17:48Z’ , ‘producerName’: ‘string’ , ‘productName’: ‘string’ , ‘status’: ‘string’ , ‘statusEx’: ‘string’ , ‘turnoverType’: ‘SELLING’, ‘productGroup’: ‘string’ },

44

‘countChildren’: 0 , ‘parent’: ‘string’ , ‘lastDocId’: ‘string’ , ‘expireDate’: ‘2020-05-06T12:46:30.098Z’ , ‘prVetDocument’: ‘string’ , ‘introducedDate’: ‘2020-05-06T12:46:30.098Z’ , ‘exporterName’: ‘string’ , ‘exporterTaxpayerId’: ‘string’ , ‘agentName’: ‘string’ , ‘agentInn’: ‘string’ , ‘lastStatusChangeDate’: ‘2020-05-06T12:46:30.098Z’ , ‘productGroup’: ‘string’ }








+ Date of IC emission. Is returned in yyyy-MM-ddTHH:mm:ss.SSS’Z format



packageType string + Packing type see Catalogue - Types of packing

ownerName string - Name of the current goods owner


productName string - Goods name

brand string - Brand

prevCises [string] - Previous IС numbers. In case of goods remarking


statusEx enum - Extended IC status: EMPTY – None; WAIT_SHIPMENT – Awaiting acceptance; WAIT_TRANSFER_TO_OWNER – Awaiting transfer to owner (contract manufacturing); REMARK_RETIRED – Remarked; RETIRED_CANCELLATION – Writing off;

45


WAIT_REMARK – IC written off after application on goods (Goods awaiting remarking)

children [string] - IC in aggregate

childrenMap [string] - Brief information on children ICs








+ Emission date. Is returned in yyyy-MM-ddTHH:mm:ss.SSS’Z format









*nextCises [string] - Next IC numbers in case of remarking






*prevCises [string] - Previous IСs (remarking)





46





















turnoverType enum - Goods circulation type: SELLING – selling; COMMISSION – commission; AGENT – agent


47

Note: for non-owner, reply depends on MC:

• If MC is emitted. Received or In circulation, all data is returned;

• If MC is Disposed, all MC data is returned, except for information about GCP that disposed of MC;

• If aggregate is aggregated, all details and IC list are returned in the level 1 aggregate;

• If aggregate is disaggregated, aggregate status and IC list are returned in the level 1 aggregate.

2.1.5. Method of receiving the IC list by identifier

URL: /api/v3/facade/cis/cis_list - a deprecated option, from now use: /api/v4/facade/cis/cis_list

Method: POST

Request example: curl -X POST ‘<v4 stand url>/facade/cis/cis_list’ -H 'Authorisation: Bearer <TOKEN>' -H 'content-type: application/json' -d ’{‘cises’:[‘0000000000000000000000000000000’]}’

Example of JSON request { ’cises’: [ ‘0000000000000000000000000000000’ ] }

Request parameters:


cises string - List of unique goods identifiers (IC)


Response example: { ‘0000000000000000000000000000000’: { ‘cis’: ‘0000000000000000000000000000000’, ‘gtin’: ‘string’, ‘producerName’: ‘string’, ‘status’: ‘EMITTED’, ‘emissionDate’: ‘2020-05-06T12:46:30.098Z’, ‘producedDate’: ‘2020-05-06T12:46:30.098Z’, ‘packType’: ‘UNIT’, ‘ownerName’: ‘string’,

48

‘ownerInn’: ‘string’, ‘productName’: ‘string’, ‘brand’: ‘string’, ‘prevCises’: [ ‘string’ ], ‘nextCises’: [ ‘string’ ], ‘statusEx’: ‘EMPTY’, ‘children’: [ ‘string’ ], ‘countChildren’: 0, ‘parent’: ‘string’, ‘lastDocId’: ‘string’, ‘expireDate’: ‘2020-05-06T12:46:30.098Z’, ‘prVetDocument’: ‘string’, ‘introducedDate’: ‘2020-05-06T12:46:30.098Z’, ‘exporterName’: ‘string’, ‘exporterTaxpayerId’: ‘string’, ‘agentName’: ‘string’, ‘agentInn’: ‘string’, ‘lastStatusChangeDate’: ‘2020-05-06T12:46:30.098Z’, ‘turnoverType’: ‘SELLING’, ‘productGroup’: ‘string’, ‘tnVed10’: ‘string’ } }











packType + Packing type see Catalogue - Types of packing

49



























tnVed10 string - FEACN code (10 symbols)

50


Note: for non-owner, reply depends on MC:

• If MC is emitted. Received or In circulation, all data is returned;

• If MC is Disposed, all MC data is returned, except for information about GCP that disposed of MC;

• If aggregate is aggregated, all details and IC list are returned in the level 1 aggregate;

• If aggregate is disaggregated, aggregate status and IC list are returned in the level 1 aggregate.

2.1.6. Method of receiving information on goods item by Goods code

As a result of successful request execution according to the Goods code list, the response returns an array with information on goods by the requested goods codes.

Note: resulting JSON can also contain a set of fields specific for a certain goods item (see Catalogue - Additional parameters for PG).

A request can be submitted with two methods:

URL: /product/info

Method: GET

Request example 1: curl -X GET '<stand url>/product/info? gtins=04690257113712,04690257113712' -H 'Authorisation: Bearer <TOKEN>'

Request example 2: curl -X GET '<v4 stand url>/product/info? gtins=04690257113712,04690257113712' -H 'Authorisation: Bearer <TOKEN>'

Request parameters:


gtins array + List of goods codes

create boolean - Create a goods item if it is not in DB true-yes; false-no


51

Response example: { ‘results’: [ { ‘id’: 0, ‘name’: ‘string’, ‘gtin’: ‘string’, ‘brand’: ‘string’, ‘packageType’: ‘string’, ‘innerUnitCount’: 0, ‘model’: ‘string’, ‘publicationDate’: 0, ‘inn’: ‘string’, ‘exporter’: { ‘id’: 0, ‘ncId’: 0, ‘exporterName’: ‘string’, ‘exporterTaxpayerId’: ‘string’, ‘kpp’: ‘string’, ‘gcp’: ‘string’, ‘gln’: ‘string’, ‘manufactureAddress’: ‘string’, ‘importerAccount’: ‘string’ }, ‘permittedInns’: [ ‘string’ ], ‘productGroupId’: 0, ‘goodSignedFlag’: true, ‘goodMarkFlag’: true, ‘goodTurnFlag’: true, ‘isKit’: true, ‘isTechGtin’: true, ‘explain’: ‘string’, ‘foreignProducer’: { ‘id’: 0, ‘name’: ‘string’, ‘inn’: ‘string’, ‘kpp’: ‘string’, ‘gcp’: ‘string’, ‘gln’: ‘string’, ‘manufactureAddress’: ‘string’ } } ], ‘total’: 0, ‘errorCode’: ‘string’ }



results array + Response

52


*id integer (int64)

+ Unique identifier of goods item

*name string + Goods name

*gtin string + Goods code

*brand string - Goods brand

*packageType string + Code of packing type Packing type see Catalogue - Types of packing

*innerUnitCount number + Amount of a goods item in a packing

*model string - Goods manufacturer

*publicationDate string (date-time)

- Date of publication of the Goods code.

In yyyy-MM-ddTHH:mm:ss.SSS’Z format

*inn string - INN

*exporter array - Applicant of the goods item to be marked and put into circulation

**id integer (int64)

- Unique identifier of goods item

**ncId integer (int64)

- Identifier of applicant in National catalogue's DB

**exporterName string - Applicant's name

**exporterTaxpayerId string - Applicant's INN or its equivalent (tax identifier)

**kpp string - KPP KPP or its equivalent

**gcp string - Global identifier of the company in GS1

**gln string - Global identifier of the location

**manufactureAddress string - Production site address

**importerAccount string - A link to importer's account

*permittedInns string - INN array Subaccount companies that may use this goods code to order MC with the goods code owner permission

*productGroupId integer - Product group identifier see Catalogue - List of supported product groups

*goodSignedFlag boolean - Attribute for availability of product card signature in NC

53


*goodMarkFlag boolean - Readiness for marking attribute

*goodTurnFlag boolean - Readiness for circulation attribute

*isKit boolean - ’Package’ attribute as per product card

*isTechGtin boolean - ’Technical’ attribute as per product card

*explain string - User error for filling attributes and signing a product card in NC

*foreignProducer array - Manufacturer details object


- Unique identifier of manufacturer

**name integer (int64)

- Name of manufacturer

**inn string - Manufacturer's INN (or its equivalent)

**kpp string - Manufacturer's KPP (or its equivalent)

**gcp string - Manufacturer's GCP

**gln string - Manufacturer's GLN

**manufactureAddress [string] - Manufacturer's address array

total number + Number of goods found

errorCode string - Error code If error occurs

2.1.7. Catalog on CMG

Method searches for goods, considering user scope. Returns product details.

URL: /product/search

Method: GET

Request example: curl -X GET '<stand url>/product/search? limit=10&offset=0&page=0&pg=shoes' -H 'Authorisation: Bearer <TOKEN>'

54

Request parameters:



pg string - Goods group: the parameter must be specified for the following goods groups: milk – ‘Dairy products’; water – ’Bottled water’

limit integer - The value sets the number of records in a reply (maximum is 10000 records, default is 10)

offset integer - Offset position in the set of results to start numeration of pages

page integer - Number of response page, initial value - 0

direction string - Sorting: ASC - sets ascending sorting order; DECS - descending sorting order

sort string - Sorting by field


productTypeDesc string - Text description of footwear type

inn string - INN of manufacturer

country string - Country of production

model string - Model / Article of manufacturer

materialUpper string – Top material

materialLining string – Lining material

materialDown string – Material of bottom

colour string – Item colour

productSize string – Stich size

Response example: { ‘results’: [ { ‘id’: 0, ‘name’: ‘string’, ‘gtin’: ‘string’, ‘brand’: ‘string’, ‘packageType’: ‘string’, ‘innerUnitCount’: 0, ‘model’: ‘string’, ‘publicationDate’: ‘string’, ‘inn’: ‘string’, ‘exporter’: { ‘id’: 0, ‘ncId’: 0, ‘exporterName’: ‘string’,

55

‘exporterTaxpayerId’: ‘string’, ‘kpp’: ‘string’, ‘gcp’: ‘string’, ‘gln’: ‘string’, ‘manufactureAddress’: ‘string’, ‘importerAccount’: ‘string’ }, ‘permittedInns’: [ ‘string’ ], ‘productGroupId’: 0, ‘goodSignedFlag’: true, ‘goodMarkFlag’: true, ‘goodTurnFlag’: true, ‘isKit’: true, ‘isTechGtin’: true, ‘explain’: ‘string’, ‘foreignProducer’: { ‘name’: ‘string’, ‘inn’: ‘string’, ‘kpp’: ‘string’, ‘gcp’: ‘string’, ‘gln’: ‘string’, ‘address’: ‘string’ } } ], ‘total’: 0, ‘errorCode’: ‘string’ }




results: +

*id integer (int64)

- Unique identifier of a goods item in DB




*packageType string - Packing type. Catalogue - Types of packing

*innerUnitCount integer (int64)

- Number of goods instances

*model string - Model / Article of manufacturer

*publicationDate (date-time)

- Date of publication of the Goods code. Is returned in yyyy-MM-ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z format

*inn string - INN of Russian manufacturer

56









**kpp string - KPP or its equivalent

**gcp string - Company's global identifier




*permittedInns string - Array of INNs of subaccount companies that may use this goods code to order MC with the goods code owner permission

*productGroupId integer - Goods group identifier, see Catalogue - List of supported product groups














**address [string] - Manufacturer's address array


errorCode string - Error code in case of an error

57

2.1.8. Catalog on CMG with additional parameters from TT GIS and FCS

Method searches for goods, considering user scope. Returns product details with additional parameters from TT GIS and FCS.

URL: /product/search

Method: GET

Request example: curl -X GET '<v4 stand url>/product/search? limit=10&offset=0&page=0&pg=shoes' -H 'Authorisation: Bearer <TOKEN>'

Request parameters:





offset integer - Offset position in the set of results to start numeration of pages

page integer - Number of response page, initial value - 0

direction string - Sorting: ASC - sets ascending sorting order; DECS - descending sorting order

sort string - Sorting by field


productTypeDesc string - Text description of footwear type

inn string - INN of manufacturer

country string - Country of production

model string - Model / Article of manufacturer

materialUpper string – Top material

materialLining string – Lining material

materialDown string – Material of bottom

colour string – Item colour

productSize string – Stich size

58

Response example: { ’results’: [ { ‘id’: 13716320, ‘name’: ‘Boots fem. nat.leather/fiber coffee (39, 1C2-14-905B)’, ‘gtin’: ‘00000000000000’, ‘brand’: ‘BONAVI’, ‘packageType’: ‘BOX’, ‘innerUnitCount’: 1, ‘model’: ‘1C2-14-905B’, ‘publicationDate’: ‘string’, ‘inn’: ‘000000000’, ‘productGroupId’: 2, ’goodSignedFlag’: true, ’goodMarkFlag’: true, ’goodTurnFlag’: true, ’isKit’: false, ’isTechGtin’: false, ‘sizes’: [ ‘39’ ], ‘colours’: [ ‘coffee’ ], ‘fts’: { ‘rds’: [ { ‘authDocDate’: ‘2020-04-30’, ‘authDocNumber’: ‘123899’ }, { ‘authDocDate’: ‘2020-03-30’, ‘authDocNumber’: ‘123899’ } ], ‘countries’: [ ‘FI’ ], ‘tnVedCode10’: [ ‘6401921000’ ] }, ‘tnVedCode’: ‘6403’ } ], ‘total’: 1, ’errorCode’: null }


59



results: +

*id integer (int64)

- Unique identifier of a goods item in DB




*packageType string - Packing type. Catalogue - Types of packing

*innerUnitCount integer (int64)

- Number of goods instances

*model string - Model / Article of manufacturer

*publicationDate (date-time)

- Date of publication of the Goods code. Is returned in yyyy-MM-ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z format

*inn string - INN of Russian manufacturer








**kpp string - KPP or its equivalent

**gcp string - Company's global identifier




*permittedInns string - Array of INNs of subaccount companies that may use this goods code to order MC with the goods code owner permission

*productGroupId integer - Goods group identifier, see Catalogue - List of supported product groups






60










**address [string] - Manufacturer's address array

*sizes [string] - An array of unique values in the stitch system - values obtained from GC and TT GIS

*colours [string] - An array of unique product colours - values obtained from GC and TT GIS

*fts array - Data obtained by GIS from FCS during introduction into circulation

**rds [string] - Array of AD data

***authDocDate string (date)

- Authorisation Document date. Is returned in yyyy-MM-dd format

***authDocNumber integer - Approval document number

**countries [string] - An array of countries of manufacture


errorCode string - Error code. If error occurs

2.1.9. Method of receiving the list of documents pre-loaded in TT GIS

URL: /facade/doc/listV2

Method: GET

Request example: curl '<stand url>/facade/doc/listV2? limit=10&order=DESC& orderColumn=receivedAt&did=623136d3-7a9b-40c9-8ce3-8091e41f83aa& orderedColumnValue=2019-01-28T09:30:40.136Z&pageDir=NEXT' -H 'content-type: application/json' -H 'Authorisation: Bearer <TOKEN>'

Request parameters:


dateFrom string (date- - Date of document, from Set in yyyy-MM-

61


time) ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z format. E.g., 2019-01-01T03:00:00.000Z

dateTo string (date-time)

- Date of document, to Set in yyyy-MM-ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z format. E.g., 2019-01-01T03:00:00.000Z

did string - Value of document number - a reference point (record where sampling starts) used to sort records. Only to be used together with orderedColumnValue parameter

documentFormat string - Document type: MANUAL – json format; UPD – Electronic Document Management; XML – XML format; CSV – CSV format

documentStatus enum - Document status. see Catalogue - Document statuses

documentType array[string] - see Catalogue - Types of documents

inputFormat boolean - incoming (true) / outgoing (false) document


number string - Document number

order enum - Sorting order: ASC – ascending; DESC – descending

orderColumn string - Name of column used to sort records. Acceptable value of receivedAt - emission date

orderedColumnValue string - Column value, a reference point (record where sampling starts) used to sort records. Only to be used together with did parameter

pageDir enum - Direction selection: PREV – Previous section; NEXT – Next section




Response example: { ‘results’: [ { ‘number’: ‘string’,

62

‘docDate’: 0, ‘receivedAt’: 0, ‘type’: ‘UNKNOWN’, ‘status’: ‘IN_PROGRESS’, ‘externalId’: ‘string’, ‘senderName’: ‘string’, ‘receiverName’: ‘string’, ‘invoiceNumber’: ‘string’, ‘invoiceDate’: 0, ‘total’: 0, ‘vat’: 0, ‘downloadStatus’: ‘string’, ‘downloadDesc’: ‘string’, ‘body’: { ‘additionalProp1’: {}, ‘additionalProp2’: {}, ‘additionalProp3’: {} }, ‘content’: ‘string’, ‘input’: true, ‘pdfFile’: ‘string’, ‘errors’: [ ‘string’ ], ‘docErrors’: [ { ‘additionalProp1’: {}, ‘additionalProp2’: {}, ‘additionalProp3’: {} } ], ‘atk’: ‘string’, ‘sender’: { ‘name’: ‘string’, ‘address’: ‘string’, ‘inn’: ‘string’, ‘kpp’: ‘string’ }, ‘receiver’: { ‘name’: ‘string’, ‘address’: ‘string’, ‘inn’: ‘string’, ‘kpp’: ‘string’ } } ], ‘total’: 0, ‘docErrors’: [ { ‘additionalProp1’: {}, ‘additionalProp2’: {}, ‘additionalProp3’: {} } ] }

63



results +

*number string - Document number

*docDate string (date-time)

+ Document date. Is returned in yyyy-MM-ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z format

*receivedAt string (date-time)

- Date and time of document receipt

Is returned in yyyy-MM-ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z format. Example 2019-01-01T03:00:00.000Z

*type string + Document type See Catalogue - Types of documents

*status string + Document processing status

See Catalogue - Document statuses

*externalId string - Document Id in the external EDM system

*senderName string + Name of document sender

*receiverName string - Name of document receiver

*invoiceNumber string - Number of invoice, Universal Correcting Document

*invoiceDate string (date-time)

- Date of invoice, Universal Correcting Document

Is returned in yyyy-MM-ddTHH:mm:ss.SSS’Z format.

*total Number - Total document amount

*vat Number - VAT amount of the document

*downloadStatus string - Document loading status


*downloadDesc string - Description of document loading

In case of error during document loading

*body Object + Document content Body of the sent document in JSON format. See Document methods cl.2.2

*content string + Document content Original content of document

*input Boolean + Attribute of incoming/outgoing document

Possible values are: true - input; false - output

*docErrors [string] - List of errors of document processing. Is returned in case of an error

64


*pdfFile string - Link to PDF file

*errors [string] - Errors. The parameter returns in case of error.

*atk string - aggregated customs code

*sender string - Sender

**name string - Name

**address string - Address

**inn string - INN

**kpp string - KPP Tax registration reason code

*receiver string - Sender

**name string - Name

**address string - Address

**inn string - INN

**kpp string - KPP Tax registration reason code



2.1.10. Method for searching a receipt by identifier

URL: /facade/receipt/{receiptId}

Method: GET

Request example: curl -X GET ‘<stand url>/facade/receipt/{receiptId}’ -H ‘accept: */*’ -H ’Authorisation: Bearer <TOKEN>‘

Request parameters:


receiptId string + Receipt identifier


65

Response example: { ‘number’: ‘string’, ‘docDate’: 0, ‘receivedAt’: 0, ‘type’: ‘UNKNOWN’, ‘status’: ‘IN_PROGRESS’, ‘externalId’: ‘string’, ‘senderName’: ‘string’, ‘receiverName’: ‘string’, ‘invoiceNumber’: ‘string’, ‘invoiceDate’: 0, ‘total’: 0, ‘vat’: 0, ‘downloadStatus’: ‘string’, ‘downloadDesc’: ‘string’, ‘body’: { ‘additionalProp1’: {}, ‘additionalProp2’: {}, ‘additionalProp3’: {} }, ‘content’: ‘string’, ‘input’: true, ‘pdfFile’: ‘string’, ‘errors’: [ ‘string’ ], ‘docErrors’: [ { ‘additionalProp1’: {}, ‘additionalProp2’: {}, ‘additionalProp3’: {} } ], ‘atk’: ‘string’, ‘sender’: { ‘name’: ‘string’, ‘address’: ‘string’, ‘inn’: ‘string’, ‘kpp’: ‘string’ }, ‘receiver’: { ‘name’: ‘string’, ‘address’: ‘string’, ‘inn’: ‘string’, ‘kpp’: ‘string’ }, ‘contractId’: ‘string’, ‘eliminationReason’: ‘KM_SPOILED’ }

66




docDate string (date-time)


receivedAt string (date-time)



type string + Document type See Catalogue - Types of documents

status string + Document processing status


externalId string - Document Id in the external EDM system

senderName string + Name of document sender

receiverName string - Name of document receiver

invoiceNumber string - Number of invoice, Universal Correcting Document

invoiceDate string (date-time)



total Number - Total document amount in kopecks

vat Number - Total document VAT amount in kopecks

downloadStatus string - Document loading status


downloadDesc string - Description of document loading


body Object - Document content Body of the sent document in JSON format. See Document methods cl.2.2

content string - Document content Original content of document

input boolean - Attribute of incoming/outgoing document


67


pdfFile string - Link to PDF file

errors [string] - Errors. The parameter returns in case of error.


sender string - Sender

*name string - Name

*address string - Address

*inn string - INN

*kpp string - KPP tax registration reason code

receiver string - Receiver

*name string - Name


*inn string - INN


contractId string - Government contract identifier

eliminationReason string - Withdrawal reason Possible values: KM_SPOILED – spoiled; KM_SPOILED_OR_LOST - IM with MC spoiled or lost; KM_LOST – lost; KM_DESTROYED – destroyed; DESCRIPTION_ERRORS - errors in goods description found; RETAIL – Retail sale; EEC_EXPORT – Export to EEU countries; BEYOND_EEC_EXPORT – export outside the EEU countries; RETURN – return to individual; REMOTE_SALE – sale by sample, remote sale; DAMAGE_LOSS – loss or damage; DESTRUCTION – destruction; CONFISCATION – confiscation; LIQUIDATION – liquidation of business; INSTALMENT - installment contract; DONATION – non-compensatory transfer;

68


STATE_ENTERPRISE – acquisition by state enterprise; NO_RETAIL_USE – use for purposes of buyer; ENTERPRISE_USE – use for purposes of enterprise; KM_CANCELLATION - cancellation of MCs not converted in IM due to expiration of time period; KM_CANCELLATION_BY_TERM - cancellation of unconverted MC (labeling) due to expiration of established shelf life; RETAIL_RETURN - Return of goods with damaged/missing IM at retail; REMOTE_SALE_RETURN - Return of goods with damaged/missing IM at remote sales

2.1.11. Method for searching a receipt body by identifier

URL: /facade/receipt/{receiptId}/body

Method: GET

Request example: curl -X GET ‘<stand url>/facade/receipt/{receiptId}/body?limit=10&pg=lp -H ‘accept: */*’ -H ‘Authorisation: Bearer <TOKEN>'

Request parameters:


receiptId string + Receipt identifier

filter array + Request filter (can be passed empty)


*pageDir enum - Direction selection: PREV – Previous section; NEXT – Next section

*orderedColumnValue string - Column value, a reference point (record where sampling starts) used to sort records

*pg string - Goods group: the parameter must be specified for the following goods groups: milk – ‘Dairy products’; water – ‘Bottled water’

69


Response example: { ‘number’: ‘string’, ‘docDate’: 0, ‘receivedAt’: 0, ‘type’: ‘UNKNOWN’, ‘status’: ‘IN_PROGRESS’, ‘externalId’: ‘string’, ‘senderName’: ‘string’, ‘receiverName’: ‘string’, ‘invoiceNumber’: ‘string’, ‘invoiceDate’: 0, ‘total’: 0, ‘vat’: 0, ‘downloadStatus’: ‘string’, ‘downloadDesc’: ‘string’, ‘body’: { ‘additionalProp1’: {}, ‘additionalProp2’: {}, ‘additionalProp3’: {} }, ‘content’: ‘string’, ‘input’: true, ‘pdfFile’: ‘string’, ‘errors’: [ ‘string’ ], ‘docErrors’: [ { ‘additionalProp1’: {}, ‘additionalProp2’: {}, ‘additionalProp3’: {} } ], ‘atk’: ‘string’, ‘sender’: { ‘name’: ‘string’, ‘address’: ‘string’, ‘inn’: ‘string’, ‘kpp’: ‘string’ }, ‘receiver’: { ‘name’: ‘string’, ‘address’: ‘string’, ‘inn’: ‘string’, ‘kpp’: ‘string’ }, ‘contractId’: ‘string’, ‘eliminationReason’: ‘KM_SPOILED’ }

70



















total Number - Total document amount in kopecks

vat Number - Total document VAT amount in kopecks





body Object + Document content Body of the document sent by FDO in JSON format

content string + Document content Original content of document

input Boolean + Attribute of incoming/outgoing document




71




*name string - Name


*inn string - INN



*name string - Name


*inn string - INN



eliminationReason string - Withdrawal reason Possible values: KM_SPOILED – spoiled; KM_SPOILED_OR_LOST - IM with MC spoiled or lost; KM_LOST – lost; KM_DESTROYED – destroyed; DESCRIPTION_ERRORS - errors in goods description found; RETAIL – Retail sale; EEC_EXPORT – Export to EEU countries; BEYOND_EEC_EXPORT – export outside the EEU countries; RETURN – return to individual; REMOTE_SALE – sale by sample, remote sale; DAMAGE_LOSS – loss or damage; DESTRUCTION – destruction; CONFISCATION – confiscation; LIQUIDATION – liquidation of business; INSTALMENT - installment contract; DONATION – non-compensatory transfer; STATE_ENTERPRISE – acquisition by state enterprise; NO_RETAIL_USE – use for purposes of buyer; ENTERPRISE_USE – use for purposes of enterprise; KM_CANCELLATION - cancellation of MCs not converted in IM due to expiration of

72


time period; KM_CANCELLATION_BY_TERM - cancellation of unconverted MC (labeling) due to expiration of established shelf life; RETAIL_RETURN - Return of goods with damaged/missing IM at retail; REMOTE_SALE_RETURN - Return of goods with damaged/missing IM at remote sales

2.1.12. Method of receiving the list of receipts pre-loaded in TT GIS

URL: /facade/receipt/listV2

Method: GET

Request example: curl -X GET ‘<stand url>/facade/receipt/listV2?number=string&dateFrom=2020-04-04T07%3A43%3A27.237Z&dateTo=2020-04-04T07%3A43%3A27.237Z&participantInn=string&\ documentType=UNKNOWN&documentStatus=IN_PROGRESS&documentFormat=MANUAL& inputFormat=true&pageDir=PREV&did=string&orderColumn=string& order=ASC&orderedColumnValue=string&limit=0&pg=string’ -H ‘accept: */*’ -H ’Authorisation: Bearer <TOKEN>'

Request parameters:



dateFrom string (date-time)

- Date of document, from Set in yyyy-MM-ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z format. E.g., 2019-01-01T03:00:00.000Z

dateTo string (date-time)

- Date of document, to Set in yyyy-MM-ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z format. E.g., 2019-01-01T03:00:00.000Z


documentType array[string] - Document type: RECEIPT - a check; RECEIPT_RETURN - a return check

documentStatus enum - Document status. see Catalogue - Document statuses

documentFormat string - Document type: MANUAL – json format; UPD – Electronic Document Management; XML – XML format; CSV – CSV format

73


inputFormat boolean - incoming (true) / outgoing (false) document

did string - Value of document number - a reference point (record where sampling starts) used to sort records. Only to be used together with orderedColumnValue parameter



order enum - Sorting order: ASC – ascending; DESC – descending

orderColumn string - Name of column used to sort records. Acceptable value of receivedAt - emission date

orderedColumnValue string - Column value, a reference point (record where sampling starts) used to sort records. Only to be used together with did parameter



Response example: { ‘results’: [ { ‘number’: ‘string’, ‘docDate’: 0, ‘receivedAt’: 0, ‘type’: ‘UNKNOWN’, ‘status’: ‘IN_PROGRESS’, ‘externalId’: ‘string’, ‘senderName’: ‘string’, ‘receiverName’: ‘string’, ‘invoiceNumber’: ‘string’, ‘invoiceDate’: 0, ‘total’: 0, ‘vat’: 0, ‘downloadStatus’: ‘string’, ‘downloadDesc’: ‘string’, ‘body’: { ‘additionalProp1’: {}, ‘additionalProp2’: {}, ‘additionalProp3’: {} },

74

‘content’: ‘string’, ‘input’: true, ‘pdfFile’: ‘string’, ‘errors’: [ ‘string’ ], ‘docErrors’: [ { ‘additionalProp1’: {}, ‘additionalProp2’: {}, ‘additionalProp3’: {} } ], ‘atk’: ‘string’, ‘sender’: { ‘name’: ‘string’, ‘address’: ‘string’, ‘inn’: ‘string’, ‘kpp’: ‘string’ }, ‘receiver’: { ‘name’: ‘string’, ‘address’: ‘string’, ‘inn’: ‘string’, ‘kpp’: ‘string’ } } ], ‘total’: 0, ‘docErrors’: [ { ‘additionalProp1’: {}, ‘additionalProp2’: {}, ‘additionalProp3’: {} } ] }



results +



+ Document date. Is returned in yyyy-MM-ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z format.




type string + Document type Document type: RECEIPT - a check; RECEIPT_RETURN - a return check

75











total Number - Total document amount

vat Number - VAT amount of the document





body Object + Document content Body of the sent document in JSON format. See Document methods cl.2.2







atk string - Aggregated Customs Code


*name string - Name


76


*inn string - INN



*name string - Name


*inn string - INN




2.1.13. Method of receiving the content of document pre-loaded in TT GIS

URL: /facade/doc/{docId}/body

Method: GET

Request example: curl -X GET '<stand url>/facade/doc/e76a1c45-c8ce-4961-84f1-1df47e5a7d35/body' -H 'content-type: application/json' -H 'Authorisation: Bearer <TOKEN>'

Request parameters:



docId string + Possible values: Unique document identifier in TT GIS; it is specified for document GIS; Identifier of a legally binding document


orderedColumnValue string - Column value, a reference point (record where sampling starts) used to sort records


77

Note – When display of more than 10000 MCs is required, the request shall be repeated. Example of more than one requests:

First request:

api/v3/facade/doc/e76a1c45-c8ce-4961-84f1-1df47e5a7d35/body ?pg=shoes&order=ASC&orderColumn=emd&pageDir=NEXT&limit={Limit}&cache=false;

Second and subsequent requests:

api/v3/facade/doc/e76a1c45-c8ce-4961-84f1-1df47e5a7d35/body ?pg=shoes&order=ASC&orderColumn=emd&pageDir=NEXT&limit={Limit}&orderedColumnValue={Previous emission date}&uit={Previous marking code}.


Пример ответа:

{ ‘number’: ‘string’, ‘docDate’: 0, ‘receivedAt’: 0, ‘type’: ‘UNKNOWN’, ‘status’: ‘string’, ‘externalId’: ‘string’, ‘senderInn’: ‘string’, ‘senderName’: ‘string’, ‘receiverInn’: ‘string’, ‘receiverName’: ‘string’, ‘invoiceNumber’: ‘string’, ‘invoiceDate’: 0, ‘total’: 0, ‘vat’: 0, ‘downloadStatus’: ‘string’, ‘downloadDesc’: ‘string’, ‘body’: { ‘additionalProp1’: {}, ‘additionalProp2’: {}, ‘additionalProp3’: {} }, ‘content’: ‘string’, ‘input’: true, ‘pdfFile’: ‘string’, ‘errors’: [ ‘string’ ], ‘docErrors’: [ { ‘additionalProp1’: {}, ‘additionalProp2’: {}, ‘additionalProp3’: {} } ], ‘errorMessage’: ‘string’, ‘errorMessages’: [

78

‘string’ ], ‘atk’: ‘string’, ‘sender’: { ‘name’: ‘string’, ‘address’: ‘string’, ‘inn’: ‘string’, ‘kpp’: ‘string’ }, ‘receiver’: { ‘name’: ‘string’, ‘address’: ‘string’, ‘inn’: ‘string’, ‘kpp’: ‘string’ }, ‘contractId’: ‘string’, ‘eliminationReason’: ‘KM_SPOILED’, ‘cisTotal’: 0 }



number string + Document number


+ Date and time of document













- Date of invoice, Universal Correcting


79


Document

total Number - Total document amount

vat Number - VAT amount of the document





body Object + Document content Body of the sent document in JSON format. See Document methods cl.2.2







errorMessage string - Error message during processing of JSON, XML

The parameter returns in case of error. Only displayed for UD documents. General description of a document-related error.

errorMessages List <string>

- List of error messages during processing of the document itself

The parameter returns in case of errors.


*name string - Name


*inn string - INN

*kpp string - KPP Tax registration reason code


*name string - Name


*inn string - INN

80


*kpp string - KPP Tax registration reason code

atk string - Aggregated Customs Code


eliminationReason string - overnmentWithdrawal reason

Possible values: KM_SPOILED – spoiled; KM_SPOILED_OR_LOST - IM with MC spoiled or lost; KM_LOST – lost; KM_DESTROYED – destroyed; DESCRIPTION_ERRORS - errors in goods description found; RETAIL – Retail sale; EEC_EXPORT – Export to EEU countries; BEYOND_EEC_EXPORT – export outside the EEU countries; RETURN – return to individual; REMOTE_SALE – sale by sample, remote sale; DAMAGE_LOSS – loss or damage; DESTRUCTION – destruction; CONFISCATION – confiscation; LIQUIDATION – liquidation of business; INSTALMENT - installment contract; DONATION – non-compensatory transfer; STATE_ENTERPRISE – acquisition by state enterprise; NO_RETAIL_USE – use for purposes of buyer; ENTERPRISE_USE – use for purposes of enterprise; KM_CANCELLATION - cancellation of MCs not converted in IM due to expiration of time period; KM_CANCELLATION_BY_TERM - cancellation of unconverted MC (labeling) due to expiration of established shelf life; RETAIL_RETURN - Return of goods with damaged/missing IM at retail; REMOTE_SALE_RETURN - Return of goods with damaged/missing IM at remote sales

cisTotal integer + Number of IC in reply

2.1.14. Method of receiving the list of goods using document number

URL: /facade/doc/{docId}/products

81

Method: GET

Request example: curl -X GET '<stand url>/facade/doc/2BM-7731369928-773101001/products' -H 'content-type: application/json' -H 'Authorisation: Bearer <TOKEN>'

Request parameters:


docId string + Possible values: Unique document identifier in TT GIS; it is specified for document GIS; Identifier of a legally binding document

column string -

columnValue string -

orderColumn string - Name of column used to sort records.

orderDir string - Sorting order: ASC – ascending; DESC – descending

cis string - Identification code

name string - Goods name

page integer - Number of pages


cost_from integer - Cost from

cost_to integer - Cost to

cost_with_tax_from integer - Cost with tax from

cost_with_tax_to integer - Cost with tax to

tax_from integer - Tax from

tax_to integer - Tax to


Response example: { ‘results’: [ { ‘name’: ‘string’, ‘measure‘: ‘string’, ‘measure_before’: ‘string’, ‘measure_after’: ‘string’, ‘cost’: 0, ‘cost_before’: 0, ‘cost_after’: 0,

82

‘cost_with_tax’: 0, ‘tax‘: ‘string’, ‘tax_before’: ‘string’, ‘tax_after’: ‘string’, ‘tax_sum’: 0, ‘tax_sum_before’: 0, ‘tax_sum_after’: 0, ‘product_cost_without_tax’: 0, ’excise’: 0, ’no’: 0, ‘children’: [ { ‘cis’: ‘string’, ‘gtin’: ‘string’, ‘name’: ‘string’ } ], ‘products_number’: 0, ‘products_number_before’: 0, ‘products_number_after’: 0, ‘add_info’: ‘string’ } ], ‘total’: 0, ’docErrors’: [ { ‘additionalProp1’: {}, ‘additionalProp2’: {}, ‘additionalProp3’: {} } ] }



results array - Result of reply


*measure string - Measurement unit

*measure_before string - Measurement unit before

*measure_after string - Measurement unit after

*cost number - Cost

*cost_before number - Cost to

*cost_after number - Cost after

*cost_with_tax number - Cost with tax

*tax string - Tax

*tax_before string - Tax to

*tax_after string - Tax after

83


*tax_sum number - Tax amount

*tax_sum_before number - Tax amount before

*tax_sum_after number - Tax amount after

*product_cost_without_tax number - Product cost without tax

*excise number - Excise tax

*no integer -

*children array - Nested MC

**cis string - Identification code


**name string - Goods item name

*products_number number - Product number

*products_number_before number - Product number before

*products_number_after number - Product number after

*add_info string - Additional information

total integer + Number of returned responses

docErrors [string] + List of errors of document processing. Only if failed

2.1.15. Method of receiving the list of 10-digit FEACN codes

As a result of successful request execution for receiving the list of FEACN codes with indication of the FEACN prefix array and pagination parameters, the response returns the information array on the FEACN codes that meet the request and the total number of elements of this array.

URL: /facade/tnved/search

Method: GET

Request example: curl -X GET '<stand url>/facade/tnved/search?validRequest=true&page=0&limit=0&sort=CODE&direction=ASC&prefix=string&pg=string&code=string -H 'Authorisation: Bearer <TOKEN>'

Request parameters:


code string - FEACN code (10 symbols)

limit integer - Value determines the number of records in response, but not more than 10000 records

84


page integer (int32)

- Number of response page, initial value - 0


prefix string - List of goods items one of which shall be the start of desired FEACN codes. It is used to filter the product group. For example, '6401,6402,6403,6404,6405'.

sort string - Sorting by: CODE – code; NAME – description

direction string - Sorting order: ASC – ascending; DESC – descending

Response example: { ‘records’: [ { ‘code’: ‘string’ , ‘description’: ‘string’ } ] , ‘total’: 0 }



records + Description of FEACN code

*code string + 10-digit FEACN code

*description string + Text description of FEACN code

total integer (int64) + Total number of FEACN codes meeting the filtering parameters

2.1.16. Method of generating consent to provision of information on marking codes for non-owners

The method generates only a draft document which shall be signed with EQES of the General Director in the User Account. The system may have only one valid consent document.

URL: /agreement-registry/agreement

Method: POST

85

Request example: curl -X POST ‘<stand url>/agreement-registry/agreement’ -H ‘accept: */*’ -H ’Authorisation: Bearer<TOKEN> ‘Content-Type: application/json’ -d ’{ ‘trustedInns’: [ ‘string’ ] }’

Request parameters:


trustedInns [string] + Trust list of INNs (of counterparties)

Response example:

1 If successful - code 201:

Document is generated successfully.

2 If failed - code 400

[ { ‘message’: ‘For the published consent revision, there is a cancellation document in \’under preparation\ status’’ , ‘object’: [ ] } , { ‘message’: ‘INNs not registered in the system’ , ‘object’: [ ‘string’ ] } ]

2.1.17. Method of document cancellation based on the current published consent document

The method cancels the latest successfully generated consent document.

URL: /agreement-registry/cancellation

Method: POST

Request example: curl -X POST ‘<stand url>/agreement-registry/cancellation’ -H ‘accept: */*’-H ’Authorisation: Bearer<TOKEN>

86

Response example:

1 If successful - code 201:

Document is generated successfully.

2 If failed - code 400

[ { ’message’: ‘User already has a consent withdrawal document in 'Generated' status’, ‘object’: [] } ]

2.1.18. Method of receiving the information on MC according to the MC list with prior consent

The method provides for submission by a GCP of a request for the information on ownership and status of MCs owned by his/her counterparty; TT GIS verificates if a valid consent for granting access has been given by this counterparty to the requesting GCP. In reply, GCP receives the information or a denial to provide the information.

URL: /km-owner-api/cises

Method: POST

Request example:

curl -X POST ‘<stand url>/km-owner-api/cises’ -H ‘accept: */*’ -H ’Authorisation: Bearer<TOKEN> ‘Content-Type: application/json’ -d ’{ ‘ownerInn’: ‘string’, ‘ownerName’: ‘string’, ‘cises’: [ ‘string’ ] }’

Request parameters:


ownerInn string + INN of presumed MC owner

ownerName string - Name of GCP owner

cises [string] + List of MCs for which the information is requested

87

Response example:

1 IF successful 200:

{ ’responses’: [ { ‘cis’: ‘string’ , ‘owner’: true , ’gtin’: ‘string’ , ‘productGroup’: ‘string’ , ‘producerInn’: ‘string’ , ‘status’: ‘string’ , ‘parent’: ‘string’ , ‘childs’: [ null ] } ] , ’errors’: [ { ‘cises’: [ ‘string’ ] } ] }

2 If error 403

{ ‘message’: ‘A signed consent document for INN is not found, or your organisation is not in the list of trusted counterparties’ }



responses [array] + Information on MC


*owner boolean + Attribute of MC ownership

If owner = false, then only cis is returned

*gtin string - Goods code It is unavailable for SPIC

*productGroup string - Goods Group see Catalogue - List of supported product groups

*producerInn string - INN of goods manufacturer

*status string - Current IC status Type of goods/IC status: EMITTED – emitted. Released; APPLIED – emitted. Received; INTRODUCED – in circulation;

88


WRITTEN_OFF – MC written off; RETIRED – dropped out; DISAGGREGATION – disaggregated (for packings only)

*parent string - IC of parent aggregate If data returned, attention should be given to the IC aggregation

*childs [array] - Child ICs

**cis string - Goods IC

**gtin string - Goods code It is unavailable for SPIC

**productGroup string - Goods Group Product code. Catalogue - List of supported product groups

**producerInn string - INN of goods manufacturer

It is unavailable for SPIC

**childs [array] - Child ICs

errors [array] - List of codes processed with errors

It is returned in response only in case of error

*cises [string] - IC

2.1.19. Method of receiving the information on marked goods

URL: /facade/marked_products/info

Method: GET

Request example: curl -X GET ‘<stand url>/facade/marked_products/info?cis=‘ -H ‘accept: */*’ -H ’Authorisation: Bearer<TOKEN>

Request parameters:


cis string + MC

Response example: { ‘cis’: ‘string’, ‘gtin’: ‘string’, ‘sgtin’: ‘string’, ‘tnvd’: ‘string’, ‘tnvedGroup’: ‘string’, ‘productName’: ‘string’, ‘producerName’: ‘string’,

89

‘producerInn’: ‘string’, ‘ownerName’: ‘string’, ‘ownerInn’: ‘string’, ‘agentName’: ‘string’, ‘agentInn’: ‘string’, ‘previousAgentName’: ‘string’, ‘previousAgentInn’: ‘string’, ‘turnoverType’: ‘SELLING’, ‘statusEx’: ‘EMPTY’, ‘docNum’: ‘string’, ‘emissionDate’: ‘2020-05-06T12:46:30.098Z’, ‘producedDate’: ‘2020-05-06T12:46:30.098Z’, ‘introducedDate’: ‘2020-05-06T12:46:30.098Z’, ‘emissionType’: ‘string’, ‘prodOrderType’: ‘SELF_MADE’, ‘lastDocId’: ‘string’, ‘name’: ‘string’, ‘brand’: ‘string’, ‘model’: ‘string’, ‘certDoc’: { ‘type’: ‘string’, ‘number’: ‘string’, ‘date’: ‘string’ }, ‘prevCises’: [ ‘string’ ], ‘nextCises’: [ ‘string’ ], ‘status’: ‘EMITTED’, ‘remarks’: [ { ‘curr’: ‘string’, ‘prev’: ‘string’, ‘date’: ‘string’ } ], ‘children’: [], ‘childrenDetails’: [ null ], ‘countChildren’: 0, ‘uitu’: ‘string’, ‘parent’: ‘string’, ‘packType’: ‘UNIT’, ‘withdrawReason’: ‘string’, ‘receiptDate’: ‘2020-05-06T12:46:30.098Z’, ‘expireDate’: ‘2020-05-06T12:46:30.098Z’, ‘prVetDocument’: ‘string’, ‘exporterName’: ‘string’, ‘exporterTaxpayerId’: ‘string’, ‘certificateType’: ‘CONFORMITY_CERTIFICATE’, ‘certificateNumber’: ‘string’, ‘certificateDate’: ‘string’,

90

‘productGroup’: ‘string’ }






tnvd string - Goods nomenclature code (10 digits)

tnvedGroup string - EEU FEACN code of goods item (initial 4 symbols)



producerInn string - INN of goods manufacturer / importer









docNum string - Document registration number







91


emissionType string - Emission type: LOCAL – manufactured in RF; FOREIGN – imported into RF; REMAINS – remains marking; CROSSBORDER – imported from EEU countries

prodOrderType enum - Type of production order: SELF_MADE - home manufacturing; OPERATOR - contract manufacturing




model string - Goods manufacturer

certDoc - Certificate

*date string - Date of certificate. Is returned in yyyy-MM-ddTHH:mm:ss.SSS’Z format

*number string - Number of certificate

*type string - Type of certificate

prevCises [string] - Previous IСs. In case of goods remarking



remarks - List of the goods remarking processes

*curr string - Current goods IC

*date string - Date of remarking. Is returned in yyyy-MM-ddTHH:mm:ss.SSS’Z format

*prev string - Previous goods ICs






*status enum + Type of goods/IC status: EMITTED – emitted. Released; APPLIED – emitted. Received; INTRODUCED – in circulation;

92


WRITTEN_OFF – MC written off; RETIRED – dropped out; DISAGGREGATION – disaggregated (for packings only)





*packageType string + Packing type. Catalogue - Types of packing








*children: [string] - All ICs in aggregate. Looks like a JSON array











*exporterTaxpayerId string - Unique identifier of the exporter in the national taxpayer

93


accounting system

*agentName string - INN of the current goods owner

*agentInn string - Name of the current goods owner





childrenDetails [array] - Marked goods



uitu string - SPIC of the upper level

parent string - Identification code of the packing where the goods are aggregated

packType string + Packing type. Catalogue - Types of packing

withdrawReason string - Reason for withdrawal: KM_SPOILED – spoiled; LOST - IMKM_LOST – lost; KM_DESTROYED – destroyed; DESCRIPTION_ERRORS - errors in goods description found; RETAIL – retail sale; EEC_EXPORT – export to EEU countries; BEYOND_EEC_EXPORT – export outside EEU countries; RETURN – return to individual; REMOTE_SALE – sale by sample, remote sale; DAMAGE_LOSS – loss or damage; DESTRUCTION – destruction; CONFISCATION – confiscation; LIQUIDATION – liquidation of business; DONATION – gratuitous transfer; STATE_ENTERPRISE – acquisition by a state enterprise; NO_RETAIL_USE – use for purposes of buyer; ENTERPRISE_USE – use for purposes of enterprise; KM_SPOILED_OR_LOST - IM with MC spoiled or lost; KM_CANCELLATION - cancellation of MCs not converted in IM due to expiration of time period; KM_CANCELLATION_BY_TERM - cancellation of unconverted MC (labeling) due to expiration of established shelf life; RETAIL_RETURN - Return of goods with damaged/missing IM at retail; REMOTE_SALE_RETURN - Return of goods with damaged/missing IM at remote sales

receiptDate string - Date of withdrawal from circulation. Is returned in yyyy-MM-

94


(date-time)

ddTHH:mm:ss.SSS’Z format






certificateType string - Type of the document that confirms the conformity: Possible values: CONFORMITY_CERTIFICATE – conformity certificate); CONFORMITY_DECLARATION – conformity declaration); CONFORMITY_CERTIFICATE_OR_DECLARATION - conformity certificate or declaration)

certificateNumber string - Number of document confirming compliance

certificateDate string - Date of document confirming compliance. Is returned in yyyy-MM-ddTHH:mm:ss.SSS’Z format


colour string - Colour. Mandatory for PG ‘Footwear’

productSize string - Size. Mandatory for PG ‘Footwear’

2.1.20. Method of receiving the information on marked goods by MC beginning

URL: /facade/marked_products/start_with

Method: POST

Request example: curl -X POST ‘<stand url>/facade/marked_products/start_with -H ‘accept: */*’ -H ‘Authorisation: Bearer<TOKEN> ‘Content-Type: application/json’ -d ‘{ ‘uit’: ‘string’ }’

Request parameters:


uit string + IC

95

Response example: { ‘cis’: ‘string’ , ‘gtin’: ‘string’ , ‘sgtin’: ‘string’ , ‘tnvd’: ‘string’ , ‘tnvedGroup’: ‘string’ , ‘productName’: ‘string’ , ‘producerName’: ‘string’ , ‘producerInn’: ‘string’ , ‘ownerName’: ‘string’ , ‘ownerInn’: ‘string’ , ‘agentName’: ‘string’ , ‘agentInn’: ‘string’ , ‘previousAgentName’: ‘string’ , ‘previousAgentInn’: ‘string’ , ‘turnoverType’: ‘SELLING’ , ‘statusEx’: ‘EMPTY’ , ‘docNum’: ‘string’ , ‘emissionDate’: ‘2020-05-06T12:46:30.098Z’ , ‘producedDate’: ‘2020-05-06T12:46:30.098Z’ , ‘introducedDate’: ‘2020-05-06T12:46:30.098Z’ , ‘emissionType’: ‘string’ , ‘prodOrderType’: ‘SELF_MADE’ , ‘lastDocId’: ‘string’ , ‘name’: ‘string’ , ‘brand’: ‘string’ , ‘model’: ‘string’ , ‘certDoc’: { ‘type’: ‘string’ , ‘number’: ‘string’ , ‘date’: ‘string’ } , ‘prevCises’: [ ‘string’ ] , ‘nextCises’: [ ‘string’ ] , ‘status’: ‘EMITTED’ , ‘remarks’: [ { ‘curr’: ‘string’ , ‘prev’: ‘string’ , ‘date’: ‘string’ } ] , ‘children’: [ { ‘cis’: ‘string’ , ‘gtin’: ‘string’ , ‘producerName’: ‘string’ , ‘status’: ‘EMITTED’ , ‘emissionDate’: ‘2020-05-06T12:46:30.098Z’ , ‘producedDate’: ‘2020-05-06T12:46:30.098Z’ , ‘packageType’: ‘UNIT’ ,

96

‘ownerName’: ‘string’ , ‘ownerInn’: ‘string’ , ‘productName’: ‘string’ , ‘brand’: ‘string’ , ‘prevCises’: [ ‘string’ ] , ‘nextCises’: [ ‘string’ ] , ‘statusEx’: ‘EMPTY’ , ‘children’: [ ‘string’ ] , ‘childrenMap’: {} , ‘countChildren’: 0 , ‘parent’: ‘string’ , ‘lastDocId’: ‘string’ , ‘expireDate’: ‘2020-05-06T12:46:30.098Z’ , ‘prVetDocument’: ‘string’ , ‘introducedDate’: ‘2020-05-06T12:46:30.098Z’ , ‘exporterName’: ‘string’ , ‘exporterTaxpayerId’: ‘string’ , ‘agentName’: ‘string’ , ‘agentInn’: ‘string’ , ‘lastStatusChangeDate’: ‘2020-05-06T12:46:30.098Z’ , ‘turnoverType’: ‘SELLING’ , ‘productGroup’: ‘string’ } ] , ‘childrenDetails’: [ null ] , ‘countChildren’: 0 , ‘uitu’: ‘string’ , ‘parent’: ‘string’ , ‘packType’: ‘UNIT’ , ‘withdrawReason’: ‘string’ , ‘receiptDate’: ‘2020-05-06T12:46:30.098Z’ , ‘expireDate’: ‘2020-05-06T12:46:30.098Z’ , ‘prVetDocument’: ‘string’ , ‘exporterName’: ‘string’ , ‘exporterTaxpayerId’: ‘string’ , ‘certificateType’: ‘CONFORMITY_CERTIFICATE’ , ‘certificateNumber’: ‘string’ , ‘certificateDate’: ‘string’ , ‘productGroup’: ‘string’ }





97



tnvd string - Goods nomenclature code (10 digits)

tnvedGroup string - EEU FEACN code of goods item (initial 4 symbols)



producerInn string - INN of goods manufacturer / importer









docNum string - Document registration number








prodOrderType enum - Type of production order: SELF_MADE - home manufacturing;

98


OPERATOR - contract manufacturing




model string - Goods manufacturer

certDoc - Certificate

*date string - Date of certificate. Is returned in yyyy-MM-ddTHH:mm:ss.SSS’Z format

*number string - Number of certificate

*type string - Type of certificate

prevCises [string] - Previous IСs. In case of goods remarking



remarks - List of the goods remarking processes

*curr string - Current goods IC

*date string - Date of remarking. Is returned in yyyy-MM-ddTHH:mm:ss.SSS’Z format

*prev string - Previous goods ICs









99




*packageType string + Packing type. Catalogue - Types of packing








*children: [string] - All ICs in aggregate. Looks like a JSON array













*agentName string - INN of the current goods owner

*agentInn string - Name of the current goods owner

*lastStatusChangeDate string (date-


100


time)



childrenDetails [array] - Marked goods



uitu string - SPIC of the upper level

parent string - Identification code of the packing where the goods are aggregated

packType string + Packing type. Catalogue - Types of packing

withdrawReason string - Reason for withdrawal: KM_SPOILED – spoiled; LOST - IMKM_LOST – lost; KM_DESTROYED – destroyed; DESCRIPTION_ERRORS - errors in goods description found; RETAIL – retail sale; EEC_EXPORT – export to EEU countries; BEYOND_EEC_EXPORT – export outside EEU countries; RETURN – return to individual; REMOTE_SALE – sale by sample, remote sale; DAMAGE_LOSS – loss or damage; DESTRUCTION – destruction; CONFISCATION – confiscation; LIQUIDATION – liquidation of business; DONATION – gratuitous transfer; STATE_ENTERPRISE – acquisition by a state enterprise; NO_RETAIL_USE – use for purposes of buyer; ENTERPRISE_USE – use for purposes of enterprise; KM_SPOILED_OR_LOST - IM with MC spoiled or lost; KM_CANCELLATION - cancellation of MCs not converted in IM due to expiration of time period; KM_CANCELLATION_BY_TERM - cancellation of unconverted MC (labeling) due to expiration of established shelf life; RETAIL_RETURN - Return of goods with damaged/missing IM at retail; REMOTE_SALE_RETURN - Return of goods with damaged/missing IM at remote sales





101





certificateType string - Type of the document that confirms the conformity: Possible values: CONFORMITY_CERTIFICATE – conformity certificate); CONFORMITY_DECLARATION – conformity declaration); CONFORMITY_CERTIFICATE_OR_DECLARATION - conformity certificate or declaration)

certificateNumber string - Number of document confirming compliance

certificateDate string - Date of document confirming compliance. Is returned in yyyy-MM-ddTHH:mm:ss.SSS’Z format


colour string - Colour. Mandatory for PG ’Footwear’

productSize string - Size. Mandatory for PG ’Footwear’

2.1.21. Method of receiving the list of goods using document number

URL: /facade/doc/{docId}/products

Method: GET

Request example: curl -X POST ‘<stand url>/facade/doc/docId/products?limit=2 -H ’Authorisation: Bearer<TOKEN>

Request parameters:


docId string + Document number

filter object + Request filter

*docId string - Document number

*column string - Column

*columnValue string - Column value

*orderColumn string - Name of column used for sorting

*orderDir string - Sorting order Possible values: ASC – ascending; DESC –

102


descending

*cis string - Goods IC

*name string - Goods item name

*page integer - Page number

*limit integer - Value determines the number of records in response, but not more than 10000 records

*cost_from integer - Cost from

*cost_to integer - Cost to

*cost_with_tax_from integer - Cost with tax from

*cost_with_tax_to integer - Cost with tax before

*tax_from integer - Tax from

*tax_to integer - Tax to

Response Example { ‘results’: [ { ‘name’: ‘string’, ‘measure‘: ‘string’, ‘measure_before’: ‘string’, ‘measure_after’: ‘string’, ‘cost’: 0, ‘cost_before’: 0, ‘cost_after’: 0, ‘cost_with_tax’: 0, ‘tax‘: ‘string’, ‘tax_before’: ‘string’, ‘tax_after’: ‘string’, ‘tax_sum’: 0, ‘tax_sum_before’: 0, ‘tax_sum_after’: 0, ‘product_cost_without_tax’: 0, ’excise’: 0, ’no’: 0, ‘children’: [ { ‘cis’: ‘string’, ‘gtin’: ‘string’, ‘name’: ‘string’ } ], ‘products_number’: 0, ‘products_number_before’: 0, ‘products_number_after’: 0, ‘add_info’: ‘string’ }

103

], ‘total’: 0, ’docErrors’: [ { ‘additionalProp1’: {}, ‘additionalProp2’: {}, ‘additionalProp3’: {} } ] }

Response Parameters




*measure string - Measurement unit

*measure_before string - Measurement unit before

*measure_after string - Measurement unit after

*cost integer - Cost

*cost_before integer - Cost to

*cost_after integer - Cost after

*cost_with_tax integer - Cost with tax

*tax string - VAT

*tax_before string - VAT before

*tax_after string - VAT after

*tax_sum string - VAT amount

*tax_sum_before string - VAT amount before

*tax_sum_after string - VAT amount after

*product_cost_without_tax integer - Product cost excluding VAT

*excise number - Excise tax

*no integer -

*children array - Nested MC

**cis string - Identification code


**name string - Goods item name

*products_number number - Amount of product

*products_number_before integer - Amount of product before

*products_number_after integer - Amount of product after

*add_info string - Additional information

104



docErrors [string] + List of errors of document processing. Only if failed

2.1.22. Method of receiving the list of obtained MC with filter option

URL: /api/v3/facade/agent/received/list

Method: GET

Request example:

curl -X GET ‘<stand url> /api/v3/facade/agent/received/list?cis=string&cisMatchMode=EQ&producerInn=string&agent=string&prevAgent=string&emissionType=INVALID_VALUE&emissionDateFrom=0&emissionDateTo=0&gtin=string&sn=string&turnoverType=SELLING&cisAggregationState=PACKED&statusExt=WAIT_SHIPMENT&cisStatus=INTRODUCED&limit=0&page=0&pg=string’ -H ‘accept: */*’ -H ’Authorisation: Bearer <Token>

Request parameters:



cisMatchMode string - Filtering by MC mode: EQ - equal to; LIKE - contains; Start_with - starts with

producerInn string - INN of manufacturer

agent string - INN of the current goods owner

prevAgent string - INN of the previous goods owner


emissionDateFrom date-time

- Date of emission from Set in yyyy-MM-ddTHH:mm:ss.SSS’Z format Example 2019-01-01T03:00:00.000Z

emissionDateTo date-time

- Date of emission to Set in yyyy-MM-ddTHH:mm:ss.SSS’Z format Example 2019-01-01T03:00:00.000Z


sn string - Serial number


105


cisAggregationState enum - IC state: PACKED- in aggregate (aggregated); NOT_PACKED – not in aggregate (disaggregated); ANY – any state

statusExt enum - Extended IC status: WITHDRAW – withdrawal; WAIT_SHIPMENT – Awaiting acceptance; WAIT_TRANSFER_TO_OWNER – Awaiting transfer to owner (contract manufacturing); REMARK_RETIRED – Remarked; WAIT_REMARK – IC written off after application on goods (Goods awaiting remarking)

cisStatus string - Current IC status: APPLIED – emitted. Received; EMITTED – emitted. Released; INTRODUCED – In circulation; RETIRED – Dropped off; DISAGGREGATION - disaggregated

limit string - The value sets the number of records in a reply (maximum is 10000 records, default is 10)

page string - Number of response page, initial value - 0

pg string - Goods group: the parameter must be specified for the following goods groups: milk – Dairy products; water – Water

withdrawReason string - Reason for withdrawal: KM_SPOILED – spoiled; LOST - IM KM_LOST – lost; KM_DESTROYED – destroyed; DESCRIPTION_ERRORS - errors in goods description found; RETAIL – retail sale; EEC_EXPORT – export to EEU countries; BEYOND_EEC_EXPORT – export outside EEU countries; RETURN – return to individual; REMOTE_SALE – sale by sample, remote sale; DAMAGE_LOSS – loss or damage; DESTRUCTION – destruction; CONFISCATION – confiscation; LIQUIDATION – liquidation of business; DONATION – gratuitous transfer; STATE_ENTERPRISE – acquisition by a state enterprise; NO_RETAIL_USE – use for purposes of buyer; ENTERPRISE_USE – use for purposes of enterprise; KM_SPOILED_OR_LOST - IM with MC spoiled or lost; KM_CANCELLATION - cancellation of MCs not converted in IM due to expiration of time period; KM_CANCELLATION_BY_TERM - cancellation of unconverted MC (labeling) due to expiration of established shelf life; RETAIL_RETURN - Return of goods with damaged/missing IM at

106


retail; REMOTE_SALE_RETURN - Return of goods with damaged/missing IM at remote sales

aggregation boolean - Displaying goods and goods packings with the same status for aggregation

Response example:

{ ‘results’: [ { ‘cis’: ‘string’ , ‘gtin’: ‘string’ , ‘sgtin’: ‘string’ , ‘productName’: ‘string’ , ‘tnVed’: ‘string’ , ‘producerName’: ‘string’ , ‘producerInn’: ‘string’ , ‘ownerName’: ‘string’ , ‘ownerInn’: ‘string’ , ‘agentName’: ‘string’ , ‘agentInn’: ‘string’ , ‘previousAgentName’: ‘string’ , ‘previousAgentInn’: ‘string’ , ‘turnoverType’: ‘SELLING’ , ‘status’: ‘EMITTED’ , ‘emissionDate’: 0 , ‘emissionType’: ‘INVALID_VALUE’ , ‘packType’: ‘UNIT’ , ‘children’: [ { ‘cis’: ‘string’ , ‘gtin’: ‘string’ , ‘producerName’: ‘string’ , ‘status’: ‘EMITTED’ , ‘emissionDate’: 0 , ‘producedDate’: 0 , ‘packageType’: ‘UNIT’ , ‘ownerName’: ‘string’ , ‘ownerInn’: ‘string’ , ‘productName’: ‘string’ , ‘brand’: ‘string’ , ‘prevCises’: [ ‘string’ ] , ‘nextCises’: [ ‘string’ ] , ‘statusEx’: ‘EMPTY’ , ‘children’: [ ‘string’ ] , ‘childrenMap’: {} ,

107

‘countChildren’: 0 , ‘parent’: ‘string’ , ‘lastDocId’: ‘string’ , ‘expireDate’: 0 , ‘prVetDocument’: ‘string’ , ‘introducedDate’: 0 , ‘exporterName’: ‘string’ , ‘exporterTaxpayerId’: ‘string’ , ‘agentName’: ‘string’ , ‘agentInn’: ‘string’ , ‘lastStatusChangeDate’: 0 , ‘turnoverType’: ‘SELLING’ , ‘productGroup’: ‘string’ } ] , ‘countChildren’: 0 , ‘prevCises’: [ ‘string’ ] , ‘nextCises’: [ ‘string’ ], ‘cisChildren’: [ ‘string’ ] } ] , ‘total’: 0, ‘docErrors’: [ { ‘additionalProp1’: {}, ‘additionalProp2’: {}, ‘additionalProp3’: {} } ] }



results: +





*tnVed string - Goods nomenclature code (10 digits)




108








*status enum - Type of goods/IC status: EMITTED – emitted. Released; APPLIED – emitted. Received; INTRODUCED – in circulation; RETIRED – dropped off; WRITTEN_OFF – MC written off; DISAGGREGATION – disaggregated (for packings only)


- IC emission date. Set in yyyy-MM-ddTHH:mm:ss.SSS’Z format


*packType string - Packing type see Catalogue - Types of packing

*children array - IC in aggregate




**status enum - Type of goods/IC status: EMITTED – emitted. Released; APPLIED – emitted. Received; INTRODUCED – in circulation; RETIRED – dropped off; DISAGGREGATION – disaggregated (for packings only)


- Emission date. Set in yyyy-MM-ddTHH:mm:ss.SSS’Z format


- Date of application. Set in yyyy-MM-ddTHH:mm:ss.SSS’Z format

**packageType enum - Packing type see Catalogue - Types of packing



109




**prevCises [string] - Previous IСs (remarking)

**nextCises [string] - Next IC numbers in case of remarking









- Date of shelf life expiration. Set in yyyy-MM-ddTHH:mm:ss.SSS’Z format (mandatory for PG ’milk’)

**prVetDocument string - Production accompanying veterinary document (mandatory for PG ’milk’)


- Date of introduction into circulation. Set in yyyy-MM-ddTHH:mm:ss.SSS’Z format





**lastStatusChangeDate string (date)

- Date of the last status change. Set in yyyy-MM-ddTHH:mm:ss.SSS’Z format

**turnoverType enum - Goods circulation type: SELLING - selling; COMMISSION - commission; AGENT - agent

**productGroup string - Goods group. see Catalogue - List of supported product groups


110


(int32)


*prevCises [string] - Previous IС numbers

cisChildren string - List of children ICs


docErrors array - List of errors

2.1.23. Method of receiving the number obtained MC with filter option

URL: /api/v3/facade/agent/received/count

Method: GET

Request example:

curl -X GET ‘<url of stand> /api/v3/facade/agent/received/count?cis=string&cisMatchMode=EQ&producerInn=string&agent=string&prevAgent=string&emissionType=INVALID_VALUE&emissionDateFrom=0&emissionDateTo=0&gtin=string&sn=string&turnoverType=SELLING&cisAggregationState=PACKED&statusExt=WAIT_SHIPMENT&cisStatus=INTRODUCED&limit=0&page=0&pg=string’ -H ‘accept: */*’ -H ’Authorisation: Bearer <Token>

Request parameters:












111











withdrawReason string - Reason for withdrawal: KM_SPOILED – spoiled; LOST - IM KM_LOST – lost; KM_DESTROYED – destroyed; DESCRIPTION_ERRORS - errors in goods description found; RETAIL – retail sale; EEC_EXPORT – export to EEU countries; BEYOND_EEC_EXPORT – export outside EEU countries; RETURN – return to individual; REMOTE_SALE – sale by sample, remote sale; DAMAGE_LOSS – loss or damage; DESTRUCTION – destruction; CONFISCATION – confiscation; LIQUIDATION – liquidation of business; DONATION – gratuitous transfer; STATE_ENTERPRISE – acquisition by a state enterprise; NO_RETAIL_USE – use for purposes of buyer; ENTERPRISE_USE – use for purposes of enterprise;

112


KM_SPOILED_OR_LOST - IM with MC spoiled or lost; KM_CANCELLATION - cancellation of MCs not converted in IM due to expiration of time period; KM_CANCELLATION_BY_TERM - cancellation of unconverted MC (labeling) due to expiration of established shelf life; RETAIL_RETURN - Return of goods with damaged/missing IM at retail; REMOTE_SALE_RETURN - Return of goods with damaged/missing IM at remote sales


Response example:

{ ‘count’: 0 }



count integer + Number of obtained MCs

2.1.24. Method of receiving the list of transferred MC with filter option

URL: /api/v3/facade/agent/given/list

Method: GET

Request example:

curl -X GET ‘<url of stand> /api/v3/facade/agent/given/list?cis=string&cisMatchMode=EQ&producerInn=string&agent=string&prevAgent=string&emissionType=INVALID_VALUE&emissionDateFrom=0&emissionDateTo=0&gtin=string&sn=string&turnoverType=SELLING&cisAggregationState=PACKED&statusExt=WAIT_SHIPMENT&cisStatus=INTRODUCED&limit=0&page=0&pg=string’ -H ‘accept: */*’ -H ‘Authorisation: Bearer <Token>

Request parameters:




113



















withdrawReason string - Reason for withdrawal: KM_SPOILED – spoiled; LOST - IM KM_LOST – lost;

114


KM_DESTROYED – destroyed; DESCRIPTION_ERRORS - errors in goods description found; RETAIL – retail sale; EEC_EXPORT – export to EEU countries; BEYOND_EEC_EXPORT – export outside EEU countries; RETURN – return to individual; REMOTE_SALE – sale by sample, remote sale; DAMAGE_LOSS – loss or damage; DESTRUCTION – destruction; CONFISCATION – confiscation; LIQUIDATION – liquidation of business; DONATION – gratuitous transfer; STATE_ENTERPRISE – acquisition by a state enterprise; NO_RETAIL_USE – use for purposes of buyer; ENTERPRISE_USE – use for purposes of enterprise; KM_SPOILED_OR_LOST - IM with MC spoiled or lost; KM_CANCELLATION - cancellation of MCs not converted in IM due to expiration of time period; KM_CANCELLATION_BY_TERM - cancellation of unconverted MC (labeling) due to expiration of established shelf life; RETAIL_RETURN - Return of goods with damaged/missing IM at retail; REMOTE_SALE_RETURN - Return of goods with damaged/missing IM at remote sales


Response example:

{ ‘results’: [ { ‘cis’: ‘string’ , ‘gtin’: ‘string’ , ‘sgtin’: ‘string’ , ‘productName’: ‘string’ , ‘tnVed’: ‘string’ , ‘producerName’: ‘string’ , ‘producerInn’: ‘string’ , ‘ownerName’: ‘string’ , ‘ownerInn’: ‘string’ , ‘agentName’: ‘string’ , ‘agentInn’: ‘string’ , ‘previousAgentName’: ‘string’ , ‘previousAgentInn’: ‘string’ , ‘turnoverType’: ‘SELLING’ , ‘status’: ‘EMITTED’ , ‘emissionDate’: 0 , ‘emissionType’: ‘INVALID_VALUE’ , ‘packType’: ‘UNIT’ , ‘children’: [ {

115

‘cis’: ‘string’ , ‘gtin’: ‘string’ , ‘producerName’: ‘string’ , ‘status’: ‘EMITTED’ , ‘emissionDate’: 0 , ‘producedDate’: 0 , ‘packageType’: ‘UNIT’ , ‘ownerName’: ‘string’ , ‘ownerInn’: ‘string’ , ‘productName’: ‘string’ , ‘brand’: ‘string’ , ‘prevCises’: [ ‘string’ ] , ‘nextCises’: [ ‘string’ ] , ‘statusEx’: ‘EMPTY’ , ‘children’: [ ‘string’ ] , ‘childrenMap’: {} , ‘countChildren’: 0 , ‘parent’: ‘string’ , ‘lastDocId’: ‘string’ , ‘expireDate’: 0 , ‘prVetDocument’: ‘string’ , ‘introducedDate’: 0 , ‘exporterName’: ‘string’ , ‘exporterTaxpayerId’: ‘string’ , ‘agentName’: ‘string’ , ‘agentInn’: ‘string’ , ‘lastStatusChangeDate’: 0 , ‘turnoverType’: ‘SELLING’ , ‘productGroup’: ‘string’ } ] , ‘countChildren’: 0 , ‘prevCises’: [ ‘string’ ] , ‘nextCises’: [ ‘string’ ], ‘cisChildren’: [ ‘string’ ] } ] , ‘total’: 0, ‘docErrors’: [ { ‘additionalProp1’: {}, ‘additionalProp2’: {}, ‘additionalProp3’: {} }

116

] }



results: +





*tnVed string - Goods nomenclature code (10 digits)










*status enum - Type of goods/IC status: EMITTED – emitted. Released; APPLIED – emitted. Received; INTRODUCED – in circulation; RETIRED – dropped off; WRITTEN_OFF – MC written off; DISAGGREGATION – disaggregated (for packings only)


- IC emission date. Set in yyyy-MM-ddTHH:mm:ss.SSS’Z format


*packType string - Packing type see Catalogue - Types of packing

*children array - IC in aggregate



117



**status enum - Type of goods/IC status: EMITTED – emitted. Released; APPLIED – emitted. Received; INTRODUCED – in circulation; WRITTEN_OFF – MC written off; RETIRED – dropped out; DISAGGREGATION – disaggregated (for packings only)


- Emission date. Set in yyyy-MM-ddTHH:mm:ss.SSS’Z format


- Date of application. Set in yyyy-MM-ddTHH:mm:ss.SSS’Z format

**packageType enum - Packing type see Catalogue - Types of packing





**prevCises [string] - Previous IСs (remarking)

**nextCises [string] - Next IC numbers in case of remarking









- Date of shelf life expiration. Set in yyyy-MM-ddTHH:mm:ss.SSS’Z format (mandatory for PG ’milk’)

**prVetDocument string - Production accompanying veterinary document (mandatory for PG ’milk’)


- Date of introduction into circulation. Set in yyyy-MM-ddTHH:mm:ss.SSS’Z format

118






**lastStatusChangeDate string (date)

- Date of the last status change. Set in yyyy-MM-ddTHH:mm:ss.SSS’Z format

**turnoverType enum - Goods circulation type: SELLING - selling; COMMISSION - commission; AGENT - agent

**productGroup string - Goods group. see Catalogue - List of supported product groups




*prevCises [string] - Previous IС numbers

cisChildren string - List of children ICs


docErrors array - List of errors

2.1.25. Method of receiving the number of transferred MC with filter option

URL: /api/v3/facade/agent/given/count

Method: GET

Request example:

curl -X GET ‘<stand url> /api/v3/facade/agent/given/count?cis=string&cisMatchMode=EQ&producerInn=string&agent=string&prevAgent=string&emissionType=INVALID_VALUE&emissionDateFrom=0&emissionDateTo=0&gtin=string&sn=string&turnoverType=SELLING&cisAggregationState=PACKED&statusExt=WAIT_SHIPMENT&cisStatus=INTRODUCED&limit=0&page=0&pg=string’ -H ‘accept: */*’ -H ’Authorisation: Bearer <Token>

Request parameters:



cisMatchMode string - Filtering by MC mode: EQ - equal to; LIKE - contains;

119


Start_with - starts with


















withdrawReason string - Reason for withdrawal: KM_SPOILED – spoiled;

120


LOST - IM KM_LOST – lost; KM_DESTROYED – destroyed; DESCRIPTION_ERRORS - errors in goods description found; RETAIL – retail sale; EEC_EXPORT – export to EEU countries; BEYOND_EEC_EXPORT – export outside EEU countries; RETURN – return to individual; REMOTE_SALE – sale by sample, remote sale; DAMAGE_LOSS – loss or damage; DESTRUCTION – destruction; CONFISCATION – confiscation; LIQUIDATION – liquidation of business; DONATION – gratuitous transfer; STATE_ENTERPRISE – acquisition by a state enterprise; NO_RETAIL_USE – use for purposes of buyer; ENTERPRISE_USE – use for purposes of enterprise; KM_SPOILED_OR_LOST - IM with MC spoiled or lost; KM_CANCELLATION - cancellation of MCs not converted in IM due to expiration of time period; KM_CANCELLATION_BY_TERM - cancellation of unconverted MC (labeling) due to expiration of established shelf life; RETAIL_RETURN - Return of goods with damaged/missing IM at retail; REMOTE_SALE_RETURN - Return of goods with damaged/missing IM at remote sales


Response example:

{ ’count’: 0 }



count integer + Number of obtained MCs

2.1.26. Requesting information on goods circulation participant by INN

As a result of successful request execution by one INN of goods circulation participant (GCP), the response returns the information on the requested participant.

URL: /facade/participants/{inn}

Method: GET

121

Request parameters:


inn array [string] + List of INNs (not more than 1000 of INNs)




id integer($int64)

- Identifier

inn string - INN

name string - Name

shortName string - Short name

fullName string - Full name

type string - Organisation type

status string - Status REGISTERED - Registered; NOT_REGISTERED - Not registered; REMOVED - Deleted; RESTORED - Restored; BLOCKED - Blocked.

kpp string - KPP

ogrn string - OGRN

head [string] - Managers

legalAddress string - Registered address

actualAddress string - Actual address

email string - Email

registrationDate integer ($int64)

- Registration

organisationForm string - Organisation Form: LE, PE, IE

emissionRegistrars string - Emission registrar

dissolved boolean - Organisation existence

122


attribute

roles [string] - Organisation roles

phone string - Phone

Request example: For public type of privacy <url of stand>/facade/participants/0000000000 Authorisation: Bearer <TOKEN>

Response example: { ‘id’: 0, ‘inn’: ‘string’, ‘name’: ‘string’, ‘shortName’: ‘string’, ‘fullName’: ‘string’, ‘type’: ‘string’, ‘status’: ‘string’, ‘kpp’: ‘string’, ‘ogrn’: ‘string’, ‘head’: [ ‘string’ ], ‘legalAddress’: ‘string’, ‘actualAddress’: ‘string’, ‘email’: ‘string’, ‘registrationDate’: 0, ‘organisationForm’: ‘IP’, ‘emissionRegistrars’: ‘string’, ‘dissolved’: true, ‘roles’: [ ‘string’ ], ‘phone’: ‘string’, ‘productGroupInfo’: { } }

2.1.27. Method of receiving the information on identification means by MC beginning

URL: /facade/identifytools/start_with

Method: POST

Request example: curl -X POST '<v4 stand url>/facade/identifytools/start_with’ -H 'Authorisation: Bearer <TOKEN>'

123

-H ‘Content-Type: application/json’ -d ’{‘uit’:’010405915570452921HXRNJW15asPkB2406405’}’

Request parameters:


uit string + Identification code


Response examples: { ‘uit’: ‘string’, ‘cis’: ‘string’, ‘gtin’: ‘string’, ‘sgtin’: ‘string’, ‘tnVedEaes’: ‘string’, ‘tnVedEaesGroup’: ‘string’, ‘productName’: ‘string’, ‘emissionDate’: ‘2020-05-06T12:46:30.098Z’, ‘producedDate’: ‘2020-05-06T12:46:30.098Z’, ‘participantName’: ‘string’, ‘participantInn’: ‘string’, ‘producerName’: ‘string’, ‘producerInn’: ‘string’, ‘ownerName’: ‘string’, ‘ownerInn’: ‘string’, ‘statusEx’: ‘EMPTY’, ‘lastDocId’: ‘string’, ‘lastDocType’: ‘UNKNOWN’, ‘emissionType’: ‘string’, ‘receiptDate’: 0, ‘withdrawReason’: ‘string’, ‘prevCises’: [ ‘string’ ], ‘nextCises’: [ ‘string’ ], ‘status’: ‘EMITTED’, ‘packType’: ‘UNIT’, ‘children’: [ { ‘cis’: ‘string’, ‘gtin’: ‘string’, ‘producerName’: ‘string’, ‘status’: ‘EMITTED’, ‘emissionDate’: ‘2020-05-06T12:46:30.098Z’, ‘producedDate’: ‘2020-05-06T12:46:30.098Z’, ‘packageType’: ‘UNIT’, ‘ownerName’: ‘string’, ‘ownerInn’: ‘string’, ‘productName’: ‘string’,

124

‘brand’: ‘string’, ‘prevCises’: [ ‘string’ ], ‘nextCises’: [ ‘string’ ], ‘statusEx’: ‘EMPTY’, ‘children’: [ ‘string’ ], ‘childrenMap’: {}, ‘countChildren’: 0, ‘parent’: ‘string’, ‘lastDocId’: ‘string’, ‘expireDate’: 0, ‘prVetDocument’: ‘string’, ‘introducedDate’: 0, ‘exporterName’: ‘string’, ‘exporterTaxpayerId’: ‘string’, ‘agentName’: ‘string’, ‘agentInn’: ‘string’, ‘lastStatusChangeDate’: 0, ‘turnoverType’: ‘SELLING’, ‘productGroup’: ‘string’ } ], ‘countChildren’: 0, ‘cisChildren’: [ ‘string’ ], ‘uitu’: ‘string’, ‘dateChange’: 0, ‘parent’: ‘string’, ‘expireDate’: 0, ‘prVetDocument’: ‘string’, ‘introducedDate’: 0, ‘agentName’: ‘string’, ‘agentInn’: ‘string’, ‘previousAgentName’: ‘string’, ‘previousAgentInn’: ‘string’, ‘exporterName’: ‘string’, ‘exporterTaxpayerId’: ‘string’, ‘turnoverType’: ‘SELLING’, ‘lastStatusChangeDate’: 0, ‘productGroup’: ‘string’ }





125




















emissionType string + Emission type: LOCAL – manufactured in RF; FOREIGN – imported into RF; REMAINS – remains marking; CROSSBORDER – imported from EEU countries



withdrawReason string - Reason for withdrawal: KM_SPOILED – spoiled; LOST - IM KM_LOST – lost; KM_DESTROYED – destroyed; DESCRIPTION_ERRORS - errors in goods description found;

126


RETAIL – retail sale; EEC_EXPORT – export to EEU countries; BEYOND_EEC_EXPORT – export outside EEU countries; RETURN – return to individual; REMOTE_SALE – sale by sample, remote sale; DAMAGE_LOSS – loss or damage; DESTRUCTION – destruction; CONFISCATION – confiscation; LIQUIDATION – liquidation of business; DONATION – gratuitous transfer; STATE_ENTERPRISE – acquisition by a state enterprise; NO_RETAIL_USE – use for purposes of buyer; ENTERPRISE_USE – use for purposes of enterprise; KM_SPOILED_OR_LOST - IM with MC spoiled or lost; KM_CANCELLATION - cancellation of MCs not converted in IM due to expiration of time period; KM_CANCELLATION_BY_TERM - cancellation of unconverted MC (labeling) due to expiration of established shelf life; RETAIL_RETURN - Return of goods with damaged/missing IM at retail; REMOTE_SALE_RETURN - Return of goods with damaged/missing IM at remote sales



status enum + Type of goods/IC status: EMITTED – emitted. Released; APPLIED – emitted. Received; INTRODUCED – in circulation; RETIRED – dropped off; DISAGGREGATION – disaggregated (for packings only)






*status enum + Type of goods/IC status: EMITTED – emitted. Released; APPLIED – emitted. Received; INTRODUCED – in circulation; RETIRED – dropped off; DISAGGREGATION – disaggregated (for packings only)



*producedDate string (date-

- Date of application. Is returned in yyyy-MM-

127


time) ddTHH:mm:ss.SSS’Z format

























128



























2.1.28. Method of receiving MC and all internal MC

URL: /facade/identifytools/aggregated

129

Method: POST

Request example: <v4 stand url>/facade/identifytools/aggregated’ - H ’Authorisation: Bearer <TOKEN>‘ -H ‘Content-Type: application/json’ -d ’{‘cises’:[‘000000462106549OOv1s0XzlzIFDjtcXJjz5cB’]}’

Request parameters:


cises List<string> + MC array Array length is 1 to 1000 MCs.


Type Mandatory Description

Map<string, Map<string, …, List<string>>> - List of MC arrays in aggregate if there is an aggregate

Response example: { ‘000000462106549OOv1s0XzlzIFDjtcXJjz5cB’: { ‘0100000046210654214u4qrBQ’: [ ‘00000046210654QuHCUeP’, ‘00000046210654kGS951L’, ‘00000046210654ndSJVa0’, ‘00000046210654HBTlASg’, ‘00000046210654RQL9x5W’, ‘000000462106548kkX4Wy’, ‘00000046210654KJEIVd4’, ‘00000046210654NAZQsBx’, ‘00000046210654SRHZnWr’, ‘00000046210654iVDjrm6’ ], ‘010000004621065421hYVhjnW’: [ ‘000000462106542xb6Fiy’, ‘00000046210654u8fmz0X’, ‘000000462106542yUlHC9’, ‘00000046210654dBpPEZs’, ‘00000046210654yOTPFS6’, ‘00000046210654aewBPk4’, ‘00000046210654zSkKEBt’, ‘00000046210654EtTF0j8’, ‘00000046210654wXVWhUu’, ‘00000046210654a2xoPyp’ ] }, ‘00000004621065421oFTjHaM’: { ‘00000046210654PQgiuyT’: [ ], ‘00000046210654br263jz’: [ ], ‘00000046210654T8ilBVZ’: [ ],

130

‘00000046210654xp8JGKc’: [ ], ‘00000046210654et2bcCN’: [ ], ‘00000046210654qTR6MnF’: [ ], ‘000000462106547h0FAsR’: [ ], ‘00000046210654aEPiJFa’: [ ], ‘00000046210654qr0Cm3Q’: [ ], ‘00000046210654VVixsXU’: [ ] }, ‘00000046210654QuHCUeP’: {} }

2.1.29. Method of receiving the information on identification tool (POST)

URL: /facade/identifytools/infolist

Method: POST

Request example: curl -X POST '<v4 stand url>/facade/identifytools/infolist’ -H 'Authorisation: Bearer <TOKEN>' -H ‘Content-Type: application/json’ -d ’{‘cises’:[‘000000462106549OOv1s0XzlzIFDjtcXJjz5cB’]}’

Request parameters:


cises string + MC

Response examples: [ { ‘uit’: ‘string’, ‘cis’: ‘string’, ‘gtin’: ‘string’, ‘sgtin’: ‘string’, ‘tnVedEaes’: ‘string’, ‘tnVedEaesGroup’: ‘string’, ‘productName’: ‘string’, ‘emissionDate’: ‘2020-05-06T12:46:30.098Z’, ‘producedDate’: ‘2020-05-06T12:46:30.098Z’, ‘participantName’: ‘string’, ‘participantInn’: ‘string’, ‘producerName’: ‘string’, ‘producerInn’: ‘string’, ‘ownerName’: ‘string’, ‘ownerInn’: ‘string’, ‘statusEx’: ‘EMPTY’, ‘lastDocId’: ‘string’, ‘lastDocType’: ‘UNKNOWN’, ‘emissionType’: ‘string’, ‘receiptDate’: 0,

131

‘withdrawReason’: ‘string’, ‘prevCises’: [ ‘string’ ], ‘nextCises’: [ ‘string’ ], ‘status’: ‘EMITTED’, ‘packType’: ‘UNIT’, ‘children’: [ { ‘cis’: ‘string’, ‘gtin’: ‘string’, ‘producerName’: ‘string’, ‘status’: ‘EMITTED’, ‘emissionDate’: ‘2020-05-06T12:46:30.098Z’, ‘producedDate’: ‘2020-05-06T12:46:30.098Z’, ‘packageType’: ‘UNIT’, ‘ownerName’: ‘string’, ‘ownerInn’: ‘string’, ‘productName’: ‘string’, ‘brand’: ‘string’, ‘prevCises’: [ ‘string’ ], ‘nextCises’: [ ‘string’ ], ‘statusEx’: ‘EMPTY’, ‘children’: [ ‘string’ ], ‘childrenMap’: {}, ‘countChildren’: 0, ‘parent’: ‘string’, ‘lastDocId’: ‘string’, ‘expireDate’: 0, ‘prVetDocument’: ‘string’, ‘introducedDate’: 0, ‘exporterName’: ‘string’, ‘exporterTaxpayerId’: ‘string’, ‘agentName’: ‘string’, ‘agentInn’: ‘string’, ‘lastStatusChangeDate’: 0, ‘turnoverType’: ‘SELLING’, ‘productGroup’: ‘string’ } ], ‘countChildren’: 0, ‘cisChildren’: [ ‘string’ ], ‘uitu’: ‘string’, ‘dateChange’: 0, ‘parent’: ‘string’, ‘expireDate’: 0,

132

‘prVetDocument’: ‘string’, ‘introducedDate’: 0, ‘agentName’: ‘string’, ‘agentInn’: ‘string’, ‘previousAgentName’: ‘string’, ‘previousAgentInn’: ‘string’, ‘exporterName’: ‘string’, ‘exporterTaxpayerId’: ‘string’, ‘turnoverType’: ‘SELLING’, ‘lastStatusChangeDate’: 0, ‘productGroup’: ‘string’ } ]





















statusEx enum - Extended IC status: EMPTY – None; WAIT_SHIPMENT – Awaiting acceptance; WAIT_TRANSFER_TO_OWNER – Awaiting transfer to owner (contract manufacturing); REMARK_RETIRED – Remarked; RETIRED_CANCELLATION – Writing off; WAIT_REMARK – IC written off after application on goods

133


(Goods awaiting remarking)



emissionType string + Emission type: LOCAL – manufactured in RF; FOREIGN – imported into RF; REMAINS – remains marking; CROSSBORDER – imported from EEU countries



withdrawReason string - Reason for withdrawal: KM_SPOILED – spoiled; LOST - IM KM_LOST – lost; KM_DESTROYED – destroyed; DESCRIPTION_ERRORS - errors in goods description found; RETAIL – retail sale; EEC_EXPORT – export to EEU countries; BEYOND_EEC_EXPORT – export outside EEU countries; RETURN – return to individual; REMOTE_SALE – sale by sample, remote sale; DAMAGE_LOSS – loss or damage; DESTRUCTION – destruction; CONFISCATION – confiscation; LIQUIDATION – liquidation of business; DONATION – gratuitous transfer; STATE_ENTERPRISE – acquisition by a state enterprise; NO_RETAIL_USE – use for purposes of buyer; ENTERPRISE_USE – use for purposes of enterprise; KM_SPOILED_OR_LOST - IM with MC spoiled or lost; KM_CANCELLATION - cancellation of MCs not converted in IM due to expiration of time period; KM_CANCELLATION_BY_TERM - cancellation of unconverted MC (labeling) due to expiration of established shelf life; RETAIL_RETURN - Return of goods with damaged/missing IM at retail; REMOTE_SALE_RETURN - Return of goods with damaged/missing IM at remote sales



status enum + Type of goods/IC status: EMITTED – emitted. Released; APPLIED – emitted. Received; INTRODUCED – in circulation; RETIRED – dropped off;

134


DISAGGREGATION – disaggregated (for packings only)






*status enum + Type of goods/IC status: EMITTED – emitted. Released; APPLIED – emitted. Received; INTRODUCED – in circulation; RETIRED – dropped off; DISAGGREGATION – disaggregated (for packings only)


















135































136









Method of receiving the number of MC with filter option

URL: /facade/identifytools/count

Method: GET

Request example: curl -X GET '<v4 stand url>/facade/identifytools/count?pg=lp’ -H 'Authorisation: Bearer <TOKEN>'

Request parameters:



*pg [string] - Goods group: the parameter must be specified for the following goods groups: milk – ‘Dairy products’; water – ’Bottled water’








137





















138





*statusExt enum - Additional status of IC: CANCELLATION_APPLIED – Written off after application on goods; REMARK_RETIRED – Remarked; RETIRED_CANCELLATION – Written off; DONATION – Gratuitous transfer of goods; STATE_ENTERPRISE – Acquisition by a state enterprise; NO_RETAIL_USE – Use for purposes of buyer; BEYOND_EEC_EXPORT – Export outside EEU countries; REMOTE_SALE – Sale by sample, remote sale; EEC_EXPORT – Export to EEU countries; RETURN – Return to individual; DAMAGE_LOSS – Loss or damage; DESTRUCTION – Destruction; CONFISCATION – Confiscation; LIQUIDATION – Liquidation of business; FTS_RESPOND_NOT_OK - Unfavorable decision by FCS; FTS_RESPOND_WAITING - Awaiting confirmation by FCS; FTS_CONTROL - Controlled by FCS

*cisStatus string - Current IC status: APPLIED – emitted. Received; EMITTED – emitted. Released; INTRODUCED – In circulation; RETIRED – Dropped off

*withdrawReason string - Reason for withdrawal: KM_SPOILED – spoiled; LOST - IM KM_LOST – lost; KM_DESTROYED – destroyed; DESCRIPTION_ERRORS - errors in goods description found; RETAIL – retail sale; EEC_EXPORT – export to EEU countries; BEYOND_EEC_EXPORT – export outside EEU countries; RETURN – return to individual; REMOTE_SALE – sale by sample, remote sale; DAMAGE_LOSS – loss or damage; DESTRUCTION – destruction; CONFISCATION – confiscation; LIQUIDATION – liquidation of business; DONATION – gratuitous transfer; STATE_ENTERPRISE – acquisition by a state enterprise; NO_RETAIL_USE – use for purposes of buyer; ENTERPRISE_USE – use for purposes of enterprise; KM_SPOILED_OR_LOST - IM with MC spoiled or lost; KM_CANCELLATION - cancellation of MCs not converted in IM due to expiration of time period;

139


KM_CANCELLATION_BY_TERM - cancellation of unconverted MC (labeling) due to expiration of established shelf life; RETAIL_RETURN - Return of goods with damaged/missing IM at retail; REMOTE_SALE_RETURN - Return of goods with damaged/missing IM at remote sales

*documentId string - Document registration number. Shall be specified when searching IC in the document

Response example: { ’count’: 678 }



count string + MC Quantity

2.1.31. Method of receiving IC by identifier

URL: /facade/cis/info

Method: GET

Request example: curl -X POST ’<v4 stand url>/facade/cis/info?cisId=81635161684’ -H 'Authorisation: Bearer <TOKEN>' -H 'content-type: application/json'

Request parameters:


cisId string - IC


Response example: { ‘cis’: ‘0000000000000000000000000000000’, ‘gtin’: ‘string’, ‘producerName’: ‘string’, ‘status’: ‘EMITTED’, ‘emissionDate’: ‘2020-05-06T12:46:30.098Z’,

140

‘producedDate’: ‘2020-05-06T12:46:30.098Z’, ‘packType’: ‘UNIT’, ‘ownerName’: ‘string’, ‘ownerInn’: ‘string’, ‘productName’: ‘string’, ‘brand’: ‘string’, ‘prevCises’: [ ‘string’ ], ‘nextCises’: [ ‘string’ ], ‘statusEx’: ‘EMPTY’, ‘children’: [ ‘string’ ], ‘countChildren’: 0, ‘parent’: ‘string’, ‘lastDocId’: ‘string’, ‘expireDate’: ‘2020-05-06T12:46:30.098Z’, ‘prVetDocument’: ‘string’, ‘introducedDate’: ‘2020-05-06T12:46:30.098Z’, ‘exporterName’: ‘string’, ‘exporterTaxpayerId’: ‘string’, ‘agentName’: ‘string’, ‘agentInn’: ‘string’, ‘lastStatusChangeDate’: ‘2020-05-06T12:46:30.098Z’, ‘turnoverType’: ‘SELLING’, ‘productGroup’: ‘string’ }






status enum + Type of goods/IC status: EMITTED – emitted. Released; APPLIED – emitted. Received; INTRODUCED – in circulation; RETIRED – dropped off; DISAGGREGATION – disaggregated (for packings only)





packType + Packing type see Catalogue - Types of packing

141



























142

2.1.32. Method of receiving the number of MC with filter option

URL: /facade/cis/count

Method: GET

Request example: curl -X GET '<v4 stand url>/facade/cis/count?pg=lp’ -H 'Authorisation: Bearer <TOKEN>'


Request parameters:



*pg [string] - Goods group: the parameter must be specified for the following goods groups: milk – ‘Dairy products’; water – ‘Bottled water’















143

















Response example: { ’count’: 678 }

144



count string + MC Quantity

2.1.33. Method of receiving the list of MC using document number

URL: /facade/cis/docNum/{docNum}

Method: GET

Request example: curl -X GET '<v4 stand url>/facade/cis/docNum/186161351’ -H 'Authorisation: Bearer <TOKEN>'


Request parameters:


docNum string + Document number

Response example:

An IC list by document number is returned

[ ’string’ ]

2.1.34. Method of searching document content by document identifier

URL: /facade/doc/{docId}/content

Method: GET

Request example: curl -X GET '<stand url>/facade/doc/{docId}/content’ -H 'Authorisation: Bearer <TOKEN>'


Request parameters:


docId string + Document number

145

Response example:

Document content is returned

[ ’string’ ]

2.2. Document Methods

The methods described in this subsection are intended to receive the information on all PGs except for MTTP and MDLP.

The following types of documents are used in non-tobacco and non-medicine methods:

• Description of remains;

• Aggregation;

• UTD for shipment;

• Introduction into circulation;

• Return into circulation;

• Shipping;

• Cancelling shipment;

• Acceptance;

• Withdrawal from circulation;

• MC order. OMS;

• Writing off MC;

• Remarking;

• ACC aggregation;

• ACC reaggregation;

• ACC disaggregation.

2.2.1. Single method of document creation

URL: /lk/documents/create

Method: POST

Type of privacy: private

Request example:

146

POST <stand url>/lk/documents/create?pg=lp Authorisation: Bearer <TOKEN> Content-Type: application/json { ‘document_format’: ‘string’, ‘product_document’: ‘<Document in Base64 format>‘, ‘type’: ‘string’, ‘signature’: ‘<Detached EES in Base64 format>‘ }

Request parameters:


pg string + Goods Group see Catalogue - List of supported product groups

Request body parameters:


document_format string + Document type Values: MANUAL – JSON format; XML – XML format; CSV – CSV format

product_document string + Document body translated into BASE64

see Catalogue - Types of documents

signature string + Detached signature (EQES) in BASE64 format

type string + Document type see Catalogue - Types of documents

Response example:

1 Code 200 If the document is created successfully, TT GIS returns a unique ID of the document:

9abd3d41-76bc-4542-a88e-b1f7be8130b5

2 If failed:

2.1. Code 401 If token is not specified:

{ <UnauthorisedException> <error>unauthorised</error> <error_description>Full authentication is required to access this resource</error_description> </UnauthorisedException> }

2.2. Code 400 If JSON structure in the request body is incorrect:

147

{ ‘error_message’: ‘JSON parse error: Cannot deserialize value of type’ }

2.3. Code 400 If the document_format field in the request body is missing:

{ ‘error_message’: ‘Document type not specified: MANUAL, CSV, XML’ }

2.4. Code 403 If PG functions are unavailable when there is a response body from medicine component:

{ ‘error_message’: ‘Remarking is not available for <GG name> GG’ }

2.5. Code 403 If PG functions are unavailable when there is no response body from medicine component:

{ ‘error_message’: ‘No access to resource’ }

2.6. Code 400 If the URL request parameter ’pg’ = ‘tobacco’:

{ ‘error_message’: ‘Method does not work with Tobacco GG’ }

2.2.2. Description of remains

Goods remains are described according to a reduced attribution.

Type of document:

Type Description

OST_DESCRIPTION Description of goods remains in JSON (MANUAL)

OST_DESCRIPTION_CSV Description of goods remains in CSV

OST_DESCRIPTION_XML Description of goods remains in XML

Starting from August 1, 2020, it is prohibited to create the above types of documents in the "Unified method of creating documents" (/lk/documents/create) for ’Footwear’ PG.

Example of document body in JSON format:

{ ‘trade_participant_inn’: ‘0000000000’, ‘products_list’: [ { ‘tnved_code_2’ : ‘62’,

148

‘brand’: ‘Trademark’, ‘name’: ‘Goods item name’, ‘product_gender’: ‘MALE’, ‘release_method’: ‘PRODUCED_IN_RF’, ‘consumer_age’: ‘Age category’, ‘model’: ‘Model’ } ] }

Document parameters:


trade_participant_inn string (9,12)

+ INN of goods circulation participant

products_list array + List of information on goods

*release_method string + Method of goods introduction into circulation

Mandatory forClothing Items, Bed, Table, Bath and Kitchen Linen

Possible values: ‘PRODUCED_IN_RF’ - manufactured in RF; ‘IMPORTED_INTO_RF’ - imported into RF

*tnved_code_2 string + Goods nomenclature code (2 digits)

Possible values: 42, 61, 62 – Clothing items, bed, table, bath and kitchen linen; 33 – Perfume and eau de toilette; 40 – New pneumatic rubber tires and tire casings; 90 – Photo cameras (except cine camera), flash lights and flash bulbs; 04, 21, 22 – Dairy products; 87, 95 – Bicycles and bicycle frames; 87 – Wheelchairs

*brand string - Trade mark

*name string - Goods name Mandatory for Photo cameras (except cine cameras), flash lights and flash bulbs

*product_gender string - Target gender Mandatory for Clothing Items, Bed, Table, Bath and Kitchen Linen

Possible values: ‘MALE’ - Male; ‘FEMALE’ - Female; ‘BABY’ - Baby; ‘UNISEX’ - Unisex.

*consumer_age string - Age group Mandatory for clothing items, bed, table, bath and kitchen linens

Possible values:

149


‘BABY’ - Baby; ‘ADULT’ - Adult; ‘NO_AGE’ - No age

*model string - Model Mandatory for ‘New pneumatic rubber tires and tire casings’ goods group

Example of document body in CSV format:

INN of economic agent,Version 1111111111,2 Goods list,,,,,, Goods nomenclature code (2 characters),Trade Mark Brand ,Goods item name,Target gender,Method for introducing a goods item into circulation,Consumer age,Model/ manufacturer SKU 00,trademark,product_name,male,Manufactured in RF,Baby,model

Example of document body in XML format:

<?xml version=‘1.0’ encoding=‘UTF-8’?> <ost_description version=‘2’ action_id=‘33.1’> <trade_participant_inn>1111111111</trade_participant_inn> <products_list> <product> <tnved_code_2>00</tnved_code_2> <brand>trademark</brand> <name>product_name</name> <product_gender>MALE</product_gender> <release_method>PRODUCED_IN_RF</release_method> <consumer_age>BABY</consumer_age> <model>model</model> </product> </products_list> </ost_description>

2.2.3. Aggregation 2.2.3.1. Aggregation

Type of document:

Type Description

AGGREGATION_DOCUMENT Aggregation in JSON (MANUAL)

AGGREGATION_DOCUMENT_CSV Aggregation in CSV

AGGREGATION_DOCUMENT_XML Aggregation in XML

150


{ ‘participantId’: ‘string’, ‘aggregationUnits’: [ { ‘unitSerialNumber’: ‘string’, ‘aggregationType’: ‘string’, ‘sntins’: [ ‘string’ ] } ] }



participantId string + EA INN

aggregationUnits array + List of created aggregates

*unitSerialNumber string + SPIC code of aggregate

Shipping package identification code is generated as per SPIC standard (18 digits)

*aggregationType string + Aggregation type code

Value can be only ’AGGREGATION’

*sntins array[string] + List of ICs included in the aggregate

Statuses of MCs or Aggregate shall be identical

Note: Aggregation may be either before or after the introduction into circulation. If the aggregation was before the introduction into circulation, the aggregates should be specified in the document of introduction into circulation instead of MC, otherwise the aggregates disaggregate. To introduce remains into circulation, generate introduction of remains into circulation first, and then perform aggregation, otherwise the aggregates would disaggregate.


Document type,Economic agent INN,Version Document for aggregation,0000000000,2 Goods parameters SPIC,Nested SIC/SPIC 000000000000000002,000000000000000005 000000000000000002,00000000000000000000000000000000000000 000000000000000000,00000000000000000000000000000000000001 000000000000000001,00000000000000000000000000000000000002 000000000000000000,’010466007901460321&%*^$!?’’'()*+-=/,;.:<>_1’ 000000000000000002,’010466007901460321&%*^$!?’’'()*+-=/,;.:<>_2’ 000000000000000001,000000000000000002

151


<?xml version=‘1.0’ encoding=‘UTF-8’?> <unit_pack document_id=‘unit_pack_7FFF90D5-4785-7EC9-899E-534A7BAA2B71’ VerForm=‘1.03’ file_date_time=‘2019-04-12T11:07:45+03:00’ VerProg=‘VerProg1’> <Document operation_date_time=‘2019-06-05T14:28:14+03:00’ document_number=‘157743-20199’> <organisation> <id_info> <LP_info org_name=‘ООО’ LP_TIN=‘0000000000’ RRC=‘000000000’/> </id_info> <Address> <location_address country_code=‘643’ text_address=‘142305’/> </Address> <contacts phone_number=‘123456789’ email=‘[email protected]’/> </organisation> <pack_content> <pack_code>000000000000000000</pack_code> <cis>00000000000000000000000000000000000002</cis> </pack_content> <pack_content> <pack_code>000000000000000001</pack_code> <cis>000000000000000002</cis> </pack_content> </Document> </unit_pack>

2.2.3.2. Reaggregation

Type of document:

Type Description

REAGGREGATION_DOCUMENT Reaggregation. JSON (MANUAL)

REAGGREGATION_DOCUMENT_CSV Reaggregation in CSV

REAGGREGATION_DOCUMENT_XML Reaggregation in XML


{ ‘participant_inn’: ‘string’ , ‘reaggregation_type’: ‘string’ , ‘uit_uitu_list’: [ { ‘uit_uitu’: ‘string’, ‘name’: ‘string’ } ] , ‘uitu’: ‘string’ }

152



participant_inn string + INN of goods circulation participant

reaggregation_type string + Operation type code Possible values: REMOVING – withdrawal; ADDING – addition

uitu string + Code of aggregate to be modified

uit_uitu_list array + List of aggregates to be added/removed

*uit_uitu string + Marking codes to be added/removed


Example of document body in CSV format: Economic agent INN,Transformation type,Shipment packing individual code (SPIC),Version 0000000000,Withdrawal,000000000000000000,2 List of shipment packings or goods IC,SPIC ‘00000000000000000000000000000000000000’, ‘11111111111111111111111111111111111111’, ,’222222222222222222’


<?xml version=‘1.0’ encoding=‘UTF-8’?> <reaggregation action_id=‘32’ version=‘2’> <trade_participant_inn>0000000000</trade_participant_inn> <reaggregation_type>REMOVING</reaggregation_type> <reaggregating_kitu>000000000000000000</reaggregating_kitu> <product_list> <packing_product> <kit>00000000000000000000000000000000000000</kit> </packing_product> <packing_product> <kit>11111111111111111111111111111111111111</kit> </packing_product> <packing_product> <kitu>222222222222222222</kitu> </packing_product> </product_list> </reaggregation>

2.2.3.3. Disaggregation

Automatic aggregate disaggregation is performed for any operations with IC in SPIC, except for cases where size and colour data are provided in ‘Introduction into circulation’ document for an imported goods item with FCS interaction (Introduction into circulation. Import with FCS).

153

Type of document:

Type Description

DISAGGREGATION_DOCUMENT Disaggregation. JSON (MANUAL)

DISAGGREGATION_DOCUMENT_CSV Disaggregation in CSV

DISAGGREGATION_DOCUMENT_XML Disaggregation in XML


{ ‘participant_inn’: ‘string’, ‘products_list’: [ { ‘uitu’: ‘string’ } ] }





*uitu string - Code of aggregate to be disaggregated


Economic agent INN,Version 0000000000,2 Shipping package list ‘000000000000000000’ ‘111111111111111111’ ‘222222222222222222’


<?xml version=‘1.0’ encoding=‘UTF-8’?> <disaggregation action_id=‘31’ version=‘2’> <trade_participant_inn>0000000000</trade_participant_inn> <packings_list> <packing> <kitu>000000000000000000</kitu> </packing> <packing> <kitu>111111111111111111</kitu> </packing> <packing> <kitu>222222222222222222</kitu> </packing>

154

</packings_list> </disaggregation>

2.2.4. Introduction into circulation 2.2.4.1. Introduction into circulation. Manufacture in the Russian Federation

Type of document:

Type Description

LP_INTRODUCE_GOODS Introduction into circulation. Manufacturing in the Russian Federation. JSON (MANUAL)

LP_INTRODUCE_GOODS_CSV Introduction into circulation. Manufacturing in the Russian Federation. CSV

LP_INTRODUCE_GOODS_XML Introduction into circulation. Manufacturing in the Russian Federation. XML


{ ‘participant_inn’: ‘0000000000’ , ‘production_date’: ‘2012-11-22’ , ‘producer_inn’: ‘000000000’ , ‘owner_inn’: ‘000000000’ , ‘production_type’: ‘OWN_PRODUCTION’, ‘doc_type’: ‘Promotion_Inform_Selfmade’ , ‘products’: [ { ‘production_date’: ‘2012-11-22’ , ‘uit_code’: ‘11111111111111111111111111111111111111’ , ‘uitu_code’: ‘000000000000000000’ , ‘tnved_code’: ‘0123456789’ , ‘producer_inn’: ‘000000000’ , ‘owner_inn’: ‘000000000’ , ‘certificate_document‘: ‘CONFORMITY_DECLARATION’ , ‘certificate_document_number’: ‘FFFFFF’ , ‘certificate_document_date’: ‘2014-11-22’ } ] }


participant_inn string + INN of participant who emitted MC

producer_inn string + INN of goods manufacturer

production_date string + Date of goods production

Set in yyyy-MM-dd format.

owner_inn string + INN of goods

155


owner

production_type string + Production order type

Possible values:

OWN_PRODUCTION – own production

doc_type string + Type of document created

products array - List of goods

*certificate_document string - Type code of document on mandatory certification

Possible values: CONFORMITY_CERTIFICATE – certificate of conformity; CONFORMITY_DECLARATION – declaration of conformity

*certificate_document_date string - Date of document on mandatory certification

Set in yyyy-MM-dd format. Range of dates from 2000-01-01 till the document creation date

*certificate_document_number string - Number of document on mandatory certification

*owner_inn string + INN of owner

*producer_inn string + INN of goods manufacturer

*production_date string + Date of goods manufacture from general data on goods introduction into circulation

Parameter is in the request if its value differs from that of production_date parameter (No. 8 in this table).

Set in yyyy-MM-dd format

*tnved_code string + Goods nomenclature code (10 digits)

*uit_code string - Unique identifier of goods item

Mandatory if uitu_code is not specified

*uitu_code string - Unique identifier of shipping package

Mandatory if uit_code is not specified

156


Document type,Economic agent INN,Date of manufacture,Goods manufacturer INN,Goods owner INN,Production order type, Request for putting goods into circulation (in-house manufacturing),0000000000,12.04.2019,0000000000,0000000000,In-house manufacturing, List of goods IC,SPIC,EEU FEACN code,Date of manufacture of the goods item,mandatory certification document,Document number,Document date, ‘11111111111111111111111111111111111111’,’000000000000000000’,0000000000,12.04.2019,Compliance certificate,111,12.04.2019, ’11111111111111111111111111111111111112’,’000000000000000000’,0000000000,12.04.2019,Compliance declaration,111,12.04.2019,


<?xml version=‘1.0’ encoding=‘UTF-8’?> <vvod action_id=‘05’ version=‘5’> <trade_participant_inn>1111111111</trade_participant_inn> <producer_inn>1111111111</producer_inn> <owner_inn>1111111111</owner_inn>  <product_date>12.04.2019</product_date> <production_order>OWN_PRODUCTION</production_order> <products_list>  <product>  <kit>00000000000000000000000000000000000002</kit>  <kitu>000000000000000000</kitu>  <product_date>12.04.2019</product_date> <tnved_code>0001000000</tnved_code> <certificate_type>CONFORMITY_CERTIFICATE</certificate_type> <certificate_number>string</certificate_number> <certificate_date>12.04.2019</certificate_date> </product> <product>  <kit>11111111111111111111111111111111111112</kit>  <kitu>000000000000000000</kitu>  <product_date>12.04.2019</product_date> <tnved_code>0000000000</tnved_code> <certificate_type>CONFORMITY_CERTIFICATE</certificate_type> <certificate_number>string</certificate_number> <certificate_date>12.04.2019</certificate_date> </product>

157

</products_list> </vvod>

2.2.4.2. Introduction into circulation. Received from individuals.

Type of document:

Type Description

LK_INDI_COMMISSIONING Introduction into circulation. Received from individuals. JSON (MANUAL)

LK_INDI_COMMISSIONING_CSV Introduction into circulation. Received from individuals. CSV

LK_INDI_COMMISSIONING_XML Introduction into circulation. Received from individuals. XML


{ "participant_inn": "1111111111", "product_receiving_date": "2019-04-19T21:00:00.000Z", "products_list": [ { "uit": "12345678912345678912345678912345678912", "product_receiving_date": "2019-04-19T21:00:00.000Z", "productName": "test product name" }, { "uitu": "1111", "children": [ { "uit": "222" } ] } ] }

Document parameters::



product_receiving_date string (date-time)

- Date of goods receipt

Set in yyyy-MM-ddTHH:mm:ss.SSS’Z format

products_list array + List of goods for introduction into circulation

*uit string - Unique identifier of goods item

Mandatory if uitu is not specified

*uitu string - Unique identifier of shipping package

Mandatory if uit is not specified

158


*product_receiving_date date + Date of goods receipt

Parameter is in the request if its value differs from that of product_receiving_date parameter.


productName string Name of the product


Economic agent INN,Goods receipt data,Version 1111111111,12.04.2019,2 Goods parameters IC,SPIC,Goods receipt date ‘000000000000000000000000000000000’,,12.04.2019


<?xml version=‘1.0’ encoding=‘UTF-8’?> <vvod_individuals action_id=‘5.3’ version=‘3’> <trade_participant_inn>1111111111</trade_participant_inn>  <product_receiving_date>12.04.2019</product_receiving_date> <products_list>  <product>  <kit>0000000000000000000000000000000</kit> <product_receiving_date>12.04.2019</product_receiving_date> </product> <product>  <kitu>000000000000000000</kitu> <product_receiving_date>12.04.2019</product_receiving_date> </product> </products_list> </vvod_individuals>

2.2.4.3. Introduction into circulation. Manufacturing outside of EEU

The method shall be considered deprecated; it will be supported till October 2020 for goods groups where unmarked products circulation prohibition date has not occurred.

When information is provided with LP_GOODS_IMPORT ‘Introduction into circulation. Manufacturing outside of EEU‘ method, declaration date for the product is verified. If the declaration date for the product is earlier than 2020-08-01, the document is processed with LP_GOODS_IMPORT ‘Introduction into circulation. Manufacturing outside of EEU‘ method; otherwise, it is processed with LP_FTS_INTRODUCE (Introduction into circulation. Import with FCS) and LP_GOODS_IMPORT (Introduction into circulation. Import outside EAEU) method.

159

Type of document:

Type Description

LP_GOODS_IMPORT Introduction into circulation. Import. JSON (MANUAL)

LP_GOODS_IMPORT_CSV Introduction into circulation. Import. CSV

LP_GOODS_IMPORT_XML Introduction into circulation. Import. XML


{ ‘doc_type’: ‘GOODSIMPORT’, ‘participant_inn’: ‘string’, ‘declaration_date’: ‘2019-12-31’, ‘declaration_number’: ‘decl num’, ‘customs_code’: ‘customs code’, ‘decision_code’: 1, ‘products’: [ { ‘uit_code’: ‘33333’, ‘uitu_code’: ‘123456789123456789’, ‘tnved_code’: ‘0123456789’, ‘certificate_document’: ‘CONFORMITY_DECLARATION ‘, ‘certificate_document_number’: ‘FFFFFF’, ‘certificate_document_date’: ‘2014-11-22’ } ], ‘pdfFile’: ‘pdfContent’ }



doc_type string + Type of document created

Parameter shall assume value ‘GOODSIMPORT’


declaration_date string + CD registration date


declaration_number string + CD registration number

customs_code string + Customs authority code

160


decision_code string + Code of decision made

Can have the following values: 10 - goods release permitted; 11 - goods release provided that payment of customs duties is ensured; 12 - goods release with special features stipulated in Article 121 of the Customs Code of the Eurasian Economic Union; 13 - goods release with special features stipulated in Article 122 of the Customs Code of the Eurasian Economic Union; 14 - goods release with special features stipulated in Article 123 of the Customs Code of the Eurasian Economic Union; 20 - conditional release of goods

pdfFile string - Attached PDF file. In Base64

products array + List of data on MC for introduction into circulation



*certificate_document_number string - Number of document on mandatory certification






*uitu_code string - Unique identifier of


161


shipping package


Economic agent INN, CD registration date,CD registration number,Customs authority code,Decision code,Version 1234567890,01.01.2019,123,11111111,10,3 Goods parameters IC,SPIC,Compliance document type,Compliance document number,Compliance document date,Goods EEU FEACN code ‘11111111111111111111111111111111111111’,,Compliance certificate,123,01.01.2019,0000000000


<?xml version=‘1.0’ encoding=‘UTF-8’?> <vvod_import action_id=‘5.1’ version=‘3’> <trade_participant_inn>1234567890</trade_participant_inn> <declaration_date>12.04.2019</declaration_date> <declaration_number>876</declaration_number> <customs_code>11111111</customs_code> <decision_code>10</decision_code> <products_list> <product> <kit>11111111111111111111111111111111111111</kit> <certificate_type>CONFORMITY_DECLARATION</certificate_type> <certificate_number>6534</certificate_number> <certificate_date>12.04.2019</certificate_date> <tnved_code>0000000003</tnved_code> </product> </products_list> </vvod_import>

2.2.4.4. Introduction into circulation. Cross-border trading

This method is available only for EEU operators. This method is not applicable for product groups:

• ‘Dairy products’;

• ‘Bottled water’;

• ‘Bicycles and bicycle frames’;

• ‘Wheelchairs’.

162

Type of document:

Type Description

CROSSBORDER Introduction into circulation. Cross-border trading. JSON (MANUAL)

CROSSBORDER_CSV Introduction into circulation. Cross-border trading. CSV

CROSSBORDER_XML Introduction into circulation. Cross-border trading. XML


{ ‘country_oksm’: ‘string’, ‘exporter_name’: ‘string’, ‘import_date’: ‘2020-01-23’, ‘primary_document_date’: ‘2020-01-23’, ‘primary_document_number’: ‘string’, ‘products_list’: [ { ‘certificate_date’: ‘2020-01-23’, ‘certificate_number’: ‘string’, ‘certificate_type’: ‘string’, ‘cost’: 0, ‘ki’: ‘string’, ‘kitu’: ‘string’, ‘tnved_code’: ‘string’, ‘vat_value’: 0 } ], ‘sender_tax_number’: ‘string’, ‘trade_participant_inn’: ‘string’ }



country_oksm string + Exporter country code

Three-digit numeric code from OKSM: 112 – Belarus; 417 – Kyrgyzstan; 487 – Kazakhstan; 051 – Armenia

exporter_name string + Name of the exporter

import_date string + Import date Set in yyyy-MM-dd format

primary_document_date string + Date of primary document confirming transfer of goods


primary_document_number string + Number of primary document

163


confirming transfer of goods


*certificate_date string (date)

- Date of document confirming compliance


*certificate_number string - Number of document on mandatory certification

*certificate_type string - Type of document confirming compliance


*cost integer - Unit price Cost is specified in kopecks

*ki string - Unique identifier of goods item

Mandatory if kitu is not specified

*kitu string - Unique identifier of shipping package

Mandatory if ki is not specified

*tnved_code string + 10-digit EEU FEACN code of goods

*vat_value integer - VAT amount Cost is specified in kopecks

sender_tax_number string + Sender’s taxpayer number

trade_participant_inn string + INN of participant who emitted MC


Economic agent INN,Sender tax payer number,Exporter name,Country code,Import date,Number of source document confirming goods movement,Date of source document confirming goods movement,Version 0000000000,UNIQUE ID,Romashka LLC,010,12.04.2019,123,12.04.2019,1 Goods parameters IC,SPIC,Goods nomenclature code (10 characters),Price per unit,VAT amount,Compliance document type,Compliance document number,Compliance document date ‘00000000000000000000000000000000000000’,,000000000,1000,0,Compliance

164

certificate,123,12.04.2019 ,’111111111111111111’,0000000000,1000,0,Compliance certificate,123,12.04.2019


<?xml version=‘1.0’ encoding=‘UTF-8’?> <vvod_crossborder action_id=‘5.5’ version=‘1’> <trade_participant_inn>00000000</trade_participant_inn> <sender_tax_number>UNIQUE ID</sender_tax_number> <exporter_name>ООО Ромашка</exporter_name> <country_oksm>000</country_oksm> <import_date>12.04.2019</import_date> <primary_document_number>123</primary_document_number> <primary_document_date>12.04.2019</primary_document_date> <products_list> <product> <ki>00000000000000000000000000000000000000</ki> <tnved_code>000000000</tnved_code> <cost>1000</cost> <vat_value>10</vat_value> <certificate_type>CONFORMITY_DECLARATION</certificate_type> <certificate_number>123</certificate_number> <certificate_date>12.04.2019</certificate_date> </product> <product> <kitu>111111111111111111</kitu> <tnved_code>000000000</tnved_code> <cost>1000</cost> <vat_value>10</vat_value> <certificate_type>CONFORMITY_DECLARATION</certificate_type> <certificate_number>123</certificate_number> <certificate_date>12.04.2019</certificate_date> <children_products_list> <product> <ki>0000000000000000000000000000000001</ki> <tnved_code>0000000000</tnved_code> <cost>1000</cost> <vat_value>10</vat_value> <certificate_type>CONFORMITY_DECLARATION</certificate_type> <certificate_number>123</certificate_number> <certificate_date>12.04.2019</certificate_date> </product> </children_products_list> </product> </products_list> </vvod_crossborder>

2.2.4.5. Introduction into circulation. In the territory of EEU countries (contract manufacturing)

This method is only used for ‘Dairy products’ goods group.

165

Type of document:

Type Description

LP_INTRODUCE_GOODS_CROSSBORDER_CSD Introduction into circulation. In the territory of EEU countries (contract manufacturing). JSON (MANUAL)

LP_INTRODUCE_GOODS_CROSSBORDER_CSD_CSV Introduction into circulation. In the territory of EEU countries (contract manufacturing). CSV

LP_INTRODUCE_GOODS_CROSSBORDER_CSD_XML Introduction into circulation. In the territory of EEU countries (contract manufacturing). XML


{ ‘country_oksm’: ‘string’ , ‘exporter_name’: ‘string’ , ‘import_date’: ‘2020-01-23’ , ‘primary_document_date’: ‘2020-01-23’ , ‘primary_document_number’: ‘string’ , ‘vsd_number’: ‘AVD number’ , ‘products_list’: [ { ‘certificate_date’: ‘2020-01-23’ , ‘certificate_number’: ‘string’ , ‘certificate_type’: ‘string’ , ‘ki’: ‘string’ , ‘kitu’: ‘string’ , ‘tnved_code’: ‘string’ } ] , ‘sender_tax_number’: ‘string’ , ‘trade_participant_inn’: ‘string’ }



country_oksm string + Exporter country code

Three-digit numeric code from OKSM: 112 – Belarus; 417 – Kyrgyzstan; 487 – Kazakhstan; 051 – Armenia

exporter_name string + Name of the exporter

import_date string + Import date Set in yyyy-MM-dd format

primary_document_date string + Date of primary document confirming transfer of goods


166


primary_document_number string + Number of primary document confirming transfer of goods

vsd_number string + AVD number Information on accompanying veterinary documents (accompanying shipping document)








*ki string - Unique identifier of goods item

Mandatory if kitu is not specified

*kitu string - Unique identifier of shipping package

Mandatory if ki is not specified

*tnved_code string + 10-digit EEU FEACN code of goods

sender_tax_number string + Sender’s taxpayer number



Economic agent INN,Sender tax payer number,Exporter name,Country code,Import date,Number of source document confirming goods movement,Date of source document confirming goods movement,VAD number,Version 0000000000,TAXPAYER ID,Exporter№1,010,01.09.2019,123,01.09.2019,VAD number,2 Goods parameters IC,SPIC,Goods EEU FECN code,Compliance document type,Compliance document

167

number,Compliance document date ‘00000000000000000000000000000000000000’,,0000000000,Compliance certificate,123,01.01.2019 ,111111111111111111,000000000,Compliance certificate,123,01.01.2019


<?xml version=‘1.0’ encoding=‘UTF-8’?> <vvod_crossborder version=‘2’> <trade_participant_inn>0000000000</trade_participant_inn> <sender_tax_number>TAXPAYER ID</sender_tax_number> <exporter_name>Экпортер №1</exporter_name> <country_oksm>000</country_oksm> <import_date>01.09.2019</import_date> <primary_document_number>123</primary_document_number> <primary_document_date>01.09.2019</primary_document_date> <vsd_number>VAD number</vsd_number> <products_list> <product> <ki>0000000000000000000000000000000000</ki> <tnved_code>000000000</tnved_code> <certificate_type>CONFORMITY_DECLARATION</certificate_type> <certificate_number>123</certificate_number> <certificate_date>01.09.2019</certificate_date> </product> <product> <kitu>111111111111111111</kitu> <tnved_code>000000000</tnved_code> <certificate_type>CONFORMITY_DECLARATION</certificate_type> <certificate_number>123</certificate_number> <certificate_date>01.09.2019</certificate_date> </product> </products_list> </vvod_crossborder>

2.2.4.6. Introduction into circulation. Remains marking

Type of document:

Type Description

LP_INTRODUCE_OST Introduction into circulation. Remains marking. JSON (MANUAL)

LP_INTRODUCE_OST_CSV Introduction into circulation. Remains marking. CSV

LP_INTRODUCE_OST_XML Introduction into circulation. Remains marking. XML


{ ‘products_list’: [ { ‘certificate_date’: ‘2020-01-23’, ‘certificate_number’: ‘string’, ‘certificate_type’: ‘string’, ‘country’: ‘string’, ‘declaration_date’: ‘2020-01-23’,

168

‘declaration_number’: ‘string’, ‘ki’: ‘string’, ‘kitu’: ‘string’ } ], ‘trade_participant_inn’: ‘string’ }




products_list array - List of information on goods

*certificate_date string(date) - Date of document on mandatory certification




A type of mandatory certification document: CONFORMITY_CERTIFICATE - certificate of conformity; CONFORMITY_DECLARATION - declaration of conformity

*country string - Country of production

Country code as per OKSM is specified. For example, code 112 is for Belarus.

*declaration_date string - CD registration date


*declaration_number string - CD registration number

*ki string - IC Mandatory if kitu is not specified

*kitu string - SPIC Mandatory if kit is not specified


Economic agent INN,Version 1111111111,2 Goods parameters IC,SPIC,Country of manufacture,CD registration date,CD registration number,Compliance document type,Compliance document number,Compliance document date

169

‘00000000000000000000000000000’,,111,12.04.2019,123456,Compliance certificate,123456,12.04.2019


<?xml version=‘1.0’ encoding=‘UTF-8’?> <vvod_ostatky version=‘2’ action_id=‘5.4’> <trade_participant_inn>1111111111</trade_participant_inn> <products_list> <product> <ki>00000000000000000000000000000</ki> <country>111</country> <declaration_date>12.04.2019</declaration_date> <declaration_number>123456</declaration_number> <certificate_type>CONFORMITY_CERTIFICATE</certificate_type> <certificate_number>123456</certificate_number> <certificate_date>12.04.2019</certificate_date> </product> </products_list> </vvod_ostatky>

2.2.4.7. Introduction into circulation. Contract manufacturing in the Russian Federation

Type of document:

Type Description

LK_CONTRACT_COMMISSIONING Introduction into circulation. Contract manufacturing in the Russian Federation. JSON (MANUAL)

LK_CONTRACT_COMMISSIONING _CSV Introduction into circulation. Contract manufacturing in the Russian Federation. CSV

LK_CONTRACT_COMMISSIONING_XML Introduction into circulation. Contract manufacturing in the Russian Federation. XML


{ ‘producer_inn’: ‘string’ , ‘owner_inn’: ‘string’ , ‘production_date’: ‘2019-04-01’, ‘production_order’: ‘CONTRACT_PRODUCTION’ , ‘products_list’: [ { ‘uit’: ‘string’ , ‘uitu’: ‘string’ , ‘tnved_code’: ‘string’ , ‘production_date’: ‘2019-04-01’, ‘certificate_doc_type’: ‘CONFORMITY_CERTIFICATE’ , ‘certificate_doc_number’: ‘string’ , ‘certificate_doc_date’: 0 } ] , ’owner’: true ,

170

’producer’: true }



producer_inn string + INN of goods manufacturer

owner_inn string + INN of goods owner

production_date string + Date of goods production


production_order string + Production order type

CONTRACT_PRODUCTION – Production of goods under a contract

owner boolean + ‘I am owner’ attribute

If producer = true, then field = false

producer boolean + ‘I am manufacturer’ attribute

If owner = true, then field = false

products_list array + List of goods for introduction into circulation

*certificate_doc_date string - Date of document on mandatory certification


*certificate_doc_type string - Type code of document on mandatory certification


*certificate_doc_number string - Number of document on mandatory certification

*production_date string + Date of goods manufacture from general data on goods introduction into circulation

Parameter is in the request if its value differs from that of production_date parameter (No. 6 in this table).







171


Manufacturer or importer INN,Owner INN,Manufacture date,Production order date,Version 1111111111,2222222222,12.04.2019,Contract manufacturing,2 Goods parameters IC,SPIC,Goods item EEU FEACN code,Manufacture date,Compliance document type,Compliance document number,Compliance document date ‘000000000000000000000000000000000000’,’000000000000000000’,0000000000,12.04.2019,Compliance certificate,12345,12.04.2019


<?xml version=‘1.0’ encoding=‘UTF-8’?> <vvod_contract_production action_id=‘5.2’ version=‘3’> <producer_inn>1111111111</producer_inn> <owner_inn>2222222222</owner_inn> <production_date>12.04.2019</production_date> <production_order>CONTRACT_PRODUCTION</production_order> <products_list>  <product>  <kit>000000000000000000000000000000000000</kit> <tnved_code>0000000000</tnved_code> <production_date>12.04.2019</production_date> <certificate_type>CONFORMITY_CERTIFICATE</certificate_type> <certificate_number>12345</certificate_number> <certificate_date>12.04.2019</certificate_date> </product> <product>  <kitu>000000000000000000</kitu> <tnved_code>0000000000</tnved_code> <production_date>12.04.2019</production_date> <certificate_type>CONFORMITY_CERTIFICATE</certificate_type> <certificate_number>12345</certificate_number> <certificate_date>12.04.2019</certificate_date> </product> </products_list> </vvod_contract_production>

2.2.4.8. Introduction into circulation. Import with FCS

When information is provided with LP_FTS_INTRODUCE ‘Introduction into circulation Import with FCS‘ method, declaration date is verified. If the declaration date is earlier than 2020-08-01, the document is processed with LP_GOODS_IMPORT ‘Introduction into circulation. Manufacturing outside of EEU‘ method; otherwise, it is processed with LP_FTS_INTRODUCE (Introduction into circulation. Import with FCS) and and LP_GOODS_IMPORT (Introduction into circulation. Import outside EAEU) method.

ATC or SPIC are not disaggregated in describing colour and size for ’Footwear’ goods group.

172

Type of document:

Type Description

LP_FTS_INTRODUCE Introduction into circulation. Import with FCS. JSON (MANUAL)

LP_FTS_INTRODUCE_CSV Introduction into circulation. Import with FCS. CSV

LP_FTS_INTRODUCE_XML Introduction into circulation. Import with FCS. XML


{ ‘trade_participant_inn’: ‘000000000’, ‘declaration_number’: ‘11111111/222222/3333333’, ‘declaration_date’: ‘01.03.2020’, ‘products_list’: [ { ‘cis’: ‘11111111111111111111111111111111111111’, ‘packType’: ‘UNIT’, ‘colour’: ‘RED’, ‘productSize’: ‘20.5’ } , { ‘cis’: ‘333333333333333333’, ‘packType’: ‘LEVEL1’, ‘colour’: ‘RED’, ‘productSize’: ‘20.5’, ‘children’: [ { ‘cis’: ‘00000000000000000000000000000000000001’, ‘packType’: ‘UNIT’, ‘colour’: ‘RED’, ‘productSize’: ‘20.5’ } ] } , { ‘cis’: ‘4444444444444444444444444’, ‘packType’: ‘ATK’ , ‘colour’: ‘RED’ , ‘productSize’: ‘20.5’ , ‘children’: [ { ‘cis’: ‘00000000000000000000000000000000000002’, ‘packType’: ‘UNIT’ , ‘colour’: ‘RED’ , ‘productSize’: ‘20.5’ } ] } ] }


173



declaration_number string + CD registration number

declaration_date string + CD registration date

Set in dd.mm.yyyy format. Range of dates from 01.01.2000 till the document creation date

products_list: + List of goods for introduction into circulation

*cis string + Unique identifier of goods item

IC or SPIC or ATC is specified "Note: in the current implementation of the import document functionality, it is only possible to specify the IC"

*packType string + Package type UNIT - IC; LEVEL1-99 - SPIC; ATK - aggregated customs code

*colour string - Colour Colour value containing 1-1024 letters in English or Russian is specified. Only Footwear GG is used

*productSize string - Size in the stitch system as per GOST 11373-88

A single size can be specified; specifying a range is not available. Size can be specified in decimal point format. A multiple of 0.5 in 14.5 - 47 range. Only Footwear GG is used

*children: array - Goods in packing

**cis string + Unique identifier of goods item

IC or SPIC or ATC is specified "Note: in the current implementation of the import document functionality, it is only possible to specify the IC"

**packType string - Package type UNIT - IC; LEVEL1-99 - SPIC; ATK - aggregated customs code

**colour string - Colour Colour value containing 1-1024 letters in English or Russian is specified. Only Footwear GG is used

**productSize string - Size in the stitch system as per GOST 11373-88

A single size can be specified; specifying a range is not available. Size can be specified in decimal point format. A multiple of 0.5 in 14.5 - 47 range. Only Footwear GG is used


Participant INN,CD registration number,CD registration date,Version 1234567891,12345678/345678/7654321,01.03.2020,1 Goods parameters ATC,IC,SPIC,Colour,Size ,11111111111111111111111111111111111111,,RED,20.5

174

,22222222222222222222222222222222222222,,RED,20.5 ,,333333333333333333,RED,20.5 4444444444444444444444444,,,RED,20.5


<vvod_import_fts version=‘1’> <trade_participant_inn>7724211288</trade_participant_inn> <declaration_number>11111111/222222/3333333</declaration_number> <declaration_date>2020-03-01</declaration_date> <products_list> <product> <ki>11111111111111111111111111111111111111</ki> <colour>RED</colour> <product_size>20.5</product_size> </product> <product> <ki>22222222222222222222222222222222222222</ki> <colour>RED</colour> <product_size>20.5</product_size> </product> <product> <kitu>333333333333333333</kitu> <colour>RED</colour> <product_size>20.5</product_size> <children> <product> <ki>00000000000000000000000000000000000001</ki> <colour>RED</colour> <product_size>20.5</product_size> </product> </children> </product> <product> <atk>4444444444444444444444444</atk> <colour>RED</colour> <product_size>20.5</product_size> <children> <product> <ki>00000000000000000000000000000000000002</ki> <colour>RED</colour> <product_size>20.5</product_size> </product> </children> </product> </products_list> </vvod_import_fts>

2.2.5. ACC aggregation

The method is not applicable for goods groups ‘Dairy products’, ‘Bottled water’, ‘Bicycles and bicycle frames’, ‘Wheelchairs’ and ‘Alternative tobacco products’.

175

Type of document:

Type Description

ATK_AGGREGATION ACC aggregation. JSON (MANUAL)

ATK_AGGREGATION_CSV ACC aggregation. CSV

ATK_AGGREGATION_XML ACC aggregation. XML


{ ‘trade_participant_inn’: ‘1111111111’, ‘products_list’: [ { ‘ki’: ‘11111111111111111111111111111111111111‘ }, { ‘ki’: ‘22222222222222222222222222222222222222’ } ] }



trade_participant_inn string + INN of goods circulation participant

products_list array + List of identification codes

*ki string + Identification code Only IC numbers are specified. Entering SPIC or IC included in SPIC or other ATC is not allowed in this field


Economic agent INN,Version 1111111111,1 Goods parameters IC 11111111111111111111111111111111111111 22222222222222222222222222222222222222

Example of document body in xml format:

<atk_aggregation version=‘1’> <trade_participant_inn>1111111111</trade_participant_inn> <product_list> <packing_product> <ki>11111111111111111111111111111111111111</ki> </packing_product>

176

<packing_product> <ki>22222222222222222222222222222222222222</ki> </packing_product> </product_list> </atk_aggregation>

2.2.6. ACC reaggregation


Type of document:

Type Description

ATK_TRANSFORMATION ACC reaggregation. JSON (MANUAL)

ATK_TRANSFORMATION_CSV ACC reaggregation. CSV

ATK_TRANSFORMATION_XML ACC reaggregation. XML


{ ‘trade_participant_inn’: ‘1111111111’, ‘atk’: ‘1111111111111111111111111’, ‘transformation_type’: ‘REMOVING’, ‘products_list’: [ { ‘ki’: ‘22222222222222222222222222222222222222‘ }, { ‘ki’: ‘33333333333333333333333333333333333333’ } ] }




atk string + Aggregated customs code to be reaggregated

transformation_type string + Type of reaggregation Removal – REMOVING; Addition – ADDING

products_list array + List of identification codes

*ki string + Identification code

177


Economic agent INN,transformation type,aggregated customs code,Version 1111111111,Withdrawal,1111111111111111111111111,2 List of goods IC 22222222222222222222222222222222222222 33333333333333333333333333333333333333

Example of document body in xml format:

<atk_transformation version=‘1’> <trade_participant_inn>1111111111</trade_participant_inn> <transformation_type>REMOVING</transformation_type> <atk>1111111111111111111111111</atk> <product_list> <product> <ki>22222222222222222222222222222222222222</ki> </product> <product> <ki>33333333333333333333333333333333333333</ki> </product> </product_list> </atk_transformation>

2.2.7. ACC disaggregation


Type of document:

Type Description

ATK_DISAGGREGATION ACC disaggregation. JSON (MANUAL)

ATK_DISAGGREGATION_CSV ACC disaggregation. CSV

ATK_DISAGGREGATION_XML ACC disaggregation. XML


{ ‘trade_participant_inn’: ‘1111111111’, ‘products_list’: [ { ‘atk’: ‘1111111111111111111111111’ }, { ‘atk’: ‘2222222222222222222222222’ } ] }

178




products_list array + List of ACC to be disaggregated

atk string - ACC


Economic agent INN,Version 1111111111,2 List of shipping packages 1111111111111111111111111 2222222222222222222222222


<atk_disaggregation version=‘1’> <trade_participant_inn>1111111111</trade_participant_inn> <product_list> <product> <atk>1111111111111111111111111</atk> </product> <product> <atk>2222222222222222222222222</atk> </product> </product_list> </atk_disaggregation>

2.2.8. Return into circulation

Type of document:

Type Description

LP_RETURN Return into circulation. JSON (MANUAL)

LP_RETURN_CSV Return into circulation. CSV

LP_RETURN_XML Return into circulation. XML


{ ‘certificate_date’: ‘2020-01-23’, ‘certificate_number’: ‘string’, ‘certificate_type’: ‘string’, ‘paid’: true, ‘primary_document_custom_name’: ‘string’, ‘primary_document_date’: ‘2020-01-23’, ‘primary_document_number’: ‘string’, ‘primary_document_type’: ‘string’,

179

‘products_list’: [ { ‘certificate_date’: ‘2020-01-23’, ‘certificate_number’: ‘string’, ‘certificate_type’: ‘string’, ‘ki’: ‘string’, ‘paid’: true, ‘primary_document_custom_name’: ‘string’, ‘primary_document_date’: ‘2020-01-23’, ‘primary_document_number’: ‘string’, ‘primary_document_type’: ‘string’ } ], ‘return_type’: ‘RETAIL_RETURN’, ‘trade_participant_inn’: ‘string’ }



certificate_date string (date)



certificate_number string - Number of document confirming compliance

certificate_type string - Type of document confirming compliance


paid boolean - Goods item was paid by buyer

Goods payment attribute

primary_document_date string (date)

- Date of primary document

Set in yyyy-MM-dd format. Mandatory for return types ‘Retail return’ and ‘Remote return’ with Goods payment attribute’ = true

primary_document_number string - Number of primary document

Mandatory for return types ‘Retail return’ and ‘Remote return’ with Goods payment attribute’ = true

primary_document_type enum - Type of primary document

RECEIPT – Cash register receipt; SALES_RECEIPT – Sales receipt; OTHER – Other. Mandatory for return types ‘Retail return’ and ‘Remote return’ with Goods payment attribute’ = true

180


primary_document_custom_name string - Name of primary document

Mandatory if ‘OTHER – Other’ is specified in the ‘Type of primary document’ field





*certificate_number string - Number of document confirming compliance


A type of supporting document: CONFORMITY_CERTIFICATE - certificate of conformity; CONFORMITY_DECLARATION - declaration of conformity

*ki string - Identification code

*paid boolean - Goods item is paid

Goods payment attribute

*primary_document_custom_name string - Name of primary document

Mandatory if ’Other’ is specified in the ‘Type of primary document’ field

*primary_document_date string (date)

+ Date of primary document


*primary_document_number string + Number of primary document

*primary_document_type enum + Type of primary document

RECEIPT – Cash register receipt; SALES_RECEIPT – Sales receipt; OTHER – Other.

return_type string + Type of return

RETAIL_RETURN – Return at retail sale; REMOTE_SALE_RETURN – Return at remote sale; RECEIPT_RETURN – Return receipt


181


Economic agent INN,Return type,Paid by customer,Source document type,source document name,Source document number,Source document date,Compliance document type,Compliance document number,Compliance document date,Version 00000000,Return at retail sale,Yes,Sales receipt,,12345,12.04.2019,Compliance certificate,12345,12.04.2019,1 Goods parameters,,,,,,,,,, IC,Paid by customer,Source document type,Source document name,Source document number,Source document date,Compliance document type,Compliance document number,Compliance document date,, ‘00000000000000000000000000000000000000’,Yes,Sales receipt,,12345,12.04.2019,Compliance certificate,12345,12.04.2019,,


<?xml version=‘1.0’ encoding=‘UTF-8’?> <return action_id=‘34’ version=‘1’> <trade_participant_inn>000000000</trade_participant_inn> <return_type>RETAIL_RETURN</return_type> <paid>true</paid> <primary_document_type>RECEIPT</primary_document_type> <primary_document_custom_name>limited issue form</primary_document_custom_name> <primary_document_number>12345</primary_document_number> <primary_document_date>12.04.2019</primary_document_date> <certificate_type>CONFORMITY_CERTIFICATE</certificate_type> <certificate_number>12345</certificate_number> <certificate_date>12.04.2019</certificate_date> <products_list> <product> <ki>00000000000000000000000000000000000000</ki> <paid>true</paid> <primary_document_type>RECEIPT</primary_document_type> <primary_document_custom_name>custom_name</primary_document_custom_name> <primary_document_number>12345</primary_document_number> <primary_document_date>12.04.2019</primary_document_date> <certificate_type>CONFORMITY_CERTIFICATE</certificate_type> <certificate_number>12345</certificate_number> <certificate_date>12.04.2019</certificate_date> </product> </products_list> </return>

182

2.2.9. Shipping

Type of document:

Type Description

LP_SHIP_GOODS Shipping. JSON (MANUAL)

LP_SHIP_GOODS_CSV Shipping. CSV

LP_SHIP_GOODS_XML Shipping. XML


{ ‘document_date’: ‘2020-04-20T14:02:19.813Z’, ‘transfer_date’: ‘2020-04-20T14:02:19.813Z’, ‘document_num’: ‘123’, ‘receiver_inn’: ‘000000000’, ‘turnover_type’: ‘SELLING’, ‘sender_inn’: ‘0000000000’, ‘to_not_participant’: false, ‘products’: [ { ‘product_description’: ‘Remains’, ‘uit_code’: ‘00000000000000000000000’, ‘product_cost’: 1000, ‘product_tax’: 200 } ], }



document_num string + Number of primary document

document_date string + Date of primary document Set in yyyy-MM-dd format

transfer_date array + Date of transfer of marked goods


products array + List of information on goods





*product_description string + Product name

*product_cost integer - Unit price Cost is specified in kopecks, including VAT.

*product_tax integer - VAT amount VAT amount is specified in

183


kopecks

receiver_inn string + INN of receiver

sender_inn string - INN of sender

to_not_participant boolean - Attribute of shipping to non-participant

Possible values: true – shipping to non-participant; false – shipping to participant

turnover_type string + Shipping type code Possible values: SELLING – selling; COMMISSION – commission; AGENT – agent


Sender INN,Receiver INN,Owner INN,Goods receipt data,Source document number,Source document date,Goods circulation type,Withdrawal reason, Withdrawal date,State contract identifier,Shipment to non-participant,Version 1111111111,2222222222,1111111111,25.05.2020,123,25.05.2020,Sale,,,,No,4 Goods parameters IC,SPIC,Price per unit,VAT amount ‘0000000000000000000000000000000’,,100,10


<?xml version=‘1.0’ encoding=‘UTF-8’?> <shipment action_id=‘10’ version=‘5’> <trade_participant_inn_sender>0000000000</trade_participant_inn_sender> <trade_participant_inn_receiver>0000000000</trade_participant_inn_receiver> <transfer_date>12.04.2019</transfer_date> <move_document_number>123</move_document_number> <move_document_date>12.04.2019</move_document_date> <turnover_type>SELLING</turnover_type> <to_not_participant>true</to_not_participant> <products_list> <product> <ki>00000000000000000000000000000000000000</ki> <cost>330305</cost> <vat_value>27085</vat_value> </product> </products_list> </shipment>

2.2.10. Shipping with withdrawal from circulation

Type of document:

Type Description

LP_SHIP_RECEIPT Shipping with withdrawal from circulation. JSON (MANUAL)

184

Type Description

LP_SHIP_RECEIPT _CSV Shipping with withdrawal from circulation. CSV

LP_SHIP_RECEIPT _XML Shipping with withdrawal from circulation. XML


{ ‘document_date’: ‘2019-01-01’ , ‘document_num’: ‘document number’ , ‘products’: [ { ‘product_cost’: 33030 , ‘product_tax’: 270 , ‘uit_code’: ‘00000000000000000000000000000000000001’ } , { ‘product_cost’: 33030 , ‘product_tax’: 270 , ‘uitu_code’: ‘111111111111111111’ } ] , ‘receiver_inn’: ‘receiver’ , ‘request_type’: ‘SHIPMENT’ , ‘transfer_date’: ‘2019-01-01’ , ‘turnover_type’: ‘SELLING’ , ‘sender_inn’: ‘sender’ , ‘withdrawal_type’: ‘NO_RETAIL_USE’ , ‘withdrawal_date’: ‘2019-10-01’ , ‘to_not_participant’: false }




document_date string + Date of primary document








*product_tax integer - VAT amount


185


request_type string + Document type Parameter value shall be = SHIPMENT

transfer_date string + Date of transfer of marked goods


turnover_type string + Shipping type code Possible values: SELLING – selling

sender_inn string - INN of sender

st_contract_id string - Identifier of state contract

Mandatory if ‘withdrawal_type’ = ‘STATE_ENTERPRISE’



withdrawal_date string + Date of withdrawal from circulation


withdrawal_type enum + Reason for withdrawal from circulation

Reason for withdrawal from circulation: DONATION – non-compensatory transfer; STATE_ENTERPRISE – acquisition by a government-owned enterprise; NO_RETAIL_USE – used by customer for internal purposes


Sender INN,Receiver INN,Shipment date,Source document number,Source document date,Goods circulation type,Reason for withdrawal,Withdrawal date,State contract ID,Shipment to non-participant,Version 1111111111,2222222222,06.05.2020,123,06.05.2020,Sale,Acquisition by a state enterprise,06.05.2020,12345678912345678912,No,5 Goods parameters IC,SPIC,Price per unit,VAT amount ‘000000000000000000qqqqqqqqqqqqq’,,10000,0


<?xml version=‘1.0’ encoding=‘UTF-8’?> <shipment action_id=‘10’ version=‘5’> <trade_participant_inn_sender>0000000000</trade_participant_inn_sender> <trade_participant_inn_receiver>0000000000</trade_participant_inn_receiver> <transfer_date>01.01.2020</transfer_date> <move_document_number>12345678901234567890</move_document_number> <move_document_date>01.01.2020</move_document_date> <turnover_type>SELLING</turnover_type>  <withdrawal_type>STATE_ENTERPRISE</withdrawal_type> 

186

<withdrawal_date>01.01.2020</withdrawal_date>  <st_contract_id>string</st_contract_id> <products_list>  <product>  <ki>00000000000000000000000000000</ki>  <cost>100000</cost>  <vat_value>100000</vat_value> </product> </products_list> </shipment>

2.2.11. Shipment at cross-border trading






Type of document:

Type Description

LP_SHIP_GOODS_CROSSBORDER Shipment at cross-border trading. JSON (MANUAL)


{ ‘document_date’: ‘2020-04-20T14:02:19.813Z’, ‘transfer_date’: ‘2020-04-20T14:02:19.813Z’, ‘document_num’: ‘123’, ‘receiver_inn’: ‘000000000’, ‘receiver’: ‘Ltd.’, ‘sender_inn’: ‘000000000’, ‘sender’: ‘Belarussian operator’, ‘to_not_participant’: false, ‘request_type’: ‘SHIPMENT’, ‘release_method’: ‘CROSSBORDER’, ‘products’: [ { ‘product_description’: ‘Remains’, ‘uit_code’: ‘00000000000000000000000000’, ‘product_cost’: 1000, ‘product_tax’: 200

187

} ], ‘exporter_taxpayer_id’:’000000000’, ‘exporter_name’:’BelObuvExport’ }





Set in yyyy-MM-ddTHH:mm:ss.SSS’ZTHH:mm:ss.SSS’Z format

transfer_date array + Date of transfer of marked goods







*product_description string + Product name


*product_tax integer - VAT amount VAT amount is specified in kopecks



sender_inn string - INN of sender or its equivalent in a EEU country




request_type string - Document type Parameter value shall be = SHIPMENT

release_method string - Method of goods introduction into circulation

Parameter shall assume value = ‘CROSSBORDER’

exporter_taxpayer_id string - Unique identifier of the exporter in the national taxpayer accounting system

188


exporter_name string - Name of the exporter

2.2.12. Cancelling shipment

Type of document:

Type Description

LP_CANCEL_SHIPMENT Cancelling shipment. JSON (MANUAL)


{ ‘participant_inn’: ‘string’, ‘pdfFile’: ‘string’, ‘shipment_number’: ‘string’ }



pdfFile string - Attached PDF file in Base64

shipment_number string + Number of document for shipping

2.2.13. Cancelling shipment at cross-border trading






Type of document:

Type Description

LP_CANCEL_SHIPMENT_CROSSBORDER Cancelling shipment at cross-border trading. JSON (MANUAL)


{ ‘participant_inn’: ‘0000000000’,

189

‘shipment_number’: ‘00000000-0000-0000-0000-000000000000’ }



participant_inn string + INN of goods circulation participant or its equivalent in a EEU country

shipment_number string + Number of document for shipping

2.2.14. Acceptance

Type of document:

Type Description

LP_ACCEPT_GOODS Acceptance. JSON (MANUAL)

LP_ACCEPT_GOODS_XML Acceptance. XML


{ ‘document_number’: ‘1221’, ‘request_type’: ‘ACCEPTANCE’, ‘reject_all’: boolean, ‘document_date’: ‘2020-06-09T00:00:00Z’, ‘accept_all’: boolean, ‘trade_sender_name’: ‘ООО’, ‘transfer_date’: ‘2020-06-09T00:00:00Z’, ‘acceptance_date’: ‘2020-06-09T00:00:00Z’, ‘trade_sender_inn’: ‘000000000’, ‘trade_recipient_inn’: ‘000000001’, ‘turnover_type’: ‘‘, ‘release_order_number’: ‘00000000-0000-0000-0000-000000000000’, ‘products’: [ { ‘uitu_code’: ‘000000000000000001’, ‘product_description’: ‘-’, ‘children’: [ { ‘uit_code’: ‘0000000000000000000000000000002’, ‘product_description’: ‘description’, ‘product_cost’: 3808333, ‘product_tax’: 634722 }, { ‘uit_code’: ‘0000000000000000000000000000003’, ‘product_description’: ‘description’ } ], ‘count_children’: 3,

190

’accepted’: true }, { ‘uitu_code’: ‘000000000000000004’, ‘product_description’: ‘-’, ‘children’: [ { ‘uit_code’: ‘0000000000000000000000000000005’, ‘product_description’: ‘description’ }, { ‘uit_code’: ‘0000000000000000000000000000007’, ‘product_description’: ‘description’ } ], ‘count_children’: 2, ’accepted’: true } ], ‘exporter_taxpayer_id’: ‘‘, ‘exporter_name’: ‘‘, ‘release_method’: ‘‘ }



document_number string - Number of primary document

request_type string + Document type Parameter value shall be = ‘ACCEPTANCE’

reject_all boolean - Reject all If value is true, specifying goods list is not required: rejects all

document_date string (date-time)



accept_all boolean - Accept all If value is true, specifying goods list is not required: accepts all

trade_sender_name string - Sender name

transfer_date string (date-time)

- Date of goods transfer


acceptance_date string (date-time)

+ Date of goods acceptance


trade_sender_inn string + INN of sender

trade_recipient_inn string + INN of receiver

turnover_type string - Shipping type Possible values: SELLING – selling;

191


code COMMISSION – commission; AGENT – agent

release_order_number string + Shipment number


*accepted boolean + Goods acceptance attribute



*uitu_code string - Unique identifier of goods item



*product_tax integer - VAT amount VAT amount is specified in kopecks

*product_description string - Goods description

*children array - IC in aggregate Information about nested MC for partial acceptance

*count_children integer (int32)


exporter_taxpayer_id string - Unique identifier of the exporter in the national taxpayer accounting system

Parameter is only specified for acceptance of Cancelling shipment at cross-border trading document

exporter_name string - Name of the exporter

Parameter is only specified for acceptance of Cancelling shipment at cross-border trading document

release_method string - Code of method of introduction into circulation

This parameter is only specified for Shipment at cross-border trading document acceptance, and it must be equal to ‘CROSSBORDER’

Note: in Acceptance document, only IC/SPIC eligible for this shipment may be specified; unspecified IC/SPIC are not accepted by default. If a non-integral SPIC is accepted, only IC which will be accepted in SPIC may also be specified

192


<?xml version=‘1.0’ encoding=‘UTF-8’?> <acceptance action_id=‘11’ version=‘6’> <shipment_id>57250cce-52cf-408b-99ef-39cc239f60fd</shipment_id> <trade_participant_inn_sender>0000000000</trade_participant_inn_sender> <trade_participant_inn_receiver>0000000000</trade_participant_inn_receiver> <shipment_date>2019-11-18T21:00:00.000Z</shipment_date> <reception_date>2019-11-18T21:00:00.000Z</reception_date> <transfer_date>12.04.2019</transfer_date> <move_document_number>784378438</move_document_number> <move_document_date>12.04.2019</move_document_date> <turnover_type>SELLING</turnover_type> <products_list>  <product> <ki>000000000000000000000000000000000</ki> <accept_type>true</accept_type> </product> </products_list> </acceptance>

2.2.15. Withdrawal from circulation

Type of document:

Type Description

LK_RECEIPT Withdrawal from circulation. JSON (MANUAL)

LK_RECEIPT_CSV Withdrawal from circulation. CSV

LK_RECEIPT_XML Withdrawal from circulation. XML


{ ‘action‘: ‘string’, ‘action_date’: ‘2020-01-23’, ‘document_date’: ‘2020-01-23’, ‘document_number’: ‘string’, ‘document_type’: ‘string’, ‘inn’: ‘string’, ‘kkt_number’: ‘string’, ‘pdfFile’: ‘string’, ‘primary_document_custom_name’: ‘string’, ‘products’: [ { ‘cis’: ‘string’, ‘primary_document_date’: ‘2020-05-26’, ‘primary_document_number’: ‘1222’, ‘primary_document_type’: ‘SALES_RECEIPT’, ‘primary_document_custom_name’: ‘string’, ‘product_cost’: 0

193

} ] }



action enum + Reason for withdrawal from circulation

Reason for withdrawal fro circulation: RETAIL – Retail sale; EEC_EXPORT – Export to EEU countries; BEYOND_EEC_EXPORT – Export outside the EEU countries; RETURN – Return to individual; REMOTE_SALE – Sale by sample, remote sale; DAMAGE_LOSS – Loss or damage; DESTRUCTION – Destruction; CONFISCATION – Confiscation; LIQUIDATION – Liquidation of business; ENTERPRISE_USE – Use for purposes of enterprise

action_date string + Date of withdrawal from circulation




document_number string + Number of primary document

document_type enum + Type of primary document

Type of primary document depends on ’action’ parameter:

RETAIL – retail sale: RECEIPT – register receipt; SALES_RECEIPT – sales receipt; OTHER – Other (with indication of name manually)

BEYOND_EEC_EXPORT – export beyond EAEU: CUSTOMS_DECLARATION – customs declaration for goods

EEC_EXPORT – export to EAEU countries: CONSIGNMENT_NOTE – Consignment note; UTD – Universal transfer document; OTHER – Other (with indication of

194


name manually)

RETURN – return to a physical entity: OTHER – Other (with indication of name manually)

REMOTE_SALE – sale on sample and remote sales: RECEIPT – Cash register receipt; SALES_RECEIPT – Sale receipt; CONSIGNMENT_NOTE – Packing list; UTD – Universal transfer document; OTHER – Other

DAMAGE_LOSS – Loss or damage: DESTRUCTION_ACT – Certificate of destruction (loss/disposal); OTHER – Other (with indication of name manually)

Destruction: DESTRUCTION – Certificate of destruction (loss/disposal); OTHER – Other (with indication of name manually)

CONFISCATION – Confiscation: CONSIGNMENT_NOTE – Packing list; UTD – Universal transfer document; OTHER – Other

LIQUIDATION – Liquidation of business: CONSIGNMENT_NOTE – Packing list; UTD – Universal transfer document; OTHER – Other

ENTERPRISE_USE – use for the internal business purposes: DESTRUCTION_ACT - Certificate of destruction (loss/disposal); OTHER – Other

inn string + EA INN

kkt_number string - Control and cash register equipment

Cash register number


195


primary_document_custom_name string - Name of primary document

Mandatory if ’Other’ is specified in the ‘Type of primary document’ field

products array + Goods item in request

*cis string + IC IC

*primary_document_date string (date)


Set in yyyy-MM-dd format; it shall be specified as required or if it deviates from the value of ‘document_date’ parameter

*primary_document_number string - Number of primary document

It shall be specified as required or if it deviates from the value of ‘document_number’ parameter

*primary_document_type enum - Type of primary document

It shall be specified as required or if it deviates from the value of ‘document_type’ parameter Primary document type depends on ’action’ parameter:

RETAIL – retail sale: RECEIPT – register receipt; SALES_RECEIPT – sales receipt; OTHER – Other (with indication of name manually)

BEYOND_EEC_EXPORT – export beyond EAEU: CUSTOMS_DECLARATION – customs declaration for goods

EEC_EXPORT – export to EAEU countries: CONSIGNMENT_NOTE – Consignment note; UTD – Universal transfer document; OTHER – Other (with indication of name manually)

RETURN – return to a physical entity: OTHER – Other (with indication of name manually)

REMOTE_SALE – sale on sample and remote sales: RECEIPT – Cash register receipt; SALES_RECEIPT – Sale receipt; CONSIGNMENT_NOTE – Packing list; UTD – Universal transfer document; OTHER – Other

DAMAGE_LOSS – Loss or damage:

196


DESTRUCTION_ACT – Certificate of destruction (loss/disposal); OTHER – Other (with indication of name manually)

Destruction: DESTRUCTION – Certificate of destruction (loss/disposal); OTHER – Other (with indication of name manually)

CONFISCATION – Confiscation: CONSIGNMENT_NOTE – Packing list; UTD – Universal transfer document; OTHER – Other

LIQUIDATION – Liquidation of business: CONSIGNMENT_NOTE – Packing list; UTD – Universal transfer document; OTHER – Other

ENTERPRISE_USE – use for the internal business purposes: DESTRUCTION_ACT - Certificate of destruction (loss/disposal); OTHER – Other

*primary_document _custom_name

string - Name of primary document

It shall be specified as required or if it deviates from the value of ‘primary_document_custom_name’ parameter

*product_cost integer - Unit price Cost is specified in kopecks, including VAT. Mandatory for receipts


Economic agent INN,Reason for withdrawal,Withdrawal date,Source document type,Source document number,Source document date,Source document name,CRE registration number,Version 00000000000,Retail sale,12.04.2019,Sales receipt,PDN,12.04.2019,custom,kkt_number,4 Goods parameters IC,Price per unit,Source document type,Source document number,Source document date,Source document name ‘00000000000000000000000000000000000000’,1000,Sales receipt,PDN,12.04.2019,custom

197


<?xml version=‘1.0’ encoding=‘UTF-8’?> <withdrawal action_id=‘15’ version=‘4’> <trade_participant_inn>0000000000</trade_participant_inn> <withdrawal_type>RETAIL</withdrawal_type> <withdrawal_date>12.04.2019</withdrawal_date> <primary_document_type>RECEIPT</primary_document_type> <primary_document_number>PDN</primary_document_number> <primary_document_date>12.04.2019</primary_document_date> <primary_document_custom_name>custom</primary_document_custom_name> <kkt_number>kkt_number</kkt_number> <products_list> <product> <kit>00000000000000000000000000000000000000</kit> <cost>1000</cost> <primary_document_type>RECEIPT</primary_document_type> <primary_document_number>PDN</primary_document_number> <primary_document_date>12.04.2019</primary_document_date> <primary_document_custom_name>custom</primary_document_custom_name> </product> </products_list> </withdrawal>

2.2.16. Writing off MC 2.2.16.1. Writing off not applied MCs

IS applied to MC in APPLIED status (Emitted. Received) when GCP does not need MC obtained from OMS, and those are to be written off TT GIS

Type of document:

Type Description

LK_KM_CANCELLATION Writing off MC. JSON (MANUAL)

LK_KM_CANCELLATION_CSV Writing off MC. CSV

LK_KM_CANCELLATION_XML Writing off MC. XML


{ ‘cancellation_doc_date’: ‘2020-01-23’ , ‘cancellation_doc_number’: ‘string’ , ‘cancellation_reason’: ‘string’ , ‘km_list’: [ { ‘cancellation_reason’: ‘string’ , ‘uit’: ‘string’ , ‘uitu’: ‘string’ } ] ,

198

‘pdfFile’: ‘string’ , ‘trade_participant_inn’: ‘string’ }



cancellation_doc_date string + Date of writing off Parameter value is a string with formatted date and time

cancellation_doc_number string + Number of primary document for writing off

cancellation_reason string + Reason for writing off Possible values: KM_SPOILED – damaged; KM_LOST – lost; KM_DESTROYED – destroyed

km_list array + List of MC data





*cancellation_reason string + Code of reason for writing off

Possible values: KM_SPOILED – damaged; KM_LOST – lost; KM_DESTROYED – destroyed



Note: to write off an MC in EMITTED status (Emitted. Released), close the order in OMS. This will bring all applied MC to APPLIED status, while others will be written off automatically. Otherwise, wait until MC are written off automatically upon expiration.


Economic agent INN,Reason for marking code cancellation,Cancellation confirmation document date,Cancellation confirmation document number,Version 0000000000,Damaged,12.04.2019,123,2 Marking code parameters IC,SPIC,Reason for marking code cancellation ‘00000000000000000000000000000000000000’,,Damaged


<?xml version=‘1.0’ encoding=‘UTF-8’?> <km_cancellation action_id=‘14’ version=‘2’> <trade_participant_inn>0000000000</trade_participant_inn> <cancellation_reason>KM_SPOILED</cancellation_reason> <cancellation_document_date>12.04.2019</cancellation_document_date>

199

<cancellation_document_number>123</cancellation_document_number> <km_list>  <km> <kit>00000000000000000000000000000000000000</kit> <cancellation_reason>KM_LOST</cancellation_reason> </km> <km> <kitu>000000000000000000</kitu> <cancellation_reason>KM_LOST</cancellation_reason> </km> </km_list> </km_cancellation>

2.2.16.2. Writing off applied MCs

This method is not used for product group ‘Dairy products’.

Is applied to MC in INTRODUCED status (in circulation) when GCP needs to write off an MC without bringing it out of circulation. MC gets status = WRITTEN_OFF and statusEx = WAIT_REMARK (MC is written off upon application to a goods item) (A goods item awaits re-marking). Thus, this MC (statusEx = WAIT_REMARK) can be further used in LK_REMARK scheme with re-marking reason = MC write-off reason in LK_APPLIED_KM_CANCELLATION scheme.


Type of document:

Type Description

LK_APPLIED_KM_CANCELLATION Writing off applied IC. JSON (MANUAL)

LK_APPLIED_KM_CANCELLATION_CSV Writing off applied IC. CSV

LK_APPLIED_KM_CANCELLATION_XML Writing off applied IC. XML


{ ‘cancellation_doc_date’: ‘2020-01-23’, ‘cancellation_doc_number’: ‘string’, ‘cancellation_reason’: ‘string’, ‘km_list’: [ { ‘cancellation_reason’: ‘string’, ‘uit’: ‘string’, ‘uitu’: ‘string’ } ], ‘pdfFile’: ‘string’, ‘trade_participant_inn’: ‘string’ }

200



cancellation_doc_date string + Date of writing off Set in yyyy-MM-dd format

cancellation_doc_number string + Number of primary document for writing off

cancellation_reason string + Reason for writing off


km_list array + List of MC data





*cancellation_reason string + Code of reason for writing off




Note: to write off an MC in EMITTED status (Emitted. Released), close the order in OMS. This will bring all applied MC to APPLIED status, while others will be written off automatically. Otherwise, wait until MC are written off automatically upon expiration.


Economic agent INN,Reason for marking code cancellation,Cancellation confirmation document date,Cancellation confirmation document number,Version 0000000000,Damaged,12.04.2019,123,2 Marking code parameters IC,SPIC,Reason for marking code cancellation ‘00000000000000000000000000000000000000’,,Damaged


<?xml version=‘1.0’ encoding=‘UTF-8’?> <km_cancellation action_id=‘14’ version=‘2’> <trade_participant_inn>0000000000</trade_participant_inn>

201

<cancellation_reason>KM_SPOILED</cancellation_reason> <cancellation_document_date>12.04.2019</cancellation_document_date> <cancellation_document_number>123</cancellation_document_number> <km_list>  <km> <kit>00000000000000000000000000000000000000</kit> <cancellation_reason>KM_LOST</cancellation_reason> </km> <km> <kitu>000000000000000000</kitu> <cancellation_reason>KM_LOST</cancellation_reason> </km> </km_list> </km_cancellation>

2.2.17. Remarking

Type of document:

Type Description

LK_REMARK Re-marking. JSON (MANUAL)

LK_REMARK_CSV Re-marking. CSV

LK_REMARK_XML Re-marking. XML


{ ‘participant_inn’: ‘0000000000’ , ‘remarking_date’: ‘2020-01-01’ , ‘remarking_cause’: ‘KM_SPOILED’ , ‘products’: [ { ‘certificate_document‘: ‘CONFORMITY_CERTIFICATE’ , ‘certificate_document_number’: ‘cert num’ , ‘certificate_document_date’: ‘2020-03-03’ , ‘last_uin’: ‘00000000000000000000000000000000000001’ , ‘new_uin’: ‘00000000000000000000000000000000000002’ , ‘remarking_date’: ‘2020-01-01’ , ‘remarking_cause’: ‘KM_SPOILED’ , ‘primary_document_date’: ‘2020-02-02’ , ‘primary_document_number’: ‘primary doc num’ , ‘primary_document_type’: ‘SALES_RECEIPT’ , ‘primary_document_custom_name’: ‘CUSTOM’ , ‘tnved_10’: ‘0000000000’ , ‘paid’: true } ] }

202




remarking_date string + Date of repeated marking


remarking_cause string + Code of reason for repeated marking

Possible values: KM_SPOILED – IM with MC spoiled or lost; DESCRIPTION_ERRORS – Errors in goods description found; RETAIL_RETURN – Return of goods with damaged/missing IM at retail sale; REMOTE_SALE_RETURN - Return of goods with damaged/missing IM at remote sale


*remarking_date string + Date of repeated marking


*remarking_cause string + Code of reason for repeated marking

Possible values: KM_SPOILED – IM with MC spoiled or lost; DESCRIPTION_ERRORS – Errors in goods description found; RETAIL_RETURN – Return of goods with damaged/missing IM at retail sale; REMOTE_SALE_RETURN - Return of goods with damaged/missing IM at remote sale

For ‘Dairy products’ and ‘Bottled water’ PG, Code of reason for repeated marking (remarking_cause) shall only have the following values: KM_SPOILED – IM with MC spoiled or lost; DESCRIPTION_ERRORS - Errors in goods description found.



203


certificate_document_number string - Number of document on mandatory certification


Set in yyyy-MM-ddTHH:mm:ss.SSS’Z format Range of dates from 2000-01-01 till the document creation date

*last_uin string - Previous unique identifier of goods item

It is not specified if ‘remarking_cause’ = ‘RETAIL_RETURN’ or ‘REMOTE_SALE_RETURN’

*new_uin string + New unique identifier of goods item

*primary_document_type enum - Type of primary document

RECEIPT – Cash register receipt; SALES_RECEIPT – Sales receipt; OTHER – Other. Parameter is mandatory if: remarking_cause = ‘Return of footwear with damaged/missing IM at retail’; remarking_cause = ‘Return with damaged/missing IM at remote sales’ + paid = true; parameter not specified if: remarking_cause = ‘Return with damaged/missing IM at remote sales’ + paid = false

*primary_document_custom_name string - Name of primary document

It shall be filled in if the primary document type is specified as ’OTHER’. Parameter is mandatory if: remarking_cause = ‘Return of footwear with damaged/missing IM at retail’; remarking_cause = ‘Return with damaged/missing IM at remote sales’ + paid = true; parameter not specified if: remarking_cause = ‘Return with damaged/missing IM at remote sales’ + paid = false

*primary_document_date string (date-time)


Set in yyyy-MM-ddTHH:mm:ss.SSS’Z format Parameter is mandatory if: remarking_cause = ‘Return of footwear with damaged/missing IM at retail’; remarking_cause = ‘Return with

204


damaged/missing IM at remote sales’ + paid = true; parameter not specified if: remarking_cause = ‘Return with damaged/missing IM at remote sales’ + paid = false

*primary_document_number string - Number of primary document

Parameter is mandatory if: remarking_cause = ‘Return of footwear with damaged/missing IM at retail’; remarking_cause = ‘Return with damaged/missing IM at remote sales’ + paid = true; parameter not specified if: remarking_cause = ‘Return with damaged/missing IM at remote sales’ + paid = false

*tnved_10 integer - Goods nomenclature code (10 digits)

Parameter is available and mandatory only if ‘remarking_cause’ = ‘RETAIL_RETURN’ or ‘REMOTE_SALE_RETURN’

*paid boolean - Goods item is paid

Goods payment attribute: true – paid; false – not paid

Note:

1. Remarking may be performed only for MC with status = introduced into circulation (INTRODUCED);

2. New MC may be only in status = Emitted. Received (APPLIED);

3. New MC may be with other goods code if ‘remarking_cause’ = ‘DESCRIPTION_ERRORS’


Economic agent INN,Remarking date,Remarking reason,Version 7724211288,09.04.2020,Return of goods with damaged IM or without IM in retail sale,5 Goods parameters Previous IM,New IM,Goods nomenclature code,Remarking date,Goods item paid,Source document type,Source document name,Source document number,Source document date,’Compliance document type’,’Compliance document number’,’Compliance document date’ ,’010290000190443821ZDXVpWif9.T>x’,6401100000,21.05.2020,Yes,Other,11,111,21.05.2020,,,

205


<?xml version=‘1.0’ encoding=‘UTF-8’?> <remark version=‘5’> <trade_participant_inn>0000000000</trade_participant_inn> <remark_date>01.01.2020</remark_date> <remark_cause>RETAIL_RETURN</remark_cause> <products_list>  <product> <last_ki>00000000000000000000000000000000000001</last_ki> <tnved_code_10>0000000000</tnved_code_10> <new_ki>00000000000000000000000000000000000002</new_ki> <remark_date>01.01.2020</remark_date> <paid>true</paid> <primary_document_type>SALES_RECEIPT</primary_document_type> <primary_document_custom_name>CUSTOM</primary_document_custom_name> <primary_document_number>primary doc num</primary_document_number>  <primary_document_date>02.02.2020</primary_document_date>  <certificate_type>CONFORMITY_CERTIFICATE</certificate_type>  <certificate_number>cert num</certificate_number>  <certificate_date>03.03.2020</certificate_date> </product> </products_list> </remark>

2.2.18. UTD for shipment

For operation with UTD, refer to the document API EDM lite.

2.2.19. Automatic introduction into circulation. OMS

For operation with OMS, refer to Order management station. API Specification.

2.2.20. MC order. OMS

For operation with MC, refer to Order management station. API Specification.

https://%D1%87%D0%B5%D1%81%D1%82%D0%BD%D1%8B%D0%B9%D0%B7%D0%BD%D0%B0%D0%BA.%D1%80%D1%84/upload/API%20%D0%AD%D0%94%D0%9E%20lite.pdf

https://%D1%87%D0%B5%D1%81%D1%82%D0%BD%D1%8B%D0%B9%D0%B7%D0%BD%D0%B0%D0%BA.%D1%80%D1%84/upload/iblock/07f/STANTSIYA-UPRAVLENIYA-ZAKAZAMI.pdf

https://%D1%87%D0%B5%D1%81%D1%82%D0%BD%D1%8B%D0%B9%D0%B7%D0%BD%D0%B0%D0%BA.%D1%80%D1%84/upload/iblock/07f/STANTSIYA-UPRAVLENIYA-ZAKAZAMI.pdf

206

3. Reference books

3.1. Catalogue - List of supported product groups

Identifier Name Description

1 lp Clothing items, bed, table, bath and kitchen linens

2 shoes Footwear

3 tobacco Tobacco products

4 perfumery Perfume and eau de toilette

5 tires New pneumatic rubber tires and tire casings

6 electronics Photo cameras (except cine cameras), flash lights and flash bulbs

8 milk Dairy products

9 bicycle Bicycles and bicycle frames

10 wheelchairs Wheelchairs

12 otp Alternative tobacco products

13 water Bottled water

3.2. Catalogue - Types of documents

Code Name Format Document type format description

AGGREGATION_DOCUMENT Aggregation JSON Aggregation. JSON

AGGREGATION_DOCUMENT_CSV Aggregation CSV Aggregation. CSV

AGGREGATION_DOCUMENT_XML Aggregation XML Aggregation. XML

DISAGGREGATION_DOCUMENT Aggregate disaggregation JSON Aggregate disaggregation. JSON

DISAGGREGATION_DOCUMENT_CSV Aggregate disaggregation CSV Aggregate disaggregation. CSV

DISAGGREGATION_DOCUMENT_XML Aggregate disaggregation XML Aggregate disaggregation. XML

REAGGREGATION_DOCUMENT Aggregate reaggregation JSON Aggregate reaggregation. JSON

REAGGREGATION_DOCUMENT_XML Aggregate reaggregation XML Aggregate reaggregation. XML

REAGGREGATION_DOCUMENT_CSV Aggregate reaggregation CSV Aggregate reaggregation. CSV

LP_INTRODUCE_GOODS Introduction into circulation. Manufacture in the Russian Federation

JSON Introduction into circulation. Manufacturing in the Russian Federation.

207


JSON

LP_INTRODUCE_GOODS_CSV Introduction into circulation. Manufacture in the Russian Federation

CSV Introduction into circulation. Manufacturing in the Russian Federation. CSV

LP_INTRODUCE_GOODS_XML Introduction into circulation. Manufacture in the Russian Federation

XML Introduction into circulation. Manufacturing in the Russian Federation. XML

LP_SHIP_GOODS Shipping JSON Shipping. JSON

LP_SHIP_GOODS_CSV Shipping CSV Shipping. CSV

LP_SHIP_GOODS_XML Shipping XML Shipping. XML

LP_SHIP_RECEIPT Shipping with withdrawal from circulation

JSON Shipping with withdrawal from circulation. JSON (MANUAL)

LP_SHIP_RECEIPT_CSV Shipping with withdrawal from circulation

CSV Shipping with withdrawal from circulation. CSV

LP_SHIP_RECEIPT_XML Shipping with withdrawal from circulation

XML Shipping with withdrawal from circulation. XML

LP_SHIP_GOODS_CROSSBORDER Shipment at cross-border trading

JSON Shipment at cross-border trading. JSON (MANUAL)

LP_ACCEPT_GOODS Acceptance JSON Acceptance. JSON

LP_ACCEPT_GOODS_XML Acceptance XML Acceptance. XML

LK_REMARK Remarking JSON Re-marking. JSON

LK_REMARK_CSV Remarking CSV Re-marking. CSV

LK_REMARK_XML Remarking XML Re-marking. XML

LP_GOODS_IMPORT Introduction into circulation. Import

JSON Introduction into circulation. Import. JSON

LP_GOODS_IMPORT_CSV Introduction into circulation. Import

CSV Introduction into circulation. Import. CSV

LP_GOODS_IMPORT_XML Introduction into circulation. Import

XML Introduction into circulation. Import. XML

208


LP_CANCEL_SHIPMENT Cancelling shipment JSON Cancelling shipment. JSON

LP_CANCEL_SHIPMENT_CROSSBORDER

Cancelling shipment at cross-border trading

JSON Cancelling shipment at cross-border trading. JSON (MANUAL)

LK_KM_CANCELLATION Writing-off unapplied MC JSON Writing-off unapplied MC. JSON

LK_KM_CANCELLATION_XML Writing-off unapplied MC XML Writing-off unapplied MC. XML

LK_KM_CANCELLATION_CSV Writing-off unapplied MC CSV Writing-off unapplied MC. CSV

LK_APPLIED_KM_CANCELLATION Writing-off applied MC JSON Writing-off applied MC. JSON

LK_APPLIED_KM_CANCELLATION_XML

Writing-off applied MC XML Writing-off applied MC. XML

LK_APPLIED_KM_CANCELLATION_CSV

Writing-off applied MC CSV Writing-off applied MC. CSV

LK_CONTRACT_COMMISSIONING Introducing a goods item into circulation. Contract manufacturing in the Russian Federation

JSON Introduction into circulation. Contract manufacturing in the Russian Federation. JSON

LK_CONTRACT_COMMISSIONING_CSV Introducing a goods item into circulation. Contract manufacturing in the Russian Federation

CSV Introduction into circulation. Contract manufacturing in the Russian Federation. CSV

LK_CONTRACT_COMMISSIONING_XML

Introducing a goods item into circulation. Contract manufacturing in the Russian Federation

XML Introduction into circulation. Contract manufacturing in the Russian Federation. XML

LK_INDI_COMMISSIONING Introducing a goods item into circulation. Received from individuals.

JSON Introduction into circulation. Received from individuals. JSON

LK_INDI_COMMISSIONING_CSV Introducing a goods item into circulation. Received from individuals.

CSV Introduction into circulation. Received from individuals. CSV

LK_INDI_COMMISSIONING_XML Introducing a goods item into circulation. Received from individuals.

XML Introduction into circulation. Received from individuals.

209


XML

LP_RETURN Return into circulation JSON Return into circulation. JSON (MANUAL)

LP_RETURN_CSV Return into circulation CSV Return into circulation. CSV

LP_RETURN_XML Return into circulation XML Return into circulation. XML

OST_DESCRIPTION Description of goods remains JSON Description of goods remains. JSON

OST_DESCRIPTION_CSV Description of goods remains CSV Description of goods remains. CSV

OST_DESCRIPTION_XML Description of goods remains XML Description of goods remains. XML

LP_INTRODUCE_OST Introduction into circulation. Remains marking

JSON Introduction into circulation. Remains marking. JSON

LP_INTRODUCE_OST_CSV Introduction into circulation. Remains marking

CSV Introduction into circulation. Remains marking. CSV

LP_INTRODUCE_OST_XML Introduction into circulation. Remains marking

XML Introduction into circulation. Remains marking. XML

CROSSBORDER Introduction into circulation. Cross-border trading

JSON Introduction into circulation. Cross-border trading. JSON

CROSSBORDER_CSV Introduction into circulation. Cross-border trading

CSV Introduction into circulation. Cross-border trading. CSV

CROSSBORDER_XML Introduction into circulation. Cross-border trading

XML Introduction into circulation. Cross-border trading. XML

LK_RECEIPT Withdrawal from circulation JSON Withdrawal from circulation. JSON

LK_RECEIPT_CSV Withdrawal from circulation CSV Withdrawal from circulation. CSV

LK_RECEIPT_XML Withdrawal from circulation XML Withdrawal from circulation. XML

LP_INTRODUCE_GOODS_CROSSBORDER_CSD_JSON

Introduction into circulation. In the territory of EEU countries (contract manufacturing)

JSON Introduction into circulation. In the territory of EEU countries (contract manufacturing).

210


JSON (MANUAL)

LP_INTRODUCE_GOODS_CROSSBORDER_CSD_XML


XML Introduction into circulation. In the territory of EEU countries (contract manufacturing). XML

LP_INTRODUCE_GOODS_CROSSBORDER_CSD_CSV


CSV Introduction into circulation. In the territory of EEU countries (contract manufacturing). CSV

LP_FTS_INTRODUCE_JSON Introduction into circulation. Import with FCS

JSON Introduction into circulation. Import with FCS. JSON (MANUAL)

LP_FTS_INTRODUCE_XML Introduction into circulation. Import with FCS

XML Introduction into circulation. Import with FCS. XML

LP_FTS_INTRODUCE_CSV Introduction into circulation. Import with FCS

CSV Introduction into circulation. Import with FCS. CSV

ATK_AGGREGATION ACC aggregation JSON ACC aggregation. JSON (MANUAL)

ATK_AGGREGATION_CSV ACC aggregation XML ACC aggregation. CSV

ATK_AGGREGATION_XML ACC aggregation CSV ACC aggregation. XML

ATK_TRANSFORMATION ACC reaggregation JSON ACC reaggregation. JSON (MANUAL)

ATK_TRANSFORMATION_CSV ACC reaggregation XML ACC reaggregation. CSV

ATK_TRANSFORMATION_XML ACC reaggregation CSV ACC reaggregation. XML

ATK_DISAGGREGATION ACC disaggregation JSON ACC disaggregation. JSON (MANUAL)

ATK_DISAGGREGATION_CSV ACC disaggregation XML ACC disaggregation. CSV

ATK_DISAGGREGATION_XML ACC disaggregation CSV ACC disaggregation. XML

RECEIPT Receipt Formed by fiscal data operator

211


RECEIPT_RETURN Return receipt Formed by fiscal data operator

Universal documents Universal documents are created in v. 1.2 API EDM lite documentation and are received from commercial electronic document management

UTD PD (consignment note) UNIVERSAL_TRANSFER_DOCUMENT

UTD TI (tax invoice) UNIVERSAL_TRANSFER_DOCUMENT

UTD TI PD (tax invoice+consignment note) UNIVERSAL_TRANSFER_DOCUMENT

UTD(c) PD (for consignment note) UNIVERSAL_TRANSFER_DOCUMENT_FIX

UTD(c) TI (for tax invoice) UNIVERSAL_TRANSFER_DOCUMENT_FIX

UTD(c) TI PD UNIVERSAL_TRANSFER_DOCUMENT_FIX

UCD DPC (for consignment note) UNIVERSAL_CORRECTION_DOCUMENT

UCD CTI (for tax invoice) UNIVERSAL_CORRECTION_DOCUMENT

UCD CTI DPC UNIVERSAL_CORRECTION_DOCUMENT

UCD(c) DPC (correction of consignment note corrective document)

UNIVERSAL_CORRECTION_DOCUMENT_FIX

UCD(c) CTI (correction of tax invoice corrective document)

UNIVERSAL_CORRECTION_DOCUMENT_FIX

UCD(c) CTI DPC UNIVERSAL_CORRECTION_DOCUMENT_FIX

Universal cancellation document UNIVERSAL_CANCEL_DOCUMENT

3.3. Catalogue - MC statuses

Code in DB Code Description

0 EMITTED Emitted

1 APPLIED Applied



https://www.multitran.com/m.exe?s=electronic+document+management&l1=1&l2=2

https://www.multitran.com/m.exe?s=electronic+document+management&l1=1&l2=2

212


2 INTRODUCED Introduced into circulation

3 WRITTEN_OFF Written off

4 RETIRED Withdrawn from circulation. WITHDRAWN for ‘Tobacco products’ GG

5 RESERVED_NOT_USED Reserved. Do not use

6 INTRODUCED_RETURNED Returned into circulation

7 DISAGGREGATED Disaggregated

8 WAIT_SHIPMENT Awaiting acceptance confirmation

9 EXPORTED Used for export document

10 LOAN_RETIRED Withdrawn from circulation under installment contract

11 REMARK_RETIRED Withdrawn from circulation during remarking

12 APPLIED_NOT_PAID Applied but not paid

13 FTS_RESPOND_NOT_OK Unfavorable decision by FCS

14 FTS_RESPOND_WAITING Awaiting confirmation by FCS

15 FTS_CONTROL Controlled by FCS

3.4. Catalogue - Types of production

Code Description

LOCAL Manufacture in the Russian Federation

FOREIGN Imported to the Russian Federation

3.5. Catalogue - Types of packing

Code Description Comment for MTTP Comment for Medicine

UNIT Goods unit Pack Goods packing

LEVEL1 Level 1 package Block Level 1 shipping package

LEVEL2 Level 2 package Box Level 2 shipping package (SSCC at the moment)

LEVEL3 Level 3 package Pallet

LEVEL4 Level 4 package

LEVEL 5 Level 5 package

BUNDLE Bundle

ACC Aggregated Customs Code

213

3.6. Catalogue - Order statuses

Code Description

NEW Registered

PRODUCTION Production

VALIDATION_FAILED Error during check

IN PROGRESS Order is under execution process

SUCCESS Order is executed

ERROR Error occurred during order execution

RESULT_EXPIRED Order has expired

3.7. Catalogue - Document statuses

Code Description

IN_PROGRESS Under check

CHECKED_OK Processed

CHECKED_NOT_OK Processed with errors

PROCESSING_ERROR Technical error

UNDEFINED Undefined

CANCELLED Cancelled. Only for ‘Cancelling shipment’ document

ACCEPTED Accepted. Only for ‘Shipment’ document.

WAIT_ACCEPTANCE Awaits acceptance. Only for ’Shipment’ document. It is set in case of successful processing of ‘Goods shipment’ document

WAIT_PARTICIPANT_REGISTRATION Awaiting registration of participant in TT GIS. Only for ’Shipment’ document. It is set in case of successful processing of ‘Goods shipment’ document to unregistered participant

WAIT_FOR_CONTINUATION Awaits document processing resumption

3.8. Catalogue - Response statuses

Code Name Description Format of error message

200 OK Response status if successful

-

201 CREATED Response status if successful

202 ACCEPTED Response status if successful

400 ERROR Bad Request

Error in request parameters (mandatory parameter is missing)

1 For NC methods: 1.1. If apikey or feed parameter is missing:

{ ‘error_message’: ‘Mandatory parameter

214


missing: <mandatory parameter name>‘ }

1.2. If other parameters are missing:

{ ‘error_message’: ‘Error in request parameters’ }

2 For all methods except for NC methods:

{ ‘error_message’: ‘Mandatory parameter missing: <mandatory parameter name>‘ }

Error in request parameters (wrong type of parameter)

1 For NC methods:

{ ‘error_message’: ‘Error in request parameters’ }


{ ‘error_message’: ‘Parameter <parameter name> requires a value of type <required parameter type>‘ }

401 ERROR Unauthorised

Authorisation error 1 For all methods requiring a token except for NC methods:

1.1. Outdated token is specified:

<InvalidTokenException> <error>invalid_token</error> <error_description>Access token expired: <token></error_description> </InvalidTokenException>

1.2. Token is not specified:

<UnauthorisedException> <error>unauthorised</error> <error_description>Full authentication is required to access this resource</error_description> </UnauthorisedException>

402 ERROR Error in attribute content of request body

403 ERROR Forbidden

Access denied 1 For all methods except for NC methods:

1.1. If a user (GCP) is not granted access to a specific remote service:


2 For all NC methods:

2.1. If incorrect API key is specified


404 ERROR Not Found

Requested information is not found in TT GIS

1 For all NC methods:

{ ‘error_message’: Data not found> not found’}

215



{ ‘error_message’: ‘<Parameter description> not found’ }

Error in indication of method URL

{‘error_message’: ‘Method with specified URL not found’ }

409 ERROR The request could not be completed due to a conflict with the current state of the resource

410 ERROR The resource was previously available at the specified URL, but now it is deleted and unavailable

413 ERROR Acceptable request body size exceeded

{‘error_message’: ‘Request too big’ }

500 ERROR Internal server Error

Internal error of remote systems (technically detailed description does not return)

{ ‘error_message’: ‘Error during request execution’ }

503 ERROR Service Unavailable

Problem with access to remote system

{‘error_message’: ‘Remote system is not available’ }

504 ERROR Error during receiving the system response

{ error_message: ‘No reply from system’ }

3.9. Catalogue - Types of organisations


1 TRADE_PARTICIPANT Goods Circulation Participant

2 PRODUCER Goods manufacturer

3 IMPORTER Importer of goods

4 WHOLESALER Wholesale trading

5 RETAIL Retail trading

6 IS_MP_OPERATOR TT GIS operator

7 CEM LABELLING_CENTER

8 OGV State authority

3.10. Catalogue - GCP statuses

Code Description

REGISTERED Registered

216

Code Description

NOT_REGISTERED Not registered

REMOVED Deleted

RESTORED Restored

BLOCKED Blocked

3.11. Catalogue - Statuses of request for GCP registration

No. Code Value

1 IN_PROGRESS Under consideration (check)

2 CHECKED_OK Checked

3 REGISTERED Document is registered (accepted by system)

4 CHECKED_NOT_OK Error

5 PROSECCING_ERROR Error during processing

6 UNDEFINED Undefined

3.12. Catalogue - Document statuses in SD life cycle

Code Description

10 New

20 Agreement

40 Signing

50 Activation

60 Active

100 Invalid

3.13. Catalogue - Status model

Each status has an indication of what type of documents it applies to:

Status Statuses of outgoing documents Statuses of incoming documents

0 Draft -

11 Awaiting sending -

1 Sent -

2 Delivered (signature not required) Signature is not required

12 Viewed (signature not required) Signature is not required (document is viewed)

3 Delivered (awaiting signing) Signature is required

13 Viewed (awaiting signing) Signature is required (document is viewed)

217

Status Statuses of outgoing documents Statuses of incoming documents

4 Signed Signed

5 Rejected Rejected

15 Rejected (request is viewed) Rejected (request is viewed)

6 Revoked Revoked

16 Cancellation requested Awaiting cancellation

17 Awaiting cancellation Cancellation requested

18 Canceled Canceled

19 Cancellation rejected Cancellation rejected

7 Refined Refined

8 Refinement required Awaiting refinement

14 Refinement required (request for refinement is viewed)

Request for refinement is viewed (awaiting refinement)

9 Error in signature Error in signature

10 Error of delivery Error of delivery

3.14. Catalogue - Additional parameters for PG

3.14.1. Additional parameters for PG ’Footwear’

Parameter Description Note

brand Trademark / Brand

productType Footwear type

productTypeDesc Text description of footwear type

name Full product name

productSize Stich size

colour Colour

materialUpper Top material

materialLining Lining material

materialDown Bottom/sole material

model Model / Article of manufacturer

218

3.14.2. Additional parameters for PG ‘Clothing, bed linen, table linen, bath and kitchen linen’


brand Trade mark


type Goods type

size Item size

colour Colour

textileType Textile type

structure Structure

consumer_age User age

gender Target gender


3.14.3. Additional parameters for PG ‘Photo cameras (except for cine cameras), flash lights and flash bulbs’


brand Trade mark


type Goods type

standardNumber Number of regulation / standard


3.14.4. Additional parameters for PG ‘Bicycles and bicycle frames’




productKind Goods type

productionYear Year of manufacture

engineType Engine type

enginePower Engine power, hp

electricEnginePower Electric motor power, W

frameSize Frame size

colour Colour

219


weightGross Gross weight

frameMaterial Frame material

rimDiameter Bead seat diameter, inches

sectionWidth Section width, inches

brakeSystemType Brake system type

frontForkType Front fork type

3.14.5. Additional parameters for PG ’Wheelchairs’



productKind Goods type


weightGross Gross weight

maximumLoad Maximum load, kg

seatDepth Seat depth

seatWidth Seat width

seatHeight Seat height

backHeight Back height

3.14.6. Additional parameters for PG ‘Perfume and eau de toilette’



perfumeryType Type of perfume

volume Declared volume

packageType Package type

packMaterial Packing material

3.14.7. Additional parameters for PG ‘New pneumatic rubber tires and tire casings’


brand Trade mark


tireSectionWidth Tire (tube) section width, mm

220


heightWidthRatio Tire section height to width ratio, %

frameConstructionType Tire carcass structure type

tireLoadIndex Load index

speedCategory The velocity category

seasonality Seasonality

frameSealingType Tire type by pressurization method

3.14.8. Additional parameters for PG ‘Dairy products’



milkProductType Type of a product

rawOrigin Raw products origin

fat Fat content, %

volumeWeight Declared output / net weight

vetisId Goods identifier in FGIS VetIS

babyFoodProduct Products for baby food

Structure Structure

221

4. Examples of authentication with EQES / Signing of documents

4.1. Example of token receiving during authorisation with attached signature / signing of documents with detached signature in 1C // sThumbprint - thumbprint of the certificate used for signing; string // representing the thumbprint in hexadecimal form // example195934d72dcdf69149901d6632aca4562d8806d8 // SignatureText must be in Base64 format // bDetached - True/False - detached(for document signing)/attached(for obtaining an authorisation token) signature Function SignText(SignatureText, sThumbprint, bDetached) CADESCOM_BASE64_TO_BINARY = 1; // Input data received in Base64 CADESCOM_CADES_TYPE = 1; // Advanced signature type CAPICOM_AUTHENTICATED_ATTRIBUTE_SIGNING_TIME = 0; // Timestamp attribute oSigner = New COMObject(‘CAdESCOM.CPSigner’); // Object that sets the creation parameters and contains information about the advanced signature.oSigner.Certificate = GetCertificateByThumbprint(sThumbprint); oSigningTimeAttr = New COMObject(‘CAdESCOM.CPAttribute’); oSigningTimeAttr.Name = CAPICOM_AUTHENTICATED_ATTRIBUTE_SIGNING_TIME; oSigningTimeAttr.Value = CurrentData(); oSigner.AuthenticatedAttributes2.Add(oSigningTimeAttr); SignatureText= AbbrPP(SignatureText); oSignedData = New COMObject(‘CAdESCOM.CadesSignedData’); // CadesSignedData object provided properties and methods for advanced signature handling. oSignedData.ContentEncoding = CADESCOM_BASE64_TO_BINARY; SignedData.Content = AbbrPP(SignatureText); EncodingType = 0; sSignedMessage = oSignedData.SignCades(oSigner, CADESCOM_CADES_TYPE, bDetached, EncodingType); // The method adds an advanced signature to a message. Return sSignedMessage; // Signature in Base64 format FunctionEnd //Thumbprint- HEX string Function GetCertificateByThumbprint(StringThumbpring) Res = Undefined; // Detected certificate (Com object) CAPICOM_CURRENT_USER_STORE = 2; //2 - Search a certificate in ‘Personal’ branch of the storage. CAPICOM_MY_STORE = ’My’; // Indicate that ‘Personal’ branch is taken from the current user's storage CAPICOM_STORE_OPEN_READ_ONLY = 0; // Open the storage for read only oStore = NewCOMObject(‘CAdESCOM.Store’); // The object describes the certificate storage oStore.Open(CAPICOM_CURRENT_USER_STORE, CAPICOM_MY_STORE, CAPICOM_STORE_OPEN_READ_ONLY); // Open the certificate storage

222

// Option 1: search a certificate by a thumbprint CAPICOM_CERTIFICATE_FIND_SHA1_HASH = 0; Certificates = oStore.Certificates.Find(CAPICOM_CERTIFICATE_FIND_SHA1_HASH, StrThumbprint); Res = Certificates.Item(1); //Option 2: traverse the collection and compare against the thumbprint //For Each CurCertificate From oStore.Certificates Loop //CurThumbprint = CurCertificate.Thumbprint; // Thumbprint in hexadecimal form is returned //If ВРЕГ(CurThumbprint) = ВРЕГ(StrThumbprint) Then//Res= CurCertificate; //Interrupt; //EndIf; //EndLoop; oStore.Close(); // Close the storage and free object 61 Return Res; EndFunction

4.2. Example of token receiving during authorisation via REACT JS. import { CadesPluginer as anyName } from ’@crpt/cades-pluginer’; //or import CadesPluginer from ’@crpt/cades-pluginer’; //usually you will need 2 methods CadesPluginer.getFinalCertsArray().then(certs => { console.log(‘certs’, certs); CadesPluginer.signMessage(‘lalala’, certs[0].certificate).then(signed => console.log(‘signed’, signed); ); });

4.3. Example of token receiving during authorisation with attached signature / signing of documents with detached signature via Java. String data = ...//getting an authorisation code boolean detached = false; // false - attached signature(for obtaining an authorisation token) // true - detached signature(for signing documents) //Generatin a signature KeyStore keyStore = loadKeyStore();//initializing a key storage List<X509CertificateHolder> chain = new ArrayList<>(); List<Certificate> certs = Arrays.asList(keyStore.getCertificateChain(alias)); certs.forEach(cert -> { try { chain.add(new X509CertificateHolder(cert.getEncoded())); } catch (IOException | CertificateEncodingException e) { log.error(‘Error while building certificate chain’, e); } }); PrivateKey privateKey = (PrivateKey) (keyStore.getKey(alias, password)); ByteArrayOutputStream out = new ByteArrayOutputStream(); CAdESSignature signature = new CAdESSignature(detached); signature.setCertificateStore(new CollectionStore(chain)); final Hashtable table = new Hashtable(); Attribute attr = new Attribute(CMSAttributes.signingTime, new DERSet(new Time(new Date()))); // устанавливаем время подписи

223

table.put(attr.getAttrType(), attr); AttributeTable attrTable = new AttributeTable(table); //Adding a signee. Algorithms may differ depending on requirements signature.addSigner(JCP.PROVIDER_NAME, JCP.GOST_DIGEST_OID, JCP.GOST_EL_DH_OID, privateKey, certs, CAdESType.CAdES_BES, null, false, attrTable, null); signature.open(out); signature.update(data); signature.close(); byte[] signedCode = out.toByteArray(); //Use the signed code for token retrieval / generated detached EQES of the document together with the document

4.4. Description of plug-in methods:

Method Description

getFinalCertsArray(): Promise<Cert[]>

Init plugin, create store, . Cert: \{certificate: \{}, info: [] }, certificate is an original cadesplugin Certificate object, info is an array [name, date_from, date_to, serial_number].

signMessage(message, cert, detached): Promise

Sign message with selected certificate

.

Last updated 2020-08-03 06:00:30 UTC

Documents

Track and Trace Government Information System API v18žписание+API.+Release_16.2_en.pdf · 4 1 General Provisions 1.1 Principles of Interaction with API Interaction of goods