Audit APIs¶
GreyMatter allows performing inventory audits in which manual count of selected inventory can be performed.
Audits can be created either from the Manager Dashboard or via API. But, they can be started only from the Manager Dashboard.
Audit Lifecycle¶
Audit Object¶
Audits can be of two types: location audit or SKU audit:
- In a location audit, a list of slots or MSUs are specified which have to be audited, and all inventory present in those slots are audited.
- In an SKU audit, product parameters are given, and all products matching those parameters are audited. All slots which have those products are brought to the audit station for this purpose.
-
audit_param_type
¶ Can be either
location
orsku
.
-
audit_param_value
¶ -
locations_list
¶ In case of a location audit
A list of strings denoting locations (either slot ids or MSU ids)
Example
{ "locations_list": [ "014", "039", "001", "039.1.E.02", "014.1.E.05" ] }
-
attributes_list
¶ In case of SKU audit
A list of SKU selector objects. Each object has two properties:
sku
andattributes_sets
.Example
{ "attributes_list": [{ "attributes_sets": [{ "product_color": [ "Green" ] }], "sku": "3001" }] }
-
Creating an Audit¶
Todo
Find API gateway URLs for audit APIs
-
POST
/api/audit
¶ Request Headers: - Content-Type – the request’s content-type has to be passed in this header
- Accept – the response content type depends on Accept header
- Authorization – OAuth token to authenticate
Status Codes: - 200 OK – No error
- 400 Bad Request – Bad data
Response JSON Object: - action (string) –
create
- audit_creator_name (string) – Optional string to denote who is creating the audit
- audit_param_name (string) – Name of audit to be displayed on UI
- audit_param_type (string) – Type of audit.
location
orsku
. - audit_param_value – An object of type
audit_param_value
- kq (bool) – Should be
true
if keying in quantity is allowed during audit
Example: Audit by LocationRequest
POST /api/audit HTTP/1.1 Host: example.com Content-Type: application/json Accept: application/json, text/javascript
{ "action": "create", "audit_creator_name": "Audit Creator Name", "audit_param_name": "Audit Name", "audit_param_type": "location", "audit_param_value": { "locations_list": [ "014", "039", "001", "039.1.E.02", "014.1.E.05" ] }, "kq": true }
Response
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8
{ "action": "create", "audit_id": "UQWHmJdsxL" }
Example: Audit by SKURequest
POST /api/audit HTTP/1.1 Host: example.com Content-Type: application/json Accept: application/json, text/javascript
{ "action": "create", "audit_creator_name": "Audit Creator Name", "audit_param_name": "Audit Name", "audit_param_type": "sku", "audit_param_value": { "attributes_list": [{ "attributes_sets": [{ "product_color": [ "Green" ] }], "sku": "3001" }] }, "kq": true }
Response
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8
{ "action": "create", "audit_id": "UQWHmJdsxL" }
Audit Notifications¶
All Audit notifications follow the generic notification format (see Event Notifications), and contain the relevant payload in the
notification_data
attribute.
Audit notifications are generated for most Audit Lifecycle events.
Audit Created Notification¶
{
"notification_data": {
"audit_data": [],
"pps_id": null,
"pps_seat_name": null,
"complete_time": null,
"audit_id": "ZFQkUnN6cj",
"user_name": null,
"audit_status": "created",
"creation_time": "2017-11-22T12:16:08.025296+05:30",
"timestamp": "2017-11-28T10:58:54.855768+05:30"
},
"notification_id": "e7828e10",
"notification_type": "audit_information",
"version_number": "1.5.0"
}
Auditlines Created Notification¶
{
"notification_data": {
"audit_data": [{
"status": "auditline_queued",
"expected_qty": 0,
"location": "002.1.A.03-04",
"item_id": "3fcb566d-c777-4910-a667-afd7e83b4d43",
"audit_line_id": "da6af053-9efc-4bee-9bcc-4cefed7c71c6",
"actual_qty": 0,
"extra_qty": 0,
"pdfa_values": {
"product_sku": "3001",
"colour": "yellow",
"smell": "foul"
}
}, {
"status": "auditline_queued",
"expected_qty": 0,
"location": "002.1.A.03-04",
"item_id": "9e0832dc-523a-416f-ad32-aba2e0e580ab",
"audit_line_id": "e57d5718-7155-447f-b447-017732413ce2",
"actual_qty": 0,
"extra_qty": 0,
"pdfa_values": {
"product_sku": "2024"
}
}],
"pps_id": 1,
"pps_seat_name": "front_1",
"complete_time": null,
"audit_id": "ZFQkUnN6cj",
"user_name": null,
"audit_status": "auditlines_created",
"creation_time": "2017-11-22T12:16:08.025296+05:30",
"timestamp": "2017-11-28T10:58:54.855768+05:30"
},
"notification_id": "e7828e10",
"notification_type": "audit_information",
"version_number": "1.5.0"
}
Waiting on Conflict Notification¶
{
"notification_data": {
"audit_data": [{
"status": "auditline_queued",
"expected_qty": 0,
"location": "002.1.A.03-04",
"item_id": "3fcb566d-c777-4910-a667-afd7e83b4d43",
"audit_line_id": "da6af053-9efc-4bee-9bcc-4cefed7c71c6",
"actual_qty": 0,
"extra_qty": 0,
"pdfa_values": {
"product_sku": "3001",
"colour": "yellow",
"smell": "foul"
}
}, {
"status": "auditline_queued",
"expected_qty": 0,
"location": "002.1.A.03-04",
"item_id": "9e0832dc-523a-416f-ad32-aba2e0e580ab",
"audit_line_id": "e57d5718-7155-447f-b447-017732413ce2",
"actual_qty": 0,
"extra_qty": 0,
"pdfa_values": {
"product_sku": "2024"
}
}],
"pps_id": 1,
"pps_seat_name": "front_1",
"complete_time": null,
"audit_id": "ZFQkUnN6cj",
"user_name": null,
"audit_status": "waiting_on_conflict",
"creation_time": "2017-11-22T12:16:08.025296+05:30",
"timestamp": "2017-11-28T10:58:54.855768+05:30"
},
"notification_id": "e7828e10",
"notification_type": "audit_information",
"version_number": "1.5.0"
}
Queued Notification¶
{
"notification_data": {
"audit_data": [{
"status": "auditline_queued",
"expected_qty": 0,
"location": "002.1.A.03-04",
"item_id": "3fcb566d-c777-4910-a667-afd7e83b4d43",
"audit_line_id": "da6af053-9efc-4bee-9bcc-4cefed7c71c6",
"actual_qty": 0,
"extra_qty": 0,
"pdfa_values": {
"product_sku": "3001",
"colour": "yellow",
"smell": "foul"
}
}, {
"status": "auditline_queued",
"expected_qty": 0,
"location": "002.1.A.03-04",
"item_id": "9e0832dc-523a-416f-ad32-aba2e0e580ab",
"audit_line_id": "e57d5718-7155-447f-b447-017732413ce2",
"actual_qty": 0,
"extra_qty": 0,
"pdfa_values": {
"product_sku": "2024"
}
}],
"pps_id": 1,
"pps_seat_name": "front_1",
"complete_time": null,
"audit_id": "ZFQkUnN6cj",
"user_name": null,
"audit_status": "queued",
"creation_time": "2017-11-22T12:16:08.025296+05:30",
"timestamp": "2017-11-28T10:58:54.855768+05:30"
},
"notification_id": "e7828e10",
"notification_type": "audit_information",
"version_number": "1.5.0"
}
Started Notification¶
{
"notification_data": {
"audit_data": [{
"status": "auditline_started",
"expected_qty": 1,
"location": "002.1.A.03-04",
"item_id": "9e0832dc-523a-416f-ad32-aba2e0e580ab",
"audit_line_id": "e57d5718-7155-447f-b447-017732413ce2",
"actual_qty": 0,
"extra_qty": 0,
"pdfa_values": {
"product_sku": "2024"
}
}, {
"status": "auditline_started",
"expected_qty": 1,
"location": "002.1.A.03-04",
"item_id": "3fcb566d-c777-4910-a667-afd7e83b4d43",
"audit_line_id": "da6af053-9efc-4bee-9bcc-4cefed7c71c6",
"actual_qty": 0,
"extra_qty": 0,
"pdfa_values": {
"product_sku": "3001",
"colour": "yellow",
"smell": "foul"
}
}],
"pps_id": 1,
"pps_seat_name": "front_1",
"complete_time": null,
"audit_id": "ZFQkUnN6cj",
"user_name": null,
"audit_status": "started",
"creation_time": "2017-11-22T12:16:08.025296+05:30",
"timestamp": "2017-11-28T10:58:54.855768+05:30"
},
"notification_id": "e7828e10",
"notification_type": "audit_information",
"version_number": "1.5.0"
}
Completed Notification¶
{
"notification_data": {
"audit_data": [{
"status": "auditline_completed",
"expected_qty": 1,
"location": "002.1.A.03-04",
"item_id": "3fcb566d-c777-4910-a667-afd7e83b4d43",
"audit_line_id": "da6af053-9efc-4bee-9bcc-4cefed7c71c6",
"actual_qty": 1,
"extra_qty": 0,
"pdfa_values": {
"product_sku": "3001",
"colour": "yellow",
"smell": "foul"
}
}, {
"status": "auditline_completed",
"expected_qty": 1,
"location": "002.1.A.03-04",
"item_id": "9e0832dc-523a-416f-ad32-aba2e0e580ab",
"audit_line_id": "e57d5718-7155-447f-b447-017732413ce2",
"actual_qty": 1,
"extra_qty": 0,
"pdfa_values": {
"product_sku": "2024"
}
}],
"pps_id": 1,
"pps_seat_name": "front_1",
"complete_time": "2017-11-22T12:18:32.553543+05:30",
"audit_id": "ZFQkUnN6cj",
"user_name": "admin",
"audit_status": "completed",
"creation_time": "2017-11-22T12:16:08.025296+05:30",
"timestamp": "2017-11-28T10:58:54.855768+05:30"
},
"notification_id": "e7828e10",
"notification_type": "audit_information",
"version_number": "1.5.0"
}
Pending Approval Notification¶
{
"notification_data": {
"audit_data": [{
"status": "auditline_pending_approval",
"expected_qty": 1,
"location": "002.1.A.03-04",
"item_id": "3fcb566d-c777-4910-a667-afd7e83b4d43",
"audit_line_id": "da6af053-9efc-4bee-9bcc-4cefed7c71c6",
"actual_qty": 0,
"extra_qty": 0,
"pdfa_values": {
"product_sku": "3001",
"colour": "yellow",
"smell": "foul"
}
}, {
"status": "auditline_started",
"expected_qty": 1,
"location": "002.1.A.03-04",
"item_id": "9e0832dc-523a-416f-ad32-aba2e0e580ab",
"audit_line_id": "e57d5718-7155-447f-b447-017732413ce2",
"actual_qty": 1,
"extra_qty": 0,
"pdfa_values": {
"product_sku": "2024"
}
}],
"pps_id": 1,
"pps_seat_name": "front_1",
"complete_time": null,
"audit_id": "ZFQkUnN6cj",
"user_name": "admin",
"audit_status": "pending_approval",
"creation_time": "2017-11-22T12:16:08.025296+05:30",
"timestamp": "2017-11-28T10:58:54.855768+05:30"
},
"notification_id": "e7828e10",
"notification_type": "audit_information",
"version_number": "1.5.0"
}
{
"notification_data": {
"audit_data": [{
"status": "auditline_pending_approval",
"expected_qty": 1,
"location": "002.1.A.03-04",
"item_id": "3fcb566d-c777-4910-a667-afd7e83b4d43",
"audit_line_id": "da6af053-9efc-4bee-9bcc-4cefed7c71c6",
"actual_qty": 0,
"extra_qty": 0,
"pdfa_values": {
"product_sku": "3001",
"colour": "yellow",
"smell": "foul"
}
}, {
"status": "auditline_completed",
"expected_qty": 1,
"location": "002.1.A.03-04",
"item_id": "9e0832dc-523a-416f-ad32-aba2e0e580ab",
"audit_line_id": "e57d5718-7155-447f-b447-017732413ce2",
"actual_qty": 1,
"extra_qty": 0,
"pdfa_values": {
"product_sku": "2024"
}
}],
"pps_id": 1,
"pps_seat_name": "front_1",
"complete_time": "2017-11-22T12:18:32.553543+05:30",
"audit_id": "ZFQkUnN6cj",
"user_name": "admin",
"audit_status": "pending_approval",
"creation_time": "2017-11-22T12:16:08.025296+05:30",
"timestamp": "2017-11-28T10:58:54.855768+05:30"
},
"notification_id": "e7828e10",
"notification_type": "audit_information",
"version_number": "1.5.0"
}
Rejected Notification¶
{
"notification_data": {
"audit_data": [{
"status": "auditline_rejected",
"expected_qty": 1,
"location": "002.1.A.03-04",
"item_id": "3fcb566d-c777-4910-a667-afd7e83b4d43",
"audit_line_id": "da6af053-9efc-4bee-9bcc-4cefed7c71c6",
"actual_qty": 0,
"extra_qty": 0,
"pdfa_values": {
"product_sku": "3001",
"colour": "yellow",
"smell": "foul"
}
}, {
"status": "auditline_completed",
"expected_qty": 1,
"location": "002.1.A.03-04",
"item_id": "9e0832dc-523a-416f-ad32-aba2e0e580ab",
"audit_line_id": "e57d5718-7155-447f-b447-017732413ce2",
"actual_qty": 1,
"extra_qty": 0,
"pdfa_values": {
"product_sku": "2024"
}
}],
"pps_id": 1,
"pps_seat_name": "front_1",
"complete_time": "2017-11-22T12:18:32.553543+05:30",
"audit_id": "ZFQkUnN6cj",
"user_name": "admin",
"audit_status": "rejected",
"creation_time": "2017-11-22T12:16:08.025296+05:30",
"timestamp": "2017-11-28T10:58:54.855768+05:30"
},
"notification_id": "e7828e10",
"notification_type": "audit_information",
"version_number": "1.5.0"
}
Approved Notification¶
{
"notification_data": {
"audit_data": [{
"status": "auditline_approved",
"expected_qty": 1,
"location": "002.1.A.03-04",
"item_id": "3fcb566d-c777-4910-a667-afd7e83b4d43",
"audit_line_id": "da6af053-9efc-4bee-9bcc-4cefed7c71c6",
"actual_qty": 0,
"extra_qty": 0,
"pdfa_values": {
"product_sku": "3001",
"colour": "yellow",
"smell": "foul"
}
}, {
"status": "auditline_completed",
"expected_qty": 1,
"location": "002.1.A.03-04",
"item_id": "9e0832dc-523a-416f-ad32-aba2e0e580ab",
"audit_line_id": "e57d5718-7155-447f-b447-017732413ce2",
"actual_qty": 1,
"extra_qty": 0,
"pdfa_values": {
"product_sku": "2024"
}
}],
"pps_id": 1,
"pps_seat_name": "front_1",
"complete_time": "2017-11-22T12:18:32.553543+05:30",
"audit_id": "ZFQkUnN6cj",
"user_name": "admin",
"audit_status": "approved",
"creation_time": "2017-11-22T12:16:08.025296+05:30",
"timestamp": "2017-11-28T10:58:54.855768+05:30"
},
"notification_id": "e7828e10",
"notification_type": "audit_information",
"version_number": "1.5.0"
}
Sent for Re-audit Notification¶
{
"notification_data": {
"audit_data": [{
"status": "auditline_sent_for_reaudit",
"expected_qty": 1,
"location": "002.1.A.03-04",
"item_id": "3fcb566d-c777-4910-a667-afd7e83b4d43",
"audit_line_id": "da6af053-9efc-4bee-9bcc-4cefed7c71c6",
"actual_qty": 0,
"extra_qty": 0,
"pdfa_values": {
"product_sku": "3001",
"colour": "yellow",
"smell": "foul"
}
}, {
"status": "auditline_completed",
"expected_qty": 1,
"location": "002.1.A.03-04",
"item_id": "9e0832dc-523a-416f-ad32-aba2e0e580ab",
"audit_line_id": "e57d5718-7155-447f-b447-017732413ce2",
"actual_qty": 1,
"extra_qty": 0,
"pdfa_values": {
"product_sku": "2024"
}
}],
"pps_id": 1,
"pps_seat_name": "front_1",
"complete_time": "2017-11-22T12:18:32.553543+05:30",
"audit_id": "ZFQkUnN6cj",
"user_name": "admin",
"audit_status": "sent_for_reaudit",
"creation_time": "2017-11-22T12:16:08.025296+05:30",
"timestamp": "2017-11-28T10:58:54.855768+05:30"
},
"notification_id": "e7828e10",
"notification_type": "audit_information",
"version_number": "1.5.0"
}
Cancelled Notification¶
{
"notification_data": {
"audit_data": [{
"status": "auditline_cancelled",
"expected_qty": 1,
"location": "003.1.A.03-04",
"item_id": "3fcb566d-c777-4910-a667-afd7e83b4d43",
"audit_line_id": "da6af053-9efc-4bee-9bcc-4cefed7c71c6",
"actual_qty": 1,
"extra_qty": 0,
"pdfa_values": {
"product_sku": "3001",
"colour": "yellow",
"smell": "foul"
}
}, {
"status": "auditline_completed",
"expected_qty": 1,
"location": "002.1.A.03-04",
"item_id": "9e0832dc-523a-416f-ad32-aba2e0e580ab",
"audit_line_id": "e57d5718-7155-447f-b447-017732413ce2",
"actual_qty": 1,
"extra_qty": 0,
"pdfa_values": {
"product_sku": "2024"
}
}],
"pps_id": 1,
"pps_seat_name": "front_1",
"complete_time": "2017-11-22T12:18:32.553543+05:30",
"audit_id": "ASEkUnN8dk",
"user_name": "admin",
"audit_status": "cancelled",
"creation_time": "2017-11-22T12:16:08.025296+05:30",
"timestamp": "2017-11-28T10:58:54.855768+05:30"
},
"notification_id": "e7828e10",
"notification_type": "audit_information",
"version_number": "1.5.0"
}
Deleted Notification¶
{
"notification_data": {
"audit_data": [],
"pps_id": null,
"pps_seat_name": null,
"complete_time": null,
"audit_id": "StkuKtBAFh",
"creation_time": "2017-04-27T13:34:17.610550+05:30",
"audit_status": "deleted",
"user_name": null
},
"notification_id": "e7828e10",
"notification_type": "audit_information",
"version_number": "1.5.0"
}
Aborted Notification¶
{
"notification_data": {
"pps_id": 1,
"pps_seat_name": "front_1",
"complete_time": "2017-11-23T11:12:32.252420+05:30",
"audit_id": "FEPYqepAem",
"user_name": "admin",
"audit_status": "aborted",
"creation_time": "2017-11-23T11:12:27.640083+05:30",
"timestamp": "2017-11-28T10:58:54.855768+05:30"
},
"notification_id": "e7828e10",
"notification_type": "audit_information",
"version_number": "1.5.0"
}