Jump to

• Request
• Response

Fetch eligible shipment lines

post

/fscmRestApi/resources/11.13.18.05/fiscalDocumentActions/action/fetchEligibleShipmentLines

Retrieves eligible shipment lines for the shipment.

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

• ShipmentId: string
  Value that uniquely identifies the shipment.

{
    "type":"object",
    "properties":{
        "ShipmentId":{
            "type":"string",
            "description":"Value that uniquely identifies the shipment.",
            "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

  Result of processing the request, which includes the list of eligible shipment lines, processing status, and a list of messages, if any.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "description":"Result of processing the request, which includes the list of eligible shipment lines, processing status, and a list of messages, if any."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    },
    "description":"Result of processing the request, which includes the list of eligible shipment lines, processing status, and a list of messages, if any."
}

Result of processing the request, which includes the list of eligible shipment lines, processing status, and a list of messages, if any.

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top