This API specification is available for download as an Open API 3.0 YAML file:
The following page lists available REST APIs for ICM 7.10 and their version dependencies:
This section covers operations for managing Punchout standards. This includes retrieving a list of available standards, details for a specific standard or available options for a chosen standard.
/customers/{CustomerKey}/punchouts
This operation returns details on supported Punchout standards. Punchout standards are defined in the punchoutconfiguration.properties and for REST API explicitly. The authenticated user requires the permission APP_B2B_VIEW_PUNCHOUT or APP_B2B_SEND_OCI_BASKET. The returned resource collection contains objects of type LinkRO with all available Punchout standards.
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.resource.PunchoutListResourceV2.getAvailablePunchouts_V2()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID |
200 - OK - The punchout standards were successfully retrieved.
401 - Unauthorized - The user could not be authenticated.
403 - Forbidden - The user does not have the required permissions.
404 - Not Found - The customer with the given ID could not be found.
This section covers operations for managing OCI Punchout configurations. This includes retrieving customer-specific configurations as well as updating an existing configuration.
/customers/{CustomerKey}/punchouts/oci5/configurations
This operation returns the customer-specific configuration for the OCI Punchout standard. The authenticated user must have the permission APP_B2B_MANAGE_PUNCHOUT.
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutConfigurationListResource.getPunchoutConfiguration()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID |
200 - OK - The customer-specific configurations for the OCI Punchout were successfully retrieved.
401 - Unauthorized - The user could not be authenticated.
403 - Forbidden - The user does not have the required permissions.
404 - Not Found - The customer could not be found or OCI Punchout is not supported.
This operation updates existing OCI Punchout configurations. A configuration can be updated entirely or partially. The fields that are not provided remain untouched, e.g.: NEW_ITEM-CONTRACT. The authenticated user requires the permission APP_B2B_MANAGE_PUNCHOUT.
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutConfigurationListResource.updatePunchoutConfiguration(com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutConfigurationRO)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID |
200 - OK - The customer-specific configurations for the OCI Punchout were successfully updated.
401 - Unauthorized - The user could not be authenticated.
403 - Forbidden - The user does not have the required permissions.
404 - Not Found - The customer could not be found or OCI Punchout is not supported.
This section covers operations for managing OCI Punchout. This includes retrieving details of OCI standard or available options.
/customers/{CustomerKey}/punchouts/oci5
This operation returns details of the OCI Punchout standard. The authenticated user requires the permission APP_B2B_VIEW_PUNCHOUT or APP_B2B_SEND_OCI_BASKET. An optional parameter basketId
can be provided to get a list of OCI Punchout fields for the Basket with the given ID.
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutItemResource.getPunchoutItemDetails(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID | |
in query | basketId | string | Returns the basket line item data according to OCI Punchout configuration |
200 - OK - The details for the OCI Punchout were successfully retrieved.
401 - Unauthorized - The user could not be authenticated.
403 - Forbidden - The user does not have the required permissions.
404 - Not Found - The customer could not be found or OCI Punchout is not supported.
This operation returns all available configuration options for the OCI Punchout standard. The authenticated user requires the permission APP_B2B_VIEW_PUNCHOUT or the permission APP_B2B_SEND_OCI_BASKET.
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutItemResource.getPunchoutConfigurationOptions()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID |
200 - OK - The configuration options for the OCI Punchout were successfully retrieved.
401 - Unauthorized - The user could not be authenticated.
403 - Forbidden - The user does not have the required permissions.
404 - Not Found - The customer could not be found or OCI Punchout is not supported.
/customers/{CustomerKey}/punchouts/oci5/background-search
This operation provides a background search functionality for products that can be utilized for cross-catalog searches of external systems like procurement systems.
For every found product matching the given search string a product record in the OCI Punchout format is returned. A record is a list of key-value pairs including all necessary transformations. Multiple records are concatinated and indexed. The fields have to be posted by the client to the external system.
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutFunctionBackgroundSearchResource.searchProducs(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID | |
in query | searchString | string | Acer | Required | The search string to search products for |
200 - OK - The product search has been successfully executed
400 - Bad Request - The search string is missing or invalid.
401 - Unauthorized - The user could not be authenticated.
403 - Forbidden - The user does not have the required permissions.
404 - Not Found - The customer could not be found or OCI Punchout is not supported.
/customers/{CustomerKey}/punchouts/oci5/transfer
This operation triggers the transfer of the OCI Punchout basket back to the external system e.g. procurement system. The following steps are performed during this process:
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutTransferResource.transferBasket(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID | |
in query | basketId | string | Required | The ID of the OCI Punchout basket to be transfered |
200 - OK - The OCI Punchout basket transfer has been successfully triggered.
400 - Bad Request - The basket ID is missing or invalid.
401 - Unauthorized - The user could not be authenticated.
403 - Forbidden - The user does not have the required permissions.
404 - Not Found - The customer could not be found or OCI Punchout is not supported.
/customers/{CustomerKey}/punchouts/oci5/validate
The operation allows to retrieve up-to-date information for a specific product with a given quantity from the Intershop Commerce System. A possible use-case is the update of product data in external systems (e.g. procurement system).
If the product was found a single product record in the OCI Punchout format is returned. The record is a list of key-value pairs including all necessary transformations. The fields have to be posted by the client to the external system.
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutFunctionValidateResource.validateProduct(java.lang.String,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID | |
in query | productId | string | 6855851 | Required | The id of the product (SKU) | |
in query | quantity | string | 3 | The requested quantity. If field is not set, then default "1" is used. |
200 - OK - The product has been successfully validated
400 - Bad Request - The search string is missing or invalid.
401 - Unauthorized - The user could not be authenticated.
403 - Forbidden - The user does not have the required permissions.
404 - Not Found - The customer could not be found or OCI Punchout is not supported.
This section covers operations for managing OCI Punchout users. This includes retrieving information on users, creating a new user, updating user data as well as deleting specific users.
/customers/{CustomerKey}/punchouts/oci5/users
This operation returns all users for the OCI Punchout standard. The authenticated user requires the permission APP_B2B_MANAGE_PUNCHOUT. The response is of type ResourceCollectionRO and contains objects of type LinkRO.
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutUserListResource.getPunchoutUsers()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID |
200 - OK - The OCI Punchout users were successfully retrieved.
401 - Unauthorized - The user could not be authenticated.
403 - Forbidden - The user does not have the required permissions.
404 - Not Found - The customer could not be found or OCI Punchout is not supported.
This operation creates a new OCI Punchout user. The ID property of Punchout user will be created automatically. The authenticated user must have the permission APP_B2B_MANAGE_PUNCHOUT.
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutUserListResource.createPunchoutUser(com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutUserRO)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID |
201 - Created - The OCI Punchout user was successfully created.
400 - Bad Request - At least one attribute is missing in the request body or the credentials are not valid regarding internal policies.
401 - Unauthorized - The user could not be authenticated.
403 - Forbidden - The user does not have the required permissions.
404 - Not Found - The customer could not be found or OCI Punchout is not supported.
409 - Conflict - The OCI Punchout user already exists.
Possible values for header 'error-key':
- punchout.login_already_exists.error
/customers/{CustomerKey}/punchouts/oci5/users/{OCIPunchoutUserKey}
This operation returns information on the given OCI Punchout user. The authenticated user requires the permission APP_B2B_MANAGE_PUNCHOUT.
public com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutUserRO com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutUserItemResource.getUserDetails()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID | |
in path | OCIPunchoutUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK - The details for the OCI Punchout user were successfully retrieved.
401 - Unauthorized - The user could not be authenticated.
403 - Forbidden - The user does not have the required permissions.
404 - Not Found - The customer/OCI Punchout user could not be found or OCI Punchout is not supported.
This operation updates the information of an OCI Punchout user. The authenticated user requires the permission APP_B2B_MANAGE_PUNCHOUT.
The following user attributes can be updated:
email
- notifications for the OCI Punchout user are send to this email address
password
- the configured password for the OCI Punchout user
active
- flag to enable/disable the OCI Punchout user
All attributes are optional, see request code examples below.
public com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutUserRO com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutUserItemResource.updatePunchoutUser(com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutUserRO)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID | |
in path | OCIPunchoutUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK - The OCI Punchout user data were successfully updated.
400 - Bad Request - If the credentials to update are not valid regarding internal policies.
401 - Unauthorized - The user could not be authenticated.
403 - Forbidden - The user does not have the required permissions.
404 - Not Found - The customer/OCI Punchout user could not be found or OCI Punchout is not supported.
This operation deletes a OCI Punchout user of a customer. The executing user must be authenticated and requires the permission APP_B2B_MANAGE_PUNCHOUT.
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutUserItemResource.deletePunchoutUser()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID | |
in path | OCIPunchoutUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
204 - No Content - The OCI Punchout user was successfully deleted.
401 - Unauthorized - The user could not be authenticated.
403 - Forbidden - The user does not have the required permissions.
404 - Not Found - The customer/OCI Punchout user could not be found or OCI Punchout is not supported.
/customers/{CustomerKey}/punchouts/cxml1.2
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.cxml.resource.CXMLPunchoutItemResource.getPunchoutItemDetails_V2(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID | |
in query | basketId | string |
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.cxml.resource.CXMLPunchoutItemResource.getPunchoutConfigurationOptions_V2()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID |
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
/customers/{CustomerKey}/punchouts/cxml1.2/sessions/{CXMLPunchoutSessionKey}
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.cxml.resource.CXMLPunchoutSessionItemResource.getSession()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID | |
in path | CXMLPunchoutSessionKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
/customers/{CustomerKey}/punchouts/cxml1.2/setuprequest
public com.intershop.sellside.rest.b2b.punchout.v2.capi.cxml.resourceobject.setup.response.CXMLPunchOutSetupResponse com.intershop.sellside.rest.b2b.punchout.v2.capi.cxml.resource.CXMLPunchoutSetupRequestResource.setupRequest(com.intershop.sellside.rest.b2b.punchout.v2.capi.cxml.resourceobject.setup.request.CXMLPunchOutSetupRequest)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID |
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
/customers/{CustomerKey}/punchouts/cxml1.2/transfer
public com.intershop.sellside.rest.b2b.punchout.v2.capi.cxml.resourceobject.transfer.CXMLPunchOutOrderMessageResponse com.intershop.sellside.rest.b2b.punchout.v2.capi.cxml.resource.CXMLPunchoutTransferBasketResource.transferBasket(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID | |
in query | sid | string |
200 - OK
401 - Unauthorized
403 - Forbidden
Header
object.CredentialHolder
object.Credential
object.CredentialHolder
object.Credential
object.CredentialHolder
object.Credential
object.Request
object.PunchOutSetupRequest
object.URL
object.date-time
CredentialRO
object.CredentialRO
object.CredentialRO
object.Link
ResourceAttribute
objects. the list of attributesResourceAttribute
: An attributeResourceAttribute
about
alternate
appendix
archives
author
bookmark
canonical
chapter
collection
contents
copyright
create-form
current
describedby
describes
disclosure
duplicate
edit
edit-form
edit-media
enclosure
first
glossary
help
hosts
hub
icon
index
item
last
latest-version
license
lrdd
monitor
monitor-group
next
next-archive
nofollow
noreferrer
payment
predecessor-version
prefetch
prev
preview
previous
prev-archive
privacy-policy
profile
related
replies
search
section
self
service
start
stylesheet
subsection
successor-version
tag
terms-of-service
type
up
version-history
via
working-copy
working-copy-of
ResourceAttribute
object. An attributeResourceAttribute
int32
int32
int32
LinkRO
objects. The list of elementsLinkRO
: A Link pointing to a resourceLink
ResourceAttribute
objects. the list of attributesResourceAttribute
: An attributeResourceAttribute
about
alternate
appendix
archives
author
bookmark
canonical
chapter
collection
contents
copyright
create-form
current
describedby
describes
disclosure
duplicate
edit
edit-form
edit-media
enclosure
first
glossary
help
hosts
hub
icon
index
item
last
latest-version
license
lrdd
monitor
monitor-group
next
next-archive
nofollow
noreferrer
payment
predecessor-version
prefetch
prev
preview
previous
prev-archive
privacy-policy
profile
related
replies
search
section
self
service
start
stylesheet
subsection
successor-version
tag
terms-of-service
type
up
version-history
via
working-copy
working-copy-of
ResourceAttribute
object. An attributeResourceAttribute
string
literals. The keys to sort forShow available configurations for OCI Punchout
PunchoutAvailableFormatterRO
objects. The available formatters for the configuration as collection of PunchoutAvailableFormatterROsPunchoutAvailableFormatterRO
: This resource holds the available formatters for the configuration as a collection of PunchoutAvailableFormatterROs.PunchoutAvailableFormatter
Trim
PunchoutAvailablePlaceholderRO
objects. The available placeholders for the configuration as collection of PunchoutAvailablePlaceholderROsPunchoutAvailablePlaceholderRO
: This resource holds the available placeholders for the configuration as collection of PunchoutAvailablePlaceholderROs.PunchoutAvailablePlaceholder
Currency
PunchoutConfigurationItemRO
objects. The configuration items as collection of PunchoutConfigurationItemROsPunchoutConfigurationItemRO
: This resource holds the configuration items as Collection of PunchoutConfigurationItemROs.NEW_ITEM-MATGROUP
{ManufacturerName}
UpperCase
PunchoutConfigurationItemMappingRO
objects. The configuration item mappings as collection of PunchoutConfigurationItemMappingROsPunchoutConfigurationItemMappingRO
: This resource holds the configuration item mappings as a collection of PunchoutConfigurationItemMappingROs.PunchoutConfigurationItemMapping
meter
m
oci
ver5
PunchoutDataRO
object. This resource holds the Punchout data as PunchoutDataRO.PunchoutData
PunchoutDataItemRO
objects.PunchoutDataItemRO
: This resource holds the Punchout data as a collection of PunchoutDataItemROs.PunchoutDataItem
PunchoutDataItemFieldRO
objects. The data item fields as a collection of PunchoutDataItemFieldROsPunchoutDataItemFieldRO
PunchoutDataItemField
0.0
PunchoutDataItemFieldRO
objects.PunchoutDataItemFieldRO
PunchoutDataItemField
0.0
PunchoutDataItemRO
objects. The Punchout data as a collection of PunchoutDataItemROsPunchoutDataItemRO
: This resource holds the Punchout data as a collection of PunchoutDataItemROs.PunchoutDataItem
PunchoutDataItemFieldRO
objects. The data item fields as a collection of PunchoutDataItemFieldROsPunchoutDataItemFieldRO
PunchoutDataItemField
0.0
PunchoutDataItemFieldRO
objects.PunchoutDataItemFieldRO
PunchoutDataItemField
0.0
PunchoutTransferDataItemFieldRO
objects. The core data of the response object.PunchoutTransferDataItemFieldRO
: The core data of the response object.FeedbackRO_v1
objects. List of errors that occurred in relation to the request.FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
FeedbackRO_v1
objects. List of informations regarding to the request (e.g. value adjustments).FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
PunchoutUser
oci1
ociuser1
ocitester@test.intershop.de
!InterShop00!
true