Serialization
The “serialization-service” provides methods for creating SGTIN and LGTIN
Requirements
- User's session must contain field “current_participant”.
{
"id": "urn:authenticateit:user:email:my@gmail.com",
"name": "ivan",
"roles": [
"user"
],
"ticket": "7b758d11-a597-44ae-8ab4-dd3cf864e20f",
"current_participant": {
"id": "urn:epc:sgln:0614141.12345.1"
}
}
- This participant must be presented in doc_storage with “type” field equals to “outsource” or “manufacturer”. Document also must provide a list of company prefixes
{
"_id": "urn:epc:sgln:0614141.12345.1",
"type": "participant",
"participant_type": [
"manufacturer"
],
"company_prefix": [
"0614141"
]
}
Create SGTINs or LGTINs with requested paremeters
Start serialization process with the given parameters. Responds with
JSON object containing serialization task id
. The returned
identifier may be used to request task status.
GS1 application identifiers (see here for additional information) may be included in the generated SGTINs or LGTINs. The following AIs are supported:
- Date AIs
11
–17
. Data for these AIs is a 6 digits string representing date inYYMMDD
format. E.g., June 11, 2019 will be represented as190611
. - Measurement AIs
310
–369
. Data for these AIs is a 6 digits string representing the measurement. The first digit in the data indicates the number of decimal places. The rest of the digits represent the measured value. E.g., net weight of 1.23 kg will be represented as AI310
with data200123
. - Additional product identification AI
240
. Data for this AI is a string up to 30 characters long. The following characters and character ranges are allowed in the data:!
–"
,%
–/
,0
–9
,A
–Z
,_
anda
–z
. - Company internal information AIs
91
–99
. Data for these AIs is a string up to 90 characters long. The same characters are allowed in the data as in AI240
(see above).
POST /serialization-service/serialize
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
gtin | base gtin | “00614141791304” |
format | serialization format | “gs1” or “epc” |
type | serialization type | “sgtin” or “lgtin” |
count | requested number | integer |
data_type |
"numeric" , "alphanumeric" or "all" |
|
length |
integer from 1 to 20 | |
sequence | sequence option | “ordered” or “random” |
owner | owner of serialized gtin | not required |
settings |
export settings | not required, if not presented - use default |
settings .labels_as_titles |
labels as titles in csv header | “yes” or “no”, default “no” |
settings .code |
gs1 code in csv | “yes” or “no”, default “yes” |
settings .owner |
owner id in csv | “yes” or “no”, default “no” |
settings .delimiter |
delimiter in csv | default "|" |
settings .name |
export product name in csv | “yes” or “no”, default “no” |
ai |
GS1 AI to be included in SGTIN or LGTIN | List of application identifiers. |
participant |
Participant identifier | Assing child supply chain participant as SGTIN owner |
location |
Business location identifier | Assing business location owner as SGTIN owner |
source | Additional source in SGTIN or LGTIN doc | single source object |
sources | Additional sources in SGTIN or LGTIN doc | list of source objects |
Example Request
{
"gtin": "02933451000009",
"name": "Butter",
"type": "lgtin",
"format": "epc",
"count": 2,
"ai": [
"12180608"
],
"sequence": "random",
"length": 12,
"data_type": "alphanumeric",
"source": {
"data": [
{
"text": {
"title": "44",
"text": "444444"
}
},
{
"text": {
"title": "55",
"text": "555555"
}
}
],
"conditions": {
"country": "036",
"language": "zh"
}
}
}
{
"gtin": "02933451000009",
"name": "Shoes",
"type": "sgtin",
"format": "gs1",
"count": 3,
"ai": [
"13180609",
"15180602",
"16180609",
"3110000033",
"17180602"
],
"sequence": "random",
"length": 12,
"data_type": "numeric",
"sources": [
{
"conditions": {},
"data": [
{
"text": {
"title": "text",
"text": "Update SGTIN widget",
"markdown": false
}
},
{
"link": {
"text": "Link",
"url": "http://www.facebook.com/shping"
}
}
]
}
]
}
Example Response
{
"id": "ff79bfae-3713-49ec-8551-2f29bb4d3b72"
}
Get status of serialization
Get status of previously started serialization task.
GET /serialization-service/serialize/:task_id
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
task_id |
string | Serialization task identifier. |
Example Response
{
"progress": 100,
"status": "started"
}
{
"status": "done",
"link": "https://dev-test-cdn.shping.com/2016-12-04T19:44:49Z-b3c59bfa-4f8e-431e-b445-de2417cdffa8.csv"
}
{
"error": "Serialization not has been started"
}
Get serialization tasks
Returns list of previously started serialization tasks.
Number of returned tasks may be limited with the limit
parameter
(default valus is 100
). Number of tasks may be skipped from the list
with the offset
parameter (0
by default).
Returned tasks may be filtered by status
(either started
or
done
), gtin
, name
(tasks for GTINs with product name matching
this string).
The resulting list may be sorted. Parameter sort_by
should be used
to specify sorting field (start_time
, gtin
, name
or
status
). Sorting order may be specified with sort_order
parameter
(asc
for ascending order and desc
for descending order).
GET /serialization-service/tasks
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
offset |
Skip number of tasks from the resulting list. | |
limit |
Limite the number of tasks in the resulting list. | |
from_date |
Only tasks started after this date. | |
to_date |
Only tasks started before this date. | |
status |
Only tasks with this status. | |
gtin |
Only tasks for the GTIN. | |
name |
Only tasks for products matching this name. | |
sort_by |
Sort tasks by field. | |
sort_order |
Ascending or descending sort order. |
Example Response
{
"id": "task_serialization",
"serialization_list": [
{
"ai": "02",
"check_digit": "4",
"company_prefix": "0614141",
"count": 10,
"end_time": "2016-12-03T13:00:43Z",
"epc_header": "urn:epc:id:lgtin:0614141.079130.",
"gs1_header": "020061414179130410",
"gtin": "00614141791304",
"indicator": "0",
"item_reference": "79130",
"link": "https://dev-test-cdn.shping.com/2016-12-03T13:00:40Z-6d20f9c0-811b-4829-b899-9512ef4ad356.csv",
"owner": "urn:epc:sgln:0614141.12345.1",
"participant": "urn:epc:sgln:0614141.123451",
"sequence": "random",
"settings": {
"code": "no",
"delimiter": "|",
"labels_as_titles": "yes",
"name": "yes",
"owner": "yes"
},
"start_time": "2016-12-03T13:00:40Z",
"type": "lgtin",
"user": "urn:epc:sgln:0614141.12345.1"
},
{
"ai": "02",
"check_digit": "4",
"company_prefix": "0614141",
"count": 10,
"end_time": "2016-12-03T10:18:50Z",
"epc_header": "urn:epc:id:lgtin:0614141.079130.",
"gs1_header": "020061414179130410",
"gtin": "00614141791304",
"indicator": "0",
"item_reference": "79130",
"last_element": "urn:epc:id:lgtin:0614141.079130.0000010030",
"link": "https://dev-test-cdn.shping.com/2016-12-03T10:18:25Z-6efdca22-e049-4f6d-9faa-ac4b7c739e1f.csv",
"owner": "urn:epc:sgln:0614141.12345.1",
"participant": "urn:epc:sgln:0614141.12345.1",
"sequence": "ordered",
"settings": {
"code": "no",
"delimiter": "|",
"labels_as_titles": "yes",
"name": "yes",
"owner": "yes"
},
"start_time": "2016-12-03T10:18:25Z",
"type": "lgtin",
"user": "urn:epc:sgln:0614141.12345.1"
}
]
}
Shipping Containers
All endpoints require serialization_admin
role for the calling user.
Import SSCCs
Create SSCC documents in the system from provided SSCC codes. Accepts
JSON object representation of the import task parameters, starts the
task and responds with id
of the task. Import description has the
following fields:
id
— a single SSCC or a list of SSCC codes to be imported. SSCCs as GS1 codes and SSCCs in EPC format are accepted.company_prefix
— import only SSCCs which have company prefix compatible with the specified prefix. The prefix must be in participant's list of prefixes or participant should have a wildcard (*
) prefix*
.
Only SSCCs which are not already present will be created. Company prefix of SSCCs should correspond to current participant's company prefixes.
POST /serialization-service/packaging/tasks
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Session ticket |
Example Request
{
"id": [
"urn:epc:id:sscc:9212345.0000000001",
"urn:epc:id:sscc:1111111.1111111111",
"00193423360000001230",
"00111111111111111118"
]
}
Example Response
{
"id": "d78c69d3-5a64-4fed-bf93-5621be12aece"
}
Generate SSCCs
Generate list of random or serial SSCCs for current
participant. Accepts JSON object representation of the generation task
parameters, starts the task and responds with id
of the
task. Generate task description has the following fields:
count
— positive number of SSCCs to be generated. This parameter is required and has no default value.sequence
— eitherordered
orrandom
. The default value israndom
.company_prefix
— use this company prefix in generated SSCCs. The prefix must be accessible by current participant, or current participant should have a wildcard prefix*
. The parameter is optional, first valid company prefix of participant will be used, if unspecified.serial_number
— start ordered SSCCs from this serial number. Only applicable for theordered
sequence. Has no default value, must be specified explicitly ifsequence
isordered
.
In ordered
mode, if generated SSCC is already present, next serial
number will be tried.
POST /serialization-service/packaging/tasks
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Session ticket |
Example Request
{
"count": 3,
"sequence": "ordered",
"company_prefix": "9212345",
"serial_number": 1
}
Example Response
{
"id": "344d2f8f-8aeb-4ae2-9cc7-954cbe3231d6"
}
Status of a SSCC Generation Task
Query status of SSCC import/generation task.
Task status representation has the total count
of SSCCs to be
created, number of already processed SSCCs in the progress
field,
list of already created SSCCs in the created
field and the list of
errors
.
GET /serialization-service/packaging/tasks/:id
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Session ticket |
Example Response
{
"count": 4,
"created": [
{
"gs1_sscc": "00099111116915813129",
"id": "urn:epc:id:sscc:9911111.0691581312"
}
],
"end_time": "2019-06-11T21:23:03Z",
"errors": [
{
"error_id": "serialization-bad_sscc_prefix",
"sscc": "00111111111111111118"
},
{
"error_id": "serialization-bad_sscc_prefix",
"sscc": "urn:epc:id:sscc:1111111.1111111111"
},
{
"error_id": "serialization-sscc_exists",
"sscc": "urn:epc:id:sscc:9212345.0000000001"
}
],
"id": "d78c69d3-5a64-4fed-bf93-5621be12aece",
"progress": 4,
"start_time": "2019-06-11T21:23:03Z",
"status": "done"
}
Status of All SSCC Generation Tasks
Get status of all SSCC create/import tasks for the
participant. Response has list of tasks
. Each entry represents a
single task (see Status of a Task
endpoint for task representation).
GET /serialization-service/packaging/tasks
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Session ticket |
Example Response
{
"tasks": [
{
"count": 4,
"created": [
{
"gs1_sscc": "00099111116915813129",
"id": "urn:epc:id:sscc:9911111.0691581312"
}
],
"end_time": "2019-06-11T21:23:03Z",
"errors": [
{
"error_id": "serialization-bad_sscc_prefix",
"sscc": "00111111111111111118"
},
{
"error_id": "serialization-bad_sscc_prefix",
"sscc": "urn:epc:id:sscc:1111111.1111111111"
},
{
"error_id": "serialization-sscc_exists",
"sscc": "urn:epc:id:sscc:9212345.0000000001"
}
],
"id": "d78c69d3-5a64-4fed-bf93-5621be12aece",
"progress": 4,
"start_time": "2019-06-11T21:23:03Z",
"status": "done"
}
]
}
Synchronous import/create SSCC
POST /serialization-service/packaging/sync
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Session ticket |
Generate list of SSCCs for current participant.
count
— positive number of SSCCs to be generated. This parameter is required and has no default value.id
— import SSCC code ot list of codes
Example Request. Generate 1 code
{
"count": 1
}
Example Response
{
"company_prefix": "7734170383",
"count": 1,
"created": [
{
"gs1_sscc": "00577341703831157974",
"id": "urn:epc:id:sscc:7734170383.5115797"
}
],
"end_time": "2020-02-19T14:14:59Z",
"progress": 1,
"sequence": "random",
"start_time": "2020-02-19T14:14:59Z",
"status": "done"
}
Example Request. Import SSCC
{
"id": ["00346079433414716042","00446079433414716049"]
}
Example Response
{
"count": 2,
"created": [
{
"gs1_sscc": "00446079433414716049",
"id": "urn:epc:id:sscc:4607943.4341471604"
},
{
"gs1_sscc": "00346079433414716042",
"id": "urn:epc:id:sscc:4607943.3341471604"
}
],
"end_time": "2020-02-19T14:20:00Z",
"progress": 2,
"start_time": "2020-02-19T14:19:59Z",
"status": "done"
}
Example Request. Import SSCC. Code already exist
{
"id": "00246079433414716045"
}
Example Response
{
"count": 1,
"end_time": "2020-02-19T14:17:03Z",
"errors": [
{
"error_id": "serialization-sscc_exists",
"sscc": "00246079433414716045"
}
],
"progress": 1,
"start_time": "2020-02-19T14:17:03Z",
"status": "done"
}
Pack Items into a Container
Endpoint to package existing SGTIN, LGTIN or children SSCC items into a container.
Item identifiers must be provided in items
field in request
body. Container is identified by SSCC in request URL.
Responds with list of sucessfully packed
items and with the list of
errors
.
POST /serialization-service/packaging/container/:sscc/pack
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Session ticket |
sscc |
string | Container identifier to pack into |
invoiceNumber |
string | Invoice Number |
invoiceDate |
string | Invoice Date |
gtin |
string | Base GTIN |
sku |
string | Optional SKU |
reflexNumber |
any | Reflex Invoice Number |
Example Request
{
"items": [
"urn:epc:id:sscc:9212345.0000000001",
"urn:epc:id:sscc:1111111.1111111111",
"urn:epc:id:sgtin:652086.0004527.000000000000001"
],
"invoiceNumber": "SomeNum",
"invoiceDate": "SomeDate",
"gtin": "00000000000000",
}
Example Response
{
"packed": [
"urn:epc:id:sscc:9212345.0000000001",
"urn:epc:id:sgtin:652086.0004527.000000000000001"
],
"errors": [
{
"item": "urn:epc:id:sscc:1111111.1111111111",
"error_id": "serialization-bad_pack_item"
}
]
}
Unpack Container
Endpoint to explicitly mark a container as unpacked. Responds with no content.
POST /serialization-service/packaging/container/:sscc/pack
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Session ticket |
sscc |
string | Container to unpack |
Example Request
{
}
Query Participant Packaging Settings
Endpoint for system participant to query packaging settings of a serialization admin participant.
Packaging settings consists of container_company_prefix
list
(participant is allowed to pack items into containers with these
prefixes) and item_company_prefix
list (participant is allowed to
pack items with these prefixes).
GET /serialization-service/packaging/participant/:participant_id/settings
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Session ticket |
participant_id |
string | Participant identifier |
Example Response
{
"container_company_prefix": [
"9212345",
"9523452"
],
"item_company_prefix": [
"9212345"
]
}
Update Participant Packaging Settings
Endpoint for system participant to update packaging settings of a
serialization admin participant. container_company_prefix
and
item_company_prefix
lists may be updated. Responds with the updated
settings.
PUT /serialization-service/packaging/participant/:participant_id/settings
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Session ticket |
participant_id |
string | Participant identifier |
Example Request
{
"item_company_prefix": [
"9212345",
"9523452"
]
}
Example Response
{
"container_company_prefix": [
"9212345",
"9523452"
],
"item_company_prefix": [
"9212345",
"9523452"
]
}
Aggregation
POST /serialization-service/aggregation
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session ticket |
gtin |
gtin | Source GTIN |
quantity |
pos_int | Required: Quantity of sgtin's |
doc |
string | Will be attached to packed sgtin |
invoiceNumber |
string | Query parameter |
sku |
string | Query parameter |
ownerInn |
string | Query parameter |
invoiceDate |
string | Query parameter |
scenarioTT |
0 or 1 | Required: Will be attached to packed sgtin |
aggregTT |
0 or 1 | Will be attached to packed sgtin |
pcb |
pos_int | Required: Quantity of sgtin's in pack |
aggregation_request |
0 or 1 | Do packing or not (default 1 (yes)). Works with reqest by invoice |
only_task |
0 or 1 | sync (default) or async (only_task = 1) |
query |
string | RSQL query |
op |
string | RSQL operator (AND or OR ) |
batch |
string | Optional batch field |
query
can be used for select of sgtins instead of invoiceNumber
, ownerInn
, invoiceDate
Example Request with option aggregation_request
=0
{
"gtin": "03348901300124",
"quantity": 5,
"doc": "test_doc",
"invoiceNumber": "Numbertest0819",
"ownerInn": "1234567891",
"invoiceDate": "2020-08-19",
"only_task": 0,
"batch": "123",
"aggregation_request": 0,
"scenarioTT": 1,
"pcb": 1
}
Example Response with option aggregation_request
=0
[
{
"aggregation_task": "ff73c94f-3335-4cf8-a34d-1559e3516a68@aggregation_task",
"code": "010334890130012421?,<don.Ji1QOV\u001d91EE05\u001d923LQZZHyjoOQ1wd2TmwXlbgWrs/ei3owacH16mF3Neu4=",
"gs1_sscc": "00577040987327502033"
},
{
"aggregation_task": "ff73c94f-3335-4cf8-a34d-1559e3516a68@aggregation_task",
"code": "010334890130012421?;H.HqheD_N>V\u001d91EE05\u001d923LQZZHyjoOQ1wd2TmwXlbgWrs/ei3owacH16mF3Neu4=",
"gs1_sscc": "00577040987327502033"
},
{
"aggregation_task": "ff73c94f-3335-4cf8-a34d-1559e3516a68@aggregation_task",
"code": "010334890130012421?EDyr\"m_1KD+F\u001d91EE05\u001d923LQZZHyjoOQ1wd2TmwXlbgWrs/ei3owacH16mF3Neu4=",
"gs1_sscc": "00577040987327502033"
},
{
"aggregation_task": "ff73c94f-3335-4cf8-a34d-1559e3516a68@aggregation_task",
"code": "010334890130012421?Ej%16y4!/85!\u001d91EE05\u001d923LQZZHyjoOQ1wd2TmwXlbgWrs/ei3owacH16mF3Neu4=",
"gs1_sscc": "00577040987327502033"
},
{
"aggregation_task": "ff73c94f-3335-4cf8-a34d-1559e3516a68@aggregation_task",
"code": "010334890130012421?gLfu:N!W11k!\u001d91EE05\u001d923LQZZHyjoOQ1wd2TmwXlbgWrs/ei3owacH16mF3Neu4=",
"gs1_sscc": "00577040987327502033"
}
]
Example Request (RSQL sync)
{
"quantity" :10,
"scenarioTT": 1,
"aggregTT": 1,
"query": "field_370a21b5f7f0c15d6dfce2a406dce5d86e74ca71==\"owner111\";field_64fdc5235d65719db2313923ad30ce7fda154808==\"invoice111\"",
"pcb":5}
}
Example Request (RSQL async)
{
"quantity" :10,
"scenarioTT": 1,
"aggregTT": 1,
"query": "field_370a21b5f7f0c15d6dfce2a406dce5d86e74ca71==\"owner111\";field_64fdc5235d65719db2313923ad30ce7fda154808==\"invoice111\"",
"type":"async",
"pcb":5}
}
Example Request (sync)
{
"gtin": "03605521651167",
"quantity": 10,
"sku": "L2598102",
"doc": "doc_number_test",
"invoiceNumber": "4400002",
"ownerInn": "7726059896",
"invoiceDate": "2020-07-25",
"scenarioTT": 0,
"pcb": 5
}
Example Request (async)
{
"gtin": "03348901300124",
"quantity": 5,
"doc": "test_doc",
"invoiceNumber": "Numbertest0819",
"ownerInn": "1234567891",
"invoiceDate": "2020-08-19",
"only_task": 0,
"batch": "123",
"aggregation_request": 1,
"scenarioTT": 1,
"pcb": 5
}
Example Response (sync)
[
{
"aggregation_task": "f09151e4-1a37-4275-a428-104319cd3e8c@aggregation_task",
"code": "010334890130012421?GqyMH2qAMR1k\u001d91EE05\u001d923LQZZHyjoOQ1wd2TmwXlbgWrs/ei3owacH16mF3Neu4=",
"gs1_sscc": "00577341703833335363"
},
{
"aggregation_task": "f09151e4-1a37-4275-a428-104319cd3e8c@aggregation_task",
"code": "010334890130012421?IBT4v?Ziy+F!\u001d91EE05\u001d923LQZZHyjoOQ1wd2TmwXlbgWrs/ei3owacH16mF3Neu4=",
"gs1_sscc": "00577341703833335363"
},
{
"aggregation_task": "f09151e4-1a37-4275-a428-104319cd3e8c@aggregation_task",
"code": "010334890130012421?M8NXs;o<8TdV\u001d91EE05\u001d923LQZZHyjoOQ1wd2TmwXlbgWrs/ei3owacH16mF3Neu4=",
"gs1_sscc": "00577341703833335363"
},
{
"aggregation_task": "f09151e4-1a37-4275-a428-104319cd3e8c@aggregation_task",
"code": "010334890130012421?oU+hD3MZgu85\u001d91EE05\u001d923LQZZHyjoOQ1wd2TmwXlbgWrs/ei3owacH16mF3Neu4=",
"gs1_sscc": "00577341703833335363"
},
{
"aggregation_task": "f09151e4-1a37-4275-a428-104319cd3e8c@aggregation_task",
"code": "010334890130012421?oUgUcU<xA!Y5\u001d91EE05\u001d923LQZZHyjoOQ1wd2TmwXlbgWrs/ei3owacH16mF3Neu4=",
"gs1_sscc": "00577341703833335363"
}
]
Example Response (async)
{
"aggregation_task": "6bea9bea-4606-44bc-817c-ce3d63c264df@aggregation_task"
}
Read aggregation tasks
GET /serialization-service/aggregation
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session ticket |
chunk_id |
string | Chunk ID of aggregation tasks list |
Example Response
{
"next": "urn:authenticateit:participant:804355519238230@aggregation_tasks@59e4f585-2d95-4bcb-badf-088830c60120",
"tasks": [
{
"end_time": "2019-11-26T20:38:01Z",
"id": "1c55090c-205c-45c2-8015-d2cfc0455f52@aggregation_task",
"link": "https://dev-cdn.shping.com/2019/11/26/1c55090c-205c-45c2-8015-d2cfc0455f52@aggregation_task.csv",
"progress": 2,
"start_time": "2019-11-26T20:37:58Z",
"status": "done",
"total": 2
}
]
}
Example Response
{
"next": null,
"tasks": [
{
"end_time": "2019-11-26T15:32:16Z",
"id": "dc019878-fda6-4a39-90e8-65179361ba74@aggregation_task",
"link": "https://dev-cdn.shping.com/2019/11/26/dc019878-fda6-4a39-90e8-65179361ba74@aggregation_task.csv",
"progress": 1,
"start_time": "2019-11-26T15:32:14Z",
"status": "done",
"total": 1
}
]
}
Read aggregation task
GET /serialization-service/aggregation/:id
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session ticket |
id |
string | Aggregation task id |
Example Response
{
"end_time": "2019-11-25T21:14:16Z",
"id": "2226d3d5-c69e-4c9f-938b-4a92c0577540@aggregation_task",
"link": "https://dev-cdn.shping.com/2019/11/25/2226d3d5-c69e-4c9f-938b-4a92c0577540@aggregation_task.csv",
"progress": 4,
"start_time": "2019-11-25T21:08:40Z",
"status": "done",
"total": 4
}
Example Response
{
"end_time": null,
"id": "034d8510-29ce-4c68-b3dd-5a5f3b3882b1@aggregation_task",
"progress": 41,
"start_time": "2019-11-26T20:56:10Z",
"status": "started",
"total": 62
}
Import sgtins
Import serialized products.
POST /serialization-service/import/sgtins
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
gtin |
base gtin | Required: Base GTIN |
task_id |
string | Required: Task ID |
quantity |
pos_integer | Required: Total sgtins quantity for the task |
sgtins |
list | Required: List of sgtins in GS1 format |
settings |
object | Settings object |
settings .labels_as_titles |
yes or no |
Labels as titles in csv header. Default no |
settings .code |
yes or no |
GS1 code in csv. Default yes |
settings .owner |
yes or no |
Owner id in csv. Default no |
settings .delimiter |
string | Default "|" |
settings .name |
yes or no |
Export product name in csv. Default no |
sources | sources_object | Additional sources |
If the response is empty, then quantity of loaded SGTINS lower than quantity
value in request.
Example Request
{
"sgtins": [
"010334890087198421UKy;UoI+lAOY6\u001d91EE05\u001d925sqJbVM5XQm2Gep4rUjZJgfU88b1RDyYwxud7zb10r0=",
"010334890087198421n=uL2(cGl0\"iE\u001d91EE05\u001d92lbePGb4f4LYgietArtEc3KlIKqRVdqnNC+cOz+kddcs=",
"010334890087198421j_r'b*k?YBf9n\u001d91EE05\u001d92u5injthuxUaXp2NIZjFOcQABYjiBblm24pFuuaWWXxU=",
"010334890087198421VQ*jD!UF:4%V2\u001d91EE05\u001d92paYoXTV5XBHsdfM19oe/bO45k1FBx5L8kZ+jLsOhdkA=",
"010334890087198421+>nec)I7DG&Gg\u001d91EE05\u001d92zTJ6EIcH9NKyXatK5h1ouMyRAuUq5L78jcjtOlX73Fk=",
"0103348900871984211Ky;UoI+lAOY6\u001d91EE05\u001d925sqJbVM5XQm2Gep4rUjZJgfU88b1RDyYwxud7zb10r0=",
"0103348900871984212=uL2(cGl0\"iE\u001d91EE05\u001d92lbePGb4f4LYgietArtEc3KlIKqRVdqnNC+cOz+kddcs=",
"0103348900871984213_r'b*k?YBf9n\u001d91EE05\u001d92u5injthuxUaXp2NIZjFOcQABYjiBblm24pFuuaWWXxU=",
"0103348900871984214Q*jD!UF:4%V2\u001d91EE05\u001d92paYoXTV5XBHsdfM19oe/bO45k1FBx5L8kZ+jLsOhdkA=",
"0103348900871984215>nec)I7DG&Gg\u001d91EE05\u001d92zTJ6EIcH9NKyXatK5h1ouMyRAuUq5L78jcjtOlX73Fk=",
"0103348900871984216Ky;UoI+lAOY6\u001d91EE05\u001d925sqJbVM5XQm2Gep4rUjZJgfU88b1RDyYwxud7zb10r0=",
"0103348900871984217=uL2(cGl0\"iE\u001d91EE05\u001d92lbePGb4f4LYgietArtEc3KlIKqRVdqnNC+cOz+kddcs=",
"0103348900871984218_r'b*k?YBf9n\u001d91EE05\u001d92u5injthuxUaXp2NIZjFOcQABYjiBblm24pFuuaWWXxU=",
"0103348900871984219Q*jD!UF:4%V2\u001d91EE05\u001d92paYoXTV5XBHsdfM19oe/bO45k1FBx5L8kZ+jLsOhdkA=",
"0103348900871984210>nec)I7DG&Gg\u001d91EE05\u001d92zTJ6EIcH9NKyXatK5h1ouMyRAuUq5L78jcjtOlX73Fk=",
"010334890087198421aKy;UoI+lAOY6\u001d91EE05\u001d925sqJbVM5XQm2Gep4rUjZJgfU88b1RDyYwxud7zb10r0=",
"010334890087198421b=uL2(cGl0\"iE\u001d91EE05\u001d92lbePGb4f4LYgietArtEc3KlIKqRVdqnNC+cOz+kddcs=",
"010334890087198421c_r'b*k?YBf9n\u001d91EE05\u001d92u5injthuxUaXp2NIZjFOcQABYjiBblm24pFuuaWWXxU=",
"010334890087198421dQ*jD!UF:4%V2\u001d91EE05\u001d92paYoXTV5XBHsdfM19oe/bO45k1FBx5L8kZ+jLsOhdkA=",
"010334890087198421e>nec)I7DG&Gg\u001d91EE05\u001d92zTJ6EIcH9NKyXatK5h1ouMyRAuUq5L78jcjtOlX73Fk=",
"010334890087198421fQ*jD!UF:4%V2\u001d91EE05\u001d92paYoXTV5XBHsdfM19oe/bO45k1FBx5L8kZ+jLsOhdkA=",
"010334890087198421g>nec)I7DG&Gg\u001d91EE05\u001d92zTJ6EIcH9NKyXatK5h1ouMyRAuUq5L78jcjtOlX73Fk="
],
"quantity": 22,
"gtin": "03348900871984",
"task_id": "198373d4-4d04-4c7f-9a5a-045b10c3bbc6",
"sources": [
{
"conditions": {},
"data": [
{
"text": {
"markdown": false,
"text": "invoiceNumber111111",
"title": "invoiceNumber"
}
},
{
"text": {
"markdown": false,
"text": "ownerInn111111",
"title": "ownerInn"
}
},
{
"text": {
"markdown": false,
"text": "2019-12-06",
"title": "invoiceDate"
}
}
]
}
],
"settings": {
"delimiter": "|"
}
}
Example Response
{
"id": "198373d4-4d04-4c7f-9a5a-045b10c3bbc6"
}
Missions
Create mission
POST /serialization-service/mission
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
client |
string | Required: Client parameter |
depo |
string | Required: Depo parameter |
msg_type |
string | Required: Type parameter (GFP or GPK ) |
msg |
object or array | Required: Message |
Example Request
{
"client": "SELDICO",
"depo": "TKV",
"msg_type": "GFP",
"msg": [
{
"preparation_number": "10400051244",
"order_number": "CHP-715211",
"pallet_number": "871112227000001107",
"gtin": "03348900871984",
"qty": "5"
}
]
}
Example Response
[
{
"epc_pallet_number": "urn:epc:id:sscc:7111222.8700000110",
"id": "f8a5d45c-9a9f-4a7c-89c9-64985f4d922d",
"pallet_number": "00871112227000001107",
"preparation_number": "10400051244"
}
]
Example Request
{
"client": "SELDICO",
"depo": "TKV",
"msg_type": "GPK",
"msg": [
{
"preparation_number": "10100051244",
"order_number": "CHP-715211",
"carton_number": "871112221000001105",
"pallet_number": "000000000000000000",
"gtin": "03348900871984",
"qty": "5"
},
{
"preparation_number": "10100051244",
"order_number": "CHP-715211",
"carton_number": "871112220000001108",
"gtin": "03348900871984",
"qty": "5"
}
]
}
Example Response
[
{
"carton_number": "00871112221000001105",
"epc_carton_number": "urn:epc:id:sscc:7111222.8100000110",
"id": "4dd0f2f1-223d-4865-8f2e-97239099699e",
"preparation_number": "10100051244"
},
{
"carton_number": "00871112220000001108",
"epc_carton_number": "urn:epc:id:sscc:7111222.8000000110",
"id": "043d3c9d-9e69-4ba3-baf1-cdb5703f2a2b",
"preparation_number": "10100051244"
}
]
Example Request
{
"client": "SELDICO",
"depo": "TKV",
"msg_type": "GPK",
"msg": [
{
"preparation_number": "10200051244",
"order_number": "CHP-715211",
"carton_number": "871112223000001109",
"pallet_number": "871112223000011108",
"gtin": "03348900871984",
"qty": "5"
},
{
"preparation_number": "10200051244",
"order_number": "CHP-715211",
"carton_number": "871112224000001106",
"pallet_number": "871112223000011108",
"gtin": "03348900871984",
"qty": "5"
}
]
}
Example Response
[
{
"carton_number": "00871112223000001109",
"epc_carton_number": "urn:epc:id:sscc:7111222.8300000110",
"epc_pallet_number": "urn:epc:id:sscc:7111222.8300001110",
"id": "f2c6112b-1b8d-4a19-b426-91d4c3d24c6f",
"pallet_number": "00871112223000011108",
"preparation_number": "10200051244"
},
{
"carton_number": "00871112224000001106",
"epc_carton_number": "urn:epc:id:sscc:7111222.8400000110",
"epc_pallet_number": "urn:epc:id:sscc:7111222.8300001110",
"id": "426e906f-1251-4571-a252-18c6e3157294",
"pallet_number": "00871112223000011108",
"preparation_number": "10200051244"
}
]
Read mission state
Workflow of read mission identifier by sscc code:
1) Get the schema (GET /index-service/index-schema
) with the type sscc
2) find record where gs1_id
= sscc code by RSQL
3) get mission identifier from mission_id
field. If mission_id
is NULL then there are no attached mission
POST /serialization-service/mission/state
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
mission |
string | Required: Mission ID |
Example Request
{ "mission": "10400051244" }
Example Response GFP
{
"list": [
{
"carton_number": null,
"client": "SELDICO",
"depo": "TKV",
"epc_carton_number": null,
"epc_pallet_number": "urn:epc:id:sscc:7111222.8700000110",
"gtin": "03348900871984",
"id": "f8a5d45c-9a9f-4a7c-89c9-64985f4d922d",
"mission_type": "GFP",
"order_number": "CHP-715211",
"pallet_number": "00871112227000001107",
"participant": "urn:authenticateit:participant:804355519238230",
"preparation_number": "10400051244",
"qty": 5,
"ts": "2020-02-05T13:38:59Z"
}
],
"mission_id": "10400051244",
"owner": "urn:authenticateit:participant:804355519238230"
}
Example Request
{ "mission": "10100051244" }
Example Response GPK with SGTINs
{
"list": [
{
"carton_number": "00871112221000001105",
"client": "SELDICO",
"depo": "TKV",
"epc_carton_number": "urn:epc:id:sscc:7111222.8100000110",
"epc_pallet_number": null,
"gtin": "03348900871984",
"id": "4dd0f2f1-223d-4865-8f2e-97239099699e",
"mission_type": "GPK",
"order_number": "CHP-715211",
"pallet_number": null,
"participant": "urn:authenticateit:participant:804355519238230",
"preparation_number": "10100051244",
"qty": 5,
"ts": "2020-02-05T13:34:41Z"
},
{
"carton_number": "00871112220000001108",
"client": "SELDICO",
"depo": "TKV",
"epc_carton_number": "urn:epc:id:sscc:7111222.8000000110",
"epc_pallet_number": null,
"gtin": "03348900871984",
"id": "043d3c9d-9e69-4ba3-baf1-cdb5703f2a2b",
"mission_type": "GPK",
"order_number": "CHP-715211",
"pallet_number": null,
"participant": "urn:authenticateit:participant:804355519238230",
"preparation_number": "10100051244",
"qty": 5,
"ts": "2020-02-05T13:34:41Z"
}
],
"mission_id": "10100051244",
"owner": "urn:authenticateit:participant:804355519238230"
}
Example Request
{ "mission": "10200051244" }
Example Response GPK with SSCCs
{
"list": [
{
"carton_number": "00871112223000001109",
"client": "SELDICO",
"depo": "TKV",
"epc_carton_number": "urn:epc:id:sscc:7111222.8300000110",
"epc_pallet_number": "urn:epc:id:sscc:7111222.8300001110",
"gtin": "03348900871984",
"id": "f2c6112b-1b8d-4a19-b426-91d4c3d24c6f",
"mission_type": "GPK",
"order_number": "CHP-715211",
"pallet_number": "00871112223000011108",
"participant": "urn:authenticateit:participant:804355519238230",
"preparation_number": "10200051244",
"qty": 5,
"ts": "2020-02-05T13:37:19Z"
},
{
"carton_number": "00871112224000001106",
"client": "SELDICO",
"depo": "TKV",
"epc_carton_number": "urn:epc:id:sscc:7111222.8400000110",
"epc_pallet_number": "urn:epc:id:sscc:7111222.8300001110",
"gtin": "03348900871984",
"id": "426e906f-1251-4571-a252-18c6e3157294",
"mission_type": "GPK",
"order_number": "CHP-715211",
"pallet_number": "00871112223000011108",
"participant": "urn:authenticateit:participant:804355519238230",
"preparation_number": "10200051244",
"qty": 5,
"ts": "2020-02-05T13:37:19Z"
}
],
"mission_id": "10200051244",
"owner": "urn:authenticateit:participant:804355519238230"
}
Attach item/items to the specific mission
PUT /serialization-service/mission/put_on
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
mission |
string | Required: Mission ID |
to_sscc |
string | Target SSCC code |
items |
list of objects | Required: Attached items |
Objects items
.item
has two parameters: item
.code
and item
.to_sscc
.
item
.code
for GFP
mission type is sscc GS1 code equal to item
.to_sscc
.
item
.code
for GPK
mission type is sgtin GS1 code or SSCC code (carton_number).
Main to_sscc
parameter will be used if item
.to_sscc
does not exist.
Example Request. Collect SGTINs for GPK
{
"mission": "10100051244",
"items": [
{
"to_sscc": "00871112221000001105",
"code": "010334890087198421z2(UKhORy!://"
},
{
"to_sscc": "00871112221000001105",
"code": "010334890087198421zrfFT&SQ1*4!m"
}
]
}
Example Response
{
"list": [
{
"carton_number": "00871112221000001105",
"client": "SELDICO",
"collected": [
{
"code": "010334890087198421zrfFT&SQ1*4!m",
"sgtin": "urn:epc:id:sgtin:3348900.087198.zrfFT&SQ1*4!m"
},
{
"code": "010334890087198421z2(UKhORy!://",
"sgtin": "urn:epc:id:sgtin:3348900.087198.z2(UKhORy!://"
}
],
"depo": "TKV",
"epc_carton_number": "urn:epc:id:sscc:7111222.8100000110",
"epc_pallet_number": null,
"gtin": "03348900871984",
"id": "4dd0f2f1-223d-4865-8f2e-97239099699e",
"mission_type": "GPK",
"order_number": "CHP-715211",
"pallet_number": null,
"participant": "urn:authenticateit:participant:804355519238230",
"preparation_number": "10100051244",
"qty": 5,
"ts": "2020-02-05T13:34:41Z"
},
{
"carton_number": "00871112220000001108",
"client": "SELDICO",
"depo": "TKV",
"epc_carton_number": "urn:epc:id:sscc:7111222.8000000110",
"epc_pallet_number": null,
"gtin": "03348900871984",
"id": "043d3c9d-9e69-4ba3-baf1-cdb5703f2a2b",
"mission_type": "GPK",
"order_number": "CHP-715211",
"pallet_number": null,
"participant": "urn:authenticateit:participant:804355519238230",
"preparation_number": "10100051244",
"qty": 5,
"ts": "2020-02-05T13:34:41Z"
}
],
"mission_id": "10100051244",
"owner": "urn:authenticateit:participant:804355519238230"
}
Example Request. Collect SSCCs for GPK
{
"mission": "10200051244",
"items": [
{
"to_sscc": "00871112223000011108",
"code": "00871112223000001109"
}
]
}
Example Response
{
"list": [
{
"carton_number": "00871112223000001109",
"client": "SELDICO",
"collected": [
{
"code": "00871112223000001109",
"epc_sscc": "urn:epc:id:sscc:7111222.8300000110"
}
],
"depo": "TKV",
"epc_carton_number": "urn:epc:id:sscc:7111222.8300000110",
"epc_pallet_number": "urn:epc:id:sscc:7111222.8300001110",
"gtin": "03348900871984",
"id": "f2c6112b-1b8d-4a19-b426-91d4c3d24c6f",
"mission_type": "GPK",
"order_number": "CHP-715211",
"pallet_number": "00871112223000011108",
"participant": "urn:authenticateit:participant:804355519238230",
"preparation_number": "10200051244",
"qty": 5,
"ts": "2020-02-05T13:37:19Z"
},
{
"carton_number": "00871112224000001106",
"client": "SELDICO",
"depo": "TKV",
"epc_carton_number": "urn:epc:id:sscc:7111222.8400000110",
"epc_pallet_number": "urn:epc:id:sscc:7111222.8300001110",
"gtin": "03348900871984",
"id": "426e906f-1251-4571-a252-18c6e3157294",
"mission_type": "GPK",
"order_number": "CHP-715211",
"pallet_number": "00871112223000011108",
"participant": "urn:authenticateit:participant:804355519238230",
"preparation_number": "10200051244",
"qty": 5,
"ts": "2020-02-05T13:37:19Z"
}
],
"mission_id": "10200051244",
"owner": "urn:authenticateit:participant:804355519238230"
}
Example Request. Collect SSCCs for GFP
{
"mission": "10400051244",
"items": [
{
"to_sscc": "00871112227000001107",
"code": "00871112227000001107"
}
]
}
Example Response
{
"list": [
{
"carton_number": null,
"client": "SELDICO",
"collected": [
{
"code": "00871112227000001107",
"epc_sscc": "urn:epc:id:sscc:7111222.8700000110"
}
],
"depo": "TKV",
"epc_carton_number": null,
"epc_pallet_number": "urn:epc:id:sscc:7111222.8700000110",
"gtin": "03348900871984",
"id": "f8a5d45c-9a9f-4a7c-89c9-64985f4d922d",
"mission_type": "GFP",
"order_number": "CHP-715211",
"pallet_number": "00871112227000001107",
"participant": "urn:authenticateit:participant:804355519238230",
"preparation_number": "10400051244",
"qty": 5,
"ts": "2020-02-05T13:38:59Z"
}
],
"mission_id": "10400051244",
"owner": "urn:authenticateit:participant:804355519238230"
}
Deattach item/items from the specific mission
PUT /serialization-service/mission/put_off
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
mission |
string | Required: Mission ID |
to_sscc |
string | Target SSCC code |
items |
list of objects | Required: Attached items |
Objects items
.item
has two parameters: item
.code
and item
.to_sscc
.
item
.code
for GFP
mission type is sscc GS1 code equal to item
.to_sscc
.
item
.code
for GPK
mission type is sgtin GS1 code or SSCC code (carton_number).
Main to_sscc
parameter will be used if item
.to_sscc
does not exist.
Example Request. Remove SGTINs (GPK)
{
"mission": "10100051244",
"items": [
{
"to_sscc": "00871112221000001105",
"code": "010334890087198421z2(UKhORy!://"
},
{
"to_sscc": "00871112221000001105",
"code": "010334890087198421zrfFT&SQ1*4!m"
}
]
}
Example Response
{
"list": [
{
"carton_number": "00871112221000001105",
"client": "SELDICO",
"collected": [],
"depo": "TKV",
"epc_carton_number": "urn:epc:id:sscc:7111222.8100000110",
"epc_pallet_number": null,
"gtin": "03348900871984",
"id": "4dd0f2f1-223d-4865-8f2e-97239099699e",
"mission_type": "GPK",
"order_number": "CHP-715211",
"pallet_number": null,
"participant": "urn:authenticateit:participant:804355519238230",
"preparation_number": "10100051244",
"qty": 5,
"ts": "2020-02-05T13:34:41Z"
},
{
"carton_number": "00871112220000001108",
"client": "SELDICO",
"depo": "TKV",
"epc_carton_number": "urn:epc:id:sscc:7111222.8000000110",
"epc_pallet_number": null,
"gtin": "03348900871984",
"id": "043d3c9d-9e69-4ba3-baf1-cdb5703f2a2b",
"mission_type": "GPK",
"order_number": "CHP-715211",
"pallet_number": null,
"participant": "urn:authenticateit:participant:804355519238230",
"preparation_number": "10100051244",
"qty": 5,
"ts": "2020-02-05T13:34:41Z"
}
],
"mission_id": "10100051244",
"owner": "urn:authenticateit:participant:804355519238230"
}
Example Request. Remove SSCC (GPK)
{
"mission": "10200051244",
"items": [
{
"to_sscc": "00871112223000011108",
"code": "00871112223000001109"
}
]
}
Example Response
{
"list": [
{
"carton_number": "00871112223000001109",
"client": "SELDICO",
"collected": [],
"depo": "TKV",
"epc_carton_number": "urn:epc:id:sscc:7111222.8300000110",
"epc_pallet_number": "urn:epc:id:sscc:7111222.8300001110",
"gtin": "03348900871984",
"id": "f2c6112b-1b8d-4a19-b426-91d4c3d24c6f",
"mission_type": "GPK",
"order_number": "CHP-715211",
"pallet_number": "00871112223000011108",
"participant": "urn:authenticateit:participant:804355519238230",
"preparation_number": "10200051244",
"qty": 5,
"ts": "2020-02-05T13:37:19Z"
},
{
"carton_number": "00871112224000001106",
"client": "SELDICO",
"depo": "TKV",
"epc_carton_number": "urn:epc:id:sscc:7111222.8400000110",
"epc_pallet_number": "urn:epc:id:sscc:7111222.8300001110",
"gtin": "03348900871984",
"id": "426e906f-1251-4571-a252-18c6e3157294",
"mission_type": "GPK",
"order_number": "CHP-715211",
"pallet_number": "00871112223000011108",
"participant": "urn:authenticateit:participant:804355519238230",
"preparation_number": "10200051244",
"qty": 5,
"ts": "2020-02-05T13:37:19Z"
}
],
"mission_id": "10200051244",
"owner": "urn:authenticateit:participant:804355519238230"
}
Example Request. Remove SSCC (GFP)
{
"mission": "10400051244",
"items": [
{
"to_sscc": "00871112227000001107",
"code": "00871112227000001107"
}
]
}
Example Response
{
"list": [
{
"carton_number": null,
"client": "SELDICO",
"collected": [],
"depo": "TKV",
"epc_carton_number": null,
"epc_pallet_number": "urn:epc:id:sscc:7111222.8700000110",
"gtin": "03348900871984",
"id": "f8a5d45c-9a9f-4a7c-89c9-64985f4d922d",
"mission_type": "GFP",
"order_number": "CHP-715211",
"pallet_number": "00871112227000001107",
"participant": "urn:authenticateit:participant:804355519238230",
"preparation_number": "10400051244",
"qty": 5,
"ts": "2020-02-05T13:38:59Z"
}
],
"mission_id": "10400051244",
"owner": "urn:authenticateit:participant:804355519238230"
}
Solea items handling
PUT /serialization-service/mission/solea
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
items |
list of objects | Required: Items to be handled |
Example Request
{
"items": [
{
"tour_code": "11111128742",
"container_handling_code": "241111111136465822",
"sku": "P083382",
"trade_unit": "03",
"sscc_client": "00577341703831364419"
},
{
"tour_code": "11111128742",
"container_handling_code": "241111111136465822",
"sku": "P083382",
"trade_unit": "03",
"sscc_client": "00577341703838605614"
},
{
"tour_code": "11111118742",
"container_handling_code": "00241111111126465825",
"sku": "P083382",
"trade_unit": "00",
"code": "0103274872387942214KRVDVZQ5BCAO"
},
{
"tour_code": "11111118742",
"container_handling_code": "00241111111126465825",
"sku": "P083382",
"trade_unit": "00",
"code": "0103274872387942218N49IWH2S854W"
},
{
"tour_code": "11111118742",
"container_handling_code": "00241111111126465825",
"sku": "P083382",
"trade_unit": "00",
"code": "010327487238794221E7SHA62IZATQ8"
}
]
}
Example Response
{
"missed": [
"010327487238794221E7SHA62IZATQ8"
],
"stored": [
"0103274872387942214KRVDVZQ5BCAO",
"0103274872387942218N49IWH2S854W",
"00577341703831364419",
"00577341703838605614"
]
}
Validate mission according SLI/SL1
POST /serialization-service/mission/validate
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
preparation_number |
string | Required: Mission ID |
type |
string | Required: sli or sl1 |
withdrawalType |
string | Withdrawal reason |
issuer |
string | SLI/SL1 issuer |
consigneeCode |
string | Reassignment participant ID |
containers |
object | Required: sli or sl1 |
containers .qty |
integer | Required: Quantity in container |
containers .cartonId |
string | Required: container id (SSCC code) |
containers .hdId |
string | Required: Pallet id (SSCC code) |
containers .gtin |
string | Required: Gtin |
issuer
is optional field. Is issuer is empty, list of childs participants will be loaded from current_participant
according ticket
Example Request
{
"preparation_number": "999888111",
"type": "sli",
"consigneeCode":"521",
"owner_code": "DIR",
"depo": "TKV",
"order_number": "CHK-999888111",
"containers": [
{
"qty": 6,
"sku": "F976014001",
"gtin": "03348900487451",
"cartonId": "999888111100001105"
},
{
"qty": 5,
"sku": "F002760017",
"gtin": "03348900387881",
"cartonId": "999888111100001105"
},
{
"qty": 6,
"sku": "F430021005",
"gtin": "03348900928381",
"hdId": "999888111200001104"
}
]
}
Example Response
{
"id": "39b86bf1-edcb-42a5-b80f-e776457ea225",
"owner": {
"external_id": "521",
"id": "urn:authenticateit:participant:571534011284642",
"inn": "7729683125",
"name": "ООО \"Семь кистей\"",
"sscc_document": "0",
"transfer_type": "1",
"withdrawal_type": ""
},
"tree": {
"00999888111100001105": [
{
"code": "010334890038788121?:J-RTyQmzW;F",
"gtin": "03348900387881",
"id": "urn:epc:id:sgtin:3348900.038788.?:J-RTyQmzW;F",
"sscc": "urn:epc:id:sscc:9988811110.9000110"
},
{
"code": "010334890038788121_'eUaeoGrR1k!",
"gtin": "03348900387881",
"id": "urn:epc:id:sgtin:3348900.038788._'eUaeoGrR1k!",
"sscc": "urn:epc:id:sscc:9988811110.9000110"
},
{
"code": "010334890038788121a7OYT7qgzxw1k",
"gtin": "03348900387881",
"id": "urn:epc:id:sgtin:3348900.038788.a7OYT7qgzxw1k",
"sscc": "urn:epc:id:sscc:9988811110.9000110"
},
{
"code": "010334890038788121g8j?&h;*<P-wk",
"gtin": "03348900387881",
"id": "urn:epc:id:sgtin:3348900.038788.g8j?&h;*<P-wk",
"sscc": "urn:epc:id:sscc:9988811110.9000110"
},
{
"code": "010334890038788121wwuK_1cYl11k!",
"gtin": "03348900387881",
"id": "urn:epc:id:sgtin:3348900.038788.wwuK_1cYl11k!",
"sscc": "urn:epc:id:sscc:9988811110.9000110"
},
{
"code": "010334890048745121\"KShI&%vCde85",
"gtin": "03348900487451",
"id": "urn:epc:id:sgtin:3348900.048745.\"KShI&%vCde85",
"sscc": "urn:epc:id:sscc:9988811110.9000110"
},
{
"code": "0103348900487451214!->I;QQ*x3dV",
"gtin": "03348900487451",
"id": "urn:epc:id:sgtin:3348900.048745.4!->I;QQ*x3dV",
"sscc": "urn:epc:id:sscc:9988811110.9000110"
},
{
"code": "010334890048745121TsAhs9bPaml;F",
"gtin": "03348900487451",
"id": "urn:epc:id:sgtin:3348900.048745.TsAhs9bPaml;F",
"sscc": "urn:epc:id:sscc:9988811110.9000110"
},
{
"code": "010334890048745121XE41Oi-gfMR1k",
"gtin": "03348900487451",
"id": "urn:epc:id:sgtin:3348900.048745.XE41Oi-gfMR1k",
"sscc": "urn:epc:id:sscc:9988811110.9000110"
},
{
"code": "010334890048745121kj0Aw+URC3dV!",
"gtin": "03348900487451",
"id": "urn:epc:id:sgtin:3348900.048745.kj0Aw+URC3dV!",
"sscc": "urn:epc:id:sscc:9988811110.9000110"
},
{
"code": "010334890048745121q7/b\"Xw,=sc>V",
"gtin": "03348900487451",
"id": "urn:epc:id:sgtin:3348900.048745.q7/b\"Xw,=sc>V",
"sscc": "urn:epc:id:sscc:9988811110.9000110"
}
],
"00999888111200001104": {
"00577341703831309557": [
{
"code": "010334890092838121,WC=fqZbD7b&5",
"gtin": "03348900928381",
"id": "urn:epc:id:sgtin:3348900.092838.,WC=fqZbD7b&5",
"sscc": "urn:epc:id:sscc:7734170383.5130955"
},
{
"code": "0103348900928381215g!iQDPzyhbaF",
"gtin": "03348900928381",
"id": "urn:epc:id:sgtin:3348900.092838.5g!iQDPzyhbaF",
"sscc": "urn:epc:id:sscc:7734170383.5130955"
},
{
"code": "0103348900928381216<J875WjF+0OV",
"gtin": "03348900928381",
"id": "urn:epc:id:sgtin:3348900.092838.6<J875WjF+0OV",
"sscc": "urn:epc:id:sscc:7734170383.5130955"
},
{
"code": "010334890092838121baOgvb?sVvi+F",
"gtin": "03348900928381",
"id": "urn:epc:id:sgtin:3348900.092838.baOgvb?sVvi+F",
"sscc": "urn:epc:id:sscc:7734170383.5130955"
},
{
"code": "010334890092838121S6h>4=dIQo6tV",
"gtin": "03348900928381",
"id": "urn:epc:id:sgtin:3348900.092838.S6h>4=dIQo6tV",
"sscc": "urn:epc:id:sscc:7734170383.5130955"
},
{
"code": "010334890092838121wIuy?IcaOG_.V",
"gtin": "03348900928381",
"id": "urn:epc:id:sgtin:3348900.092838.wIuy?IcaOG_.V",
"sscc": "urn:epc:id:sscc:7734170383.5130955"
}
]
}
}
}
Example Request
{
"preparation_number": "999888111",
"type": "sli",
"consigneeCode":"521",
"owner_code": "DIR",
"depo": "TKV",
"order_number": "CHK-999888111",
"containers": [
{
"qty": 6,
"sku": "F976014001",
"gtin": "03348900487451",
"cartonId": "999888111100001105"
},
{
"qty": 5,
"sku": "F002760017",
"gtin": "03348900387881",
"cartonId": "999888111100001105"
},
{
"qty": 6,
"sku": "F430021005",
"gtin": "03348900928381",
"hdId": "999888111200001104"
}
]
}
Example Response
{
"id": "f12f1461-78eb-4812-bd02-f587b7c6e2b9",
"owner": {
"external_id": "521",
"id": "urn:authenticateit:participant:571534011284642",
"inn": "7729683125",
"name": "ООО \"Семь кистей\"",
"sscc_document": "1",
"transfer_type": "1",
"withdrawal_type": ""
},
"tree": {
"00577341703836841656": [
{
"code": "010334890092838121,WC=fqZbD7b&5",
"gtin": "03348900928381",
"id": "urn:epc:id:sgtin:3348900.092838.,WC=fqZbD7b&5",
"sscc": "urn:epc:id:sscc:7734170383.5130955"
},
{
"code": "0103348900928381215g!iQDPzyhbaF",
"gtin": "03348900928381",
"id": "urn:epc:id:sgtin:3348900.092838.5g!iQDPzyhbaF",
"sscc": "urn:epc:id:sscc:7734170383.5130955"
},
{
"code": "0103348900928381216<J875WjF+0OV",
"gtin": "03348900928381",
"id": "urn:epc:id:sgtin:3348900.092838.6<J875WjF+0OV",
"sscc": "urn:epc:id:sscc:7734170383.5130955"
},
{
"code": "010334890092838121baOgvb?sVvi+F",
"gtin": "03348900928381",
"id": "urn:epc:id:sgtin:3348900.092838.baOgvb?sVvi+F",
"sscc": "urn:epc:id:sscc:7734170383.5130955"
},
{
"code": "010334890092838121S6h>4=dIQo6tV",
"gtin": "03348900928381",
"id": "urn:epc:id:sgtin:3348900.092838.S6h>4=dIQo6tV",
"sscc": "urn:epc:id:sscc:7734170383.5130955"
},
{
"code": "010334890092838121wIuy?IcaOG_.V",
"gtin": "03348900928381",
"id": "urn:epc:id:sgtin:3348900.092838.wIuy?IcaOG_.V",
"sscc": "urn:epc:id:sscc:7734170383.5130955"
},
{
"code": "010334890038788121?:J-RTyQmzW;F",
"gtin": "03348900387881",
"id": "urn:epc:id:sgtin:3348900.038788.?:J-RTyQmzW;F",
"sscc": "urn:epc:id:sscc:9988811110.9000110"
},
{
"code": "010334890038788121_'eUaeoGrR1k!",
"gtin": "03348900387881",
"id": "urn:epc:id:sgtin:3348900.038788._'eUaeoGrR1k!",
"sscc": "urn:epc:id:sscc:9988811110.9000110"
},
{
"code": "010334890038788121a7OYT7qgzxw1k",
"gtin": "03348900387881",
"id": "urn:epc:id:sgtin:3348900.038788.a7OYT7qgzxw1k",
"sscc": "urn:epc:id:sscc:9988811110.9000110"
},
{
"code": "010334890038788121g8j?&h;*<P-wk",
"gtin": "03348900387881",
"id": "urn:epc:id:sgtin:3348900.038788.g8j?&h;*<P-wk",
"sscc": "urn:epc:id:sscc:9988811110.9000110"
},
{
"code": "010334890038788121wwuK_1cYl11k!",
"gtin": "03348900387881",
"id": "urn:epc:id:sgtin:3348900.038788.wwuK_1cYl11k!",
"sscc": "urn:epc:id:sscc:9988811110.9000110"
},
{
"code": "010334890048745121\"KShI&%vCde85",
"gtin": "03348900487451",
"id": "urn:epc:id:sgtin:3348900.048745.\"KShI&%vCde85",
"sscc": "urn:epc:id:sscc:9988811110.9000110"
},
{
"code": "0103348900487451214!->I;QQ*x3dV",
"gtin": "03348900487451",
"id": "urn:epc:id:sgtin:3348900.048745.4!->I;QQ*x3dV",
"sscc": "urn:epc:id:sscc:9988811110.9000110"
},
{
"code": "010334890048745121TsAhs9bPaml;F",
"gtin": "03348900487451",
"id": "urn:epc:id:sgtin:3348900.048745.TsAhs9bPaml;F",
"sscc": "urn:epc:id:sscc:9988811110.9000110"
},
{
"code": "010334890048745121XE41Oi-gfMR1k",
"gtin": "03348900487451",
"id": "urn:epc:id:sgtin:3348900.048745.XE41Oi-gfMR1k",
"sscc": "urn:epc:id:sscc:9988811110.9000110"
},
{
"code": "010334890048745121kj0Aw+URC3dV!",
"gtin": "03348900487451",
"id": "urn:epc:id:sgtin:3348900.048745.kj0Aw+URC3dV!",
"sscc": "urn:epc:id:sscc:9988811110.9000110"
},
{
"code": "010334890048745121q7/b\"Xw,=sc>V",
"gtin": "03348900487451",
"id": "urn:epc:id:sgtin:3348900.048745.q7/b\"Xw,=sc>V",
"sscc": "urn:epc:id:sscc:9988811110.9000110"
}
]
}
}
Check mission according SL1/SLI
POST /serialization-service/mission/validate/check
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
preparation_number |
string | Required: Mission ID |
type |
string | Required: sli or sl1 |
withdrawalType |
string | Withdrawal reason |
issuer |
string | SLI/SL1 issuer |
consigneeCode |
string | Reassignment participant ID |
containers |
object | Required: sli or sl1 |
containers .qty |
integer | Required: Quantity in container |
containers .cartonId |
string | Required: container id (SSCC code) |
containers .hdId |
string | Required: Pallet id (SSCC code) |
containers .gtin |
string | Required: Gtin |
issuer
is optional field. Is issuer is empty, list of childs participants will be loaded from current_participant
according ticket
Example Request
{
"preparation_number": "20000000768",
"type": "sl1",
"consigneeCode": "0010147739",
"order_number": "3018248267",
"owner_code": "CTY",
"depo": "TKV",
"issuer": "urn:authenticateit:participant:399530525345285",
"containers": [
{
"qty": 1,
"hdId": "221234567800025229",
"cartonId": "221234567800025229",
"sku": "99240015005",
"gtin": "03614225306907"
},
{
"qty": 2,
"hdId": "221234567800025229",
"cartonId": "221234567800025229",
"sku": "99240015005",
"gtin": "03614225306907"
},
{
"qty": 2,
"hdId": "221234567800025229",
"cartonId": "221234567800025229",
"sku": "65789474000",
"gtin": "03607342401341"
}
]
}
Example Response
{
"arg": {
"accept": "*/*",
"accept-encoding": "gzip, deflate, br",
"accept-language": "ru-RU,ru;q=0.9,en-AU;q=0.8,en;q=0.7,en-US;q=0.6",
"authenticateit_identity_ticket": "63eb8926-e661-42c1-998d-3f008665c8e5",
"cache-control": "no-cache",
"connection": "upgrade",
"consigneeCode": "0010147739",
"containers": [
{
"cartonId": "221234567800025229",
"gtin": "03614225306907",
"hdId": "221234567800025229",
"qty": 1,
"sku": "99240015005"
},
{
"cartonId": "221234567800025229",
"gtin": "03614225306907",
"hdId": "221234567800025229",
"qty": 2,
"sku": "99240015005"
},
{
"cartonId": "221234567800025229",
"gtin": "03607342401341",
"hdId": "221234567800025229",
"qty": 2,
"sku": "65789474000"
}
],
"content-length": "739",
"content-type": "application/json",
"depo": "TKV",
"host": "dev-api.shping.com",
"issuer": "urn:authenticateit:participant:399530525345285",
"order_number": "3018248267",
"origin": "chrome-extension://fhbjgbiflinjbdggehcddcbncdddomop",
"owner_code": "CTY",
"postman-token": "30a80c54-a4c1-afd5-0be8-abfc775d971a",
"preparation_number": "20000000768",
"sec-fetch-dest": "empty",
"sec-fetch-mode": "cors",
"sec-fetch-site": "none",
"ticket": "63eb8926-e661-42c1-998d-3f008665c8e5",
"type": "sl1",
"user-agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.102 Safari/537.36",
"x-forwared-for": "91.185.64.113",
"x-real-ip": "91.185.64.113"
},
"consignee": {
"external_id": "0010147739",
"id": "urn:authenticateit:participant:86831822859448",
"inn": "0000000000",
"name": "COTY Russia Interdep. Customer ZDEP",
"shipment_reg_mode": "010",
"withdrawal_type": ""
},
"grouped_data": [
{
"carton": "00221234567800025229",
"count": 2,
"gtin": "03607342401341",
"pallet": null,
"sku": "65789474000"
},
{
"carton": "00221234567800025229",
"count": 3,
"gtin": "03614225306907",
"pallet": null,
"sku": "99240015005"
}
],
"link": "https://dev-cdn.shping.com/2020/9/14/validate_export_93cbb97f-ab88-4be8-a372-aed536ac669d.csv",
"result": {
"00221234567800025229": [
{
"code": "010360734240134121)St0BR/;IWO2L",
"gtin": "03607342401341",
"id": "urn:epc:id:sgtin:3607342.040134.)St0BR/;IWO2L",
"sscc": "urn:epc:id:sscc:2123456780.2002522"
},
{
"code": "010360734240134121)soGpSMP<+ltl",
"gtin": "03607342401341",
"id": "urn:epc:id:sgtin:3607342.040134.)soGpSMP<+ltl",
"sscc": "urn:epc:id:sscc:2123456780.2002522"
},
{
"code": "010361422530690721GzyRXe-fE&YA:",
"gtin": "03614225306907",
"id": "urn:epc:id:sgtin:3614225.030690.GzyRXe-fE&YA:",
"sscc": "urn:epc:id:sscc:2123456780.2002522"
},
{
"code": "010361422530690721drJ2gMDDYFBRA",
"gtin": "03614225306907",
"id": "urn:epc:id:sgtin:3614225.030690.drJ2gMDDYFBRA",
"sscc": "urn:epc:id:sscc:2123456780.2002522"
},
{
"code": "010361422530690721dzYfNVWI.tz,y",
"gtin": "03614225306907",
"id": "urn:epc:id:sgtin:3614225.030690.dzYfNVWI.tz,y",
"sscc": "urn:epc:id:sscc:2123456780.2002522"
}
]
},
"ts": "2020-09-14T07:09:14Z",
"withdrawal_reason": null
}
Check consignee code
POST /serialization-service/mission/validate/check/consignee
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
consigneeCode |
string | Consignee code |
inn |
string | Consignee INN |
issuer |
string | Issuer Id |
issuer
is optional field. Is issuer is empty, list of childs participants will be loaded from current_participant
according ticketinn
or consigneeCode
should be presented in inpit data
Example Request
{
"consigneeCode": "0010147739",
"issuer": "urn:authenticateit:participant:399530525345285"
}
Example Response
[
{
"external_id": "0010147739",
"id": "urn:authenticateit:participant:86831822859448",
"inn": "0000000000",
"name": "COTY Russia Interdep. Customer ZDEP",
"shipment_reg_mode": "010",
"withdrawal_type": ""
}
]
Extract grouped data by sscc
POST /serialization-service/mission/validate/check/sscc
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
sscc |
string or list | Required: Sscc code/codes |
Example Request
{
"sscc": [
"221234567800025229"
]
}
Example Response
[
{
"carton": "00221234567800025229",
"count": 2,
"gtin": "03607342401341",
"pallet": null,
"sku": "65789474000"
},
{
"carton": "00221234567800025229",
"count": 3,
"gtin": "03614225306907",
"pallet": null,
"sku": "99240015005"
}
]
Continue reassignment (withdrawal)
POST /serialization-service/mission/validate/reassignment
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
id |
string | Required: Reassignment ID |
Example Request
{
"id": "f12f1461-78eb-4812-bd02-f587b7c6e2b9"
}
Read order data by order number
POST /serialization-service/mission/order
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
order |
string | Required: Order Number |
Example Request
{
"order": "CHA-1234"
}
Example Response
{
"link": "https://dev-cdn.shping.com/2020/9/1/order_data@63336a8b-b946-43de-a19a-49010a71f16b.json",
"ts": "2020-09-01T18:19:51Z"
}
Merge containers
POST /serialization-service/packaging/container/merge
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
sscc_from |
string or list | Required: Source SSCC code (or list) |
sscc_to |
string | Required: Destination SSCC code |
Example Request
{
"sscc_from": "urn:epc:id:sscc:7734170383.0001090",
"sscc_to": "urn:epc:id:sscc:7734170383.0001091"
}
Example Request
{
"sscc_from": ["urn:epc:id:sscc:7734170383.0001090"],
"sscc_to": "urn:epc:id:sscc:7734170383.0001091"
}
Disaggragate container
POST /serialization-service/packaging/container/disaggragate
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
sscc |
string | Required: SSCC code |
Example Request
{
"sscc": "urn:epc:id:sscc:7734170383.0001091"
}
Pack items to container
PUT /serialization-service/packaging/items/pack
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
sscc |
string | Required: SSCC code |
items |
string | Required: List of SGTIN's or list of SSCC's |
Example Request
{
"sscc": "urn:epc:id:sscc:7734170383.0001092",
"items": [
"urn:epc:id:sgtin:3348900.087198.!\":Oov+ffaCS)",
"urn:epc:id:sgtin:3348900.087198.!!pDlI5LU3K9+"
]
}
Example Request
{
"sscc": "urn:epc:id:sscc:7734170383.0001093",
"items": [
"urn:epc:id:sscc:7734170383.0001091",
"urn:epc:id:sscc:7734170383.0001092"
]
}
Unpack items from container
PUT /serialization-service/packaging/items/unpack
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
sscc |
string | Required: SSCC code |
items |
string | Required: List of SGTIN's or list of SSCC's |
Example Request
{
"sscc": "urn:epc:id:sscc:7734170383.0001092",
"items": [
"urn:epc:id:sgtin:3348900.087198.!\":Oov+ffaCS)",
"urn:epc:id:sgtin:3348900.087198.!!pDlI5LU3K9+"
]
}
Example Request
{
"sscc": "urn:epc:id:sscc:7734170383.0001093",
"items": [
"urn:epc:id:sscc:7734170383.0001091",
"urn:epc:id:sscc:7734170383.0001092"
]
}
Circulation
Remove crypto-tails
POST /serialization-service/circulation/cryptotails/delete
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
sscc |
string | Required: SSCC code |
invoiceNumber |
string | Required: Invoice Number |
invoiceDate |
string | Required: Invoice Date |
gtin |
string | Required: Base GTIN |
codes |
list | List of SGTINs objects |
declaration_number |
string | Optional. Will be converted to sources |
declaration_date |
string | Optional. Will be converted to sources |
customs_code |
string | Optional. Will be converted to sources |
tnved_code |
string | Optional. Will be converted to sources |
certificate_document |
string | Optional. Will be converted to sources |
certificate_document_number |
string | Optional. Will be converted to sources |
certificate_document_date |
string | Optional. Will be converted to sources |
Parameter sscc
or group of invoiceNumber
, invoiceDate
, gtin
are required.
If the list of codes (codes
) has not been set then all codes of sscc will be applied.
Example Request
{
"sscc": "00577040987327986277",
"invoiceNumber": "invoiceNumberTestCert",
"invoiceDate": "2020-05-30",
"gtin": "03614228074223",
"declaration_number": "test_declar_num",
"declaration_date": "test_declar_date",
"customs_code": "cus_code",
"tnved_code": "3303009000",
"certificate_document": "CONFORMITY_DECLARATION",
"certificate_document_date": "23.02.2020",
"certificate_document_number": "ЕАЭСRUД-FR.АC19.В.05411"
}
Example Request
{
"sscc": "00577040987322576244",
"codes": [
{
"code": "010361422807422321_WgwfSmClB<Ko",
"id": "urn:epc:id:sgtin:3614228.007422._WgwfSmClB<Ko"
},
{
"code": "010361422807422321_X(ip30:vYSVU",
"id": "urn:epc:id:sgtin:3614228.007422._X(ip30:vYSVU"
},
{
"code": "010361422807422321_Y>',=FKrmQ(B",
"id": "urn:epc:id:sgtin:3614228.007422._Y>',=FKrmQ(B"
}
],
"gtin": "03614228074223",
"declaration_number": "test_declar_num",
"declaration_date": "test_declar_date",
"customs_code": "cus_code",
"tnved_code": "3303009000",
"certificate_document": "CONFORMITY_DECLARATION",
"certificate_document_date": "23.02.2020",
"certificate_document_number": "ЕАЭСRUД-FR.АC19.В.05411"
}
Remove crypto-tails by specific codes
POST /serialization-service/circulation/cryptotails/delete/direct
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
codes |
list | Required: List of SGTINs objects |
declaration_number |
string | Optional. Will be converted to sources |
declaration_date |
string | Optional. Will be converted to sources |
customs_code |
string | Optional. Will be converted to sources |
tnved_code |
string | Optional. Will be converted to sources |
certificate_document |
string | Optional. Will be converted to sources |
certificate_document_number |
string | Optional. Will be converted to sources |
certificate_document_date |
string | Optional. Will be converted to sources |
codes.id
values should be EPS format sgtins and should be previously stored
Example Request
{
"codes": [
{
"id": "urn:epc:id:sgtin:3348901.030012._-0<V;Y1doLF!"
},
{
"id": "urn:epc:id:sgtin:3348901.030012._,SIPYJFA%b&5"
},
{
"id": "urn:epc:id:sgtin:3348901.030012._:vbTQAtd!raF"
},
{
"id": "urn:epc:id:sgtin:3348901.030012._.>7HCLabAi+F"
},
{
"id": "urn:epc:id:sgtin:3348901.030012._=elRd5KBI?85"
}
],
"declaration_number": "test_declar_num",
"declaration_date": "test_declar_date",
"customs_code": "cus_code",
"tnved_code": "3303009000",
"certificate_document": "CONFORMITY_DECLARATION",
"certificate_document_date": "23.02.2020",
"certificate_document_number": "ЕАЭСRUД-FR.АC19.В.05411"
}
Get initial SSCC
POST /serialization-service/circulation/sscc/get
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
invoiceNumber |
string | Invoice Number |
invoiceDate |
string | Invoice Date |
gtin |
string | Base GTIN |
list |
array | Search list |
Example Request
{
"list": [
{
"invoiceNumber": "CHK-11223402",
"gtin": "03614228074223"
}
]
}
Example Response
[
{
"codes": [
{
"code": "010361422807422321!)W5A_-,NpGKZ",
"id": "urn:epc:id:sgtin:3614228.007422.!)W5A_-,NpGKZ"
},
{
"code": "010361422807422321!;fWMsXgkqA*E",
"id": "urn:epc:id:sgtin:3614228.007422.!;fWMsXgkqA*E"
},
{
"code": "010361422807422321!EsuN5t4wq:Po",
"id": "urn:epc:id:sgtin:3614228.007422.!EsuN5t4wq:Po"
}
],
"gtin": "03614228074223",
"invoiceDate": "2020-07-11",
"invoiceNumber": "CHK-11223402",
"qty": 3,
"reflexNumber": null,
"sscc": "00577040987322576244"
}
]
Example Request
{
"invoiceNumber": "CHK-11223402",
"gtin": "03614228074223",
"invoiceDate": "2020-07-11"
}
Example Response
{
"codes": [
{
"code": "010361422807422321!)W5A_-,NpGKZ",
"id": "urn:epc:id:sgtin:3614228.007422.!)W5A_-,NpGKZ"
},
{
"code": "010361422807422321!;fWMsXgkqA*E",
"id": "urn:epc:id:sgtin:3614228.007422.!;fWMsXgkqA*E"
},
{
"code": "010361422807422321!EsuN5t4wq:Po",
"id": "urn:epc:id:sgtin:3614228.007422.!EsuN5t4wq:Po"
}
],
"qty": 3,
"reflexNumber": null,
"sscc": "00577040987322576244"
}
Remark. Start process.
POST /serialization-service/remark
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
code |
string | Required: Sgtin code |
Example Request
{
"code": "010334647010957521uKH0NMNOqmo7c"
}
Example Response
{
"id": "urn:epc:id:sgtin:3346470.010957.uKH0NMNOqmo7c@code_remark"
}
Remark. Get status
POST /serialization-service/remark/status/get
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
id |
string | Required: Remark Id |
Example Request
{
"id": "urn:epc:id:sgtin:3346470.010957.uKH0NMNOqmo7c@code_remark"
}
Example Response. Pending
{
"id": "urn:epc:id:sgtin:3346470.010957.uKH0NMNOqmo7c@code_remark",
"certificate_document": "CONFORMITY_CERT",
"certificate_document_date": "2018-09-17T21:00:00.000Z",
"certificate_document_number": "certificateDocumentNumber",
"code": "010334647010957521uKH0NMNOqmo7c",
"gtin": "03346470109575",
"inn": "7734170383",
"participant": "urn:authenticateit:participant:804355519238230",
"sgtin": "urn:epc:id:sgtin:3346470.010957.uKH0NMNOqmo7c",
"st_ts_wr": "2020-01-29T14:43:09Z",
"status": "pending",
"user": "urn:authenticateit:user:email:system@authenticateit.com"
}
Example Response. Success
{
"certificate_document": "CONFORMITY_CERT",
"certificate_document_date": "2018-09-17T21:00:00.000Z",
"certificate_document_number": "certificateDocumentNumber",
"code": "010334647010957521uKH0NMNOqmo7c",
"gtin": "03346470109575",
"id": "urn:epc:id:sgtin:3346470.010957.uKH0NMNOqmo7c@code_remark",
"inn": "7734170383",
"new_code": "010334647010957521x5eiSsYJ0yCJX\u001d91EE05\u001d92gF3jaA99RKBLOViAe1akW9nMYKQlgV/NKm8nVTFAcJM=",
"new_sgtin": "urn:epc:id:sgtin:3346470.010957.x5eiSsYJ0yCJX",
"participant": "urn:authenticateit:participant:804355519238230",
"sgtin": "urn:epc:id:sgtin:3346470.010957.uKH0NMNOqmo7c",
"status": "success",
"user": "urn:authenticateit:user:email:system@authenticateit.com"
}
Example Response. Failure
{
"id": "urn:epc:id:sgtin:3346470.010957.uKH0NMNOqmo7c@code_remark",
"certificate_document": "CONFORMITY_CERT",
"certificate_document_date": "2018-09-17T21:00:00.000Z",
"certificate_document_number": "certificateDocumentNumber",
"code": "010334647010957521uKH0NMNOqmo7c",
"gtin": "03346470109575",
"inn": "7734170383",
"participant": "urn:authenticateit:participant:804355519238230",
"sgtin": "urn:epc:id:sgtin:3346470.010957.uKH0NMNOqmo7c",
"st_ts_wr": "2020-01-29T14:43:09Z",
"status": "failure",
"user": "urn:authenticateit:user:email:system@authenticateit.com"
}
Remark. Mark code as used
POST /serialization-service/remark/used
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
id |
string | Required: Remark Id |
Example Request
{
"id": "urn:epc:id:sgtin:3346470.010957.uKH0NMNOqmo7c@code_remark"
}
Example Response
{
"certificate_document": "CONFORMITY_CERT",
"certificate_document_date": "2018-09-17T21:00:00.000Z",
"certificate_document_number": "certificateDocumentNumber",
"code": "010334647010957521uKH0NMNOqmo7c",
"gtin": "03346470109575",
"id": "urn:epc:id:sgtin:3346470.010957.uKH0NMNOqmo7c@code_remark",
"inn": "7734170383",
"new_code": "010334647010957521x5eiSsYJ0yCJX",
"new_sgtin": "urn:epc:id:sgtin:3346470.010957.x5eiSsYJ0yCJX",
"participant": "urn:authenticateit:participant:804355519238230",
"sgtin": "urn:epc:id:sgtin:3346470.010957.uKH0NMNOqmo7c",
"status": "success",
"used": true,
"user": "urn:authenticateit:user:email:system@authenticateit.com"
}
Remark. Change status
POST /serialization-service/remark/status/set
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
id |
string | Required: Remark Id |
status |
string | Required: success or failure |
code |
string | Required: SGTIN code if status =success |
Example Request
{
"id": "urn:epc:id:sgtin:3346470.010957.bVYVDka8KDnkw@code_remark",
"status": "success",
"code": "010334647010957521uKH0NMNOqmo7c\u001d91EE05\u001d92gF3jaA99RKBLOViAe1akW9nMYKQlgV/NKm8nVTFAcJM="
}
Return orders
Create return order
POST /serialization-service/circulation/returns/order
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
invoiceNumber |
string | Required: Invoice Number |
invoiceDate |
string | Invoice Number |
deliveryNumber |
string | Delivery Number |
list |
list | Required: Return composition |
issuer |
string | Return issuer |
Example Request
{
"invoiceNumber": "TestNumber",
"list": [
{
"gtin": "03274872369436",
"qty": "5",
"sku": "P041283"
},
{
"gtin": "03348900871984",
"qty": "5",
"sku": "F032622889"
}
]
}
Example Response
{
"invoiceNumber": "TestNumber",
"list": [
{
"gtin": "03274872369436",
"qty": 5,
"sku": "P041283"
},
{
"gtin": "03348900871984",
"qty": 5,
"sku": "F032622889"
}
],
"owner": "urn:authenticateit:participant:804355519238230"
}
Read return order state
POST /serialization-service/circulation/returns/order/get
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
invoiceNumber |
string | Required: Invoice Number |
Example Request
{
"invoiceNumber": "TestNumber"
}
Example Response
{
"invoiceNumber": "TestNumber",
"list": [
{
"gtin": "03274872369436",
"qty": 5,
"sku": "P041283"
},
{
"gtin": "03348900871984",
"qty": 5,
"sku": "F032622889"
}
],
"owner": "urn:authenticateit:participant:804355519238230"
}
Assembly of SGTINs
PUT /serialization-service/circulation/returns/order
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
invoiceNumber |
string | Required: Invoice Number |
list |
[string] | Required: List of codes |
Example Request
{
"invoiceNumber": "TestNumber",
"list": [
"010334890087198421&_ZLFOAU=LY3/\u001d91EE05\u001d92gF3jaA99RKBLOViAe1akW9nMYKQlgV/NKm8nVTFAcJM=",
"010334890087198421<:/pCsZFTSC3P\u001d91EE05\u001d92gF3jaA99RKBLOViAe1akW9nMYKQlgV/NKm8nVTFAcJM="
]
}
Example Response
{
"invoiceNumber": "TestNumber",
"list": [
{
"gtin": "03274872369436",
"qty": 5,
"sku": "P041283"
},
{
"collected": [
{
"code": "010334890087198421&_ZLFOAU=LY3/\u001d91EE05\u001d92gF3jaA99RKBLOViAe1akW9nMYKQlgV/NKm8nVTFAcJM=",
"id": "urn:epc:id:sgtin:3348900.087198.&_ZLFOAU=LY3/"
},
{
"code": "010334890087198421<:/pCsZFTSC3P\u001d91EE05\u001d92gF3jaA99RKBLOViAe1akW9nMYKQlgV/NKm8nVTFAcJM=",
"id": "urn:epc:id:sgtin:3348900.087198.<:/pCsZFTSC3P"
}
],
"gtin": "03348900871984",
"qty": 5,
"sku": "F032622889"
}
],
"owner": "urn:authenticateit:participant:804355519238230"
}
Mark return order application processing
POST /serialization-service/circulation/returns/order/mark
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
id |
string | Required: Request Id |
status |
string | success (default) or failure |
Example Request
{
"id": "dc82783c-681a-48e9-bc88-e43a59243726"
}
Inventory reports
Inventory the state of container
POST /serialization-service/packaging/container/inventory
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
sscc |
string | Required: Container code |
items |
list | Required: List of coupled item codes |
Example Request
{
"sscc": "00001191000013055040",
"items": [
"010334890087198421>K3P9+qfui5Y5\u001d91EE05\u001d923LQZZHyjoOQ1wd2TmwXlbgWrs/ei3owacH16mF3Neu4=",
"010334890087198421g'H:S8QfQ8*gk\u001d91EE05\u001d923LQZZHyjoOQ1wd2TmwXlbgWrs/ei3owacH16mF3Neu4="
]
}
Read inventory reports
POST /serialization-service/packaging/container/inventory/get
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
skip |
string | Like offset in sql |
take |
string | Like limit in sql |
order |
string | RSQL order |
type |
string | Type of request: data or count |
query |
string | RSQL query |
op |
string | Condition: OR/AND |
Field list for filters:
"carton" - carton EPC ID
"carton_gs1" - carton GS1 ID
"pallet" - pallet EPC ID
"pallet_gs1" - pallet GS1 ID
"doc_id" - report doc ID
"gtin" - GTIN value
"sku" - SKU value
"ts" - inventory datetime
"id" - row ID
"user_first_name" - user's first name
"user_id" - user ID
"user_last_name" - user's last name
"not_valid" - quantity of not valid scanned elements
"presented" - quantity of elements in T&T
"scanned" - quantity of total scanned elements
"valid" - quantity of valid elements
Example Request
{
"order": "ts-desc",
"query":"",
"op":"AND",
"skip": "1",
"take": "2"
}
Example Request
{
"order": "ts-desc",
"query":"user_last_name=like=|Admin|",
"op":"AND",
"skip": "1",
"take": "2"
}
Example Response
{
"count": 8,
"data": [
{
"carton": "urn:epc:id:sscc:7734170383.5325689",
"carton_gs1": "00577341703833256897",
"doc_id": "urn:authenticateit:participant:804355519238230@inventory_report@bd0bb3ca-014c-4fc5-93b5-bbfed38650b4",
"gtin": "00334647023406",
"id": "urn:authenticateit:participant:804355519238230@inventory_report@bd0bb3ca-014c-4fc5-93b5-bbfed38650b4@2020-03-10T11:13:36Z@518f0a8a-483f-4add-99e2-e5751574ce15",
"not_valid": 0,
"pallet": null,
"pallet_gs1": null,
"participant_id": "urn:authenticateit:participant:804355519238230",
"presented": 15,
"scanned": 0,
"sku": "\" 02340",
"ts": "2020-03-10T11:13:36Z",
"user_first_name": "System",
"user_id": "urn:authenticateit:user:email:system@authenticateit.com",
"user_last_name": "Administrator",
"valid": 0
},
{
"carton": "urn:epc:id:sscc:7734170383.5325689",
"carton_gs1": "00577341703833256897",
"doc_id": "urn:authenticateit:participant:804355519238230@inventory_report@ac769822-a794-4876-9cdc-1277332d0cb5",
"gtin": "00334647023406",
"id": "urn:authenticateit:participant:804355519238230@inventory_report@ac769822-a794-4876-9cdc-1277332d0cb5@2020-03-10T11:12:12Z@e42a5132-fe94-4d5a-9de5-15c1db1fd6f8",
"not_valid": 15,
"pallet": "urn:epc:id:sscc:7734170.5383894911",
"pallet_gs1": "00577341703838949114",
"participant_id": "urn:authenticateit:participant:804355519238230",
"presented": 15,
"scanned": 0,
"sku": "\" 02340",
"ts": "2020-03-10T11:12:12Z",
"user_first_name": "System",
"user_id": "urn:authenticateit:user:email:system@authenticateit.com",
"user_last_name": "Administrator",
"valid": 0
}
]
}
Certificates
Set certificate
Method allows to set certificate data according invoice_number
and gtin
POST /serialization-service/certificate/set
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
gtin |
string | Required: Gtin code |
invoice_number |
string | Required: Emission invoice |
certificate_document |
string | Required: Document type |
certificate_document_date |
string | Required: Document date |
certificate_document_number |
string | Required: Document number |
Example Request
{
"gtin": "00000000000000",
"invoice_number": "TestInvoiceNumber",
"certificate_document": "Test type",
"certificate_document_date": "Test date",
"certificate_document_number": "Test number"
}
Example Response
{
"certificate_document": "Test type",
"certificate_document_date": "Test date",
"certificate_document_number": "Test number",
"gtin": "00000000000000",
"id": "00000000000000@urn:authenticateit:participant:804355519238230@TestInvoiceNumber@certificate",
"invoice_number": "TestInvoiceNumber",
"issuer": "urn:authenticateit:participant:804355519238230",
"ts": "2020-05-25T12:32:35Z",
"type": "gtin_certificate",
"user": "urn:authenticateit:user:email:system@authenticateit.com"
}
Get certificate
POST /serialization-service/certificate/get
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
gtin |
string | Required: Gtin code |
invoice_number |
string | Required: Emission invoice |
Example Request
{
"gtin": "00000000000000",
"invoice_number": "TestInvoiceNumber"
}
Example Response
{
"certificate_document": "Test type",
"certificate_document_date": "Test date",
"certificate_document_number": "Test number",
"gtin": "00000000000000",
"id": "00000000000000@urn:authenticateit:participant:804355519238230@TestInvoiceNumber@certificate",
"invoice_number": "TestInvoiceNumber",
"issuer": "urn:authenticateit:participant:804355519238230",
"ts": "2020-05-25T12:32:35Z",
"type": "gtin_certificate",
"user": "urn:authenticateit:user:email:system@authenticateit.com"
}
Custom declaration
Set declaration data
Method allows to set declaration data according invoice_number
and gtin
POST /serialization-service/gtd/set
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
gtin |
string | Required: Gtin code |
invoice_number |
string | Required: Emission invoice |
customs_code |
string | Required: Custom code |
declaration_date |
string | Required: Document date |
declaration_number |
string | Required: Document number |
Example Request
{
"gtin": "03614228074223",
"invoice_number": "TestInvoiceNumber",
"customs_code": "40003",
"declaration_date": "2020-06-12",
"declaration_number": "123456-9232"
}
Example Response
{
"customs_code": "40003",
"declaration_date": "2020-06-12",
"declaration_number": "123456-9232",
"gtin": "03614228074223",
"id": "03614228074223@urn:authenticateit:participant:804355519238230@TestInvoiceNumber@gtd",
"invoice_number": "TestInvoiceNumber",
"issuer": "urn:authenticateit:participant:804355519238230",
"ts": "2020-06-24T14:31:12Z",
"type": "gtin_gtd",
"user": "urn:authenticateit:user:email:system@authenticateit.com"
}
Track & Trace Log
Read Log
Retrieve log of Track & Trace operations. Responds with the list of
log entries in data
field. Log entries may be filtered by providing
parameters in the request JSON body. The following parameters may be
used for filtering:
after_time
,before_time
— fetch only entries having timestamp greater thanafter_time
and less thanbefore_time
.invoice_number
— fetch only entries having the specified invoice number.sscc
— fetch only entries where container SSCC equals to the specified one.operation
— fetch only entries of the specified type (pack_products
,pack_containers
,reassignment
orunpack
).
Number of returned entries may be limited with limit
parameter (50
by default).
The returned entries are sorted by timestamp from most recent to least
recent. Sort order may be changed with sort_order
parameter (asc
or desc
).
POST /serialization-service/track_trace/get_log
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Session ticket |
Example Request
{
"after_time": "2020-02-01T01:15:00Z",
"operation": "pack_products",
"sort_order": "asc"
}
Example Response
{
"after_time": "2020-02-01T01:15:00Z",
"operation": "pack_products",
"limit": 50,
"sort_order": "asc",
"data": [
{
"invoice_number": "SAP-256004",
"item_number": "L125896",
"operation": "pack_products",
"serial_number": "%156487';4566",
"sscc": "0123456789456321478",
"timestamp": "2020-02-05T09:18:00Z",
"user_id": "urn:authenticateit:user:email:NLAR@shping.com"
},
{
"invoice_number": "SAP-256004",
"item_number": "L125897",
"operation": "pack_products",
"serial_number": "%156487';4567",
"sscc": "0123456789456321478",
"timestamp": "2020-02-05T09:23:00Z",
"user_id": "urn:authenticateit:user:email:NLAR@shping.com"
},
{
"invoice_number": "SAP-256004",
"item_number": "L125898",
"operation": "pack_products",
"serial_number": "%156487';4568",
"sscc": "0123456789456321478",
"timestamp": "2020-02-05T09:30:00Z",
"user_id": "urn:authenticateit:user:email:NLAR@shping.com"
}
]
}
iDoc
Set invoice
POST /serialization-service/idoc/invoice
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
delivery_type |
string | Required: Any of "010", "020", "030". Only "010" value is valid |
issuer |
string | Required: Issuer participant_id |
owner_inn |
string | Optional field |
wh_code |
string | Optional field |
supplier_code |
string | Optional field |
doc_type |
string | Required: Any of "010", "020", "030", "040" |
doc_number |
string | Required: Ivoice number |
doc_date |
string | Required: Ivoice date |
order_num |
string | Optional field |
order_date |
string | Optional field |
items |
nonempty_list | Required: Items |
Example Request
{
"delivery_type": "010",
"doc_type": "010",
"doc_number": "9994000016",
"doc_date": "20.07.2020",
"issuer": "urn:authenticateit:participant:207527590306155",
"items": [
{
"sku": "L5678801",
"gtin": "03360373016334",
"qty": 1000
}
]
}
Example Response
{
"doc_date": "20.07.2020",
"doc_number": "9994000016",
"id": "urn:authenticateit:participant:207527590306155@idoc_invoice@9994000016@20.07.2020"
}
E-commerce
Set invoice
POST /serialization-service/ecommerce/invoice
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
Example Request
{
"shipment_date": "130005",
"shipment_time": "20200603",
"consigneeCode": "126314547000",
"order_type": "XO",
"orders": [
{
"order_date": "20200603",
"order_number": "S5086",
"items": [
{
"sku": "7712010000",
"batch": "0004712458",
"code": "010002713102042421TGlXO&;OL)MYH\""
},
{
"sku": "7712010000",
"batch": "0004712458",
"code": "010002713102042421_F(kL&;hMAoG)="
}
]
}
]
}
Example Response
[
{
"order_date": "20200603",
"order_number": "S5086"
}
]
Set G9 report
POST /serialization-service/ecommerce/g9_report
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
Example Request
{
"items": [
{
"OrdNum": "test",
"OrdT": "Z3OS",
"DelNum": "111",
"VAT Prof": "Prof",
"CustPONum": "S5086"
}
]
}
Example Response
[]
Example Response
[
{
"consignee": {
"external_id": "999",
"id": "urn:authenticateit:participant:801025803422407",
"inn": "1111111111",
"name": "OOO",
"parent": "urn:authenticateit:participant:804355519238232",
"shipment_reg_mode": "040"
},
"id": "882a2075-18d0-4438-8917-c71b9039809e",
"tree": {
"00577301663158816249": [
{
"code": "010370055021675921Xucn;IMElDtW*",
"id": "urn:epc:id:sgtin:3700550.021675.Xucn;IMElDtW*"
},
{
"code": "010370055021675921XXe<>qn)P+NqX",
"id": "urn:epc:id:sgtin:3700550.021675.XXe<>qn)P+NqX"
},
{
"code": "010376018435353421'KlPmPE/xgC!v",
"id": "urn:epc:id:sgtin:3760184.035353.'KlPmPE/xgC!v"
},
{
"code": "010376018435353421(xiDfiQ9m:nNd",
"id": "urn:epc:id:sgtin:3760184.035353.(xiDfiQ9m:nNd"
}
]
},
"withdrawal": ""
}
]
Set order
POST /serialization-service/ecommerce/order
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
Items | list | Required: Order items |
Header | object | Required: Order header |
Example Request
{
"Header": {
"DocumentType": "deliveryInter",
"OrderType": "ZOR",
"CreationDate": "20200903",
"DeliveryNumber": "test_delivery_num",
"BillTo": "999",
"Country": "4330"
},
"Items": [
{
"Product": "22RN010000",
"gtin": "00020714080303",
"QTY": 30
}
]
}
Set order confirmation
POST /serialization-service/ecommerce/order/confirmation
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
Lines | list | Required: Order items |
OrderNum | string | Required: Order number |
DocId | string | Required: Doc id |
DocType | string | Required: Doc type |
Example Request
{
"OrderNum": "test_delivery_num",
"DocId": "test_id",
"DocType": "test_type",
"Lines": [
{
"Carton_sscc": "140000000000000003",
"Codes": [
"010002071408030321,_(*b/oes!U;-",
"010002071408030321,:hkXZVuegN=7",
"010002071408030321,/.Ix(HnEpti/",
"010002071408030321,Ahc?77rZe.)T",
"010002071408030321,aoNTgEH'jQlg",
"010002071408030321,GiwV+XUBVVQI"
]
},
{
"Codes": [
"010002071408030321,iUjRGpt%ybQA",
"010002071408030321,Xk7gmiTaqXMc",
"010002071408030321,XUOo?c06d?aR",
"010002071408030321,YiL-GYkCajFW",
"010002071408030321,YlakVfL5Y4\"B"
]
}
]
}
Set order shipped
POST /serialization-service/ecommerce/order/shipped
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
Orders | list | Required: List of orders |
Example Request
{
"Orders": [
"test_delivery_num",
"test_delivery_num1",
"test_delivery_num2"
]
}
Example Response
[
{
"order": "test_delivery_num",
"shipment": {
"consignee": {
"external_id": "999",
"id": "urn:authenticateit:participant:801025803422407",
"inn": "6027088229",
"name": "ООО \"Вернисаж\"",
"parent": "urn:authenticateit:participant:804355519238232",
"shipment_reg_mode": "070"
},
"id": "ed2f818e-eca4-49a7-8ea4-f7f4e5806041",
"tree": [
{
"code": "010002071408030321,_(*b/oes!U;-",
"id": "urn:epc:id:sgtin:0020714.008030.,_(*b/oes!U;-"
},
{
"code": "010002071408030321,:hkXZVuegN=7",
"id": "urn:epc:id:sgtin:0020714.008030.,:hkXZVuegN=7"
},
{
"code": "010002071408030321,/.Ix(HnEpti/",
"id": "urn:epc:id:sgtin:0020714.008030.,/.Ix(HnEpti/"
},
{
"code": "010002071408030321,Ahc?77rZe.)T",
"id": "urn:epc:id:sgtin:0020714.008030.,Ahc?77rZe.)T"
},
{
"code": "010002071408030321,aoNTgEH'jQlg",
"id": "urn:epc:id:sgtin:0020714.008030.,aoNTgEH'jQlg"
},
{
"code": "010002071408030321,GiwV+XUBVVQI",
"id": "urn:epc:id:sgtin:0020714.008030.,GiwV+XUBVVQI"
},
{
"code": "010002071408030321,iUjRGpt%ybQA",
"id": "urn:epc:id:sgtin:0020714.008030.,iUjRGpt%ybQA"
},
{
"code": "010002071408030321,Xk7gmiTaqXMc",
"id": "urn:epc:id:sgtin:0020714.008030.,Xk7gmiTaqXMc"
},
{
"code": "010002071408030321,XUOo?c06d?aR",
"id": "urn:epc:id:sgtin:0020714.008030.,XUOo?c06d?aR"
},
{
"code": "010002071408030321,YiL-GYkCajFW",
"id": "urn:epc:id:sgtin:0020714.008030.,YiL-GYkCajFW"
},
{
"code": "010002071408030321,YlakVfL5Y4\"B",
"id": "urn:epc:id:sgtin:0020714.008030.,YlakVfL5Y4\"B"
}
],
"withdrawal": ""
}
}
]
Order cancellation
POST /serialization-service/ecommerce/order/cancellation
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
Orders | list | Required: Order items |
Example Request
{
"Orders": ["test_order_1", "test_order_2"]
}
Example Response
{
"success": ["test_order_1"],
"failed": ["test_order_2"]
}
Set order reassignment
POST /serialization-service/ecommerce/order/reassignment
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
id | string | Required: Reassignment id |
Example Request
{
"id": "ed2f818e-eca4-49a7-8ea4-f7f4e5806041"
}
Change SGTINs widgets data
Create change task
The max number of SGTINs per request has been limited to 10000
POST /serialization-service/sources/change
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Session ticket |
update |
object | RSQL filter |
data |
object | New data |
Example Request
{
"update": {
"query": "field_64fdc5235d65719db2313923ad30ce7fda154808==\"SomeInvoice\";field_d59192b9c8f264b356075d2fd455117e5c1265a0=in=(\"F069740088\")",
"op": "AND"
},
"data": {
"field_64fdc5235d65719db2313923ad30ce7fda154808": "SomeInvoiceNew",
"field_788b526ed37de69261195db7782dc9f51cf7f46f": "2020-10-01"
}
}
Example Response
{
"id": "7cde7dc7-36d1-4318-bbbc-5681c0f4a2dd"
}
Read change task
The max number of SGTINs per request has been limited to 10000
GET /serialization-service/sources/change/:id
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Session ticket |
id |
string | Task Id |
Example Response
{
"count": 2000,
"data": {
"field_64fdc5235d65719db2313923ad30ce7fda154808": "SomeInvoiceNew",
"field_788b526ed37de69261195db7782dc9f51cf7f46f": "2020-10-01"
},
"op": "AND",
"progress": 1500,
"query": "field_64fdc5235d65719db2313923ad30ce7fda154808==\"SomeInvoice\";field_d59192b9c8f264b356075d2fd455117e5c1265a0=in=(\"F069740088\")",
"start_time": "2020-10-01T06:52:00Z",
"status": "pending",
"ts": "2020-10-01T06:51:14Z"
}
Example Response
{
"count": 2000,
"data": {
"field_64fdc5235d65719db2313923ad30ce7fda154808": "SomeInvoiceNew",
"field_788b526ed37de69261195db7782dc9f51cf7f46f": "2020-10-01"
},
"end_time": "2020-10-01T06:54:01Z",
"op": "AND",
"progress": 2000,
"query": "field_64fdc5235d65719db2313923ad30ce7fda154808==\"SomeInvoice\";field_d59192b9c8f264b356075d2fd455117e5c1265a0=in=(\"F069740088\")",
"start_time": "2020-10-01T06:52:00Z",
"status": "success",
"ts": "2020-10-01T06:51:14Z"
}
Manual SGTINs reassignment
Create reassignment task
The max number of SGTINs per request has been limited to 10000
POST /serialization-service/reassignment/task
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session ticket |
filter |
object | RSQL filter |
order_number |
object | New order number |
codes |
list | List of sgtins |
Parameter filter
or codes
is required
Example Request
{
"to_participant": "urn:authenticateit:participant:188573846852916",
"filter": {
"query": "sscc==urn:epc:id:sscc:7705788023.5641503",
"op": "AND"
},
"order_number": "SomeTestOrder"
}
Example Request
{
"to_participant": "urn:authenticateit:participant:804355519238230",
"codes": [
"010342322000689321_cWCtfQPxbrEY",
"010342322000689321-f1knd+cnr3de",
"010342322000689321-K<skT&Y=86E_"
],
"order_number": "SomeTestOrder"
}
Example Response
{
"id": "1e04e5ec-af70-4f37-a4ad-7b56cf0d613c"
}
Read reassignment task status
GET /serialization-service/reassignment/task/:id
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Session ticket |
id |
string | Task Id |
Example Response
{
"count": 16,
"op": "AND",
"order_number": "test",
"query": "sscc==urn:epc:id:sscc:7705788023.5641503",
"status": "pending",
"ts": "2020-10-22T20:49:32Z"
}
Example Response
{
"codes": [
{
"code": "010342322000689321_cWCtfQPxbrEY",
"id": "urn:epc:id:sgtin:3423220.000689._cWCtfQPxbrEY"
},
{
"code": "010342322000689321-f1knd+cnr3de",
"id": "urn:epc:id:sgtin:3423220.000689.-f1knd+cnr3de"
},
{
"code": "010342322000689321-K<skT&Y=86E_",
"id": "urn:epc:id:sgtin:3423220.000689.-K<skT&Y=86E_"
}
],
"count": 3,
"order_number": "SomeTestOrder",
"status": "success",
"ts": "2020-10-22T20:52:23Z"
}
MOLCOM extra methods
Accumulation of additional data
POST /serialization-service/packaging/initial
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
doc_num |
string | Required: Invoice number |
delivery_type |
string | Any of "INT", "EXT", "INB" |
recipient_inn |
string | Part of emission filename |
billing_doc_number |
string | Based on CCD |
delivery_number |
string | Based on CCD |
doc_type |
string | Any of "ZOR", "ZTST" |
gtin_codes |
string | List of emission gtins |
sscc_codes |
string | List of emission sscc's |
Example Request
{
"delivery_type": "INB",
"doc_num": "9590879255",
"gtin_codes": [
"00027131284215",
"00022548423080",
"00020714080303",
"00020714001940",
"00763511009817",
"00020714881436",
"00887167466135",
"00887167267107",
"00888066113779",
"00887167001978"
],
"recipient_inn": "ELC",
"sscc_codes": [
]
}
Read additional data
POST /serialization-service/packaging/initial/get
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
doc_num |
string | Required: Invoice number |
Example Request
{
"doc_num": "9590879255"
}
Example Response
{
"delivery_type": "EXT",
"final_aggregation_status": null,
"final_aggregation_status_updated_ts": null,
"gtin_codes": [
"00020714080303",
"00020714080310",
"00020714711733"
],
"in_circulation": null,
"in_circulation_ts": null,
"recipient_inn": "7701010842",
"sscc_codes": [],
"sticking_confirmed": null,
"sticking_confirmed_ts": null
}
Example Response
{
"delivery_type": "EXT",
"final_aggregation_status": "not started",
"final_aggregation_status_updated_ts": null,
"gtin_codes": [
"00020714080303",
"00020714080310",
"00020714711733"
],
"in_circulation": 0,
"in_circulation_ts": null,
"recipient_inn": "7701010842",
"sscc_codes": [],
"sticking_confirmed": 1,
"sticking_confirmed_ts": "2020-10-17T16:43:16Z"
}
Set circulation success status
POST /serialization-service/circulation/success
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
doc_num |
string | Required: Invoice number |
Example Request
{
"doc_num": "9590879255"
}
Set aggregation success status
POST /serialization-service/aggregation/upd/success
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
doc_num |
string | Required: Invoice number |
Example Request
{
"doc_num": "9590879255"
}
Get analytic data
POST /serialization-service/analytic
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
ret_type |
string | Required: total or filtered |
date_from |
string | Filter. Date format YYYY-MM-DD |
date_to |
string | Filter. Date format YYYY-MM-DD |
issuer |
string | Filter. Issuer filter |
type |
list | Filter. [created , into_circulation , shipped ] |
date_as |
string | Convert date as. month , week , year , day |
Filter by date
, issuer
and type
could be added
Date could be converted to year
, month
or week number
(day
is default)
Example Request total
{
"ret_type": "total",
"date_from": "2020-08-31",
"date_to": "2020-11-31",
"issuer": "urn:authenticateit:participant:399530525345285",
"type": ["created", "into_circulation", "shipped"]
}
Example Responce total
{
"data": [
{
"count": 6709,
"type": "created"
},
{
"count": 826,
"type": "into_circulation"
},
{
"count": 273,
"type": "shipped"
}
]
}
Example Request filtered
{
"ret_type": "filtered",
"date_from": "2020-08-31",
"date_to": "2020-11-31",
"issuer": "urn:authenticateit:participant:399530525345285",
"type": ["created", "into_circulation", "shipped"],
"date_as": "month"
}
Example Responce filtered
{
"data": [
{
"count": 102,
"issuer": "urn:authenticateit:participant:399530525345285",
"month": "2020-08",
"owner": "urn:authenticateit:participant:804355519238230",
"type": "created"
},
{
"count": 4083,
"issuer": "urn:authenticateit:participant:399530525345285",
"month": "2020-09",
"owner": "urn:authenticateit:participant:804355519238230",
"type": "created"
},
{
"count": 785,
"issuer": "urn:authenticateit:participant:399530525345285",
"month": "2020-09",
"owner": "urn:authenticateit:participant:804355519238230",
"type": "into_circulation"
},
{
"count": 273,
"issuer": "urn:authenticateit:participant:399530525345285",
"month": "2020-09",
"owner": "urn:authenticateit:participant:804355519238230",
"type": "shipped"
},
{
"count": 1884,
"issuer": "urn:authenticateit:participant:399530525345285",
"month": "2020-10",
"owner": "urn:authenticateit:participant:804355519238230",
"type": "created"
},
{
"count": 640,
"issuer": "urn:authenticateit:participant:399530525345285",
"month": "2020-11",
"owner": "urn:authenticateit:participant:804355519238230",
"type": "created"
},
{
"count": 41,
"issuer": "urn:authenticateit:participant:399530525345285",
"month": "2020-11",
"owner": "urn:authenticateit:participant:804355519238230",
"type": "into_circulation"
}
]
}
Get retailers order
GET /serialization-service/retailer/order
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
string | Required: Order Id |
Example Responce total
{
"codes": [
{
"code": "0100027131043287214WrdhPFmIHERj",
"sku": "7011010000"
},
{
"code": "010002713104328721X(l';RWrqklL/",
"sku": "7011010000"
},
{
"code": "010002713104329421kjzmiX_qZ=vKl",
"sku": "7017010000"
},
{
"code": "010002713108686421l5LJKapN3ab3_",
"sku": "4829020000"
}
],
"order": "2089350093"
}
Retailers operations workflow
Set operations
POST /serialization-service/retailer/operations
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
list |
list | Required: Operations |
filename |
string | Required: Filename |
Example Request
{
"filename": "testfile.csv",
"list": [
{
"doc_num": "some_doc",
"doc_date": "20201112",
"doc_type": "sale",
"sgtin": "010000000000000021SSSSSSSSSSSS1"
},
{
"doc_num": "some_doc",
"doc_date": "20201112",
"doc_type": "return",
"sgtin": "010000000000000021SSSSSSSSSSSS1"
}
]
}
Example Responce
{
"id": "c9093e79-258f-4bd4-a999-0bfdea0b985f"
}
Get operations status
GET /serialization-service/retailer/operations
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
string | Required: Operations Id |
Example Success Responce
{
"operations_id": "1cb23905-ea6c-44fe-b186-2d5bc3b36ef2",
"ret": {
"gain": [
{
"doc_date": "20201112",
"doc_num": "some_doc",
"id": "721e4cc0-6235-4b0e-86db-761781146be1",
"sgtins": [
"010002713104329421-nGD;o\"h*mfMt"
]
}
],
"tester": [
{
"doc_date": "20201112",
"doc_num": "some_doc",
"id": "db21b8f2-98d4-4710-867c-99fca6ee27c6",
"sgtins": [
"010002713104329421-nGD;o\"h*mfMt"
]
}
]
},
"status": "success"
}
Example Failure Responce
{
"operations_id": "048704ac-5963-49d2-96d1-38e5ae270fb1",
"ret": [
{
"error": {
"error": "Flag is not supported.",
"error_data": [
"ZTS"
],
"error_id": "serialization-bad_mix2_usage_flag",
"error_object": null
},
"sgtin": "010002713104329421BnJJxmhTOL,fP"
}
],
"status": "failure"
}
Example Pending Responce
{
"operations_id": "048704ac-5963-49d2-96d1-38e5ae270fb1",
"status": "pending"
}
Set operation id success status
POST /serialization-service/retailer/operations/status
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
operations_id |
string | Required: Operations Id |
id |
string | Required: Operation Id |
uid |
string | Optional CRPT UID |
Example Request
{
"operations_id": "557333bb-773d-46d4-9309-eda10a4b4ef6",
"id":"980be5e7-3b29-4d04-9511-f309bcc20b7a",
"uid":"276a729e-2617-483b-984d-4499a91b30cc"
}
Returns ELC workflow
Create UTD BUYBACK task
POST /serialization-service/ecommerce/returns/utd
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
delivery_number |
string | Required: Order number |
list |
list | Required: List of codes |
filename |
string | Required: Source filename |
Example Request
{
"filename": "some_file_name",
"delivery_number": "202103033",
"list": [
{
"code": "0100027131086864215p5T<,olcNTPk",
"sku": "ASKU1",
"declaration_number": "10013160/091219/0535389"
},
{
"code": "0100027131086864215SJDb=sgtwE4y",
"sku": "ASKU1",
"declaration_number": "10013160/091219/0535389"
},
{
"code": "0100027131086864215wtBXlPLL>fJH",
"sku": "ASKU1",
"declaration_number": "10013160/091219/0535389"
},
{
"code": "0100027131086864215wtBXlPLL>fJH",
"declaration_number": "10013160/091219/0535389"
}
]
}
Example Responce
{
"id": "urn:authenticateit:participant:804355519238231@ecommerce_returns_utd@202103033"
}
Read UTD BUYBACK task status
GET /serialization-service/ecommerce/returns/utd
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
string | Required: Task Id |
Example Responce. pending
{
"status": "pending"
}
Example Responce. failure
{
"error": "Can't uniquely identify the SKU.",
"error_codes": [
"0100027131086864215wtBXlPLL>fJH"
],
"status": "failure"
}
Example Responce. success
{
"plan": [
{
"codes": [
{
"codes": [
"0100027131086864215SJDb=sgtwE4y",
"0100027131086864215p5T<,olcNTPk",
"0100027131086864215wtBXlPLL>fJH"
],
"gtin": "00027131086864"
}
],
"delivery": "202103032",
"type": "BUYBACK"
}
],
"status": "success"
}
Set returns list
POST /serialization-service/ecommerce/returns
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
list |
list | Required: Operations |
filename |
string | Required: Filename |
Example Request
{
"list": [
{
"type": "CANCEL",
"delivery": "mode_010_test_1",
"inbound_delivery_number": "some_inb_num"
},
{ "ucd": "ucd",
"code": "010002713108686421_\"!cgo'\''ISw(2Y",
"type": "ZCM",
"utd_number": "utd_number",
"delivery": "mode_010_test_1",
"inbound_delivery_number": "some_inb_num"
},
{ "ucd": "ucd",
"code": "010002713108686421_:g!UINJSr5<Q",
"type": "ZCM",
"utd_number": "utd_number",
"delivery": "mode_010_test_1",
"inbound_delivery_number": "some_inb_num"
},
{ "ucd": "ucd",
"code": "010002713108686421_>GRthpGyZNR:",
"type": "ZCM",
"utd_number": "utd_number",
"delivery": "mode_010_test_1",
"inbound_delivery_number": "some_inb_num"
},
{ "ucd": "ucd",
"code": "010002713108686421_fXIW;uTLGNSl",
"type": "ZCM",
"utd_number": "utd_number",
"delivery": "mode_010_test_1",
"inbound_delivery_number": "some_inb_num"
},
{ "ucd": "ucd",
"code": "010002713108686421_i9wmOWDZEU)X",
"type": "ZCM",
"utd_number": "utd_number",
"delivery": "mode_010_test_1",
"inbound_delivery_number": "some_inb_num"
},
{ "ucd": "ucd",
"code": "010002713108686421_OlQ>M%yAZe?J",
"type": "ZCM",
"utd_number": "utd_number",
"delivery": "mode_010_test_1",
"inbound_delivery_number": "some_inb_num"
},
{ "ucd": "ucd",
"code": "010002713108686421_R8.oOeU'\''Jc.q",
"type": "ZCM",
"utd_number": "utd_number",
"delivery": "mode_010_test_1",
"inbound_delivery_number": "some_inb_num"
},
{
"type": "ZRT",
"ucd": "ucd",
"code": "234500000000001001",
"utd_number": "utd_number",
"delivery": "mode_010_test_2",
"inbound_delivery_number": "inbound_delivery_number"
},
{
"type": "ZRT",
"ucd": "ucd",
"code": "010002713108686421/HFlAYV-CFAyn",
"utd_number": "utd_number",
"delivery": "mode_010_test_2",
"inbound_delivery_number": "inbound_delivery_number"
},
{
"type": "ZRT",
"ucd": "ucd",
"code": "010002713108686421/IjLNzBSRJMey",
"utd_number": "utd_number",
"delivery": "mode_010_test_2",
"inbound_delivery_number": "inbound_delivery_number"
},
{
"type": "ZRT",
"ucd": "ucd",
"code": "010002713108686421/oG+vm&8Kq%dU",
"utd_number": "utd_number",
"delivery": "mode_010_test_2",
"inbound_delivery_number": "inbound_delivery_number"
},
{
"type": "ZRT",
"ucd": "ucd",
"code": "010002713108686421/r7mq4u>R0K6t",
"utd_number": "utd_number",
"delivery": "mode_010_test_2",
"inbound_delivery_number": "inbound_delivery_number"
}
],
"filename": "some_filename.csv"
}
Example Responce
{
"id": "0db8e7af-f9f0-455b-9dab-dcdab2b430ea"
}
Get returns list status
GET /serialization-service/ecommerce/returns/?id=0db8e7af-f9f0-455b-9dab-dcdab2b430ea
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
string | Required: Operations Id |
Example Pending Responce
{
"status": "pending"
}
Example Success Responce
{
"list": [
{
"delivery": "mode_010_test_1",
"error": "type_temporarily_not_supported",
"inbound_delivery_number": "some_inb_num",
"sgtins": [
{
"code": "010002713108686421_iJs\"OaoYEVHV",
"custody": "urn:authenticateit:participant:927064170770438",
"id": "urn:epc:id:sgtin:0027131.008686._iJs\"OaoYEVHV",
"order_shipped": "mode_010_test_1",
"sku": "4829020000"
},
{
"code": "010002713108686421_onbJt'Pn_%4C",
"custody": "urn:authenticateit:participant:927064170770438",
"id": "urn:epc:id:sgtin:0027131.008686._onbJt'Pn_%4C",
"order_shipped": "mode_010_test_1",
"sku": "4829020000"
}
],
"type": "CANCEL"
},
{
"code": "010002713108686421_\"!cgo'ISw(2Y",
"delivery": "mode_010_test_1",
"inbound_delivery_number": "some_inb_num",
"sgtins": [
{
"code": "010002713108686421_\"!cgo'ISw(2Y",
"custody": "urn:authenticateit:participant:927064170770438",
"id": "urn:epc:id:sgtin:0027131.008686._\"!cgo'ISw(2Y",
"order_shipped": "mode_010_test_1",
"sku": "4829020000"
}
],
"type": "ZCM",
"ucd": "ucd",
"utd_number": "utd_number"
},
{
"code": "010002713108686421_:g!UINJSr5<Q",
"delivery": "mode_010_test_1",
"inbound_delivery_number": "some_inb_num",
"sgtins": [
{
"code": "010002713108686421_:g!UINJSr5<Q",
"custody": "urn:authenticateit:participant:927064170770438",
"id": "urn:epc:id:sgtin:0027131.008686._:g!UINJSr5<Q",
"order_shipped": "mode_010_test_1",
"sku": "4829020000"
}
],
"type": "ZCM",
"ucd": "ucd",
"utd_number": "utd_number"
},
{
"code": "010002713108686421_>GRthpGyZNR:",
"delivery": "mode_010_test_1",
"inbound_delivery_number": "some_inb_num",
"sgtins": [
{
"code": "010002713108686421_>GRthpGyZNR:",
"custody": "urn:authenticateit:participant:927064170770438",
"id": "urn:epc:id:sgtin:0027131.008686._>GRthpGyZNR:",
"order_shipped": "mode_010_test_1",
"sku": "4829020000"
}
],
"type": "ZCM",
"ucd": "ucd",
"utd_number": "utd_number"
},
{
"code": "010002713108686421_fXIW;uTLGNSl",
"delivery": "mode_010_test_1",
"inbound_delivery_number": "some_inb_num",
"sgtins": [
{
"code": "010002713108686421_fXIW;uTLGNSl",
"custody": "urn:authenticateit:participant:927064170770438",
"id": "urn:epc:id:sgtin:0027131.008686._fXIW;uTLGNSl",
"order_shipped": "mode_010_test_1",
"sku": "4829020000"
}
],
"type": "ZCM",
"ucd": "ucd",
"utd_number": "utd_number"
},
{
"code": "010002713108686421_i9wmOWDZEU)X",
"delivery": "mode_010_test_1",
"inbound_delivery_number": "some_inb_num",
"sgtins": [
{
"code": "010002713108686421_i9wmOWDZEU)X",
"custody": "urn:authenticateit:participant:927064170770438",
"id": "urn:epc:id:sgtin:0027131.008686._i9wmOWDZEU)X",
"order_shipped": "mode_010_test_1",
"sku": "4829020000"
}
],
"type": "ZCM",
"ucd": "ucd",
"utd_number": "utd_number"
},
{
"code": "010002713108686421_OlQ>M%yAZe?J",
"delivery": "mode_010_test_1",
"inbound_delivery_number": "some_inb_num",
"sgtins": [
{
"code": "010002713108686421_OlQ>M%yAZe?J",
"custody": "urn:authenticateit:participant:927064170770438",
"id": "urn:epc:id:sgtin:0027131.008686._OlQ>M%yAZe?J",
"order_shipped": "mode_010_test_1",
"sku": "4829020000"
}
],
"type": "ZCM",
"ucd": "ucd",
"utd_number": "utd_number"
},
{
"code": "010002713108686421_R8.oOeU'Jc.q",
"delivery": "mode_010_test_1",
"inbound_delivery_number": "some_inb_num",
"sgtins": [
{
"code": "010002713108686421_R8.oOeU'Jc.q",
"custody": "urn:authenticateit:participant:927064170770438",
"id": "urn:epc:id:sgtin:0027131.008686._R8.oOeU'Jc.q",
"order_shipped": "mode_010_test_1",
"sku": "4829020000"
}
],
"type": "ZCM",
"ucd": "ucd",
"utd_number": "utd_number"
},
{
"code": "234500000000001001",
"delivery": "mode_010_test_2",
"inbound_delivery_number": "inbound_delivery_number",
"sgtins": [
{
"code": "010002713108686421/c2Ds/7AGKZf'",
"custody": "urn:authenticateit:participant:927064170770438",
"id": "urn:epc:id:sgtin:0027131.008686./c2Ds/7AGKZf'",
"order_shipped": "mode_010_test_2",
"sku": "4829020000"
},
{
"code": "010002713108686421/CVmwtNopr5O<",
"custody": "urn:authenticateit:participant:927064170770438",
"id": "urn:epc:id:sgtin:0027131.008686./CVmwtNopr5O<",
"order_shipped": "mode_010_test_2",
"sku": "4829020000"
},
{
"code": "010002713108686421/EtbdpZpqO)vy",
"custody": "urn:authenticateit:participant:927064170770438",
"id": "urn:epc:id:sgtin:0027131.008686./EtbdpZpqO)vy",
"order_shipped": "mode_010_test_2",
"sku": "4829020000"
},
{
"code": "010002713108686421/F-mYpSan2;'s",
"custody": "urn:authenticateit:participant:927064170770438",
"id": "urn:epc:id:sgtin:0027131.008686./F-mYpSan2;'s",
"order_shipped": "mode_010_test_2",
"sku": "4829020000"
},
{
"code": "010002713108686421/GAJgbfJc&>jD",
"custody": "urn:authenticateit:participant:927064170770438",
"id": "urn:epc:id:sgtin:0027131.008686./GAJgbfJc&>jD",
"order_shipped": "mode_010_test_2",
"sku": "4829020000"
},
{
"code": "010002713108686421/gVEl3eog<ioL",
"custody": "urn:authenticateit:participant:927064170770438",
"id": "urn:epc:id:sgtin:0027131.008686./gVEl3eog<ioL",
"order_shipped": "mode_010_test_2",
"sku": "4829020000"
}
],
"type": "ZRT",
"ucd": "ucd",
"utd_number": "utd_number"
},
{
"code": "010002713108686421/HFlAYV-CFAyn",
"delivery": "mode_010_test_2",
"inbound_delivery_number": "inbound_delivery_number",
"sgtins": [
{
"code": "010002713108686421/HFlAYV-CFAyn",
"custody": "urn:authenticateit:participant:927064170770438",
"id": "urn:epc:id:sgtin:0027131.008686./HFlAYV-CFAyn",
"order_shipped": "mode_010_test_2",
"sku": "4829020000"
}
],
"type": "ZRT",
"ucd": "ucd",
"utd_number": "utd_number"
},
{
"code": "010002713108686421/IjLNzBSRJMey",
"delivery": "mode_010_test_2",
"inbound_delivery_number": "inbound_delivery_number",
"sgtins": [
{
"code": "010002713108686421/IjLNzBSRJMey",
"custody": "urn:authenticateit:participant:927064170770438",
"id": "urn:epc:id:sgtin:0027131.008686./IjLNzBSRJMey",
"order_shipped": "mode_010_test_2",
"sku": "4829020000"
}
],
"type": "ZRT",
"ucd": "ucd",
"utd_number": "utd_number"
},
{
"code": "010002713108686421/oG+vm&8Kq%dU",
"delivery": "mode_010_test_2",
"inbound_delivery_number": "inbound_delivery_number",
"sgtins": [
{
"code": "010002713108686421/oG+vm&8Kq%dU",
"custody": "urn:authenticateit:participant:927064170770438",
"id": "urn:epc:id:sgtin:0027131.008686./oG+vm&8Kq%dU",
"order_shipped": "mode_010_test_2",
"sku": "4829020000"
}
],
"type": "ZRT",
"ucd": "ucd",
"utd_number": "utd_number"
},
{
"code": "010002713108686421/r7mq4u>R0K6t",
"delivery": "mode_010_test_2",
"inbound_delivery_number": "inbound_delivery_number",
"sgtins": [
{
"code": "010002713108686421/r7mq4u>R0K6t",
"custody": "urn:authenticateit:participant:927064170770438",
"id": "urn:epc:id:sgtin:0027131.008686./r7mq4u>R0K6t",
"order_shipped": "mode_010_test_2",
"sku": "4829020000"
}
],
"type": "ZRT",
"ucd": "ucd",
"utd_number": "utd_number"
}
],
"plan": [
{
"codes": [
{
"codes": [
"010002713108686421/gVEl3eog<ioL",
"010002713108686421/GAJgbfJc&>jD",
"010002713108686421/F-mYpSan2;'s",
"010002713108686421/EtbdpZpqO)vy",
"010002713108686421/CVmwtNopr5O<",
"010002713108686421/c2Ds/7AGKZf'",
"010002713108686421/HFlAYV-CFAyn",
"010002713108686421/IjLNzBSRJMey",
"010002713108686421/oG+vm&8Kq%dU",
"010002713108686421/r7mq4u>R0K6t"
],
"gtin": "00027131086864"
}
],
"delivery": "mode_010_test_2",
"type": "ZRT"
}
],
"result": [
{
"codes": [
{
"code": "010002713108686421_R8.oOeU'Jc.q",
"status": "OK",
"type": "ZCM"
},
{
"code": "010002713108686421_OlQ>M%yAZe?J",
"status": "OK",
"type": "ZCM"
},
{
"code": "010002713108686421_i9wmOWDZEU)X",
"status": "OK",
"type": "ZCM"
},
{
"code": "010002713108686421_fXIW;uTLGNSl",
"status": "OK",
"type": "ZCM"
},
{
"code": "010002713108686421_>GRthpGyZNR:",
"status": "OK",
"type": "ZCM"
},
{
"code": "010002713108686421_:g!UINJSr5<Q",
"status": "OK",
"type": "ZCM"
},
{
"code": "010002713108686421_\"!cgo'ISw(2Y",
"status": "OK",
"type": "ZCM"
}
],
"delivery": "mode_010_test_1"
}
],
"status": "success"
}
Set returns plan confirmation
POST /serialization-service/ecommerce/returns/confirmation
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
invoice |
string | Required: Invoice (delivery) |
list |
string | Required: Confirmation list |
Example Request
{
"list": [
{
"codes": [
"010002713108686421/gVEl3eog<ioL",
"010002713108686421/GAJgbfJc&>jD",
"010002713108686421/F-mYpSan2;'s",
"010002713108686421/F-mYpSan2;'s"
],
"gtin": "00027131086864"
},
{
"codes": [
"010000000000000021/F-mYpSan2;'s"
],
"gtin": "00000000000000"
}
],
"invoice": "mode_010_test_2"
}
Example Responce
{
"id": "urn:authenticateit:participant:804355519238232@ecommerce_returns@6c1fd9f4-0a52-4121-9fc4-403cae1e299c@result@confirmation@mode_010_test_2",
"result": [
{
"codes": [
{
"code": "010002713108686421/EtbdpZpqO)vy",
"status": "NOK",
"type": "ZRT"
},
{
"code": "010002713108686421/CVmwtNopr5O<",
"status": "NOK",
"type": "ZRT"
},
{
"code": "010002713108686421/c2Ds/7AGKZf'",
"status": "NOK",
"type": "ZRT"
},
{
"code": "010002713108686421/HFlAYV-CFAyn",
"status": "NOK",
"type": "ZRT"
},
{
"code": "010002713108686421/IjLNzBSRJMey",
"status": "NOK",
"type": "ZRT"
},
{
"code": "010002713108686421/oG+vm&8Kq%dU",
"status": "NOK",
"type": "ZRT"
},
{
"code": "010002713108686421/r7mq4u>R0K6t",
"status": "NOK",
"type": "ZRT"
},
{
"code": "010002713108686421/gVEl3eog<ioL",
"status": "OK",
"type": "ZRT"
},
{
"code": "010002713108686421/GAJgbfJc&>jD",
"status": "OK",
"type": "ZRT"
},
{
"code": "010002713108686421/F-mYpSan2;'s",
"status": "OK",
"type": "ZRT"
}
],
"delivery": "mode_010_test_2",
"type": "ZRT"
}
]
}
Manual buybacks
POST /serialization-service/ecommerce/returns/buyback
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
codes |
list | Required: List of codes |
shipment_reg_mode |
string | Required: Order's shipment_reg_mode (from 010 to 090 ) |
header |
object | Required: Order's header |
OrderType
- always ZPOS
.
DeliveryType
- always LF
.
DeliveryNumber
- preferred delivery number.
BillTo
- preferred consignee code.
Example Request
{
"shipment_reg_mode": "070",
"codes": [
"010002713104329421\"ARke,LCS1cPf"
],
"header": {
"OrderType": "ZPOS",
"DeliveryNumber": "TEST_DELIVERY_NUM_RET",
"DeliveryType": "LF",
"BillTo": "C4330"
}
}
Inventory alignments
Set order
POST /serialization-service/inventory/alignment/order
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
OrderNum |
string | Required: Order number |
Codes |
list | Required: List of codes |
DocId |
string | Optional DocId |
DocType |
string | Optional DocType |
Example Request
{
"Codes": [
"0100027131086864215SJDb=sgtwE4y",
"0100027131086864215wtBXlPLL>fJH",
"0100027131086864216Ocn_RKpHkoMw"
],
"OrderNum": "test_order",
"DocId": "SomeId",
"DocType": "SomeType"
}
Example Responce
{
"id": "fcacd5c2d08235be629cb0ee55d90e1bf8ef16d2"
}
Get order validation status
GET /serialization-service/inventory/alignment/order
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
string | Required: Order Id |
Example Responce
{
"status": "pending"
}
Example Responce
{
"result": [
{
"circulation_status": null,
"code": "0100027131086864215SJDb=sgtwE4y",
"custody": "urn:authenticateit:participant:804355519238231",
"id": "urn:epc:id:sgtin:0027131.008686.5SJDb=sgtwE4y"
},
{
"circulation_status": null,
"code": "0100027131086864215wtBXlPLL>fJH",
"custody": "urn:authenticateit:participant:804355519238231",
"id": "urn:epc:id:sgtin:0027131.008686.5wtBXlPLL>fJH"
},
{
"circulation_status": null,
"code": "0100027131086864216Ocn_RKpHkoMw",
"custody": "urn:authenticateit:participant:804355519238231",
"id": "urn:epc:id:sgtin:0027131.008686.6Ocn_RKpHkoMw"
}
],
"status": "validation_success"
}
Example Responce
{
"errors": [
{
"error": "The code has not been confirmed.",
"error_data": [
"0100027131086864215SJDb=sgtwE4y1"
],
"error_id": "serialization-unexpected_code",
"error_object": null
},
{
"error": "The code has not been confirmed.",
"error_data": [
"0100027131086864215wtBXlPLL>fJH2"
],
"error_id": "serialization-unexpected_code",
"error_object": null
},
{
"error": "The code has not been confirmed.",
"error_data": [
"0100027131086864216Ocn_RKpHkoMw3"
],
"error_id": "serialization-unexpected_code",
"error_object": null
}
],
"status": "failed"
}
Set CRPT registration status
POST /serialization-service/inventory/alignment/order/status
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
string | Required: Order Id |
status |
string | Required: success or failed |
Example Request
{
"id": "fcacd5c2d08235be629cb0ee55d90e1bf8ef16d2",
"status": "success"
}
Relabeling
Create task
POST /serialization-service/relabeling/task
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
doc_num |
string | Required: Order number |
list |
list | Required: List of codes |
filename |
string | Required: Source filename |
Example Request
{
"doc_num": "20210209-01",
"filename": "file_20210209-01",
"list": [
{
"sku": "62YL010000",
"gtin": "00020714080303",
"qty": 3
}
]
}
Example Responce
{
"id": "urn:authenticateit:participant:804355519238232@relabeling_task@20210209-01"
}
Read task status
POST /serialization-service/relabeling/task/get
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
string | Required: Task Id. |
Example Request
{
"id": "urn:authenticateit:participant:804355519238232@relabeling_task@20210209-01"
}
Example Responce. pending
{
"list": [
{
"gtin": "00020714080303",
"qty": 3,
"sku": "62YL010000"
}
],
"status": "pending"
}
Example Responce. failure
{
"error": {
"error": "Not enough codes to complete the task.",
"error_data": [],
"error_id": "serialization-relabeling_not_enough_available_codes",
"error_object": {
"available": 0,
"gtin": "00020714080303",
"requested": 3,
"sku": "62YL010000"
}
},
"list": [
{
"gtin": "00020714080303",
"qty": 3,
"sku": "62YL010000"
}
],
"status": "failure"
}
Example Responce. validation_success
. Prev codes available
{
"list": [
{
"codes": [
{
"certificate_document": "CONFORMITY_DECLAR",
"certificate_document_date": "2020-07-07",
"code": "010002713108686421/CVmwtNopr5O<",
"customs_code": "10013160",
"declaration_date": "2019-12-09",
"declaration_number": "10013160/091219/0535389",
"id": "urn:epc:id:sgtin:0027131.008686./CVmwtNopr5O<",
"tnved": "3303009000"
},
{
"certificate_document": "CONFORMITY_DECLAR",
"certificate_document_date": "2020-07-07",
"code": "010002713108686421/EtbdpZpqO)vy",
"customs_code": "10013160",
"declaration_date": "2019-12-09",
"declaration_number": "10013160/091219/0535389",
"id": "urn:epc:id:sgtin:0027131.008686./EtbdpZpqO)vy",
"tnved": "3303009000"
},
{
"certificate_document": "CONFORMITY_DECLAR",
"certificate_document_date": "2020-07-07",
"code": "010002713108686421/c2Ds/7AGKZf'",
"customs_code": "10013160",
"declaration_date": "2019-12-09",
"declaration_number": "10013160/091219/0535389",
"id": "urn:epc:id:sgtin:0027131.008686./c2Ds/7AGKZf'",
"tnved": "3303009000"
}
],
"gtin": "00027131086864",
"qty": 3,
"sku": "4829020000"
}
],
"status": "validation_success"
}
Example Responce. validation_success
. Prev codes not available
{
"list": [
{
"gtin": "00027131086864",
"qty": 3,
"sku": "4829020000"
}
],
"status": "validation_success"
}
Set final task status
POST /serialization-service/relabeling/task/status
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
string | Required: Task Id. |
status |
string | Required: Status (success or failure ) |
codes |
list | List of codes (required if status = success ) |
Example Request. Status = success
. Prev codes not available
{
"codes": [
"010002713104329421\"ARke,LCS1cPf1\u001d91TEST\u001d92dGVzdFNEvy2ZmV+r8daab0I2Mu9kdmEdv5BTBZ0kGR8=",
"010002713108686421/CVmwtNopr5O<1\u001d91TEST\u001d92dGVzdFNEvy2ZmV+r8daab0I2Mu9kdmEdv5BTBZ0kGR8=",
"010002713108686421/EtbdpZpqO)vy1\u001d91TEST\u001d92dGVzdFNEvy2ZmV+r8daab0I2Mu9kdmEdv5BTBZ0kGR8=",
"010002713108686421/c2Ds/7AGKZf'1\u001d91TEST\u001d92dGVzdFNEvy2ZmV+r8daab0I2Mu9kdmEdv5BTBZ0kGR8="
],
"id": "urn:authenticateit:participant:804355519238232@relabeling_task@20210209-01",
"status": "success"
}
Example Responce. Status = success
. Prev codes not available
{
"confirmation_list": [
{
"codes": [
"010002713104329421\"ARke,LCS1cPf1\u001d91TEST\u001d92dGVzdFNEvy2ZmV+r8daab0I2Mu9kdmEdv5BTBZ0kGR8="
],
"gtin": "00027131043294"
},
{
"codes": [
"010002713108686421/CVmwtNopr5O<1\u001d91TEST\u001d92dGVzdFNEvy2ZmV+r8daab0I2Mu9kdmEdv5BTBZ0kGR8=",
"010002713108686421/EtbdpZpqO)vy1\u001d91TEST\u001d92dGVzdFNEvy2ZmV+r8daab0I2Mu9kdmEdv5BTBZ0kGR8=",
"010002713108686421/c2Ds/7AGKZf'1\u001d91TEST\u001d92dGVzdFNEvy2ZmV+r8daab0I2Mu9kdmEdv5BTBZ0kGR8="
],
"gtin": "00027131086864"
}
],
"doc_num": "20210209-01"
}
Example Request. Status = success
. Prev codes available
{
"codes": [
{
"prev_code": "010002713104329421\"ARke,LCS1cPf",
"new_code": "010002713104329421\"ARke,LCS1cPf1\u001d91TEST\u001d92dGVzdFNEvy2ZmV+r8daab0I2Mu9kdmEdv5BTBZ0kGR8="
},
{
"prev_code": "010002713108686421/CVmwtNopr5O<",
"new_code": "010002713108686421/CVmwtNopr5O<1\u001d91TEST\u001d92dGVzdFNEvy2ZmV+r8daab0I2Mu9kdmEdv5BTBZ0kGR8="
},
{
"prev_code": "010002713108686421/EtbdpZpqO)vy",
"new_code": "010002713108686421/EtbdpZpqO)vy1\u001d91TEST\u001d92dGVzdFNEvy2ZmV+r8daab0I2Mu9kdmEdv5BTBZ0kGR8="
} ,
{
"prev_code": "010002713108686421/c2Ds/7AGKZf'",
"new_code": "010002713108686421/c2Ds/7AGKZf'1\u001d91TEST\u001d92dGVzdFNEvy2ZmV+r8daab0I2Mu9kdmEdv5BTBZ0kGR8="
}
],
"id": "urn:authenticateit:participant:804355519238232@relabeling_task@20210209-01",
"status": "success"
}
Example Responce. Status = success
. Prev codes available
{
"confirmation_list": [
{
"codes": [
"010002713104329421\"ARke,LCS1cPf1\u001d91TEST\u001d92dGVzdFNEvy2ZmV+r8daab0I2Mu9kdmEdv5BTBZ0kGR8="
],
"gtin": "00027131043294"
},
{
"codes": [
"010002713108686421/CVmwtNopr5O<1\u001d91TEST\u001d92dGVzdFNEvy2ZmV+r8daab0I2Mu9kdmEdv5BTBZ0kGR8=",
"010002713108686421/EtbdpZpqO)vy1\u001d91TEST\u001d92dGVzdFNEvy2ZmV+r8daab0I2Mu9kdmEdv5BTBZ0kGR8=",
"010002713108686421/c2Ds/7AGKZf'1\u001d91TEST\u001d92dGVzdFNEvy2ZmV+r8daab0I2Mu9kdmEdv5BTBZ0kGR8="
],
"gtin": "00027131086864"
}
],
"doc_num": "20210209-01"
}
Example Responce. Status = success
{
"error": "Incomplete list of codes. Some codes has been skipped.",
"error_data": [
"010002713108686421/c2Ds/7AGKZf'"
],
"error_id": "serialization-skipped_codes",
"error_object": null
}
Example Request. Status = failure
{
"id": "urn:authenticateit:participant:804355519238232@relabeling_task@20210209-01",
"status": "failure"
}