Assignees
Manage pick-pack assignees
Authorizations
Path parameters
tenantstring · min: 3 · max: 16RequiredPattern:
Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$
orderIdstringRequired
Order's unique identifier.
Query parameters
forcebooleanOptionalDefault:
If set to true, the new assignee will replace the old one. If set to false, a bad request will be returned if the order already has an assignee.
true
Body
idstringRequiredExample:
Identifier of an assignment
123
siteCodestringRequiredExample:
Code of a site
main
firstNamestringRequiredExample:
First name of assignee
John
lastNamestringRequiredExample:
Last name of assignee
Smith
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
404
Resource has not been found.
application/json
409
Conflict
application/json
500
Internal Service Error occurred.
application/json
post
POST /pick-pack/{tenant}/orders/{orderId}/assignees HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 68
{
"id": "123",
"firstName": "John",
"lastName": "Smith",
"siteCode": "main"
}
{
"message": "Success",
"code": 200
}
Authorizations
Path parameters
tenantstring · min: 3 · max: 16RequiredPattern:
Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$
orderIdstringRequired
Order's unique identifier.
assigneeIdstring · min: 3 · max: 16RequiredPattern:
assignee which will be removed from order
[a-zA-Z0-9_-]+
Responses
204
The request has succeeded.
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
delete
DELETE /pick-pack/{tenant}/orders/{orderId}/assignees/{assigneeId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Was this helpful?