Create transactions
post
/fscmRestApi/resources/11.13.18.05/shippingTransactions
Request
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Action: string
Maximum Length:
80
Transaction that the application creates for the shipment. You can use only value CONFIRM for this attribute. -
ErrorMessage: string
Message, such as warning or error, that describes the action the organization takes on the shipment. If the action is successful, then this attribute is empty.
-
Organization: string
Maximum Length:
80
Abbreviation that identifies the organization that makes the shipment. -
Result: string
Maximum Length:
80
Status of the service request. Contains one of the following values: SUCCESS, WARNING, or ERROR. -
ShipmentName: string
Name of the material shipment.
Response
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 : shippingTransactions-item-response
Type:
Show Source
object
-
Action: string
Maximum Length:
80
Transaction that the application creates for the shipment. You can use only value CONFIRM for this attribute. -
ErrorMessage: string
Message, such as warning or error, that describes the action the organization takes on the shipment. If the action is successful, then this attribute is empty.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Organization: string
Maximum Length:
80
Abbreviation that identifies the organization that makes the shipment. -
Result: string
Maximum Length:
80
Status of the service request. Contains one of the following values: SUCCESS, WARNING, or ERROR. -
ShipmentName: string
Name of the material shipment.
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 update one shipment.
Example cURL Command
Use the following cURL command to submit a request on the REST resource. This example confirms shipment 2240327 in organization M1:
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/shippingTransactions?onlyData=true"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{"ShipmentName": "2240327","Action": "CONFIRM","Organization": "M1"}'
Example Response Body
The following example includes the contents of the response body in JSON format:
"{ "Action" : "CONFIRM", "ErrorMessage" : "WSH\u0000WSH_ONE_DEL_CNFRM_SUCCESS\u0000DEL_NAME\u00002240327\u0000", "Organization" : null, "Result" : "SUCCESS", "ShipmentName" : "2240327", "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/shippingTransactions/2240327", "name" : "shippingTransactions", "kind" : "item" }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/shippingTransactions/2240327", "name" : "shippingTransactions", "kind" : "item" } ] }"