Jump to

• Request
• Response

Update one product

patch

/fscmRestApi/resources/11.13.18.05/channelSpecialPriceAgreements/{SpecialPriceAgreementId}/child/products/{ProductId}

Request

Path Parameters

• ProductId(required): integer
  Value that uniquely identifies the product.
• SpecialPriceAgreementId(required): integer(int64)
  Value that uniquely identifies the special price agreement.

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

• CompetitorItem: string
  Maximum Length: 960

  Name of the competitor item.
• CompetitorItemPrice: number
  Price of the competitor item.
• Item: string
  Maximum Length: 255

  Name of the item in the inventory.
• ItemId: string
  Maximum Length: 240

  Value that uniquely identifies the item in the inventory.
• LineNumber: number
  Number that identifies the product line.
• OriginalUnitSellingPrice: number
  Unit selling price of the item.
• Quantity: number
  Quantity of the items.
• RebateAmount: number
  Amount of the rebate.
• RebateType: string
  Maximum Length: 255

  Name of the rebate type.
• RebateTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the rebate type.
• UnitOfMeasure: string
  Maximum Length: 255

  Unit of measure of the item.
• UnitOfMeasureCode: string
  Maximum Length: 30

  Abbreviation that identifies the unit of measure.

{
    "type":"object",
    "properties":{
        "CompetitorItem":{
            "maxLength":960,
            "type":"string",
            "description":"Name of the competitor item.",
            "nullable":true
        },
        "CompetitorItemPrice":{
            "type":"number",
            "description":"Price of the competitor item.",
            "nullable":true
        },
        "Item":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the item in the inventory.",
            "nullable":true
        },
        "ItemId":{
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely identifies the item in the inventory.",
            "nullable":false
        },
        "LineNumber":{
            "type":"number",
            "description":"Number that identifies the product line.",
            "nullable":true
        },
        "OriginalUnitSellingPrice":{
            "type":"number",
            "description":"Unit selling price of the item.",
            "nullable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the items.",
            "nullable":false
        },
        "RebateAmount":{
            "type":"number",
            "description":"Amount of the rebate.",
            "nullable":false
        },
        "RebateType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the rebate type.",
            "nullable":true
        },
        "RebateTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the rebate type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UnitOfMeasure":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure of the item.",
            "nullable":true
        },
        "UnitOfMeasureCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "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 : channelSpecialPriceAgreements-products-item-response

Type: object

Show Source

• CompetitorItem: string
  Maximum Length: 960

  Name of the competitor item.
• CompetitorItemPrice: number
  Price of the competitor item.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• EstimatedAmount: number
  Read Only: true

  Estimated rebate amount for the item.
• Item: string
  Maximum Length: 255

  Name of the item in the inventory.
• ItemDescription: string
  Read Only: true

  Maximum Length: 255

  Description of the item in the inventory.
• ItemId: string
  Maximum Length: 240

  Value that uniquely identifies the item in the inventory.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  User who most recently updated the record.
• LineNumber: number
  Number that identifies the product line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OriginalUnitSellingPrice: number
  Unit selling price of the item.
• ProductId: integer
  Value that uniquely identifies the product.
• Quantity: number
  Quantity of the items.
• RebateAmount: number
  Amount of the rebate.
• RebateType: string
  Maximum Length: 255

  Name of the rebate type.
• RebateTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the rebate type.
• SpecialPriceAgreementId: integer (int64)
  Value that uniquely identifies the special price agreement program.
• UnitOfMeasure: string
  Maximum Length: 255

  Unit of measure of the item.
• UnitOfMeasureCode: string
  Maximum Length: 30

  Abbreviation that identifies the unit of measure.

{
    "type":"object",
    "properties":{
        "CompetitorItem":{
            "maxLength":960,
            "type":"string",
            "description":"Name of the competitor item.",
            "nullable":true,
            "x-queryable":true
        },
        "CompetitorItemPrice":{
            "type":"number",
            "description":"Price of the competitor item.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedAmount":{
            "type":"number",
            "description":"Estimated rebate amount for the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Item":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the item in the inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the item in the inventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely identifies the item in the inventory.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineNumber":{
            "type":"number",
            "description":"Number that identifies the product line.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalUnitSellingPrice":{
            "type":"number",
            "description":"Unit selling price of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductId":{
            "type":"integer",
            "description":"Value that uniquely identifies the product.",
            "nullable":false,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the items.",
            "nullable":false,
            "x-queryable":true
        },
        "RebateAmount":{
            "type":"number",
            "description":"Amount of the rebate.",
            "nullable":false,
            "x-queryable":true
        },
        "RebateType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the rebate type.",
            "nullable":true,
            "x-queryable":true
        },
        "RebateTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the rebate type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SpecialPriceAgreementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the special price agreement program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitOfMeasureCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

RebateTypeLookupVVO

Parameters:

• finder: LookupTypeFinder%3BbindLookupType%3DORA_CJM_SPA_REBATE_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: RebateTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top