Jump to

• Request
• Response

Update one supplier

patch

/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHubRequests/{OrderKey}/child/lines/{linesUniqID}/child/supplier/{supplierUniqID}

Request

Path Parameters

• OrderKey(required): string
  Value that uniquely identifies the sales order. This value is derived by concatenating the value of SourceOrderSystem, a colon, and the value of SourceOrderId. For orders created through the Oracle Order Management Cloud work area, the SourceOrderId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceOrderId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order.
• linesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Order Lines resource and used to uniquely identify an instance of Order Lines. The client should not generate the hash key value. Instead, the client should query on the Order Lines collection resource in order to navigate to a specific instance of Order Lines to get the hash key.
• supplierUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Supplier resource and used to uniquely identify an instance of Supplier. The client should not generate the hash key value. Instead, the client should query on the Supplier collection resource in order to navigate to a specific instance of Supplier to get the hash key.

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

• AddressLine1: string
  Maximum Length: 240

  First address line of the supplier who supplies the item.
• AddressLine2: string
  Maximum Length: 240

  Second address line of the supplier who supplies the item.
• AddressLine3: string
  Maximum Length: 240

  Third address line of the supplier who supplies the item.
• AddressLine4: string
  Maximum Length: 240

  Fourth address line of the supplier who supplies the item.
• City: string
  Maximum Length: 60

  City of the supplier who supplies the item.
• Country: string
  Maximum Length: 60

  Country of the supplier who supplies the item.
• County: string
  Maximum Length: 60

  County of the supplier who supplies the item.
• PostalCode: string
  Maximum Length: 60

  Postal code of the supplier who supplies the item.
• Province: string
  Maximum Length: 60

  Province of the supplier who supplies the item.
• State: string
  Maximum Length: 60

  State of the supplier who supplies the item.
• SupplierId: string
  Maximum Length: 1000

  Value that uniquely identifies the supplier who supplies the item. You can use a supplier according to the contractual obligations in drop ship.
• SupplierName: string
  Maximum Length: 1000

  Name of the supplier who supplies the item. You can use a supplier according to a contractual obligation in drop ship.
• SupplierNumber: string
  Maximum Length: 154

  Number of the supplier who supplies the item. You can use a supplier according to the contractual obligation in the drop-ship order. Although this attribute has been exposed in REST stage and file-based data import (FBDI), it isn't available in the REST service. So, this attribute isn't consumed when the REST service is used for FBDI. However, it's consumed when an Oracle Application Development Framework (ADF) service is used for FBDI.
• SupplierSiteId: integer (int64)
  Value that uniquely identifies the supplier who supplies the item.

{
    "type":"object",
    "properties":{
        "PostalCode":{
            "maxLength":"60",
            "type":"string",
            "description":"Postal code of the supplier who supplies the item.",
            "nullable":true
        },
        "City":{
            "maxLength":"60",
            "type":"string",
            "description":"City of the supplier who supplies the item.",
            "nullable":true
        },
        "SupplierNumber":{
            "maxLength":"154",
            "type":"string",
            "description":"Number of the supplier who supplies the item. You can use a supplier according to the contractual obligation in the drop-ship order. Although this attribute has been exposed in REST stage and file-based data import (FBDI), it isn't available in the REST service. So, this attribute isn't consumed when the REST service is used for FBDI. However, it's consumed when an Oracle Application Development Framework (ADF) service is used for FBDI.",
            "nullable":true
        },
        "County":{
            "maxLength":"60",
            "type":"string",
            "description":"County of the supplier who supplies the item.",
            "nullable":true
        },
        "Province":{
            "maxLength":"60",
            "type":"string",
            "description":"Province of the supplier who supplies the item.",
            "nullable":true
        },
        "AddressLine3":{
            "maxLength":"240",
            "type":"string",
            "description":"Third address line of the supplier who supplies the item.",
            "nullable":true
        },
        "SupplierId":{
            "maxLength":"1000",
            "type":"string",
            "description":"Value that uniquely identifies the supplier who supplies the item. You can use a supplier according to the contractual obligations in drop ship.",
            "nullable":true
        },
        "AddressLine2":{
            "maxLength":"240",
            "type":"string",
            "description":"Second address line of the supplier who supplies the item.",
            "nullable":true
        },
        "AddressLine1":{
            "maxLength":"240",
            "type":"string",
            "description":"First address line of the supplier who supplies the item.",
            "nullable":true
        },
        "SupplierName":{
            "maxLength":"1000",
            "type":"string",
            "description":"Name of the supplier who supplies the item. You can use a supplier according to a contractual obligation in drop ship.",
            "nullable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier who supplies the item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "State":{
            "maxLength":"60",
            "type":"string",
            "description":"State of the supplier who supplies the item.",
            "nullable":true
        },
        "AddressLine4":{
            "maxLength":"240",
            "type":"string",
            "description":"Fourth address line of the supplier who supplies the item.",
            "nullable":true
        },
        "Country":{
            "maxLength":"60",
            "type":"string",
            "description":"Country of the supplier who supplies the item.",
            "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 : salesOrdersForOrderHubRequests-lines-supplier-item-response

Type: object

Show Source

• AddressLine1: string
  Maximum Length: 240

  First address line of the supplier who supplies the item.
• AddressLine2: string
  Maximum Length: 240

  Second address line of the supplier who supplies the item.
• AddressLine3: string
  Maximum Length: 240

  Third address line of the supplier who supplies the item.
• AddressLine4: string
  Maximum Length: 240

  Fourth address line of the supplier who supplies the item.
• City: string
  Maximum Length: 60

  City of the supplier who supplies the item.
• Country: string
  Maximum Length: 60

  Country of the supplier who supplies the item.
• County: string
  Maximum Length: 60

  County of the supplier who supplies the item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostalCode: string
  Maximum Length: 60

  Postal code of the supplier who supplies the item.
• Province: string
  Maximum Length: 60

  Province of the supplier who supplies the item.
• State: string
  Maximum Length: 60

  State of the supplier who supplies the item.
• SupplierId: string
  Maximum Length: 1000

  Value that uniquely identifies the supplier who supplies the item. You can use a supplier according to the contractual obligations in drop ship.
• SupplierName: string
  Maximum Length: 1000

  Name of the supplier who supplies the item. You can use a supplier according to a contractual obligation in drop ship.
• SupplierNumber: string
  Maximum Length: 154

  Number of the supplier who supplies the item. You can use a supplier according to the contractual obligation in the drop-ship order. Although this attribute has been exposed in REST stage and file-based data import (FBDI), it isn't available in the REST service. So, this attribute isn't consumed when the REST service is used for FBDI. However, it's consumed when an Oracle Application Development Framework (ADF) service is used for FBDI.
• SupplierSiteId: integer (int64)
  Value that uniquely identifies the supplier who supplies the item.

{
    "type":"object",
    "properties":{
        "PostalCode":{
            "maxLength":"60",
            "type":"string",
            "description":"Postal code of the supplier who supplies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "maxLength":"60",
            "type":"string",
            "description":"City of the supplier who supplies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierNumber":{
            "maxLength":"154",
            "type":"string",
            "description":"Number of the supplier who supplies the item. You can use a supplier according to the contractual obligation in the drop-ship order. Although this attribute has been exposed in REST stage and file-based data import (FBDI), it isn't available in the REST service. So, this attribute isn't consumed when the REST service is used for FBDI. However, it's consumed when an Oracle Application Development Framework (ADF) service is used for FBDI.",
            "nullable":true,
            "x-queryable":true
        },
        "County":{
            "maxLength":"60",
            "type":"string",
            "description":"County of the supplier who supplies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "maxLength":"60",
            "type":"string",
            "description":"Province of the supplier who supplies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressLine3":{
            "maxLength":"240",
            "type":"string",
            "description":"Third address line of the supplier who supplies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierId":{
            "maxLength":"1000",
            "type":"string",
            "description":"Value that uniquely identifies the supplier who supplies the item. You can use a supplier according to the contractual obligations in drop ship.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressLine2":{
            "maxLength":"240",
            "type":"string",
            "description":"Second address line of the supplier who supplies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressLine1":{
            "maxLength":"240",
            "type":"string",
            "description":"First address line of the supplier who supplies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierName":{
            "maxLength":"1000",
            "type":"string",
            "description":"Name of the supplier who supplies the item. You can use a supplier according to a contractual obligation in drop ship.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier who supplies the item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "State":{
            "maxLength":"60",
            "type":"string",
            "description":"State of the supplier who supplies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressLine4":{
            "maxLength":"240",
            "type":"string",
            "description":"Fourth address line of the supplier who supplies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":"60",
            "type":"string",
            "description":"Country of the supplier who supplies the item.",
            "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