Jump to

• Request
• Response
• Examples

Create one cancellation request

post

/fscmRestApi/resources/11.13.18.05/inventoryMovementRequests/action/cancelLineQuantity

Creates a cancellation request by passing the cancellation quantity and allocated quantity.

Request

Header Parameters

• Metadata-Context: string
  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: string
  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/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• allocatedQuantity: number
  Value that indicates the allocated quantity.
• allocatedQuantityUOM: string
  Unit of measure for the allocated quantity.
• cancelledQuantity: number
  Value that indicates the quantity to be canceled.
• cancelledQuantityUOM: string
  Unit of measure for the quantity to be canceled.
• headerId: number
  Value that uniquely identifies the movement request header.
• headerNumber: string
  Number that identifies the movement request.
• lineId: number
  Value that uniquely identifies the movement request line.
• lineNumber: number
  Number that identifies the movement request line.
• organizationCode: string
  Abbreviation that identifies the organization.
• organizationId: number
  Value that uniquely identifies the organization.

{
    "type":"object",
    "properties":{
        "organizationId":{
            "type":"number",
            "description":"Value that uniquely identifies the organization.",
            "nullable":true
        },
        "organizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the organization.",
            "nullable":true
        },
        "cancelledQuantity":{
            "type":"number",
            "description":"Value that indicates the quantity to be canceled.",
            "nullable":true
        },
        "cancelledQuantityUOM":{
            "type":"string",
            "description":"Unit of measure for the quantity to be canceled.",
            "nullable":true
        },
        "allocatedQuantity":{
            "type":"number",
            "description":"Value that indicates the allocated quantity.",
            "nullable":true
        },
        "headerNumber":{
            "type":"string",
            "description":"Number that identifies the movement request.",
            "nullable":true
        },
        "lineId":{
            "type":"number",
            "description":"Value that uniquely identifies the movement request line.",
            "nullable":true
        },
        "lineNumber":{
            "type":"number",
            "description":"Number that identifies the movement request line.",
            "nullable":true
        },
        "headerId":{
            "type":"number",
            "description":"Value that uniquely identifies the movement request header.",
            "nullable":true
        },
        "allocatedQuantityUOM":{
            "type":"string",
            "description":"Unit of measure for the allocated quantity.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  Returns the line status and message, along with other details.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Returns the line status and message, along with other details."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Returns the line status and message, along with other details."
}

Returns the line status and message, along with other details.

Back to Top

Examples

These examples describe how to create one cancellation request.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/inventoryMovementRequests/action/cancelLineQuantity"

For example:

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/"

Example 1

This example describes how to cancel a movement request line interfaced with a WMS.

Example 1 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 updates.

{
"headerNumber": 5597988,
"headerId":5597988,
"lineNumber" :1,
"lineId" : 4301066,
"organizationCode" :"M3",
"cancelledQuantity":99,
"cancelledQuantityUOM":"Ea",
"allocatedQuantity":99,
"allocatedQuantityUOM":"Ea"
}

Example 1 Response Body

The following example includes the contents of the response body in JSON format:

{
    "result": {
        "HeaderNumber": "5597988",
        "HeaderId": "5597988",
        "LineNumber": "1",
        "LineId": "4301066",
        "OrganizationId": "606",
        "OrganizationCode": "M3",
        "CancelledQuantity": "99",
        "CancelledQuantityUOM": "Ea",
        "AllocatedQuantity": "99",
        "AllocatedQuantityUOM": "Ea",
        "ReturnStatus": "SUCCESS",
        "LineStatus": "Preapproved"
    }
}

Example 2

This example describes how to cancel partial quantities for a movement request line interfaced with a WMS.

Example 2 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 updates.

{
"headerNumber": 5597007,
"headerId":5597007,
"lineNumber" :2,
"lineId" : 4300116,
"organizationCode" :"M3",
"cancelledQuantity":5,
"cancelledQuantityUOM":"Ea",
"allocatedQuantity":10,
"allocatedQuantityUOM":"Ea"
}

Example 2 Response Body

The following example includes the contents of the response body in JSON format:

{
    "result": {
        "HeaderNumber": "5597007",
        "HeaderId": "5597007",
        "LineNumber": "2",
        "LineId": "4300116",
        "OrganizationId": "606",
        "OrganizationCode": "M3",
        "CancelledQuantity": "5",
        "CancelledQuantityUOM": "Ea",
        "AllocatedQuantity": "10",
        "AllocatedQuantityUOM": "Ea",
        "ReturnStatus": "SUCCESS",
        "LineStatus": "Preapproved"
    }
}

Back to Top