Jump to

• Request
• Response
• Examples

Update a price break

patch

/fscmRestApi/resources/11.13.18.05/draftSupplierNegotiationResponses/{draftSupplierNegotiationResponsesUniqID}/child/lines/{LineId}/child/priceBreaks/{PriceBreakId}

Request

Path Parameters

• LineId(required): number
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• PriceBreakId(required): integer
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• draftSupplierNegotiationResponsesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Draft Supplier Negotiation Responses resource and used to uniquely identify an instance of Draft Supplier Negotiation Responses. The client should not generate the hash key value. Instead, the client should query on the Draft Supplier Negotiation Responses collection resource in order to navigate to a specific instance of Draft Supplier Negotiation Responses to get the hash key.

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/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• PriceBreakEndDate: string (date)
  Title: End Date

  Date when the price break expires.
• PriceBreakStartDate: string (date)
  Title: Start Date

  Date when the price break goes into effect.
• PricingBasis: string
  Title: Pricing Basis

  Maximum Length: 80

  Basis that the application uses to calculate the price break. A list of accepted values is defined in the lookup type PON_SHIPMENT_PRICING_BASIS.
• PricingBasisCode: string
  Maximum Length: 25

  Abbreviation that identifies the basis that the application uses to calculate the response line price break. A list of accepted values is defined in the lookup type PON_SHIPMENT_PRICING_BASIS.
• Quantity: number
  Title: Quantity

  Quantity for the price break.
• ResponseValue: number
  Title: Response Value

  Response value of the price break.
• ShipToLocation: string
  Title: Display Name

  Maximum Length: 240

  Name of the location to which the supplier ships the item.
• ShipToLocationId: integer
  Title: Ship-to Location ID

  Value that uniquely identifies the location to which the supplier ships the item.
• ShipToOrganization: string
  Title: Ship-to Organization

  Maximum Length: 240

  Name of the inventory organization to which the supplier ships the item.
• ShipToOrganizationId: integer
  Title: Ship-to Organization ID

  Value that uniquely identifies the inventory organization to which the supplier ships the item.

{
    "type":"object",
    "properties":{
        "ShipToLocation":{
            "title":"Display Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the location to which the supplier ships the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ShipToLocationId":{
            "title":"Ship-to Location ID",
            "type":"integer",
            "description":"Value that uniquely identifies the location to which the supplier ships the item.",
            "nullable":true
        },
        "PricingBasisCode":{
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the basis that the application uses to calculate the response line price break. A list of accepted values is defined in the lookup type PON_SHIPMENT_PRICING_BASIS.",
            "nullable":true
        },
        "PricingBasis":{
            "title":"Pricing Basis",
            "maxLength":80,
            "type":"string",
            "description":"Basis that the application uses to calculate the price break. A list of accepted values is defined in the lookup type PON_SHIPMENT_PRICING_BASIS.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PriceBreakStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the price break goes into effect.",
            "format":"date",
            "nullable":true
        },
        "ShipToOrganizationId":{
            "title":"Ship-to Organization ID",
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization to which the supplier ships the item.",
            "nullable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity for the price break.",
            "nullable":true
        },
        "ResponseValue":{
            "title":"Response Value",
            "type":"number",
            "description":"Response value of the price break.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PricingBasis",
                    "PricingBasisCode"
                ]
            }
        },
        "ShipToOrganization":{
            "title":"Ship-to Organization",
            "maxLength":240,
            "type":"string",
            "description":"Name of the inventory organization to which the supplier ships the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PriceBreakEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the price break expires.",
            "format":"date",
            "nullable":true
        }
    }
}

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 : draftSupplierNegotiationResponses-lines-priceBreaks-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Identifies the user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  Timestamp of the creation of the row.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the line.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the line.
• Line: string
  Read Only: true

  Maximum Length: 25

  Number that identifies the negotiation line.
• LineId: integer
  Title: Line ID

  Read Only: true

  Value that identifies the negotiation line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PriceBreakEndDate: string (date)
  Title: End Date

  Date when the price break expires.
• PriceBreakId: integer
  Title: Price Break ID

  Read Only: true

  Date when the price break goes into effect.
• PriceBreakStartDate: string (date)
  Title: Start Date

  Date when the price break goes into effect.
• PricingBasis: string
  Title: Pricing Basis

  Maximum Length: 80

  Basis that the application uses to calculate the price break. A list of accepted values is defined in the lookup type PON_SHIPMENT_PRICING_BASIS.
• PricingBasisCode: string
  Maximum Length: 25

  Abbreviation that identifies the basis that the application uses to calculate the response line price break. A list of accepted values is defined in the lookup type PON_SHIPMENT_PRICING_BASIS.
• Quantity: number
  Title: Quantity

  Quantity for the price break.
• ResponseNumber: integer (int64)
  Title: Response Number

  Read Only: true

  Value that identifies the supplier response.
• ResponseValue: number
  Title: Response Value

  Response value of the price break.
• ShipToLocation: string
  Title: Display Name

  Maximum Length: 240

  Name of the location to which the supplier ships the item.
• ShipToLocationId: integer
  Title: Ship-to Location ID

  Value that uniquely identifies the location to which the supplier ships the item.
• ShipToOrganization: string
  Title: Ship-to Organization

  Maximum Length: 240

  Name of the inventory organization to which the supplier ships the item.
• ShipToOrganizationId: integer
  Title: Ship-to Organization ID

  Value that uniquely identifies the inventory organization to which the supplier ships the item.
• TargetPrice: number
  Title: Target Price

  Read Only: true

  Target price for the price break.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Timestamp of the creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Identifies the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToLocationId":{
            "title":"Ship-to Location ID",
            "type":"integer",
            "description":"Value that uniquely identifies the location to which the supplier ships the item.",
            "nullable":true,
            "x-queryable":true
        },
        "LineId":{
            "title":"Line ID",
            "type":"integer",
            "description":"Value that identifies the negotiation line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PricingBasisCode":{
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the basis that the application uses to calculate the response line price break. A list of accepted values is defined in the lookup type PON_SHIPMENT_PRICING_BASIS.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceBreakStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the price break goes into effect.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity for the price break.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetPrice":{
            "title":"Target Price",
            "type":"number",
            "description":"Target price for the price break.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToOrganization":{
            "title":"Ship-to Organization",
            "maxLength":240,
            "type":"string",
            "description":"Name of the inventory organization to which the supplier ships the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Line":{
            "maxLength":25,
            "type":"string",
            "description":"Number that identifies the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ShipToLocation":{
            "title":"Display Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the location to which the supplier ships the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PricingBasis":{
            "title":"Pricing Basis",
            "maxLength":80,
            "type":"string",
            "description":"Basis that the application uses to calculate the price break. A list of accepted values is defined in the lookup type PON_SHIPMENT_PRICING_BASIS.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PriceBreakId":{
            "title":"Price Break ID",
            "type":"integer",
            "description":"Date when the price break goes into effect.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToOrganizationId":{
            "title":"Ship-to Organization ID",
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization to which the supplier ships the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ResponseValue":{
            "title":"Response Value",
            "type":"number",
            "description":"Response value of the price break.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PricingBasis",
                    "PricingBasisCode"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResponseNumber":{
            "title":"Response Number",
            "type":"integer",
            "description":"Value that identifies the supplier response.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PriceBreakEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the price break expires.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the line.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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."
        }
    }
}

Links

PricingBasisLookupLOVVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DPON_SHIPMENT_PRICING_BASIS

The following properties are defined on the LOV link relation:

• Source Attribute: PricingBasis; Target Attribute: Meaning
• Display Attribute: Meaning

Back to Top

Examples

This example describes how to update a price break in a negotiation response line using a response ID, line ID, group ID, and price breaks ID.

Example cURL Command

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

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/draftSupplierNegotiationResponsesUniqID/child/lines/LineId/child/priceBreaks/PriceBreakId"

For example:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/189742/child/lines/2/child/priceBreaks/1"

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

{
    "ResponseValue": 150
}

Example Response Body

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

{
    "ResponseNumber": 189742,
    "LineId": 2,
    "Line": "2",
    "PriceBreakId": 1,
    "ShipToOrganizationId": 911,
    "ShipToOrganization": "Vision Germany",
    "ShipToLocationId": 16306,
    "ShipToLocation": "Addison TX",
    "Quantity": 200,
    "ResponseValue": 150.00,
    "TargetPrice": null,
    "PriceBreakStartDate": null,
    "PriceBreakEndDate": null,
    "PricingBasisCode": "PRICE",
    "PricingBasis": "Price",
    "CreatedBy": "CVSUPPB01",
    "CreationDate": "2022-10-05T19:19:05+00:00",
    "LastUpdatedBy": "CVSUPPB01",
    "LastUpdateDate": "2022-10-05T19:47:06.006+00:00",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/189742/child/lines/2/child/priceBreaks/1",
            "name": "priceBreaks",
            "kind": "item",
            "properties": {
                "changeIndicator": ". . ."
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/189742/child/lines/2/child/priceBreaks/1",
            "name": "priceBreaks",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/189742/child/lines/2",
            "name": "lines",
            "kind": "item"
        }
    ]
}

Back to Top