Jump to

• Request
• Response

Update a line

patch

/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/{InterfaceHeaderId}/child/lines/{InterfaceLineId}

Request

Path Parameters

• InterfaceHeaderId(required): integer(int64)
  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=
• InterfaceLineId(required): integer(int64)
  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=

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

• Action: string
  Maximum Length: 25

  Action to perform on the lines. Valid values include CREATE, UPDATE, or CANCEL. This is a mandatory attribute.
• AdjustedPrice: number
  Value of the unit price after adjustment.
• AdjustmentPercentage: number
  Value by which the base price is adjusted.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the item.
• ItemDescription: string
  Maximum Length: 240

  Description of the item.
• ItemNumber: string
  Maximum Length: 300

  Number that uniquely identifies the item.
• LineNumber: integer (int64)
  Number that uniquely identifies the external purchase prices line.
• ManufacturerPartNumber: string
  Maximum Length: 700

  Number that uniquely identifies the manufacturer part.
• ManufacturerTradingPartnerItemId: integer (int64)
  Value that uniquely identifies the manufacturer part.
• Price: number
  Value of the unit price before adjustment.
• PriceEndDate: string (date)
  Date when the price becomes effective.
• PriceStartDate: string (date)
  Date when the price becomes ineffective.
• PurchasingCategoryCode: string
  Maximum Length: 820

  Abbreviation that identifies the purchasing category of the manufacturer part.
• PurchasingCategoryId: integer (int64)
  Value that uniquely identifies the purchasing category.
• SourcePurchasingCategory: string
  Maximum Length: 700

  Name of the purchasing category of the manufacturer.
• SourceReferenceId: string
  Maximum Length: 30

  Value that uniquely identifies the external purchase prices in the source system.
• SourceUnitOfMeasure: string
  Maximum Length: 25

  Name of the source unit of measure.
• SourceUOMQuantity: number
  Quantity of the source unit of measure.
• UnitOfMeasure: string
  Title: UOM Name

  Maximum Length: 25

  Name of the unit of measure.
• UnitOfMeasureCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure.
• UNSPSCCode: string
  Maximum Length: 10

  Value that uniquely identifies the UNSPSC.
• VendorItemId: integer (int64)
  Value that uniquely identifies the supplier part.
• VendorPartNumber: string
  Maximum Length: 300

  Number that uniquely identifies the supplier part.

{
    "type":"object",
    "properties":{
        "Action":{
            "maxLength":25,
            "type":"string",
            "description":"Action to perform on the lines. Valid values include CREATE, UPDATE, or CANCEL. This is a mandatory attribute.",
            "nullable":false
        },
        "AdjustedPrice":{
            "type":"number",
            "description":"Value of the unit price after adjustment.",
            "nullable":false
        },
        "AdjustmentPercentage":{
            "type":"number",
            "description":"Value by which the base price is adjusted.",
            "nullable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the item.",
            "nullable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that uniquely identifies the item.",
            "nullable":true
        },
        "LineNumber":{
            "type":"integer",
            "description":"Number that uniquely identifies the external purchase prices line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ManufacturerPartNumber":{
            "maxLength":700,
            "type":"string",
            "description":"Number that uniquely identifies the manufacturer part.",
            "nullable":true
        },
        "ManufacturerTradingPartnerItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the manufacturer part.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Price":{
            "type":"number",
            "description":"Value of the unit price before adjustment.",
            "nullable":true
        },
        "PriceEndDate":{
            "type":"string",
            "description":"Date when the price becomes effective.",
            "format":"date",
            "nullable":false
        },
        "PriceStartDate":{
            "type":"string",
            "description":"Date when the price becomes ineffective.",
            "format":"date",
            "nullable":false
        },
        "PurchasingCategoryCode":{
            "maxLength":820,
            "type":"string",
            "description":"Abbreviation that identifies the purchasing category of the manufacturer part.",
            "nullable":true
        },
        "PurchasingCategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchasing category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SourcePurchasingCategory":{
            "maxLength":700,
            "type":"string",
            "description":"Name of the purchasing category of the manufacturer.",
            "nullable":true
        },
        "SourceReferenceId":{
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the external purchase prices in the source system.",
            "nullable":false
        },
        "SourceUOMQuantity":{
            "type":"number",
            "description":"Quantity of the source unit of measure.",
            "nullable":true
        },
        "SourceUnitOfMeasure":{
            "maxLength":25,
            "type":"string",
            "description":"Name of the source unit of measure.",
            "nullable":true
        },
        "UNSPSCCode":{
            "maxLength":10,
            "type":"string",
            "description":"Value that uniquely identifies the UNSPSC.",
            "nullable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Name of the unit of measure.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UnitOfMeasureCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":true
        },
        "VendorItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier part.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "VendorPartNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that uniquely identifies the supplier part.",
            "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 : externalPurchasePricesRequests-lines-item-response

Type: object

Show Source

• Action: string
  Maximum Length: 25

  Action to perform on the lines. Valid values include CREATE, UPDATE, or CANCEL. This is a mandatory attribute.
• AdjustedPrice: number
  Value of the unit price after adjustment.
• AdjustmentPercentage: number
  Value by which the base price is adjusted.
• BatchId: number
  Value that uniquely identifies the external purchase prices request batch.
• ErrorFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then an error exists in the external purchase prices requests. If false, then no error exists and the external purchase prices are imported successfully. This attribute doesn't have a default value.
• InterfaceHeaderKey: string
  Maximum Length: 30

  Number that uniquely identifies the external purchase prices requests.
• InterfaceLineId: integer (int64)
  Value that uniquely identifies the request line.
• InterfaceLineKey: string
  Maximum Length: 30

  Number that uniquely identifies the request line.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the item.
• ItemDescription: string
  Maximum Length: 240

  Description of the item.
• ItemNumber: string
  Maximum Length: 300

  Number that uniquely identifies the item.
• LineNumber: integer (int64)
  Number that uniquely identifies the external purchase prices line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoadRequestId: number
  Value that uniquely identifies the process that loaded the external purchase prices request data to the interface tables.
• ManufacturerPartNumber: string
  Maximum Length: 700

  Number that uniquely identifies the manufacturer part.
• ManufacturerTradingPartnerItemId: integer (int64)
  Value that uniquely identifies the manufacturer part.
• Price: number
  Value of the unit price before adjustment.
• PriceEndDate: string (date)
  Date when the price becomes effective.
• PriceStartDate: string (date)
  Date when the price becomes ineffective.
• PurchasingCategoryCode: string
  Maximum Length: 820

  Abbreviation that identifies the purchasing category of the manufacturer part.
• PurchasingCategoryId: integer (int64)
  Value that uniquely identifies the purchasing category.
• SourcePurchasingCategory: string
  Maximum Length: 700

  Name of the purchasing category of the manufacturer.
• SourceReferenceId: string
  Maximum Length: 30

  Value that uniquely identifies the external purchase prices in the source system.
• SourceUnitOfMeasure: string
  Maximum Length: 25

  Name of the source unit of measure.
• SourceUOMQuantity: number
  Quantity of the source unit of measure.
• UnitOfMeasure: string
  Title: UOM Name

  Maximum Length: 25

  Name of the unit of measure.
• UnitOfMeasureCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure.
• UNSPSCCode: string
  Maximum Length: 10

  Value that uniquely identifies the UNSPSC.
• VendorItemId: integer (int64)
  Value that uniquely identifies the supplier part.
• VendorPartNumber: string
  Maximum Length: 300

  Number that uniquely identifies the supplier part.

{
    "type":"object",
    "properties":{
        "Action":{
            "maxLength":25,
            "type":"string",
            "description":"Action to perform on the lines. Valid values include CREATE, UPDATE, or CANCEL. This is a mandatory attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "AdjustedPrice":{
            "type":"number",
            "description":"Value of the unit price after adjustment.",
            "nullable":false,
            "x-queryable":true
        },
        "AdjustmentPercentage":{
            "type":"number",
            "description":"Value by which the base price is adjusted.",
            "nullable":true,
            "x-queryable":true
        },
        "BatchId":{
            "type":"number",
            "description":"Value that uniquely identifies the external purchase prices request batch.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then an error exists in the external purchase prices requests. If false, then no error exists and the external purchase prices are imported successfully. This attribute doesn't have a default value.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "InterfaceHeaderKey":{
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the external purchase prices requests.",
            "nullable":false,
            "x-queryable":true
        },
        "InterfaceLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the request line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "InterfaceLineKey":{
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the request line.",
            "nullable":false,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that uniquely identifies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "LineNumber":{
            "type":"integer",
            "description":"Number that uniquely identifies the external purchase prices line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LoadRequestId":{
            "type":"number",
            "description":"Value that uniquely identifies the process that loaded the external purchase prices request data to the interface tables.",
            "nullable":true,
            "x-queryable":true
        },
        "ManufacturerPartNumber":{
            "maxLength":700,
            "type":"string",
            "description":"Number that uniquely identifies the manufacturer part.",
            "nullable":true,
            "x-queryable":true
        },
        "ManufacturerTradingPartnerItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the manufacturer part.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Price":{
            "type":"number",
            "description":"Value of the unit price before adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceEndDate":{
            "type":"string",
            "description":"Date when the price becomes effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PriceStartDate":{
            "type":"string",
            "description":"Date when the price becomes ineffective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PurchasingCategoryCode":{
            "maxLength":820,
            "type":"string",
            "description":"Abbreviation that identifies the purchasing category of the manufacturer part.",
            "nullable":true,
            "x-queryable":true
        },
        "PurchasingCategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchasing category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourcePurchasingCategory":{
            "maxLength":700,
            "type":"string",
            "description":"Name of the purchasing category of the manufacturer.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceReferenceId":{
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the external purchase prices in the source system.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceUOMQuantity":{
            "type":"number",
            "description":"Quantity of the source unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceUnitOfMeasure":{
            "maxLength":25,
            "type":"string",
            "description":"Name of the source unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "UNSPSCCode":{
            "maxLength":10,
            "type":"string",
            "description":"Value that uniquely identifies the UNSPSC.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Name of the unit of measure.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UnitOfMeasureCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "VendorItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier part.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VendorPartNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that uniquely identifies the supplier part.",
            "nullable":true,
            "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."
        }
    }
}

Back to Top