This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Get all Handover Container respecting the given filter
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
startAfterIdstringOptional
entity to start after
sizeintegerOptional
number of entities to show
Default: 25
facilityRefsstring[]Optional
facilities to filter the results
Responses
200
All HandoverContainer matching the given parameters.
application/json
anyOptional
StrippedHandoverContainer
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
Bearer authentication header of the form Bearer <token>.
Path parameters
handoverContainerIdstringRequired
id of the handover container
Responses
200
HandoverContainer successfully deleted.
No content
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
404
Entity not found
application/json
delete
/api/handovercontainers/{handoverContainerId}
No content
Get handover container stack
get
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Return the stack of a given handover container if found
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
handoverContainerIdstringRequired
id of the handover container
Responses
200
Stack for the given handoverContainer matching the given id.
application/json
Stack
createdstring · date-timeRequired
The date this entity was created at the platform. This value is generated by the service.
Example: 2020-02-03T08:45:51.525Z
facilityRefsstring[] · max: 50Required
Linked Facilities through reference
idstringRequired
Unique identifier of the Stack
lastModifiedstring · date-timeRequired
The date this entity was modified last. This value is generated by the service.
Example: 2020-02-03T09:45:51.525Z
processRefsstring[] · max: 50Required
Linked Processes through reference
versioninteger · int64Required
The version of the document to be used in optimistic locking mechanisms.
Example: 42
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.
channelstring · enumRequiredPossible values:
customAttributesobjectOptional
Attributes that can be added to the handover job. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
facilityRefstringRequired
The id of the facility reference.
Example: Esb20gpHBL94X5NdMp3C
fullIdentifierstringOptional
An information to identify the recipient
loadUnitRefsstring[]Optional
Reference to array of load unit Refs
operativeProcessRefstringOptional
orderDatestring · date-timeRequired
The date this order was created at the supplying system.
Bearer authentication header of the form Bearer <token>.
Body
HandoverJobSearchPayload
afterstringOptional
The cursor to start after for forward pagination. The value is provided in the pageInfo.endCursor field of the response. Cannot be used with before or last.
beforestringOptional
The cursor to start before for backward pagination. The value is provided in the pageInfo.startCursor field of the response. Cannot be used with after or size (first).
lastnumber · min: 1 · max: 250Optional
Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.
sizenumber · min: 1 · max: 250Optional
Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.
startAfterIdstringOptionalDeprecated
The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.
Responses
200
Your search result
application/json
HandoverJobPaginatedResult
totalnumberOptional
The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this