Jump to

• Request
• Response
• Examples

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Action":{
            "maxLength":80,
            "type":"string",
            "description":"Transaction that the application creates for the shipment. You can use only value CONFIRM for this attribute.",
            "nullable":true,
            "x-queryable":false
        },
        "Organization":{
            "maxLength":80,
            "type":"string",
            "description":"Abbreviation that identifies the organization that makes the shipment.",
            "nullable":true,
            "x-queryable":false
        },
        "ErrorMessage":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipmentName":{
            "type":"string",
            "description":"Name of the material shipment.",
            "nullable":true,
            "x-queryable":false
        },
        "Result":{
            "maxLength":80,
            "type":"string",
            "description":"Status of the service request. Contains one of the following values: SUCCESS, WARNING, or ERROR.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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.

Body ()

Root Schema : shippingTransactions-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Action":{
            "maxLength":80,
            "type":"string",
            "description":"Transaction that the application creates for the shipment. You can use only value CONFIRM for this attribute.",
            "nullable":true,
            "x-queryable":false
        },
        "Organization":{
            "maxLength":80,
            "type":"string",
            "description":"Abbreviation that identifies the organization that makes the shipment.",
            "nullable":true,
            "x-queryable":false
        },
        "ErrorMessage":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipmentName":{
            "type":"string",
            "description":"Name of the material shipment.",
            "nullable":true,
            "x-queryable":false
        },
        "Result":{
            "maxLength":80,
            "type":"string",
            "description":"Status of the service request. Contains one of the following values: SUCCESS, WARNING, or ERROR.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

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"
  } ]
}"

Back to Top