This API specification is available for download as an Open API 3.0 YAML file:
/customers/{CustomerKey}/punchouts
The Returned Resource Collection contains objets of type LinkRO
public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutListResource.getAvailablePunchouts()
Location | Name | Format | Description |
---|---|---|---|
in path | CustomerKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
200 - OK
401 - Unauthorized
403 - Forbidden
/customers/{CustomerKey}/punchouts/{PunchoutKey}
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 | Description |
---|---|---|---|
in path | CustomerKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
in path | PunchoutKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
in query | basketId | string | |
in query | searchTerm | string |
200 - OK
401 - Unauthorized
403 - Forbidden
public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutItemResource.getPunchoutConfigurationOptions()
Location | Name | Format | Description |
---|---|---|---|
in path | CustomerKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
in path | PunchoutKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
200 - OK
401 - Unauthorized
403 - Forbidden
/customers/{CustomerKey}/punchouts/{PunchoutKey}/configurations
public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutConfigurationListResource.getPunchoutConfiguration()
Location | Name | Format | Description |
---|---|---|---|
in path | CustomerKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
in path | PunchoutKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
200 - OK
401 - Unauthorized
403 - Forbidden
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 | Description |
---|---|---|---|
in path | CustomerKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
in path | PunchoutKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
200 - OK
401 - Unauthorized
403 - Forbidden
/customers/{CustomerKey}/punchouts/{PunchoutKey}/users
response ResourceCollectionRO 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 | Description |
---|---|---|---|
in path | CustomerKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
in path | PunchoutKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
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 | Description |
---|---|---|---|
in path | CustomerKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
in path | PunchoutKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
201 - Created
400 - Bad Request
401 - Unauthorized
403 - Forbidden
409 - Conflict
/customers/{CustomerKey}/punchouts/{PunchoutKey}/users/{PunchoutUserKey}
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 | Description |
---|---|---|---|
in path | CustomerKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
in path | PunchoutKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
in path | PunchoutUserKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
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 | Description |
---|---|---|---|
in path | CustomerKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
in path | PunchoutKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
in path | PunchoutUserKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutUserItemResource.deletePunchoutUser()
Location | Name | Format | Description |
---|---|---|---|
in path | CustomerKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
in path | PunchoutKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
in path | PunchoutUserKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
204 - No Content
401 - Unauthorized
403 - Forbidden
404 - Not 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
PunchoutConfigurationOptions
Show available configurations for OCI punchout
PunchoutAvailableFormatterRO
objects. The available formatters for the Configuration as Collection of PunchoutAvailableFormatterROsPunchoutAvailableFormatterRO
: The available formatters for the Configuration as Collection of PunchoutAvailableFormatterROsPunchoutAvailableFormatter
Trim
PunchoutAvailablePlaceholderRO
objects. The available placeholders for the Configuration as Collection of PunchoutAvailablePlaceholderROsPunchoutAvailablePlaceholderRO
: The available placeholders for the Configuration as Collection of PunchoutAvailablePlaceholderROsPunchoutAvailablePlaceholder
Currency
PunchoutConfiguration
PunchoutConfigurationItemRO
objects. The configuration Items as Collection of PunchoutConfigurationItemROsPunchoutConfigurationItemRO
: The configuration Items as Collection of PunchoutConfigurationItemROsPunchoutConfigurationItem
NEW_ITEM-MATGROUP
{ManufacturerName}
UpperCase
PunchoutConfigurationItemMappingRO
objects. The configuration Item Mappings as Collection of PunchoutConfigurationItemMappingROsPunchoutConfigurationItemMappingRO
: The configuration Item Mappings as Collection of PunchoutConfigurationItemMappingROsPunchoutConfigurationItemMapping
meter
m
PunchoutItem
oci
ver5
PunchoutDataRO
object. The Punchout Data as PunchoutDataROPunchoutData
PunchoutDataItemRO
objects.PunchoutDataItemRO
: The Punchout Data as Collection of PunchoutDataItemROsPunchoutDataItem
PunchoutDataItemFieldRO
objects. The Data Item Fields as Collection of PunchoutDataItemFieldROsPunchoutDataItemFieldRO
: NEW_ITEM-PRICE
PunchoutDataItemField
0.0
PunchoutDataItemFieldRO
objects.PunchoutDataItemFieldRO
: NEW_ITEM-PRICE
PunchoutDataItemField
0.0
PunchoutDataItemRO
objects. The Punchout Data as Collection of PunchoutDataItemROsPunchoutDataItemRO
: The Punchout Data as Collection of PunchoutDataItemROsPunchoutDataItem
PunchoutDataItemFieldRO
objects. The Data Item Fields as Collection of PunchoutDataItemFieldROsPunchoutDataItemFieldRO
: NEW_ITEM-PRICE
PunchoutDataItemField
0.0
PunchoutDataItemFieldRO
objects.PunchoutDataItemFieldRO
: NEW_ITEM-PRICE
PunchoutDataItemField
0.0
PunchoutUser
oci1
ociuser1
ocitester@test.intershop.de
!InterShop00!
true
object
literals.uri
string
literals.int32
INFORMATIONAL
SUCCESSFUL
REDIRECTION
CLIENT_ERROR
SERVER_ERROR
OTHER
string
literals.date-time
date-time
int32
int32
string
literals.string
literals.string
literals.uri
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.