CommunitySupport PortalYouTubeFree trialSign Up!

Recalculations

Manage pick-pack recalculations

Triggering an order recalculation

post

Triggers order recalculation for a specified order list.

Required scopes
This endpoint requires the following scopes:
  • : Needed to manage resources in the service.
Authorizations
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]+$
Body
orderIdsstring[]Optional

The order identifiers requiring recalculation. This attribute is optional. In case the job type is AUTOMATIC the orders for recalculation will be selected automatically based on last packing events.

Example: 123
jobTypestring · enumRequired

The recalculation job types. Possible values:

  • MANUAL - recalculates all orders provided in the orderIds attribute
  • AUTOMATIC - finds orders that need recalculation and triggers recalculation for them
Example: MANUALPossible values:
Responses
200

Job creation response

application/json
post
/pick-pack/{tenant}/jobs/recalculations
POST /pick-pack/{tenant}/jobs/recalculations HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "jobType": "MANUAL",
  "orderIds": [
    "03DV9N3R",
    "5XS34VOB",
    "JGPZWWLA",
    "JGPZWWLA",
    "09FFWHA2",
    "1B70WHY7"
  ]
}
{
  "jobId": "text"
}

Retrieving a job

get

Retrieves a specified job.

Required scopes
This endpoint requires the following scopes:
  • : Needed to retrieve information about resources in the service.
Authorizations
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]+$
jobIdstring · min: 3 · max: 16Required

jobId of requested order recalculation job

Pattern: [a-zA-Z0-9_-]+
Responses
200

Recalculation job response

application/json
get
/pick-pack/{tenant}/jobs/recalculations/{jobId}
GET /pick-pack/{tenant}/jobs/recalculations/{jobId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "123",
  "jobType": "MANUAL",
  "orders": [
    {
      "orderId": "123",
      "message": "Order recalculated successfully",
      "jobOrderStatus": "SUCCESS"
    }
  ],
  "jobStatus": "SUCCESS",
  "startedAt": "2021-03-04T13:45:00.883Z",
  "finishedAt": "2021-03-04T13:45:00.883Z"
}
PreviousAssigneesNextEvents

Last updated

Was this helpful?