Assignees

Manage pick-pack assignees

Adding an assignee to an order

post

Adds an assignee to a specified order.

Note: If the order has the packingStatus set to CANCELLED, it is not possible to modify the assignee 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]+$

orderIdstringRequired

Order's unique identifier.

Query parameters

forcebooleanOptional

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.

Default: true

Body

application/json

idstringRequired

Identifier of an assignment

Example: 123

siteCodestringRequired

Code of a site

Example: main

firstNamestringRequired

First name of assignee

Example: John

lastNamestringRequired

Last name of assignee

Example: 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

/pick-pack/{tenant}/orders/{orderId}/assignees

HTTPcURLJavaScriptPython

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
}

Deleting an assignee from an order

delete

Deletes a specified assignee from a specified 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]+$

orderIdstringRequired

Order's unique identifier.

assigneeIdstring · min: 3 · max: 16Required

assignee which will be removed from order

Pattern: [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

/pick-pack/{tenant}/orders/{orderId}/assignees/{assigneeId}

HTTPcURLJavaScriptPython

DELETE /pick-pack/{tenant}/orders/{orderId}/assignees/{assigneeId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content