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 configurations. This includes retrieving customer-specific configurations as well as updating an existing configuration.
/customers/{CustomerKey}/punchouts/{PunchoutKey}/configurations
This operation returns the customer-specific configuration for the selected Punchout standard. The authenticated user must have the permission APP_B2B_MANAGE_PUNCHOUT.
public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutConfigurationListResource.getPunchoutConfiguration()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID | |
in path | PunchoutKey | string | oci | Required | The type of the Punchout |
200 - OK - The customer-specific configurations for the Punchout standard 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 or Punchout with the given ID could not be found.
This operation updates existing Punchout configurations. The 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.application.storefront.rest.b2b.capi.punchout.resource.PunchoutConfigurationListResource.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 | |
in path | PunchoutKey | string | oci | Required | The type of the Punchout |
200 - OK - The customer-specific configurations for the Punchout standard 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 or Punchout with the given ID could not be found.
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. 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.application.storefront.rest.b2b.capi.punchout.resource.PunchoutListResource.getAvailablePunchouts()
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.
/customers/{CustomerKey}/punchouts/{PunchoutKey}
This operation returns details of the selected Punchout standard. The authenticated user requires the permission APP_B2B_VIEW_PUNCHOUT or APP_B2B_SEND_OCI_BASKET. Either basketId
or searchTerm
is allowed.
public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutItemResource.getPunchoutItemDetails(java.lang.String,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID | |
in path | PunchoutKey | string | oci | Required | The type of the Punchout | |
in query | basketId | string | Returns the basket line item data according to Punchout configuration | ||
in query | searchTerm | string | Sony | Returns data of products that match the search term |
200 - OK - The details for the Punchout standard 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 or Punchout with the given ID could not be found.
This operation returns all available configuration options for the selected 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.application.storefront.rest.b2b.capi.punchout.resource.PunchoutItemResource.getPunchoutConfigurationOptions()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID | |
in path | PunchoutKey | string | oci | Required | The type of the Punchout |
200 - OK - The configuration options for the Punchout standard 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 or Punchout with the given ID could not be found.
This section covers operations for managing Punchout users. This includes retrieving information on users, creating a new user, updating user data as well as deleting specific users.
/customers/{CustomerKey}/punchouts/{PunchoutKey}/users
This operation returns all users for the selected 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.application.storefront.rest.b2b.capi.punchout.resource.PunchoutUserListResource.getPunchoutUsers()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID | |
in path | PunchoutKey | string | oci | Required | The type of the Punchout |
200 - OK - The 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 or punchout with the given ID could not be found.
This operation creates a new Punchout user. The ID property of PunchoutUser will be created automatically. The authenticated user must have the permission APP_B2B_MANAGE_PUNCHOUT.
public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutUserListResource.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 | |
in path | PunchoutKey | string | oci | Required | The type of the Punchout |
201 - Created - The 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 or Punchout with the given ID could not be found.
409 - Conflict - The Punchout user already exists.
Possible values for header 'error-key':
- punchout.login_already_exists.error
/customers/{CustomerKey}/punchouts/{PunchoutKey}/users/{PunchoutUserKey}
This operation returns information on the given Punchout user. The authenticated user requires the permissionAPP_B2B_MANAGE_PUNCHOUT.
public com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutUserRO com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutUserItemResource.getUserDetails()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID | |
in path | PunchoutKey | string | oci | Required | The type of the Punchout | |
in path | PunchoutUserKey | string | ociuser@test.intershop.de | Required | The ID of the Punchout user |
200 - OK - The details for the 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, Punchout or Punchout user with the given ID could not be found.
This operation updates the information of a Punchout user. The authenticated user requires the permission APP_B2B_MANAGE_PUNCHOUT.
The following user attributes can be updated:
email
- notifications for the Punchout user are send to this email address
password
- the configured password for the Punchout user
active
- flag to enable/disable the Punchout user
All attributes are optional, see request code examples below.
public com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutUserRO com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutUserItemResource.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 | PunchoutKey | string | oci | Required | The type of the Punchout | |
in path | PunchoutUserKey | string | ociuser@test.intershop.de | Required | The ID of the Punchout user |
200 - OK - The Punchout user data was 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, Punchout or Punchout user with the given ID could not be found.
This operation deletes a Punchout-specific 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.application.storefront.rest.b2b.capi.punchout.resource.PunchoutUserItemResource.deletePunchoutUser()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID | |
in path | PunchoutKey | string | oci | Required | The type of the Punchout | |
in path | PunchoutUserKey | string | ociuser@test.intershop.de | Required | The ID of the Punchout user |
204 - No Content - The 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, Punchout or Punchout user with the given ID could not be found.
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 a 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 a collection of PunchoutAvailablePlaceholderROsPunchoutAvailablePlaceholderRO
: This resource holds the available placeholders for the configuration as a collection of PunchoutAvailablePlaceholderROs.PunchoutAvailablePlaceholder
Currency
PunchoutConfigurationItemRO
objects. The configuration items as a collection of PunchoutConfigurationItemROsPunchoutConfigurationItemRO
: This resource holds the configuration items as a 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
PunchoutUser
oci1
ociuser1
ocitester@test.intershop.de
!InterShop00!
true
The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.