Jump to

• Request
• Response
• Examples

Update a profile

patch

/fscmRestApi/resources/11.13.18.05/supplierTradeProfiles/{SupplierTradeProfileId}

Request

Path Parameters

• SupplierTradeProfileId(required): integer(int64)
  Value that uniquely identifies the supplier trade profile. It is a primary key that the application generates when it creates the supplier trade profile.

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

• CategorySetId: integer (int64)
  Value that uniquely identifies the catalog assigned to a supplier.
• DefaultClaimOwner: string
  Default owner for the claim.
• DefaultClaimOwnerId: integer (int64)
  Value that uniquely identifies the default owner for the claim.
• DefaultProgramOwner: string
  Default owner for the program, if the program is created via the Supplier Portal.
• DefaultProgramOwnerId: integer (int64)
  Value that uniquely identifies the default owner for the program.
• EnabledFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the supplier trade profile is enabled. If false, then the supplier trade profile is disabled. The default value is true.
• GracePeriodInDays: integer (int64)
  Number of days that the ship and debit can extend beyond the to date on a ship and debit program. The maximum value is 9999 days.
• ProcessAccrualsForReturnsFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then accruals will be generated and processed for return orders. If false, then accruals will not be generated for return orders. The default value is false.
• SupplierCatalog: string
  Name of the catalog assigned to a supplier.

{
    "type":"object",
    "properties":{
        "GracePeriodInDays":{
            "type":"integer",
            "description":"Number of days that the ship and debit can extend beyond the to date on a ship and debit program. The maximum value is 9999 days.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DefaultClaimOwner":{
            "type":"string",
            "description":"Default owner for the claim.",
            "nullable":true
        },
        "DefaultClaimOwnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the default owner for the claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DefaultProgramOwnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the default owner for the program.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SupplierCatalog":{
            "type":"string",
            "description":"Name of the catalog assigned to a supplier.",
            "nullable":true
        },
        "DefaultProgramOwner":{
            "type":"string",
            "description":"Default owner for the program, if the program is created via the Supplier Portal.",
            "nullable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the supplier trade profile is enabled. If false, then the supplier trade profile is disabled. The default value is true.",
            "nullable":true
        },
        "CategorySetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the catalog assigned to a supplier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProcessAccrualsForReturnsFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then accruals will be generated and processed for return orders. If false, then accruals will not be generated for return orders. The default value is false.",
            "nullable":true,
            "default":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(required):
  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(required):
  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 : supplierTradeProfiles-item-response

Type: object

Show Source

• CategorySetId: integer (int64)
  Value that uniquely identifies the catalog assigned to a supplier.
• ClientBusinessUnit: string
  Maximum Length: 240

  Name of the business unit.
• ClientBusinessUnitId: integer (int64)
  Value that uniquely identifies the business unit.
• 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.
• DefaultClaimOwner: string
  Default owner for the claim.
• DefaultClaimOwnerId: integer (int64)
  Value that uniquely identifies the default owner for the claim.
• DefaultProgramOwner: string
  Default owner for the program, if the program is created via the Supplier Portal.
• DefaultProgramOwnerId: integer (int64)
  Value that uniquely identifies the default owner for the program.
• EnabledFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the supplier trade profile is enabled. If false, then the supplier trade profile is disabled. The default value is true.
• GracePeriodInDays: integer (int64)
  Number of days that the ship and debit can extend beyond the to date on a ship and debit program. The maximum value is 9999 days.
• LastUpdateDate: string (date-time)
  Read Only: true

  Login that the user used when updating the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProcessAccrualsForReturnsFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then accruals will be generated and processed for return orders. If false, then accruals will not be generated for return orders. The default value is false.
• Supplier: string
  Maximum Length: 360

  Name of the supplier supporting the channel program.
• SupplierAddress: string
  Read Only: true

  Address of the supplier site.
• SupplierCatalog: string
  Name of the catalog assigned to a supplier.
• SupplierId: integer (int64)
  Value that uniquely identifies the supplier.
• SupplierNumber: string
  Maximum Length: 30

  Number that identifies the supplier.
• SupplierSite: string
  Maximum Length: 240

  Value that identifies the supplier site. Valid values should be sites where the supplier trade profile business unit is configured as Client to BU in supplier site assignments.
• SupplierSiteId: integer (int64)
  Value that uniquely identifies the supplier site.
• SupplierTradeProfileId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier trade profile. It is a primary key that the application generates when it creates the supplier trade profile.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated 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
        },
        "ClientBusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultClaimOwner":{
            "type":"string",
            "description":"Default owner for the claim.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultClaimOwnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the default owner for the claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DefaultProgramOwnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the default owner for the program.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierCatalog":{
            "type":"string",
            "description":"Name of the catalog assigned to a supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierTradeProfileId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier trade profile. It is a primary key that the application generates when it creates the supplier trade profile.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierAddress":{
            "type":"string",
            "description":"Address of the supplier site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "GracePeriodInDays":{
            "type":"integer",
            "description":"Number of days that the ship and debit can extend beyond the to date on a ship and debit program. The maximum value is 9999 days.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClientBusinessUnit":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierSite":{
            "maxLength":240,
            "type":"string",
            "description":"Value that identifies the supplier site. Valid values should be sites where the supplier trade profile business unit is configured as Client to BU in supplier site assignments.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Supplier":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier supporting the channel program.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultProgramOwner":{
            "type":"string",
            "description":"Default owner for the program, if the program is created via the Supplier Portal.",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the supplier trade profile is enabled. If false, then the supplier trade profile is disabled. The default value is true.",
            "nullable":true,
            "x-queryable":true
        },
        "CategorySetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the catalog assigned to a supplier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProcessAccrualsForReturnsFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then accruals will be generated and processed for return orders. If false, then accruals will not be generated for return orders. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Login that the user used when updating the record.",
            "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."
        }
    }
}

Back to Top

Examples

This example describes how to update a profile.

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/supplierTradeProfiles/300100185773744"

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.

{
	"GracePeriodInDays": "10",
	"ProcessAccrualsForReturnsFlag": "N"
}

Example Response Body

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

{
	"SupplierTradeProfileId": 300100185773744,
	"ClientBusinessUnit": "Vision Operations",
	"ClientBusinessUnitId": 204,
	"SupplierId": 1178,
	"Supplier": "CDS, Inc",
	"SupplierNumber": "5102",
	"SupplierSite": "PITTSBURGH",
	"SupplierSiteId": 2854,
	"EnabledFlag": true,
	"DefaultClaimOwner": "channel_user",
	"DefaultClaimOwnerId": 300100181693728,
	"GracePeriodInDays": 10,
	"ProcessAccrualsForReturnsFlag": false,
	"CreatedBy": "channel_user",
	"CreationDate": "2020-06-03T02:32:20+00:00",
	"LastUpdateDate": "2020-06-03T02:38:09+00:00",
	"LastUpdatedBy": "channel_user",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/supplierTradeProfiles/300100185773744",
		"name": "supplierTradeProfiles",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/supplierTradeProfiles/300100185773744",
		"name": "supplierTradeProfiles",
		"kind": "item"
	}
	]
}

Back to Top