Jump to

• Request
• Response
• Examples

Create transactions

post

/fscmRestApi/resources/11.13.18.05/splitPickTransactions

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

• ErrorCode: string
  Abbreviation that identifies the error that occurred when the pick split fails. If the pick split does not fail, then this attribute is empty.
• ErrorExplanation: string
  Maximum Length: 80

  Explanation of why the error occurred when the pick split fails. If the pick split does not fail, then this attribute is empty.
• NewPickSlipLine: integer
  Value that uniquely identifies the new line on the pick slip.
• PickSlip: integer
  Value that uniquely identifies the pick slip.
• PickSlipLine: integer
  Value that uniquely identifies a line on the pick slip.
• RemoveAllocatedLotSerials: string
  Contains one of the following values. Y: remove allocated lots and serials. N: do not remove. If allocated lots and serials exist, then the warehouse cannot split the transaction. The default value is N.
• ReturnStatus: string
  Status of the pick split. Contains one of the following values: SUCCESS or ERROR.
• SplitQuantity: number
  Quantity to split into the new pick slip line.

{
    "type":"object",
    "properties":{
        "ErrorExplanation":{
            "maxLength":80,
            "type":"string",
            "description":"Explanation of why the error occurred when the pick split fails. If the pick split does not fail, then this attribute is empty.",
            "nullable":true,
            "x-queryable":false
        },
        "PickSlip":{
            "type":"integer",
            "description":"Value that uniquely identifies the pick slip.",
            "nullable":false,
            "x-queryable":false
        },
        "SplitQuantity":{
            "type":"number",
            "description":"Quantity to split into the new pick slip line.",
            "nullable":true,
            "x-queryable":false
        },
        "NewPickSlipLine":{
            "type":"integer",
            "description":"Value that uniquely identifies the new line on the pick slip.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnStatus":{
            "type":"string",
            "description":"Status of the pick split. Contains one of the following values: SUCCESS or ERROR.",
            "nullable":true,
            "x-queryable":false
        },
        "RemoveAllocatedLotSerials":{
            "type":"string",
            "description":"Contains one of the following values. Y: remove allocated lots and serials. N: do not remove. If allocated lots and serials exist, then the warehouse cannot split the transaction. The default value is N.",
            "nullable":true,
            "x-queryable":false
        },
        "PickSlipLine":{
            "type":"integer",
            "description":"Value that uniquely identifies a line on the pick slip.",
            "nullable":false,
            "x-queryable":false
        },
        "ErrorCode":{
            "type":"string",
            "description":"Abbreviation that identifies the error that occurred when the pick split fails. If the pick split does not fail, then this attribute is empty.",
            "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 : splitPickTransactions-item-response

Type: object

Show Source

• ErrorCode: string
  Abbreviation that identifies the error that occurred when the pick split fails. If the pick split does not fail, then this attribute is empty.
• ErrorExplanation: string
  Maximum Length: 80

  Explanation of why the error occurred when the pick split fails. If the pick split does not fail, then this attribute is empty.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NewPickSlipLine: integer
  Value that uniquely identifies the new line on the pick slip.
• PickSlip: integer
  Value that uniquely identifies the pick slip.
• PickSlipLine: integer
  Value that uniquely identifies a line on the pick slip.
• RemoveAllocatedLotSerials: string
  Contains one of the following values. Y: remove allocated lots and serials. N: do not remove. If allocated lots and serials exist, then the warehouse cannot split the transaction. The default value is N.
• ReturnStatus: string
  Status of the pick split. Contains one of the following values: SUCCESS or ERROR.
• SplitQuantity: number
  Quantity to split into the new pick slip line.

{
    "type":"object",
    "properties":{
        "ErrorExplanation":{
            "maxLength":80,
            "type":"string",
            "description":"Explanation of why the error occurred when the pick split fails. If the pick split does not fail, then this attribute is empty.",
            "nullable":true,
            "x-queryable":false
        },
        "PickSlip":{
            "type":"integer",
            "description":"Value that uniquely identifies the pick slip.",
            "nullable":false,
            "x-queryable":false
        },
        "SplitQuantity":{
            "type":"number",
            "description":"Quantity to split into the new pick slip line.",
            "nullable":true,
            "x-queryable":false
        },
        "NewPickSlipLine":{
            "type":"integer",
            "description":"Value that uniquely identifies the new line on the pick slip.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnStatus":{
            "type":"string",
            "description":"Status of the pick split. Contains one of the following values: SUCCESS or ERROR.",
            "nullable":true,
            "x-queryable":false
        },
        "RemoveAllocatedLotSerials":{
            "type":"string",
            "description":"Contains one of the following values. Y: remove allocated lots and serials. N: do not remove. If allocated lots and serials exist, then the warehouse cannot split the transaction. The default value is N.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PickSlipLine":{
            "type":"integer",
            "description":"Value that uniquely identifies a line on the pick slip.",
            "nullable":false,
            "x-queryable":false
        },
        "ErrorCode":{
            "type":"string",
            "description":"Abbreviation that identifies the error that occurred when the pick split fails. If the pick split does not fail, then this attribute is empty.",
            "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 split one pick slip line.

Example cURL Command

Use the following cURL command to submit a request on the REST resource. This example splits a pick slip line for pick slip 1127157, on pick slip line 1, for split quantity of 1:

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

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.

{  
  "PickSlip" : 1127157
, "PickSlipLine" : 1
, "SplitQuantity" : 1
 }

Example Response Body

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

{
  "ErrorCode" : null,
  "ErrorExplanation" : null,
  "NewPickSlipLine" : 2,
  "PickSlip" : 1127157,
  "PickSlipLine" : 1,
  "ReturnStatus" : " Success",
  "SplitQuantity" : 1,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servernamefscmRestApi/resources/version/splitPickTransactions/00020000000EACED0005770800000000001132F50000000EACED000577080000000000000001",
    "name" : "splitPickTransactions",
    "kind" : "item"
  }, {
    "rel" : "canonical",
    "href" : "https://servername/fscmRestApi/resources/version/splitPickTransactions/00020000000EACED0005770800000000001132F50000000EACED000577080000000000000001",
    "name" : "splitPickTransactions",
    "kind" : "item"
  } ]
           }

Back to Top