This method has the same functionality as the GetInboundItemsByID method except that this method also returns all the meta data fields in the form of a Payload.
Syntax
C# | ![]() |
---|---|
GetInboundItemsByIDExResponse GetInboundItemsByIDEx(Authentication authentication, GetInboundItemsByIDExRequest request) |
Parameters
Parameter | Type | Required? | Description | |
---|---|---|---|---|
Input Header | Authorization | String | Required for OAuth 2.0 authorization | A string representing the authentication of the request via an access token in the format Authorization: Bearer {AccessToken}. Example header: Authorization:Bearer M1Q0NjJvZ7Q5OPM2NDW1ZTCjOGZmYjI4 |
x-ch-request-id | String | Client generated unique identifier for tracking | ||
Input Body | authentication | Required | Authentication credentials (User Id and PIN) | |
request | Required | Request Object | ||
Output Header | x-ch-activity-id | String | Server generated unique identifier for tracking | |
x-ch-execution-time | String | Server execution time in milli-seconds | ||
Result | GetInboundItemsIDResult | Response Object (Output) |
Remarks
GetInboundItemsByIDEx retrieves items based on the item ID's specified.
Items will not be deleted from the server after calling this method. To delete RemoveInboundItemsByID should be called passing in the list of ID's retrieved that you wish to remove.