Events

Manage pick-pack events

Retrieving all events

get

Retrieves all events after a specified timestamp.

Required scopes

This endpoint requires the following scopes:

• : Needed to retrieve information about resources in the service.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant name should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

Query parameters

timestampstring · min: 3 · max: 16Optional

Date after which we want to filter the events.

Pattern: yyyy-MM-dd'T'HH:mm:ssZ

pageNumberintegerOptional

Number of the page.

pageSizeinteger · max: 20000Optional

Size of the page.

Responses

200

Order entry event

application/json

400

Request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

500

Internal Service Error occurred.

application/json

get

/pick-pack/{tenant}/events

HTTPcURLJavaScriptPython

GET /pick-pack/{tenant}/events HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "eventId": "123",
    "productId": "123",
    "deliveryCycle": "2023-10-13-11-test",
    "orderNumber": "123",
    "timestamp": "2020-09-14T13:35:18.333Z",
    "pickedAmount": 2,
    "packedAmount": 2,
    "canceledAmount": 0,
    "packedAmountInPc": 2,
    "supplierId": "1234",
    "user": "1234",
    "site": "main",
    "unit": "H87",
    "bookProduct": true
  }
]

Creating a new packing event

post

Creates a new packing event.

Note: If the order has the packingStatus set to CANCELLED, it is not possible to create any new packing events for that order.

Required scopes

This endpoint requires the following scopes:

• : Needed to manage resources in the service.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant name should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

Header parameters

saas-tokenstringRequired

Token provided by the Emporix system, used to identify logged in customers. This token has an expiry date and is signed with a passphrase.

Body

application/json

eventIdstringRequired

The event id generated by the client

Example: 123

orderNumberstringRequired

The order number for which the packing event is created

Example: 123

productIdstringRequired

The product id for which the packing event is created

Example: 123

deliveryCyclestringOptional

The delivery cycle for which the packing event is created

Example: 2023-10-13-11-test

pickedAmountintegerOptional

The amount of picked items

Example: 1

packedAmountintegerOptional

The amount of packed items

Example: 1

canceledAmountintegerOptional

The amount of cancelled items

Example: 0

supplierIdstringOptional

The supplier id

Example: 123

unitstringRequired

The unit of the packed item

Example: H87

timestampstring · date-timeRequired

Timestamp of the packing event in ISO format

Example: 2020-09-14T13:35:18.333Z

sitestringRequired

The site code for which the event is created

Example: main

bookProductbooleanOptionalExample: true

Responses

200

Event creation response

application/json

400

Request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

409

Conflict

application/json

500

Internal Service Error occurred.

application/json

post

/pick-pack/{tenant}/events

HTTPcURLJavaScriptPython

POST /pick-pack/{tenant}/events HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
saas-token: text
Content-Type: application/json
Accept: */*
Content-Length: 249

{
  "eventId": "123",
  "orderNumber": "123",
  "productId": "123",
  "deliveryCycle": "2023-10-13-11-test",
  "pickedAmount": 1,
  "packedAmount": 1,
  "canceledAmount": 0,
  "supplierId": "123",
  "unit": "H87",
  "timestamp": "2020-09-14T13:35:18.333Z",
  "site": "main",
  "bookProduct": true
}

{
  "message": "Success",
  "code": 200
}