REST API for Oracle Fusion Cloud Procurement

Update one punchout catalog

patch

/fscmRestApi/resources/11.13.18.05/punchoutCatalogs/{CatalogId}

Request

Path Parameters

CatalogId(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

Root Schema : schema

Type: object

Show Source

AllowPriceOverrideOnPOLinesFlag: boolean

Title: Allow price override on purchase order lines

Maximum Length: 1

Indicates whether price override is allowed on purchase order lines. Contains one of the following values: true or false. If true, then you can override the price on purchase order lines. If false, then you can't override the price on purchase order lines. This attribute doesn't have a default value.
ApplyMappingFlag: boolean

Maximum Length: 1

Indicates whether mapping is applied. Contains one of the following values: true or false. If true, then mapping is applied. If false, then mapping isn't applied. This attribute doesn't have a default value.
BuyerCompanyId: string

Title: Company ID

Maximum Length: 35

Unique identifier of the buyer company. This value represents the Domain when the punchout catalog Source is SUPPLIER_VIA_CXML and Company Identification when the Source is SUPPLIER_VIA_XML or EXCHANGE.
BuyerCompanyName: string

Title: Company Name

Maximum Length: 240

Name of the buyer company. This value represents the Identity when the punchout catalog Source is SUPPLIER_VIA_CXML and Company Name when the Source is SUPPLIER_VIA_XML or EXCHANGE.
CatalogDescription: string

Title: Description

Maximum Length: 240

Description of the punchout catalog.
CatalogName: string

Title: Catalog Name

Maximum Length: 30

Name of the punchout catalog.
categoryAssignments: array Category Assignments

Title: Category Assignments

Details of the categories assigned to the informational catalog for browsing.
DefaultCategoryId: integer (int64)

Unique identifier of the item category that will be used to default on requisition lines created using punchouts when a category can't be determined based on the payload values.
DefaultCategoryName: string

Title: Default Category Name

Maximum Length: 2400

Name of the item category that will be used to default on requisition lines created using punchouts when a category can't be determined based on the payload values.
DeriveMasterItemUsingSupplierItemFlag: boolean

Title: Derive master items using a supplier item

Maximum Length: 1

Indicates whether the application derives the master item using the supplier item when using the punchout. Contains one of the following values: true or false. If true, then the application derives the master item using the supplier item. If false, then the application doesn't derive the master item using the supplier item. This attribute doesn't have a default value.
DisableAutosourcingFlag: boolean

Title: Disable automatic document sourcing

Maximum Length: 1

Indicates whether automatic sourcing is disabled. Contains one of the following values: true or false. If true, then automatic sourcing is disabled. If false, then automatic sourcing isn't disabled. This attribute doesn't have a default value.
EnableItemLevelPunchoutFlag: boolean

Title: Enable item level punchout

Maximum Length: 1

Indicates whether item-level punchout is enabled. Contains one of the following values: true or false. If true, then item-level punchout is enabled. If false, then item-level punchout isn't enabled. This attribute doesn't have a default value.
EncodingMethod: string

Title: Encoding Method

Maximum Length: 30

Encoding method used for the punchout catalog data.
ImageURL: string

Title: Image URL

Maximum Length: 240

URL of the catalog image.
Keywords: string

Title: Keywords

Maximum Length: 4000

Keywords that help identify and search for the punchout catalog.
MapSetId: integer (int64)

Unique identifier of the supplier content map set associated with the punchout catalog.
MapSetName: string

Title: Map Set

Maximum Length: 30

Name of the supplier content map set associated with the punchout catalog.
Password: string

Title: Password

Maximum Length: 100

Password used to access the punchout catalog.
PricesNegotiatedFlag: boolean

Title: All prices are negotiated

Maximum Length: 1

Default Value: true

Indicates whether prices are negotiated. Contains one of the following values: true or false. If true, then prices are negotiated. If false, then prices aren't negotiated. This attribute doesn't have a default value.
ProcessCatalogItemsFlag: boolean

Title: Process master items and agreement lines using punchout

Maximum Length: 1

Indicates whether the catalog is enabled to shop for master items and agreement lines from the punchout site. Contains one of the following values: true or false. If true, then the catalog is enabled to shop for master items and agreement lines. If false, then the catalog isn't enabled to shop for master items and agreement lines. This attribute doesn't have a default value.
punchoutSearchItems: array Punchout Search Items

Title: Punchout Search Items

A collection of items uploaded to the punchout catalog that can be searched during shopping. For example, uploaded search items can represent catalog entries available through punchout.
PunchoutURL: string

Title: Punchout URL

Maximum Length: 240

URL of the punchout catalog.
SendDeliverToLocationFlag: boolean

Title: Send deliver-to location to punchout site

Maximum Length: 1

Indicates whether the deliver-to location from the requester's preferences will be sent in the punchout setup request document. Contains one of the following values: true or false. If true, then the deliver-to location is sent. If false, then the deliver-to location isn't sent. This attribute doesn't have a default value.
SendOptionalInformationFlag: boolean

Title: Send optional user and company information to punchout site

Maximum Length: 1

Indicates whether optional information is sent. Contains one of the following values: true or false. If true, then the application sends optional information. If false, then the application doesn't send optional information. This attribute doesn't have a default value.
Source: string

Title: Source

Maximum Length: 20

Type of the source document format.
Supplier: string

Maximum Length: 360

Supplier for the punchout catalog.
SupplierId: integer (int64)

Unique identifier of the supplier.
SupplierName: string

Title: Supplier Name

Maximum Length: 240

Name of the supplier company.
SupplierNumber: string

Title: Supplier ID

Maximum Length: 256

Number assigned to the supplier company.
SupplierSite: string

Title: Supplier Site

Maximum Length: 240

Supplier site of the supplier configured on the punchout catalog.
SupplierSiteId: integer (int64)

Unique identifier of the supplier site.
UserName: string

Title: User Name

Maximum Length: 100

User name used to authenticate the connection to the punchout site.

{
    "type":"object",
    "properties":{
        "AllowPriceOverrideOnPOLinesFlag":{
            "title":"Allow price override on purchase order lines",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether price override is allowed on purchase order lines. Contains one of the following values: true or false. If true, then you can override the price on purchase order lines. If false, then you can't override the price on purchase order lines. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ApplyMappingFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether mapping is applied. Contains one of the following values: true or false. If true, then mapping is applied. If false, then mapping isn't applied. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "BuyerCompanyId":{
            "title":"Company ID",
            "maxLength":35,
            "type":"string",
            "description":"Unique identifier of the buyer company. This value represents the Domain when the punchout catalog Source is SUPPLIER_VIA_CXML and Company Identification when the Source is SUPPLIER_VIA_XML or EXCHANGE.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "BuyerCompanyName":{
            "title":"Company Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the buyer company. This value represents the Identity when the punchout catalog Source is SUPPLIER_VIA_CXML and Company Name when the Source is SUPPLIER_VIA_XML or EXCHANGE.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CatalogDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the punchout catalog.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CatalogName":{
            "title":"Catalog Name",
            "maxLength":30,
            "type":"string",
            "description":"Name of the punchout catalog.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "DefaultCategoryId":{
            "type":"integer",
            "description":"Unique identifier of the item category that will be used to default on requisition lines created using punchouts when a category can't be determined based on the payload values.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "DefaultCategoryName":{
            "title":"Default Category Name",
            "maxLength":2400,
            "type":"string",
            "description":"Name of the item category that will be used to default on requisition lines created using punchouts when a category can't be determined based on the payload values.",
            "nullable":true,
            "x-queryable":false
        },
        "DeriveMasterItemUsingSupplierItemFlag":{
            "title":"Derive master items using a supplier item",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the application derives the master item using the supplier item when using the punchout. Contains one of the following values: true or false. If true, then the application derives the master item using the supplier item. If false, then the application doesn't derive the master item using the supplier item. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DisableAutosourcingFlag":{
            "title":"Disable automatic document sourcing",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether automatic sourcing is disabled. Contains one of the following values: true or false. If true, then automatic sourcing is disabled. If false, then automatic sourcing isn't disabled. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "EnableItemLevelPunchoutFlag":{
            "title":"Enable item level punchout",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether item-level punchout is enabled. Contains one of the following values: true or false. If true, then item-level punchout is enabled. If false, then item-level punchout isn't enabled. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "EncodingMethod":{
            "title":"Encoding Method",
            "maxLength":30,
            "type":"string",
            "description":"Encoding method used for the punchout catalog data.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ImageURL":{
            "title":"Image URL",
            "maxLength":240,
            "type":"string",
            "description":"URL of the catalog image.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Keywords":{
            "title":"Keywords",
            "maxLength":4000,
            "type":"string",
            "description":"Keywords that help identify and search for the punchout catalog.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "KeywordsClob"
                ]
            }
        },
        "MapSetId":{
            "type":"integer",
            "description":"Unique identifier of the supplier content map set associated with the punchout catalog.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "MapSetName":{
            "title":"Map Set",
            "maxLength":30,
            "type":"string",
            "description":"Name of the supplier content map set associated with the punchout catalog.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Password":{
            "title":"Password",
            "maxLength":100,
            "type":"string",
            "description":"Password used to access the punchout catalog.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PricesNegotiatedFlag":{
            "title":"All prices are negotiated",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether prices are negotiated. Contains one of the following values: true or false. If true, then prices are negotiated. If false, then prices aren't negotiated. This attribute doesn't have a default value.",
            "nullable":true,
            "default":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ProcessCatalogItemsFlag":{
            "title":"Process master items and agreement lines using punchout",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the catalog is enabled to shop for master items and agreement lines from the punchout site. Contains one of the following values: true or false. If true, then the catalog is enabled to shop for master items and agreement lines. If false, then the catalog isn't enabled to shop for master items and agreement lines. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PunchoutURL":{
            "title":"Punchout URL",
            "maxLength":240,
            "type":"string",
            "description":"URL of the punchout catalog.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SendDeliverToLocationFlag":{
            "title":"Send deliver-to location to punchout site",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the deliver-to location from the requester's preferences will be sent in the punchout setup request document. Contains one of the following values: true or false. If true, then the deliver-to location is sent. If false, then the deliver-to location isn't sent. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SendOptionalInformationFlag":{
            "title":"Send optional user and company information to punchout site",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether optional information is sent. Contains one of the following values: true or false. If true, then the application sends optional information. If false, then the application doesn't send optional information. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Source":{
            "title":"Source",
            "maxLength":20,
            "type":"string",
            "description":"Type of the source document format.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Supplier":{
            "maxLength":360,
            "type":"string",
            "description":"Supplier for the punchout catalog.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "ProcurementBUId",
                    "ProcurementBU"
                ]
            }
        },
        "SupplierId":{
            "type":"integer",
            "description":"Unique identifier of the supplier.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "SupplierName":{
            "title":"Supplier Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier company.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SupplierNumber":{
            "title":"Supplier ID",
            "maxLength":256,
            "type":"string",
            "description":"Number assigned to the supplier company.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":240,
            "type":"string",
            "description":"Supplier site of the supplier configured on the punchout catalog.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SupplierId",
                    "ProcurementBUId"
                ]
            }
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Unique identifier of the supplier site.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false,
                "dependencies":[
                    "SupplierId"
                ]
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":100,
            "type":"string",
            "description":"User name used to authenticate the connection to the punchout site.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "categoryAssignments":{
            "title":"Category Assignments",
            "type":"array",
            "description":"Details of the categories assigned to the informational catalog for browsing.",
            "items":{
                "$ref":"#/components/schemas/punchoutCatalogs-categoryAssignments-item-patch-request"
            }
        },
        "punchoutSearchItems":{
            "title":"Punchout Search Items",
            "type":"array",
            "description":"A collection of items uploaded to the punchout catalog that can be searched during shopping. For example, uploaded search items can represent catalog entries available through punchout.",
            "items":{
                "$ref":"#/components/schemas/punchoutCatalogs-punchoutSearchItems-item-patch-request"
            }
        }
    }
}

Nested Schema : Category Assignments

Type: array

Title: Category Assignments

Details of the categories assigned to the informational catalog for browsing.

Show Source

Array of: object punchoutCatalogs-categoryAssignments-item-patch-request

{
    "title":"Category Assignments",
    "type":"array",
    "description":"Details of the categories assigned to the informational catalog for browsing.",
    "items":{
        "$ref":"#/components/schemas/punchoutCatalogs-categoryAssignments-item-patch-request"
    }
}

Nested Schema : Punchout Search Items

Type: array

Title: Punchout Search Items

A collection of items uploaded to the punchout catalog that can be searched during shopping. For example, uploaded search items can represent catalog entries available through punchout.

Show Source

Array of: object punchoutCatalogs-punchoutSearchItems-item-patch-request

{
    "title":"Punchout Search Items",
    "type":"array",
    "description":"A collection of items uploaded to the punchout catalog that can be searched during shopping. For example, uploaded search items can represent catalog entries available through punchout.",
    "items":{
        "$ref":"#/components/schemas/punchoutCatalogs-punchoutSearchItems-item-patch-request"
    }
}

Nested Schema : punchoutCatalogs-categoryAssignments-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : punchoutCatalogs-punchoutSearchItems-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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.

Root Schema : punchoutCatalogs-item-response

Type: object

Show Source

AllowPriceOverrideOnPOLinesFlag: boolean

Title: Allow price override on purchase order lines

Maximum Length: 1

Indicates whether price override is allowed on purchase order lines. Contains one of the following values: true or false. If true, then you can override the price on purchase order lines. If false, then you can't override the price on purchase order lines. This attribute doesn't have a default value.
ApplyMappingFlag: boolean

Maximum Length: 1

Indicates whether mapping is applied. Contains one of the following values: true or false. If true, then mapping is applied. If false, then mapping isn't applied. This attribute doesn't have a default value.
BuyerCompanyId: string

Title: Company ID

Maximum Length: 35

Unique identifier of the buyer company. This value represents the Domain when the punchout catalog Source is SUPPLIER_VIA_CXML and Company Identification when the Source is SUPPLIER_VIA_XML or EXCHANGE.
BuyerCompanyName: string

Title: Company Name

Maximum Length: 240

Name of the buyer company. This value represents the Identity when the punchout catalog Source is SUPPLIER_VIA_CXML and Company Name when the Source is SUPPLIER_VIA_XML or EXCHANGE.
CatalogDescription: string

Title: Description

Maximum Length: 240

Description of the punchout catalog.
CatalogId: integer (int64)

Read Only: true

Unique identifier of the catalog.
CatalogName: string

Title: Catalog Name

Maximum Length: 30

Name of the punchout catalog.
CatalogType: string

Title: Catalog Type

Read Only: true

Maximum Length: 80

Type of the catalog. Value for this attribute is always Punchout.
CatalogTypeCode: string

Read Only: true

Maximum Length: 15

Default Value: PUNCHOUT

Code that identifies the type of the punchout catalog. The value is always PUNCHOUT.
categoryAssignments: array Category Assignments

Title: Category Assignments

Details of the categories assigned to the informational catalog for browsing.
CreatedBy: string

Read Only: true

Maximum Length: 64

User who created the punchout catalog.
CreationDate: string (date-time)

Read Only: true

The date when the punchout catalog was created.
DefaultCategoryId: integer (int64)

Unique identifier of the item category that will be used to default on requisition lines created using punchouts when a category can't be determined based on the payload values.
DefaultCategoryName: string

Title: Default Category Name

Maximum Length: 2400

Name of the item category that will be used to default on requisition lines created using punchouts when a category can't be determined based on the payload values.
DeriveMasterItemUsingSupplierItemFlag: boolean

Title: Derive master items using a supplier item

Maximum Length: 1

Indicates whether the application derives the master item using the supplier item when using the punchout. Contains one of the following values: true or false. If true, then the application derives the master item using the supplier item. If false, then the application doesn't derive the master item using the supplier item. This attribute doesn't have a default value.
DisableAutosourcingFlag: boolean

Title: Disable automatic document sourcing

Maximum Length: 1

Indicates whether automatic sourcing is disabled. Contains one of the following values: true or false. If true, then automatic sourcing is disabled. If false, then automatic sourcing isn't disabled. This attribute doesn't have a default value.
EnableItemLevelPunchoutFlag: boolean

Title: Enable item level punchout

Maximum Length: 1

Indicates whether item-level punchout is enabled. Contains one of the following values: true or false. If true, then item-level punchout is enabled. If false, then item-level punchout isn't enabled. This attribute doesn't have a default value.
EncodingMethod: string

Title: Encoding Method

Maximum Length: 30

Encoding method used for the punchout catalog data.
ImageURL: string

Title: Image URL

Maximum Length: 240

URL of the catalog image.
Keywords: string

Title: Keywords

Maximum Length: 4000

Keywords that help identify and search for the punchout catalog.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

User who last updated the punchout catalog.
LastUpdatedDate: string (date-time)

Read Only: true

The date when the punchout catalog was last updated.
links: array Links

Title: Links

The link relations associated with the resource instance.
MapSetId: integer (int64)

Unique identifier of the supplier content map set associated with the punchout catalog.
MapSetName: string

Title: Map Set

Maximum Length: 30

Name of the supplier content map set associated with the punchout catalog.
ParentCatalogId: integer (int64)

Read Only: true

Unique identifier of the parent catalog.
Password: string

Title: Password

Maximum Length: 100

Password used to access the punchout catalog.
PricesNegotiatedFlag: boolean

Title: All prices are negotiated

Maximum Length: 1

Default Value: true

Indicates whether prices are negotiated. Contains one of the following values: true or false. If true, then prices are negotiated. If false, then prices aren't negotiated. This attribute doesn't have a default value.
ProcessCatalogItemsFlag: boolean

Title: Process master items and agreement lines using punchout

Maximum Length: 1

Indicates whether the catalog is enabled to shop for master items and agreement lines from the punchout site. Contains one of the following values: true or false. If true, then the catalog is enabled to shop for master items and agreement lines. If false, then the catalog isn't enabled to shop for master items and agreement lines. This attribute doesn't have a default value.
ProcurementBU: string

Title: Procurement BU

Maximum Length: 240

Procurement business unit in which the punchout catalog is created.
ProcurementBUId: integer (int64)

Unique identifier of the procurement business unit in which the catalog is created.
punchoutSearchItems: array Punchout Search Items

Title: Punchout Search Items

A collection of items uploaded to the punchout catalog that can be searched during shopping. For example, uploaded search items can represent catalog entries available through punchout.
PunchoutURL: string

Title: Punchout URL

Maximum Length: 240

URL of the punchout catalog.
PunchoutURLKey: integer (int64)

Read Only: true

Key to the URL to the supplier website configured for the punchout catalog.
SendDeliverToLocationFlag: boolean

Title: Send deliver-to location to punchout site

Maximum Length: 1

Indicates whether the deliver-to location from the requester's preferences will be sent in the punchout setup request document. Contains one of the following values: true or false. If true, then the deliver-to location is sent. If false, then the deliver-to location isn't sent. This attribute doesn't have a default value.
SendOptionalInformationFlag: boolean

Title: Send optional user and company information to punchout site

Maximum Length: 1

Indicates whether optional information is sent. Contains one of the following values: true or false. If true, then the application sends optional information. If false, then the application doesn't send optional information. This attribute doesn't have a default value.
Source: string

Title: Source

Maximum Length: 20

Type of the source document format.
Supplier: string

Maximum Length: 360

Supplier for the punchout catalog.
SupplierId: integer (int64)

Unique identifier of the supplier.
SupplierName: string

Title: Supplier Name

Maximum Length: 240

Name of the supplier company.
SupplierNumber: string

Title: Supplier ID

Maximum Length: 256

Number assigned to the supplier company.
SupplierSite: string

Title: Supplier Site

Maximum Length: 240

Supplier site of the supplier configured on the punchout catalog.
SupplierSiteId: integer (int64)

Unique identifier of the supplier site.
TradingPartnerId: number

Read Only: true

Unique identifier of the trading partner.
UserName: string

Title: User Name

Maximum Length: 100

User name used to authenticate the connection to the punchout site.

{
    "type":"object",
    "properties":{
        "AllowPriceOverrideOnPOLinesFlag":{
            "title":"Allow price override on purchase order lines",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether price override is allowed on purchase order lines. Contains one of the following values: true or false. If true, then you can override the price on purchase order lines. If false, then you can't override the price on purchase order lines. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ApplyMappingFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether mapping is applied. Contains one of the following values: true or false. If true, then mapping is applied. If false, then mapping isn't applied. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "BuyerCompanyId":{
            "title":"Company ID",
            "maxLength":35,
            "type":"string",
            "description":"Unique identifier of the buyer company. This value represents the Domain when the punchout catalog Source is SUPPLIER_VIA_CXML and Company Identification when the Source is SUPPLIER_VIA_XML or EXCHANGE.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "BuyerCompanyName":{
            "title":"Company Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the buyer company. This value represents the Identity when the punchout catalog Source is SUPPLIER_VIA_CXML and Company Name when the Source is SUPPLIER_VIA_XML or EXCHANGE.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CatalogDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the punchout catalog.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CatalogId":{
            "type":"integer",
            "description":"Unique identifier of the catalog.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CatalogName":{
            "title":"Catalog Name",
            "maxLength":30,
            "type":"string",
            "description":"Name of the punchout catalog.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "CatalogType":{
            "title":"Catalog Type",
            "maxLength":80,
            "type":"string",
            "description":"Type of the catalog. Value for this attribute is always Punchout.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CatalogTypeCode":{
            "maxLength":15,
            "type":"string",
            "description":"Code that identifies the type of the punchout catalog. The value is always PUNCHOUT.",
            "nullable":false,
            "readOnly":true,
            "default":"PUNCHOUT",
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the punchout catalog.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the punchout catalog was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DefaultCategoryId":{
            "type":"integer",
            "description":"Unique identifier of the item category that will be used to default on requisition lines created using punchouts when a category can't be determined based on the payload values.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "DefaultCategoryName":{
            "title":"Default Category Name",
            "maxLength":2400,
            "type":"string",
            "description":"Name of the item category that will be used to default on requisition lines created using punchouts when a category can't be determined based on the payload values.",
            "nullable":true,
            "x-queryable":false
        },
        "DeriveMasterItemUsingSupplierItemFlag":{
            "title":"Derive master items using a supplier item",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the application derives the master item using the supplier item when using the punchout. Contains one of the following values: true or false. If true, then the application derives the master item using the supplier item. If false, then the application doesn't derive the master item using the supplier item. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DisableAutosourcingFlag":{
            "title":"Disable automatic document sourcing",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether automatic sourcing is disabled. Contains one of the following values: true or false. If true, then automatic sourcing is disabled. If false, then automatic sourcing isn't disabled. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "EnableItemLevelPunchoutFlag":{
            "title":"Enable item level punchout",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether item-level punchout is enabled. Contains one of the following values: true or false. If true, then item-level punchout is enabled. If false, then item-level punchout isn't enabled. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "EncodingMethod":{
            "title":"Encoding Method",
            "maxLength":30,
            "type":"string",
            "description":"Encoding method used for the punchout catalog data.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ImageURL":{
            "title":"Image URL",
            "maxLength":240,
            "type":"string",
            "description":"URL of the catalog image.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Keywords":{
            "title":"Keywords",
            "maxLength":4000,
            "type":"string",
            "description":"Keywords that help identify and search for the punchout catalog.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "KeywordsClob"
                ]
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the punchout catalog.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdatedDate":{
            "type":"string",
            "description":"The date when the punchout catalog was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "MapSetId":{
            "type":"integer",
            "description":"Unique identifier of the supplier content map set associated with the punchout catalog.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "MapSetName":{
            "title":"Map Set",
            "maxLength":30,
            "type":"string",
            "description":"Name of the supplier content map set associated with the punchout catalog.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ParentCatalogId":{
            "type":"integer",
            "description":"Unique identifier of the parent catalog.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "Password":{
            "title":"Password",
            "maxLength":100,
            "type":"string",
            "description":"Password used to access the punchout catalog.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PricesNegotiatedFlag":{
            "title":"All prices are negotiated",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether prices are negotiated. Contains one of the following values: true or false. If true, then prices are negotiated. If false, then prices aren't negotiated. This attribute doesn't have a default value.",
            "nullable":true,
            "default":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ProcessCatalogItemsFlag":{
            "title":"Process master items and agreement lines using punchout",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the catalog is enabled to shop for master items and agreement lines from the punchout site. Contains one of the following values: true or false. If true, then the catalog is enabled to shop for master items and agreement lines. If false, then the catalog isn't enabled to shop for master items and agreement lines. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ProcurementBU":{
            "title":"Procurement BU",
            "maxLength":240,
            "type":"string",
            "description":"Procurement business unit in which the punchout catalog is created.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false,
                "dependencies":[
                    "OrganizationId"
                ]
            }
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Unique identifier of the procurement business unit in which the catalog is created.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "PunchoutURL":{
            "title":"Punchout URL",
            "maxLength":240,
            "type":"string",
            "description":"URL of the punchout catalog.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PunchoutURLKey":{
            "type":"integer",
            "description":"Key to the URL to the supplier website configured for the punchout catalog.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "SendDeliverToLocationFlag":{
            "title":"Send deliver-to location to punchout site",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the deliver-to location from the requester's preferences will be sent in the punchout setup request document. Contains one of the following values: true or false. If true, then the deliver-to location is sent. If false, then the deliver-to location isn't sent. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SendOptionalInformationFlag":{
            "title":"Send optional user and company information to punchout site",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether optional information is sent. Contains one of the following values: true or false. If true, then the application sends optional information. If false, then the application doesn't send optional information. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Source":{
            "title":"Source",
            "maxLength":20,
            "type":"string",
            "description":"Type of the source document format.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Supplier":{
            "maxLength":360,
            "type":"string",
            "description":"Supplier for the punchout catalog.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "ProcurementBUId",
                    "ProcurementBU"
                ]
            }
        },
        "SupplierId":{
            "type":"integer",
            "description":"Unique identifier of the supplier.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "SupplierName":{
            "title":"Supplier Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier company.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SupplierNumber":{
            "title":"Supplier ID",
            "maxLength":256,
            "type":"string",
            "description":"Number assigned to the supplier company.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":240,
            "type":"string",
            "description":"Supplier site of the supplier configured on the punchout catalog.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SupplierId",
                    "ProcurementBUId"
                ]
            }
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Unique identifier of the supplier site.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false,
                "dependencies":[
                    "SupplierId"
                ]
            }
        },
        "TradingPartnerId":{
            "type":"number",
            "description":"Unique identifier of the trading partner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":100,
            "type":"string",
            "description":"User name used to authenticate the connection to the punchout site.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "categoryAssignments":{
            "title":"Category Assignments",
            "type":"array",
            "description":"Details of the categories assigned to the informational catalog for browsing.",
            "items":{
                "$ref":"#/components/schemas/punchoutCatalogs-categoryAssignments-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "punchoutSearchItems":{
            "title":"Punchout Search Items",
            "type":"array",
            "description":"A collection of items uploaded to the punchout catalog that can be searched during shopping. For example, uploaded search items can represent catalog entries available through punchout.",
            "items":{
                "$ref":"#/components/schemas/punchoutCatalogs-punchoutSearchItems-item-response"
            }
        }
    }
}

Nested Schema : Category Assignments

Type: array

Title: Category Assignments

Details of the categories assigned to the informational catalog for browsing.

Show Source

Array of: object punchoutCatalogs-categoryAssignments-item-response

{
    "title":"Category Assignments",
    "type":"array",
    "description":"Details of the categories assigned to the informational catalog for browsing.",
    "items":{
        "$ref":"#/components/schemas/punchoutCatalogs-categoryAssignments-item-response"
    }
}

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 : Punchout Search Items

Type: array

Title: Punchout Search Items

A collection of items uploaded to the punchout catalog that can be searched during shopping. For example, uploaded search items can represent catalog entries available through punchout.

Show Source

Array of: object punchoutCatalogs-punchoutSearchItems-item-response

{
    "title":"Punchout Search Items",
    "type":"array",
    "description":"A collection of items uploaded to the punchout catalog that can be searched during shopping. For example, uploaded search items can represent catalog entries available through punchout.",
    "items":{
        "$ref":"#/components/schemas/punchoutCatalogs-punchoutSearchItems-item-response"
    }
}

Nested Schema : punchoutCatalogs-categoryAssignments-item-response

Type: object

Show Source

AssignmentType: string

Title: Assignment Type

Maximum Length: 20

Type of the assigned category. Valid values are PURCHASING_CATEGORY for purchasing and BROWSING_CATEGORY for browsing.
CatalogAssignmentId: integer (int64)

Read Only: true

Unique identifier of category assignment to the punchout catalog.
CatalogId: integer (int64)

Read Only: true

Unique identifier of the catalog.
CategoryId: integer (int64)

Unique identifier of the category.
CategoryName: string

Title: Category

Maximum Length: 250

Name of the category assigned to the punchout catalog.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64

User who created the category assignment.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

The date when the category assignment was created.
Description: string

Title: Description

Read Only: true

Maximum Length: 250

Brief description about the category.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 64

User who last updated the category assignment.
LastUpdatedDate: string (date-time)

Title: Last Updated Date

Read Only: true

The date when the category assignment was last updated.
links: array Links

Title: Links

The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AssignmentType":{
            "title":"Assignment Type",
            "maxLength":20,
            "type":"string",
            "description":"Type of the assigned category. Valid values are PURCHASING_CATEGORY for purchasing and BROWSING_CATEGORY for browsing.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "CatalogAssignmentId":{
            "type":"integer",
            "description":"Unique identifier of category assignment to the punchout catalog.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CatalogId":{
            "type":"integer",
            "description":"Unique identifier of the catalog.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "CategoryId":{
            "type":"integer",
            "description":"Unique identifier of the category.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":250,
            "type":"string",
            "description":"Name of the category assigned to the punchout catalog.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the category assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the category assignment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":250,
            "type":"string",
            "description":"Brief description about the category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the category assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdatedDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the category assignment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "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."
        }
    }
}

Nested Schema : punchoutCatalogs-punchoutSearchItems-item-response

Type: object

Show Source

Agreement: string

Title: Agreement

Read Only: true

Maximum Length: 20

Agreement associated with the punchout search item.
AgreementHeaderId: integer (int64)

Read Only: true

Unique identifier of the agreement.
Amount: number

Title: Amount

Read Only: true

Amount for the punchout search item.
Category: string

Title: Category Name

Read Only: true

Maximum Length: 2400

Category of the punchout search item.
CategoryId: integer (int64)

Read Only: true

Unique identifier of the category.
CreatedBy: string

Title: Created By

Maximum Length: 64

User who created the punchout search item.
CreationDate: string (date-time)

Title: Creation Date

The date when the punchout search item was created.
Currency: string

Title: Currency

Read Only: true

Maximum Length: 80

Currency of the item price or the item amount.
CurrencyCode: string

Read Only: true

Maximum Length: 15

Code that identifies the currency of the item price or the item amount.
ImageURL: string

Title: Image URL

Read Only: true

Maximum Length: 700

URL of the item image.
ItemDescription: string

Title: Item Description

Read Only: true

Maximum Length: 240

Description of the item.
ItemLanguageCode: string

Read Only: true

Maximum Length: 4

Code that identifies the language of item upload.
ItemLongDescription: string

Title: Long Description

Read Only: true

Maximum Length: 4000

Long description of the item.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 64

User who last updated the punchout search item.
LastUpdatedDate: string (date-time)

Title: Last Updated Date

Read Only: true

The date when the punchout search item was last updated.
LineType: string

Title: Line Type

Read Only: true

Maximum Length: 30

Line type used for the punchout search item.
LineTypeId: integer (int64)

Read Only: true

Unique identifier of the line type.
links: array Links

Title: Links

The link relations associated with the resource instance.
Manufacturer: string

Title: Manufacturer

Read Only: true

Maximum Length: 240

Manufacturer of the item.
ManufacturerPartNumber: string

Title: Manufacturer Part Number

Read Only: true

Maximum Length: 30

Manufacturer's part number of the item.
ProcessId: integer (int64)

Title: Process ID

Read Only: true

Unique identifier of the process used to upload the item.
PunchoutCatalogId: integer (int64)

Read Only: true

Unique identifier of the punchout catalog.
PunchoutSearchItemId: integer (int64)

Read Only: true

Unique identifier of the punchout search item.
Supplier: string

Title: Supplier

Read Only: true

Maximum Length: 360

Supplier associated with the punchout search item.
SupplierId: integer (int64)

Read Only: true

Unique identifier of the supplier.
SupplierItem: string

Title: Supplier Item

Read Only: true

Maximum Length: 300

Supplier item number associated with the item.
SupplierItemAuxillaryId: string

Title: Supplier Item Auxiliary Identifier

Read Only: true

Maximum Length: 255

Auxiliary identifier of the supplier item.
UnitPrice: number

Title: Price

Read Only: true

Price of one unit of the item.
UOM: string

Title: UOM

Read Only: true

Maximum Length: 25

Unit of measure of the item.
UOMCode: string

Read Only: true

Maximum Length: 3

Code that identifies the unit of measure for the item.

{
    "type":"object",
    "properties":{
        "Agreement":{
            "title":"Agreement",
            "maxLength":20,
            "type":"string",
            "description":"Agreement associated with the punchout search item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgreementHeaderId":{
            "type":"integer",
            "description":"Unique identifier of the agreement.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount for the punchout search item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":28,
                "scale":10
            }
        },
        "Category":{
            "title":"Category Name",
            "maxLength":2400,
            "type":"string",
            "description":"Category of the punchout search item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryId":{
            "type":"integer",
            "description":"Unique identifier of the category.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the punchout search item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the punchout search item was created.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Currency":{
            "title":"Currency",
            "maxLength":80,
            "type":"string",
            "description":"Currency of the item price or the item amount.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Code that identifies the currency of the item price or the item amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ImageURL":{
            "title":"Image URL",
            "maxLength":700,
            "type":"string",
            "description":"URL of the item image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ItemLanguageCode":{
            "maxLength":4,
            "type":"string",
            "description":"Code that identifies the language of item upload.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ItemLongDescription":{
            "title":"Long Description",
            "maxLength":4000,
            "type":"string",
            "description":"Long description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the punchout search item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdatedDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the punchout search item was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LineType":{
            "title":"Line Type",
            "maxLength":30,
            "type":"string",
            "description":"Line type used for the punchout search item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineTypeId":{
            "type":"integer",
            "description":"Unique identifier of the line type.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "Manufacturer":{
            "title":"Manufacturer",
            "maxLength":240,
            "type":"string",
            "description":"Manufacturer of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManufacturerPartNumber":{
            "title":"Manufacturer Part Number",
            "maxLength":30,
            "type":"string",
            "description":"Manufacturer's part number of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessId":{
            "title":"Process ID",
            "type":"integer",
            "description":"Unique identifier of the process used to upload the item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "PunchoutCatalogId":{
            "type":"integer",
            "description":"Unique identifier of the punchout catalog.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "PunchoutSearchItemId":{
            "type":"integer",
            "description":"Unique identifier of the punchout search item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false
            }
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":360,
            "type":"string",
            "description":"Supplier associated with the punchout search item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Unique identifier of the supplier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "SupplierItem":{
            "title":"Supplier Item",
            "maxLength":300,
            "type":"string",
            "description":"Supplier item number associated with the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierItemAuxillaryId":{
            "title":"Supplier Item Auxiliary Identifier",
            "maxLength":255,
            "type":"string",
            "description":"Auxiliary identifier of the supplier item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOM":{
            "title":"UOM",
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure of the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"edit"
            }
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Code that identifies the unit of measure for the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "UnitPrice":{
            "title":"Price",
            "type":"number",
            "description":"Price of one unit of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":28,
                "scale":10
            }
        },
        "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"
    }
}

Links

addCategoryAssignments

Operation: /fscmRestApi/resources/11.13.18.05/punchoutCatalogs/{CatalogId}/action/addCategoryAssignments

Parameters:

CatalogId: $request.path.CatalogId

Adds category assignments for browsing to the punchout catalog.

categoryAssignments

Operation: /fscmRestApi/resources/11.13.18.05/punchoutCatalogs/{CatalogId}/child/categoryAssignments

Parameters:

CatalogId: $request.path.CatalogId

Details of the categories assigned to the informational catalog for browsing.

downloadResources

Operation: /fscmRestApi/resources/11.13.18.05/punchoutCatalogs/{CatalogId}/action/downloadResources

Parameters:

CatalogId: $request.path.CatalogId

Downloads the resources required to upload the search items to a punchout catalog.

punchoutSearchItems

Operation: /fscmRestApi/resources/11.13.18.05/punchoutCatalogs/{CatalogId}/child/punchoutSearchItems

Parameters:

CatalogId: $request.path.CatalogId

A collection of items uploaded to the punchout catalog that can be searched during shopping. For example, uploaded search items can represent catalog entries available through punchout.

uploadPunchoutSearchItems

Operation: /fscmRestApi/resources/11.13.18.05/punchoutCatalogs/{CatalogId}/action/uploadPunchoutSearchItems

Parameters:

CatalogId: $request.path.CatalogId

Uploads punchout search items to the punchout catalog based on the uploaded file referenced by the parameters.