Get all exceptions
get
/fscmRestApi/resources/11.13.18.05/shippingExceptions
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Find shipping exceptions according to the primary key criteria.
Finder Variables:- ShippingExceptionId; integer; Value that uniquely identifies the shipping exception.
- PrimaryKey: Find shipping exceptions according to the primary key criteria.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ExceptionComments; string; Comments for the shipping exception.
- ExceptionDescription; string; Description of the shipping exception.
- Item; string; Value that uniquely identifies the inventory item.
- ItemId; integer; Value that uniquely identifies the item.
- OrganizationCode; string; Abbreviation that identifies the inventory organization.
- OrganizationId; integer; Value that uniquely identifies the inventory organization.
- OrganizationName; string; Name of the inventory organization.
- PackingUnit; string; Value that uniquely identifies the packing unit.
- PackingUnitId; integer; Value that uniquely identifies the container used when packing the detail line.
- Severity; string; Severity of the shipping exception.
- Shipment; string; Name of the material shipment.
- ShipmentId; integer; Value that uniquely identifies the shipment.
- ShipmentLine; integer; Value that uniquely identifies the shipment line.
- ShippingException; string; Display name of the shipping exception.
- ShippingExceptionCode; string; Abbreviation that identifies the shipping exception.
- ShippingExceptionId; integer; Value that uniquely identifies the shipping exception.
- Status; string; Status of the shipping exception.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : shippingExceptions
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : shippingExceptions-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the shipping exception. -
CreationDate: string
(date-time)
Read Only:
true
Date when the shipping exception was created. -
DFF: array
Flexfields for Shipping Exceptions
Title:
Flexfields for Shipping Exceptions
The Flexfields for Shipping Exceptions manages details about shipping exceptions. -
ExceptionComments: string
Maximum Length:
2000
Comments for the shipping exception. -
ExceptionDescription: string
Read Only:
true
Maximum Length:100
Description of the shipping exception. -
Item: string
Read Only:
true
Maximum Length:300
Value that uniquely identifies the inventory item. -
ItemDescription: string
Read Only:
true
Maximum Length:300
Description of the inventory item. -
ItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the shipping exception was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the shipping exception. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the inventory organization. -
OrganizationId: integer
Read Only:
true
Value that uniquely identifies the inventory organization. -
OrganizationName: string
Read Only:
true
Maximum Length:240
Name of the inventory organization. -
PackingUnit: string
Maximum Length:
30
Value that uniquely identifies the packing unit. -
PackingUnitId: integer
(int64)
Value that uniquely identifies the container used when packing the detail line.
-
Severity: string
Read Only:
true
Maximum Length:80
Severity of the shipping exception. -
Shipment: string
Maximum Length:
30
Name of the material shipment. -
ShipmentId: integer
(int64)
Value that uniquely identifies the shipment.
-
ShipmentLine: integer
(int64)
Value that uniquely identifies the shipment line.
-
ShippingException: string
Maximum Length:
80
Display name of the shipping exception. -
ShippingExceptionCode: string
Maximum Length:
50
Abbreviation that identifies the shipping exception. -
ShippingExceptionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the shipping exception. -
SourceOrder: string
Read Only:
true
Maximum Length:150
Number that identifies the source order header. -
SourceOrderFulfillmentLine: string
Read Only:
true
Maximum Length:150
Number that identifies the source order fulfillment line within the source order line. -
SourceOrderFulfillmentLineId: integer
Read Only:
true
Value that uniquely identifies the source order fulfillment line. -
SourceOrderLine: string
Read Only:
true
Maximum Length:150
Number that identifies the source order line within the source order header. -
SourceSystem: string
Read Only:
true
Maximum Length:80
Name of the source application. -
SourceSystemId: integer
Read Only:
true
Value that uniquely identifies the source application. -
Status: string
Maximum Length:
80
Status of the shipping exception.
Nested Schema : Flexfields for Shipping Exceptions
Type:
array
Title:
Flexfields for Shipping Exceptions
The Flexfields for Shipping Exceptions manages details about shipping exceptions.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : shippingExceptions-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for shipping exceptions. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for shipping exceptions. -
ExceptionId: integer
(int64)
Value that uniquely identifies the shipping exception.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to get all exceptions.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/shippingExceptions"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "ShippingExceptionId": 3386979, "ShippingExceptionCode": "WSH_PICK_BACKORDER", "ShippingException": "Backordered at Picking", "Severity": "Information", "Status": "Open", "ExceptionDescription": "The shipment line was backordered at picking.", "ExceptionComments": "Pick Release process could not allocate 3 of item EBSITEMS000011 for order 63706 as there was insufficient quantity available Or Inventory allocations have failed, and the line has been back ordered.", "CreationDate": "2007-04-30T12:43:13+00:00", "CreatedBy": "1318", "LastUpdateDate": "2018-10-26T14:16:49+00:00", "LastUpdatedBy": "WHSE_MGR_M1", "ShipmentId": null, "Shipment": null, "ShipmentLine": null, "PackingUnitId": null, "PackingUnit": null, "ItemId": 160757, "Item" : EBSITEMS000011, "OrganizationId": null, "OrganizationCode": null, "OrganizationName": null, "SourceSystemId": null, "SourceSystem": null, "SourceOrder": null, "SourceOrderLine": null, "SourceOrderFulfillmentLine": null, "SourceOrderFulfillmentLineId": null, "ItemDescription" : 'Vanilla reservable EBS item' }, { "ShippingExceptionId": 3386980, "ShippingExceptionCode": "WSH_PICK_BACKORDER", "ShippingException": "Backordered at Picking", "Severity": "Information", "Status": "No action required", "ExceptionDescription": "The shipment line was backordered at picking.", "ExceptionComments": "Pick Release process could not allocate 3 of item EBSITEMS000012 for order 63706 as there was insufficient quantity available Or Inventory allocations have failed, and the line has been back ordered.", "CreationDate": "2007-04-30T12:43:13+00:00", "CreatedBy": "1318", "LastUpdateDate": "2007-04-30T12:43:13+00:00", "LastUpdatedBy": "1318", "ShipmentId": null, "Shipment": null, "ShipmentLine": null, "PackingUnitId": null, "PackingUnit": null, "ItemId": 160758, "Item" : EBSITEMS000011, "OrganizationId": null, "OrganizationCode": null, "OrganizationName": null, "SourceSystemId": null, "SourceSystem": null, "SourceOrder": null, "SourceOrderLine": null, "SourceOrderFulfillmentLine": null, "SourceOrderFulfillmentLineId": null, "ItemDescription" : 'Vanilla reservable EBS item' } ], "count": 2, "hasMore": true, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/shippingExceptions", "name": "shippingExceptions", "kind": "collection" } ] }