Jump to

• Request
• Response

Update a transfer cost detail

patch

/fscmRestApi/resources/11.13.18.05/supplyRequests/{SupplyOrderReferenceNumber}/child/supplyRequestLines/{SupplyOrderReferenceLineNumber}/child/transferCostRequestDetails/{TransferCostTypeName}

Request

Path Parameters

• SupplyOrderReferenceLineNumber(required): string
  Number that identifies the supply request line in the supply request sent to Oracle Supply Chain Orchestration Cloud.
• SupplyOrderReferenceNumber(required): string
  Number that identifies the supply request sent to Oracle Supply Chain Orchestration Cloud.
• TransferCostTypeName(required): string
  Name of the shipping cost type. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Cost Types task.

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

• InterfaceBatchNumber: string
  Maximum Length: 50

  Number that identifies the batch of supply requests that are sent to Oracle Supply Chain Orchestration Cloud to create supplies. The batch consists of one or more supply requests.
• TransferCostAmount: number
  Amount for the transfer cost on a transfer order line.
• TransferCostCurrencyCode: string
  Maximum Length: 15

  Code that identifies the currency for the transfer cost amount.
• TransferCostOperation: string
  Maximum Length: 30

  Default Value: CREATE

  Indicates whether the transfer cost line is to be created, updated, or canceled. Values include CREATE, UPDATE, and CANCEL.
• TransferCostTypeName: string
  Maximum Length: 60

  Name of the shipping cost type. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Cost Types task.

{
    "type":"object",
    "properties":{
        "TransferCostAmount":{
            "type":"number",
            "description":"Amount for the transfer cost on a transfer order line.",
            "nullable":true
        },
        "TransferCostCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Code that identifies the currency for the transfer cost amount.",
            "nullable":true
        },
        "TransferCostTypeName":{
            "maxLength":"60",
            "type":"string",
            "description":"Name of the shipping cost type. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Cost Types task.",
            "nullable":false
        },
        "TransferCostOperation":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the transfer cost line is to be created, updated, or canceled. Values include CREATE, UPDATE, and CANCEL.",
            "nullable":true,
            "default":"CREATE"
        },
        "InterfaceBatchNumber":{
            "maxLength":"50",
            "type":"string",
            "description":"Number that identifies the batch of supply requests that are sent to Oracle Supply Chain Orchestration Cloud to create supplies. The batch consists of one or more supply requests.",
            "nullable":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:
  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.

Body ()

Root Schema : supplyRequests-supplyRequestLines-transferCostRequestDetails-item-response

Type: object

Show Source

• InterfaceBatchNumber: string
  Maximum Length: 50

  Number that identifies the batch of supply requests that are sent to Oracle Supply Chain Orchestration Cloud to create supplies. The batch consists of one or more supply requests.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TransferCostAmount: number
  Amount for the transfer cost on a transfer order line.
• TransferCostCurrencyCode: string
  Maximum Length: 15

  Code that identifies the currency for the transfer cost amount.
• TransferCostOperation: string
  Maximum Length: 30

  Default Value: CREATE

  Indicates whether the transfer cost line is to be created, updated, or canceled. Values include CREATE, UPDATE, and CANCEL.
• TransferCostTypeName: string
  Maximum Length: 60

  Name of the shipping cost type. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Cost Types task.

{
    "type":"object",
    "properties":{
        "TransferCostAmount":{
            "type":"number",
            "description":"Amount for the transfer cost on a transfer order line.",
            "nullable":true,
            "x-queryable":true
        },
        "TransferCostCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Code that identifies the currency for the transfer cost amount.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TransferCostTypeName":{
            "maxLength":"60",
            "type":"string",
            "description":"Name of the shipping cost type. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Cost Types task.",
            "nullable":false,
            "x-queryable":true
        },
        "TransferCostOperation":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the transfer cost line is to be created, updated, or canceled. Values include CREATE, UPDATE, and CANCEL.",
            "nullable":true,
            "default":"CREATE",
            "x-queryable":true
        },
        "InterfaceBatchNumber":{
            "maxLength":"50",
            "type":"string",
            "description":"Number that identifies the batch of supply requests that are sent to Oracle Supply Chain Orchestration Cloud to create supplies. The batch consists of one or more supply requests.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

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