Related Documents
Document Properties
Kbid
29L952
Last Modified
12-Oct-2021
Added to KB
09-Sep-2021
Public Access
Everyone
Status
Online
Doc Type
References
Product
ICM 7.10

Reference - Punchout API 2.2.0


Product Version

7.10.34.0

Product To Version


Status

Final

This API specification is available for download as an Open API 3.0 YAML file: 

References

The following page lists available REST APIs for ICM 7.10 and their version dependencies:

API Specification

Introduction

OpenAPI Version: 3.0.1
Punchout Version: 2.2.0-beta

The Intershop Punchout REST API contains resources for managing supported Punchout standards, Punchout configurations and Punchout users.
This includes updating configurations, creating, changing or deleting users or user data as well as retrieving information on available standards and options.

Accept Header

To use Version 2.x of the Punchout REST API, append the accept header application/vnd.intershop.punchout.v2+json to the request.

General API

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
GET: Returns supported Punchout standards Deprecated.

Description

This operation returns details on supported Punchout standards. Punchout standards are defined in the punchoutconfiguration.properties and for REST API explicitly. The returned resource collection contains objects of type LinkRO including all available Punchout standards.

To use this operation, an authenticated user with the permissions "View Punchout" (APP_B2B_VIEW_PUNCHOUT) or "Send OCI Cart" (APP_B2B_SEND_OCI_BASKET) is required.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.resource.PunchoutListResourceV2.getAvailablePunchouts_V2()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID

Response

200 - OK - The Punchout standards were successfully retrieved.

LinkROResourceCollectionRO application/vnd.intershop.punchout.v2+json

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.

OCI - Configuration API

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
GET: Returns customer-specific OCI Punchout configurations

Description

This operation returns the customer-specific configuration for the OCI Punchout standard.

To use this operation, an authenticated user with the permission "Manage Punchout" (APP_B2B_MANAGE_PUNCHOUT) is required.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutConfigurationListResource.getPunchoutConfiguration()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID

Response

200 - OK - The customer-specific configurations for the OCI Punchout were successfully retrieved.

PunchoutConfigurationRO application/vnd.intershop.punchout.v2+json

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.

PUT: Updates an existing OCI Punchout configuration

Description

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.

To use this operation, an authenticated user with the permission "Manage Punchout" (APP_B2B_MANAGE_PUNCHOUT) is required.

Java Method

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)

Request Body

PunchoutConfigurationRO */*

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID

Response

200 - OK - The customer-specific configurations for the OCI Punchout were successfully updated.

PunchoutConfigurationRO application/vnd.intershop.punchout.v2+json

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.

OCI - General API

This section covers operations for managing OCI Punchout. This includes retrieving details of the OCI standard or available options.

/customers/{CustomerKey}/punchouts/oci5
GET: Returns details for the OCI Punchout. If basketId is provided, it returns the basket line item data according to OCI Punchout configuration

Description

This operation returns details of the OCI Punchout standard. An optional parameter basketId can be provided to get a list of OCI Punchout fields for the basket with the given ID.

To use this operation, an authenticated user with the permissions "View Punchout" (APP_B2B_VIEW_PUNCHOUT) or "Send OCI Cart" (APP_B2B_SEND_OCI_BASKET) is required.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutItemResource.getPunchoutItemDetails(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in querybasketIdstringThe ID of the basket to get basket line item data according to OCI Punchout configuration.

Response

200 - OK - The details for the OCI Punchout were successfully retrieved.

PunchoutItemRO application/vnd.intershop.punchout.v2+json

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.

OPTIONS: Shows configuration options for the OCI Punchout

Description

This operation returns all available configuration options for the OCI Punchout standard.

To use this operation, an authenticated user with the permission "Manage Punchout" (APP_B2B_MANAGE_PUNCHOUT) is required.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutItemResource.getPunchoutConfigurationOptions()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID

Response

200 - OK - The configuration options for the OCI Punchout were successfully retrieved.

PunchoutConfigurationOptionsRO application/vnd.intershop.punchout.v2+json

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
GET: [BETA] Searches for products

Description

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 that matches the specified 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 concatenated and indexed. The fields have to be posted by the client to the external system.

To use this operation, an authenticated user with the permission "Send OCI Cart" (APP_B2B_SEND_OCI_BASKET) is required.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutFunctionBackgroundSearchResource.searchProducts(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in querysearchStringstringAcerRequired | The search string to search products for. The string must be enclosed in quotation marks if it contains special characters, e.g. "A-Data". Wildcards are not supported.

Response

200 - OK - The product search has been successfully executed

PunchoutTransferContainerRO application/vnd.intershop.punchout.v2+json

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
POST: [BETA] Triggers the OCI Punchout basket transfer

Description

This operation triggers the transfer of the OCI Punchout basket back to an external system, e.g. procurement system. The following steps are performed during this process:
*A product record in the OCI punchout format is returned for each line item in the basket. A record is a list of key-value pairs including all necessary transformations. Multiple records are concatenated and indexed. The fields have to be posted by the client to the external system.

  • All Punchout fields are returned as a list of key-value pairs including all necessary transformations. The fields have to be posted by the client to the procurement system.
  • The Punchout basket is closed and cannot be used anymore.
  • The Punchout workflow ends and is recorded for license purposes.

To use this operation, an authenticated user with the permission "Send OCI Cart" (APP_B2B_SEND_OCI_BASKET) is required.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutTransferResource.transferBasket(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in querybasketIdstringRequired | The ID of the OCI Punchout basket to be transferred

Response

200 - OK - The OCI Punchout basket transfer has been successfully triggered.

PunchoutTransferContainerRO application/vnd.intershop.punchout.v2+json

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
GET: [BETA] Validates a product with given id and quantity

Description

This 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).
When the product is 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.

To use this operation, an authenticated user with the permission "Send OCI Cart" (APP_B2B_SEND_OCI_BASKET) is required.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutFunctionValidateResource.validateProduct(java.lang.String,java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in queryproductIdstring6855851Required | The id of the product (SKU)
in queryquantitystring3The requested quantity. If field is not set, then default "1" is used.

Response

200 - OK - The product has been successfully validated

PunchoutTransferContainerRO application/vnd.intershop.punchout.v2+json

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.

OCI - User Management API

This section covers operations for managing OCI Punchout users. This includes retrieving information on users, creating new users, updating user data as well as deleting specific users.

/customers/{CustomerKey}/punchouts/oci5/users
GET: Returns OCI Punchout users

Description

This operation returns all users for the OCI Punchout standard. The response is of type ResourceCollectionRO and contains objects of type LinkRO.

To use this operation, an authenticated user with the permission "Manage Punchout" (APP_B2B_MANAGE_PUNCHOUT) is required.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutUserListResource.getPunchoutUsers()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID

Response

200 - OK - The OCI Punchout users were successfully retrieved.

LinkROResourceCollectionRO application/vnd.intershop.punchout.v2+json

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.

POST: Creates an OCI Punchout user

Description

This operation creates a new OCI Punchout user. The ID property of the Punchout user will be created automatically.

To use this operation, an authenticated user with the permission "Manage Punchout" (APP_B2B_MANAGE_PUNCHOUT) is required.

Java Method

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)

Request Body

PunchoutUserRO */*

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID

Response

201 - Created - The OCI Punchout user was successfully created.

LinkRO application/vnd.intershop.punchout.v2+json

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}
GET: Returns information on the given OCI Punchout user

Description

This operation returns information on the given OCI Punchout user.

To use this operation, an authenticated user with the permission "Manage Punchout" (APP_B2B_MANAGE_PUNCHOUT) is required.

Java Method

public com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutUserRO com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutUserItemResource.getUserDetails()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathOCIPunchoutUserKeystringociuser@test.intershop.deRequired | The ID of the OCI Punchout user

Response

200 - OK - The details for the OCI Punchout user were successfully retrieved.

PunchoutUserRO application/vnd.intershop.punchout.v2+json

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.

PUT: Updates OCI Punchout user data

Description

This operation updates the information of an OCI Punchout user.

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.

To use this operation, an authenticated user with the permission "Manage Punchout" (APP_B2B_MANAGE_PUNCHOUT) is required.

Java Method

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)

Request Body

PunchoutUserRO */*

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathOCIPunchoutUserKeystringociuser@test.intershop.deRequired | The ID of the OCI Punchout user

Response

200 - OK - The OCI Punchout user data were successfully updated.

PunchoutUserRO application/vnd.intershop.punchout.v2+json

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.

DELETE: Deletes an OCI Punchout specific user of a customer

Description

This operation deletes an OCI Punchout user of a customer.

To use this operation, an authenticated user with the permission "Manage Punchout" (APP_B2B_MANAGE_PUNCHOUT) is required.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutUserItemResource.deletePunchoutUser()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathOCIPunchoutUserKeystringociuser@test.intershop.deRequired | The ID of the OCI Punchout user

Response

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.

cXML - General API

This section covers operations for managing cXML Punchout. This includes retrieving details of the cXML standard or available options.

/customers/{CustomerKey}/punchouts/cxml1.2
GET: [BETA] Returns details for cXML Punchout

Description

This operation returns details of the cXML Punchout standard. An optional parameter basketId can be provided to get a list of cXML Punchout fields for the basket.

To use this operation, an authenticated user with the permissions "View punchout" (APP_B2B_VIEW_PUNCHOUT) or "Send cXML Cart" (APP_B2B_SEND_CXML_BASKET) is required.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.cxml.resource.CXMLPunchoutItemResource.getPunchoutItemDetails_V2(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in querybasketIdstringThe ID of the basket to get a list of cXML Punchout fields for

Response

200 - OK - The details for the cXML Punchout were successfully retrieved.

PunchoutItemRO application/vnd.intershop.punchout.v2+json

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 cXML Punchout is not supported.

/customers/{CustomerKey}/punchouts/cxml1.2/sessions/{CXMLPunchoutSessionKey}
GET: [BETA] Returns information on a specific cXML Punchout session

Description

This operation returns information on the given cXML Punchout session.

To use this operation, an authenticated user with the permission "Send cXML Cart" (APP_B2B_SEND_CXML_BASKET) is required.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.cxml.resource.CXMLPunchoutSessionItemResource.getSession()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathCXMLPunchoutSessionKeystringXYSZ12345Required | The ID of the cXML Punchout session (sid)

Response

200 - OK - The details for the cXML Punchout session were successfully retrieved.

CXMLSessionRO application/vnd.intershop.punchout.v2+json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer/cXML Punchout user could not be found or cXML Punchout is not supported.

/customers/{CustomerKey}/punchouts/cxml1.2/setuprequest
POST: [BETA] Creates a cXML Punchout session

Description

This operation performs a Punchout setup request. I.e. it initiates a new Punchout session and returns the URL to the web shop. The URL contains an access token and a session ID (sid) which can be used to get further information about the session.
This requires valid login credentials in the submitted cXML document.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.cxml.resource.CXMLPunchoutSetupRequestResource.setupRequest(javax.xml.transform.stream.StreamSource)

Request Body

Object */*

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID

Response

200 - OK - The cXML Punchout has been successfully triggered.

CXML text/xml

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 cXML Punchout is not supported.

/customers/{CustomerKey}/punchouts/cxml1.2/transfer
POST: [BETA] Triggers the cXML Punchout basket transfer

Description

This operation triggers the transfer of the cXML Punchout basket back to the external system, e.g. procurement system. The following steps are performed during this process:

  • An XML document (cXML Punchout format) including all line items of the basket is returned. The whole document has to be posted by the client to the procurement system.
  • The Punchout basket is closed and cannot be used anymore.
  • The Punchout workflow ends and is recorded for license purposes.

To use this operation, an authenticated user with the permission "Send cXML Cart" (APP_B2B_SEND_CXML_BASKET) is required.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.cxml.resource.CXMLPunchoutTransferBasketResource.transferBasket(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in querysidstringThe ID of the cXML Punchout session

Response

200 - OK - The cXML Punchout basket transfer has been successfully triggered.

CXML text/xml

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

cXML - User Management API

This section covers operations for managing cXML Punchout users. This includes retrieving information on users, creating new users, updating user data as well as deleting specific users.

/customers/{CustomerKey}/punchouts/cxml1.2/users
GET: [BETA] Returns cXML Punchout users

Description

This operation returns all users for the cXML Punchout standard. The response is of type ResourceCollectionRO and contains objects of type LinkRO.

To use this operation, an authenticated user with the permission "Manage Punchout" (APP_B2B_MANAGE_PUNCHOUT) is required.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.cxml.resource.CXMLPunchoutUserListResource.getPunchoutUsers()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID

Response

200 - OK - The cXML Punchout users were successfully retrieved.

LinkROResourceCollectionRO application/vnd.intershop.punchout.v2+json

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 cXML Punchout is not supported.

POST: [BETA] Creates a cXML Punchout user

Description

This operation creates a new cXML Punchout user and automatically assigns an ID.

To use this operation, an authenticated user with the permission "Manage Punchout" (APP_B2B_MANAGE_PUNCHOUT) is required.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.cxml.resource.CXMLPunchoutUserListResource.createPunchoutUser(com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutUserRO)

Request Body

PunchoutUserRO */*

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID

Response

201 - Created - The cXML Punchout user was successfully created.

LinkRO application/vnd.intershop.punchout.v2+json

400 - Bad Request - At least one attribute is missing in the request body or the credentials are not valid with regard to 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 cXML Punchout is not supported.

409 - Conflict - The cXML Punchout user already exists.
Possible values for header 'error-key':
- punchout.login_already_exists.error

/customers/{CustomerKey}/punchouts/cxml1.2/users/{CXMLPunchoutUserKey}
GET: [BETA] Returns information on the given cXML Punchout user

Description

This operation returns information on the given cXML Punchout user.

To use this operation, an authenticated user with the permission "Manage Punchout" (APP_B2B_MANAGE_PUNCHOUT) is required.

Java Method

public com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutUserRO com.intershop.sellside.rest.b2b.punchout.v2.capi.cxml.resource.CXMLPunchoutUserItemResource.getUserDetails()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathCXMLPunchoutUserKeystringcxmluser@test.intershop.deRequired | The ID of the cXML Punchout user

Response

200 - OK - The details for the cXML Punchout user were successfully retrieved.

PunchoutUserRO application/vnd.intershop.punchout.v2+json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer/cXML Punchout user could not be found or cXML Punchout is not supported.

PUT: [BETA] Updates cXML Punchout user data

Description

This operation updates the information of a cXML Punchout user. The following user attributes can be updated:

  • email - Notifications for the cXML Punchout user are send to this email address
  • password - The configured password for the cXML Punchout user
  • active - Flag to enable/disable the cXML Punchout user

All attributes are optional, see request code examples below.

To use this operation, an authenticated user with the permission "Manage Punchout" (APP_B2B_MANAGE_PUNCHOUT) is required.

Java Method

public com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutUserRO com.intershop.sellside.rest.b2b.punchout.v2.capi.cxml.resource.CXMLPunchoutUserItemResource.updatePunchoutUser(com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutUserRO)

Request Body

PunchoutUserRO */*

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathCXMLPunchoutUserKeystringcxmluser@test.intershop.deRequired | The ID of the cXML Punchout user

Response

200 - OK - The cXML Punchout user data were successfully updated.

PunchoutUserRO application/vnd.intershop.punchout.v2+json

400 - Bad Request - The credentials to be updated are not valid with regard to 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/cXML Punchout user could not be found or cXML Punchout is not supported.

DELETE: [BETA] Deletes a cXML Punchout user of a customer

Description

This operation deletes a cXML Punchout user of a customer.

To use this operation, an authenticated user with the permission "Manage Punchout" (APP_B2B_MANAGE_PUNCHOUT) is required.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.cxml.resource.CXMLPunchoutUserItemResource.deletePunchoutUser()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathCXMLPunchoutUserKeystringcxmluser@test.intershop.deRequired | The ID of the cXML Punchout user

Response

204 - No Content - The cXML 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/cXML Punchout user could not be found or cXML Punchout is not supported.

Request and Response Object Schemata

Object */*{
  • "publicId":
    string
  • "systemId":
    string
  • "inputStream":
    object
  • "reader":
    object
}
CXML text/xml{
  • "header":
    object
    A Header object.
    {
    • "from":
      object
      Required | A From object.
      {
      • "credential":
        array
        Required | An array of Credential objects.
        [
        Credential
        {
        • "identity":
          object
          Required | A Identity object.
          {
          • "content":
            array
            An array of object literals.
          • "lastChangedTimestamp":
            string
          }
        • "cxmlAuthentication":
          object
          {
          • "name":
            object
            The name of the returned element
            {
            • "namespaceURI":
              string
            • "localPart":
              string
            • "prefix":
              string
            }
          • "value":
            object
          • "nil":
            boolean
          • "typeSubstituted":
            boolean
          • "globalScope":
            boolean
          }
        • "domain":
          string
        • "type":
          string
          The type of the object. This is normally a constant that can be used to differentiate objects by their type.
        }
        ]
      • "correspondent":
        object
        A Correspondent object.
        {
        • "contact":
          array
          Required | An array of Contact objects.
          [
          Contact
          {
          • "name":
            object
            Required | A Name object.
            {
            • "content":
              string
            • "lang":
              string
            }
          • "postalAddress":
            array
            An array of PostalAddress objects.
            [
            PostalAddress
            {
            • "deliverTo":
              array
              An array of string literals.
            • "street":
              array
              Required | An array of string literals.
            • "city":
              object
              Required | A City object.
              {
              • "content":
                string
              • "cityCode":
                string
              }
            • "municipality":
              object
              A Municipality object.
              {
              • "content":
                string
              • "municipalityCode":
                string
              }
            • "state":
              object
              A State object.
              {
              • "content":
                string
              • "isoStateCode":
                string
              }
            • "postalCode":
              string
            • "country":
              object
              Required | A Country object.
              {
              • "content":
                string
              • "isoCountryCode":
                string
              }
            • "extrinsic":
              array
              An array of Extrinsic objects.
              [
              Extrinsic
              {
              • "content":
                array
                An array of object literals.
              • "name":
                string
                The name of an element.
              }
              ]
            • "name":
              string
              The name of an element.
            }
            ]
          • "email":
            array
            An array of Email objects.
            [
            Email
            {
            • "content":
              string
            • "name":
              string
              The name of an element.
            • "preferredLang":
              string
            }
            ]
          • "phone":
            array
            An array of Phone objects.
            [
            Phone
            {
            • "telephoneNumber":
              object
              Required | A TelephoneNumber object.
              {
              • "countryCode":
                object
                Required | A CountryCode object.
                {
                • "content":
                  string
                • "isoCountryCode":
                  string
                }
              • "areaOrCityCode":
                string
                Required
              • "number":
                string
                Required
              • "extension":
                string
              }
            • "name":
              string
              The name of an element.
            }
            ]
          • "fax":
            array
            An array of Fax objects.
            [
            Fax
            {
            • "telephoneNumber":
              object
              A TelephoneNumber object.
              {
              • "countryCode":
                object
                Required | A CountryCode object.
                {
                • "content":
                  string
                • "isoCountryCode":
                  string
                }
              • "areaOrCityCode":
                string
                Required
              • "number":
                string
                Required
              • "extension":
                string
              }
            • "url":
              object
              A URL object.
              {
              • "content":
                string
              • "name":
                string
                The name of an element.
              }
            • "email":
              object
              A Email object.
              {
              • "content":
                string
              • "name":
                string
                The name of an element.
              • "preferredLang":
                string
              }
            • "name":
              string
              The name of an element.
            }
            ]
          • "url":
            array
            An array of URL objects.
            [
            URL
            {
            • "content":
              string
            • "name":
              string
              The name of an element.
            }
            ]
          • "idReference":
            array
            An array of IdReference objects.
            [
            IdReference
            {
            • "creator":
              object
              A Creator object.
              {
              • "content":
                string
              • "lang":
                string
              }
            • "description":
              object
              A Description object.
              {
              • "content":
                array
                An array of object literals.
              • "lang":
                string
              • "type":
                string
                The type of the object. This is normally a constant that can be used to differentiate objects by their type.
              }
            • "identifier":
              string
            • "domain":
              string
            }
            ]
          • "extrinsic":
            array
            An array of Extrinsic objects.
            [
            Extrinsic
            {
            • "content":
              array
              An array of object literals.
            • "name":
              string
              The name of an element.
            }
            ]
          • "role":
            string
          • "addressID":
            string
          • "addressIDDomain":
            string
          }
          ]
        • "routing":
          object
          A Routing object.
          {
          • "destination":
            string
          }
        • "extrinsic":
          array
          An array of Extrinsic objects.
          [
          Extrinsic
          {
          • "content":
            array
            An array of object literals.
          • "name":
            string
            The name of an element.
          }
          ]
        • "preferredLanguage":
          string
        }
      }
    • "to":
      object
      Required | A To object.
      {
      • "credential":
        array
        Required | An array of Credential objects.
        [
        Credential
        {
        • "identity":
          object
          Required | A Identity object.
          {
          • "content":
            array
            An array of object literals.
          • "lastChangedTimestamp":
            string
          }
        • "cxmlAuthentication":
          object
          {
          • "name":
            object
            The name of the returned element
            {
            • "namespaceURI":
              string
            • "localPart":
              string
            • "prefix":
              string
            }
          • "value":
            object
          • "nil":
            boolean
          • "typeSubstituted":
            boolean
          • "globalScope":
            boolean
          }
        • "domain":
          string
        • "type":
          string
          The type of the object. This is normally a constant that can be used to differentiate objects by their type.
        }
        ]
      • "correspondent":
        object
        A Correspondent object.
        {
        • "contact":
          array
          Required | An array of Contact objects.
          [
          Contact
          {
          • "name":
            object
            Required | A Name object.
            {
            • "content":
              string
            • "lang":
              string
            }
          • "postalAddress":
            array
            An array of PostalAddress objects.
            [
            PostalAddress
            {
            • "deliverTo":
              array
              An array of string literals.
            • "street":
              array
              Required | An array of string literals.
            • "city":
              object
              Required | A City object.
              {
              • "content":
                string
              • "cityCode":
                string
              }
            • "municipality":
              object
              A Municipality object.
              {
              • "content":
                string
              • "municipalityCode":
                string
              }
            • "state":
              object
              A State object.
              {
              • "content":
                string
              • "isoStateCode":
                string
              }
            • "postalCode":
              string
            • "country":
              object
              Required | A Country object.
              {
              • "content":
                string
              • "isoCountryCode":
                string
              }
            • "extrinsic":
              array
              An array of Extrinsic objects.
              [
              Extrinsic
              {
              • "content":
                array
                An array of object literals.
              • "name":
                string
                The name of an element.
              }
              ]
            • "name":
              string
              The name of an element.
            }
            ]
          • "email":
            array
            An array of Email objects.
            [
            Email
            {
            • "content":
              string
            • "name":
              string
              The name of an element.
            • "preferredLang":
              string
            }
            ]
          • "phone":
            array
            An array of Phone objects.
            [
            Phone
            {
            • "telephoneNumber":
              object
              Required | A TelephoneNumber object.
              {
              • "countryCode":
                object
                Required | A CountryCode object.
                {
                • "content":
                  string
                • "isoCountryCode":
                  string
                }
              • "areaOrCityCode":
                string
                Required
              • "number":
                string
                Required
              • "extension":
                string
              }
            • "name":
              string
              The name of an element.
            }
            ]
          • "fax":
            array
            An array of Fax objects.
            [
            Fax
            {
            • "telephoneNumber":
              object
              A TelephoneNumber object.
              {
              • "countryCode":
                object
                Required | A CountryCode object.
                {
                • "content":
                  string
                • "isoCountryCode":
                  string
                }
              • "areaOrCityCode":
                string
                Required
              • "number":
                string
                Required
              • "extension":
                string
              }
            • "url":
              object
              A URL object.
              {
              • "content":
                string
              • "name":
                string
                The name of an element.
              }
            • "email":
              object
              A Email object.
              {
              • "content":
                string
              • "name":
                string
                The name of an element.
              • "preferredLang":
                string
              }
            • "name":
              string
              The name of an element.
            }
            ]
          • "url":
            array
            An array of URL objects.
            [
            URL
            {
            • "content":
              string
            • "name":
              string
              The name of an element.
            }
            ]
          • "idReference":
            array
            An array of IdReference objects.
            [
            IdReference
            {
            • "creator":
              object
              A Creator object.
              {
              • "content":
                string
              • "lang":
                string
              }
            • "description":
              object
              A Description object.
              {
              • "content":
                array
                An array of object literals.
              • "lang":
                string
              • "type":
                string
                The type of the object. This is normally a constant that can be used to differentiate objects by their type.
              }
            • "identifier":
              string
            • "domain":
              string
            }
            ]
          • "extrinsic":
            array
            An array of Extrinsic objects.
            [
            Extrinsic
            {
            • "content":
              array
              An array of object literals.
            • "name":
              string
              The name of an element.
            }
            ]
          • "role":
            string
          • "addressID":
            string
          • "addressIDDomain":
            string
          }
          ]
        • "routing":
          object
          A Routing object.
          {
          • "destination":
            string
          }
        • "extrinsic":
          array
          An array of Extrinsic objects.
          [
          Extrinsic
          {
          • "content":
            array
            An array of object literals.
          • "name":
            string
            The name of an element.
          }
          ]
        • "preferredLanguage":
          string
        }
      }
    • "sender":
      object
      Required | A Sender object.
      {
      • "credential":
        array
        Required | An array of Credential objects.
        [
        Credential
        {
        • "identity":
          object
          Required | A Identity object.
          {
          • "content":
            array
            An array of object literals.
          • "lastChangedTimestamp":
            string
          }
        • "cxmlAuthentication":
          object
          {
          • "name":
            object
            The name of the returned element
            {
            • "namespaceURI":
              string
            • "localPart":
              string
            • "prefix":
              string
            }
          • "value":
            object
          • "nil":
            boolean
          • "typeSubstituted":
            boolean
          • "globalScope":
            boolean
          }
        • "domain":
          string
        • "type":
          string
          The type of the object. This is normally a constant that can be used to differentiate objects by their type.
        }
        ]
      • "userAgent":
        string
        Required
      }
    • "path":
      object
      A Path object.
      {
      • "node":
        array
        Required | An array of Node objects.
        [
        Node
        {
        • "credential":
          array
          Required | An array of Credential objects.
          [
          Credential
          {
          • "identity":
            object
            Required | A Identity object.
            {
            • "content":
              array
              An array of object literals.
            • "lastChangedTimestamp":
              string
            }
          • "cxmlAuthentication":
            object
            {
            • "name":
              object
              The name of the returned element
              {
              • "namespaceURI":
                string
              • "localPart":
                string
              • "prefix":
                string
              }
            • "value":
              object
            • "nil":
              boolean
            • "typeSubstituted":
              boolean
            • "globalScope":
              boolean
            }
          • "domain":
            string
          • "type":
            string
            The type of the object. This is normally a constant that can be used to differentiate objects by their type.
          }
          ]
        • "type":
          string
          The type of the object. This is normally a constant that can be used to differentiate objects by their type.
        • "itemDetailsRequired":
          string
        }
        ]
      }
    • "originalDocument":
      object
      A OriginalDocument object.
      {
      • "payloadID":
        string
      }
    }
  • "message":
    object
    A Message object.
    {
    • "status":
      object
      A Status object.
      {
      • "content":
        string
      • "code":
        string
      • "text":
        string
      • "lang":
        string
      }
    • "cxmlMessages":
      object
      {
      • "name":
        object
        The name of the returned element
        {
        • "namespaceURI":
          string
        • "localPart":
          string
        • "prefix":
          string
        }
      • "value":
        object
      • "nil":
        boolean
      • "typeSubstituted":
        boolean
      • "globalScope":
        boolean
      }
    • "deploymentMode":
      string
    • "inReplyTo":
      string
    • "id":
      string
    }
  • "request":
    object
    A Request object.
    {
    • "cxmlRequests":
      object
      {
      • "name":
        object
        The name of the returned element
        {
        • "namespaceURI":
          string
        • "localPart":
          string
        • "prefix":
          string
        }
      • "value":
        object
      • "nil":
        boolean
      • "typeSubstituted":
        boolean
      • "globalScope":
        boolean
      }
    • "deploymentMode":
      string
    • "id":
      string
    }
  • "response":
    object
    A Response object.
    {
    • "status":
      object
      A Status object.
      {
      • "content":
        string
      • "code":
        string
      • "text":
        string
      • "lang":
        string
      }
    • "profileResponse":
      object
      A ProfileResponse object.
      {
      • "option":
        array
        An array of Option objects.
        [
        Option
        {
        • "content":
          string
        • "name":
          string
          The name of an element.
        • "adtype":
          array
          An array of string literals.
        }
        ]
      • "transaction":
        array
        Required | An array of Transaction objects.
        [
        Transaction
        {
        • "url":
          object
          Required | A URL object.
          {
          • "content":
            string
          • "name":
            string
            The name of an element.
          }
        • "option":
          array
          An array of Option objects.
          [
          Option
          {
          • "content":
            string
          • "name":
            string
            The name of an element.
          • "adtype":
            array
            An array of string literals.
          }
          ]
        • "requestName":
          string
        • "adtype":
          array
          An array of string literals.
        }
        ]
      • "effectiveDate":
        string
      • "lastRefresh":
        string
      • "adtype":
        array
        An array of string literals.
      }
    • "punchOutSetupResponse":
      object
      A StartPageElement object.
      {
      • "startPage":
        object
        Required | A StartPage object.
        {
        • "url":
          object
          Required | A URL object.
          {
          • "content":
            string
          • "name":
            string
            The name of an element.
          }
        }
      }
    • "providerSetupResponse":
      object
      A StartPageElement object.
      {
      • "startPage":
        object
        Required | A StartPage object.
        {
        • "url":
          object
          Required | A URL object.
          {
          • "content":
            string
          • "name":
            string
            The name of an element.
          }
        }
      }
    • "getPendingResponse":
      object
      A GetPendingResponse object.
      {
      • "cxml":
        array
        Required | An array of CXML objects.
        [
        CXML
        {
        • "header":
          object
          A Header object.
          {
          • "from":
            object
            Required | A From object.
            {
            • "credential":
              array
              Required | An array of Credential objects.
              [
              Credential
              {
              • "identity":
                object
                Required | A Identity object.
                {
                • "content":
                  array
                  An array of object literals.
                • "lastChangedTimestamp":
                  string
                }
              • "cxmlAuthentication":
                object
                {
                • "name":
                  object
                  The name of the returned element
                  {
                  • "namespaceURI":
                    string
                  • "localPart":
                    string
                  • "prefix":
                    string
                  }
                • "value":
                  object
                • "nil":
                  boolean
                • "typeSubstituted":
                  boolean
                • "globalScope":
                  boolean
                }
              • "domain":
                string
              • "type":
                string
                The type of the object. This is normally a constant that can be used to differentiate objects by their type.
              }
              ]
            • "correspondent":
              object
              A Correspondent object.
              {
              • "contact":
                array
                Required | An array of Contact objects.
                [
                Contact
                {
                • "name":
                  object
                  Required | A Name object.
                  {
                  • "content":
                    string
                  • "lang":
                    string
                  }
                • "postalAddress":
                  array
                  An array of PostalAddress objects.
                  [
                  PostalAddress
                  {
                  • "deliverTo":
                    array
                    An array of string literals.
                  • "street":
                    array
                    Required | An array of string literals.
                  • "city":
                    object
                    Required | A City object.
                    {
                    • "content":
                      string
                    • "cityCode":
                      string
                    }
                  • "municipality":
                    object
                    A Municipality object.
                    {
                    • "content":
                      string
                    • "municipalityCode":
                      string
                    }
                  • "state":
                    object
                    A State object.
                    {
                    • "content":
                      string
                    • "isoStateCode":
                      string
                    }
                  • "postalCode":
                    string
                  • "country":
                    object
                    Required | A Country object.
                    {
                    • "content":
                      string
                    • "isoCountryCode":
                      string
                    }
                  • "extrinsic":
                    array
                    An array of Extrinsic objects.
                    [
                    Extrinsic
                    {
                    • "content":
                      array
                      An array of object literals.
                    • "name":
                      string
                      The name of an element.
                    }
                    ]
                  • "name":
                    string
                    The name of an element.
                  }
                  ]
                • "email":
                  array
                  An array of Email objects.
                  [
                  Email
                  {
                  • "content":
                    string
                  • "name":
                    string
                    The name of an element.
                  • "preferredLang":
                    string
                  }
                  ]
                • "phone":
                  array
                  An array of Phone objects.
                  [
                  Phone
                  {
                  • "telephoneNumber":
                    object
                    Required | A TelephoneNumber object.
                    {
                    • "countryCode":
                      object
                      Required | A CountryCode object.
                      {
                      • "content":
                        string
                      • "isoCountryCode":
                        string
                      }
                    • "areaOrCityCode":
                      string
                      Required
                    • "number":
                      string
                      Required
                    • "extension":
                      string
                    }
                  • "name":
                    string
                    The name of an element.
                  }
                  ]
                • "fax":
                  array
                  An array of Fax objects.
                  [
                  Fax
                  {
                  • "telephoneNumber":
                    object
                    A TelephoneNumber object.
                    {
                    • "countryCode":
                      object
                      Required | A CountryCode object.
                      {
                      • "content":
                        string
                      • "isoCountryCode":
                        string
                      }
                    • "areaOrCityCode":
                      string
                      Required
                    • "number":
                      string
                      Required
                    • "extension":
                      string
                    }
                  • "url":
                    object
                    A URL object.
                    {
                    • "content":
                      string
                    • "name":
                      string
                      The name of an element.
                    }
                  • "email":
                    object
                    A Email object.
                    {
                    • "content":
                      string
                    • "name":
                      string
                      The name of an element.
                    • "preferredLang":
                      string
                    }
                  • "name":
                    string
                    The name of an element.
                  }
                  ]
                • "url":
                  array
                  An array of URL objects.
                  [
                  URL
                  {
                  • "content":
                    string
                  • "name":
                    string
                    The name of an element.
                  }
                  ]
                • "idReference":
                  array
                  An array of IdReference objects.
                  [
                  IdReference
                  {
                  • "creator":
                    object
                    A Creator object.
                    {
                    • "content":
                      string
                    • "lang":
                      string
                    }
                  • "description":
                    object
                    A Description object.
                    {
                    • "content":
                      array
                      An array of object literals.
                    • "lang":
                      string
                    • "type":
                      string
                      The type of the object. This is normally a constant that can be used to differentiate objects by their type.
                    }
                  • "identifier":
                    string
                  • "domain":
                    string
                  }
                  ]
                • "extrinsic":
                  array
                  An array of Extrinsic objects.
                  [
                  Extrinsic
                  {
                  • "content":
                    array
                    An array of object literals.
                  • "name":
                    string
                    The name of an element.
                  }
                  ]
                • "role":
                  string
                • "addressID":
                  string
                • "addressIDDomain":
                  string
                }
                ]
              • "routing":
                object
                A Routing object.
                {
                • "destination":
                  string
                }
              • "extrinsic":
                array
                An array of Extrinsic objects.
                [
                Extrinsic
                {
                • "content":
                  array
                  An array of object literals.
                • "name":
                  string
                  The name of an element.
                }
                ]
              • "preferredLanguage":
                string
              }
            }
          • "to":
            object
            Required | A To object.
            {
            • "credential":
              array
              Required | An array of Credential objects.
              [
              Credential
              {
              • "identity":
                object
                Required | A Identity object.
                {
                • "content":
                  array
                  An array of object literals.
                • "lastChangedTimestamp":
                  string
                }
              • "cxmlAuthentication":
                object
                {
                • "name":
                  object
                  The name of the returned element
                  {
                  • "namespaceURI":
                    string
                  • "localPart":
                    string
                  • "prefix":
                    string
                  }
                • "value":
                  object
                • "nil":
                  boolean
                • "typeSubstituted":
                  boolean
                • "globalScope":
                  boolean
                }
              • "domain":
                string
              • "type":
                string
                The type of the object. This is normally a constant that can be used to differentiate objects by their type.
              }
              ]
            • "correspondent":
              object
              A Correspondent object.
              {
              • "contact":
                array
                Required | An array of Contact objects.
                [
                Contact
                {
                • "name":
                  object
                  Required | A Name object.
                  {
                  • "content":
                    string
                  • "lang":
                    string
                  }
                • "postalAddress":
                  array
                  An array of PostalAddress objects.
                  [
                  PostalAddress
                  {
                  • "deliverTo":
                    array
                    An array of string literals.
                  • "street":
                    array
                    Required | An array of string literals.
                  • "city":
                    object
                    Required | A City object.
                    {
                    • "content":
                      string
                    • "cityCode":
                      string
                    }
                  • "municipality":
                    object
                    A Municipality object.
                    {
                    • "content":
                      string
                    • "municipalityCode":
                      string
                    }
                  • "state":
                    object
                    A State object.
                    {
                    • "content":
                      string
                    • "isoStateCode":
                      string
                    }
                  • "postalCode":
                    string
                  • "country":
                    object
                    Required | A Country object.
                    {
                    • "content":
                      string
                    • "isoCountryCode":
                      string
                    }
                  • "extrinsic":
                    array
                    An array of Extrinsic objects.
                    [
                    Extrinsic
                    {
                    • "content":
                      array
                      An array of object literals.
                    • "name":
                      string
                      The name of an element.
                    }
                    ]
                  • "name":
                    string
                    The name of an element.
                  }
                  ]
                • "email":
                  array
                  An array of Email objects.
                  [
                  Email
                  {
                  • "content":
                    string
                  • "name":
                    string
                    The name of an element.
                  • "preferredLang":
                    string
                  }
                  ]
                • "phone":
                  array
                  An array of Phone objects.
                  [
                  Phone
                  {
                  • "telephoneNumber":
                    object
                    Required | A TelephoneNumber object.
                    {
                    • "countryCode":
                      object
                      Required | A CountryCode object.
                      {
                      • "content":
                        string
                      • "isoCountryCode":
                        string
                      }
                    • "areaOrCityCode":
                      string
                      Required
                    • "number":
                      string
                      Required
                    • "extension":
                      string
                    }
                  • "name":
                    string
                    The name of an element.
                  }
                  ]
                • "fax":
                  array
                  An array of Fax objects.
                  [
                  Fax
                  {
                  • "telephoneNumber":
                    object
                    A TelephoneNumber object.
                    {
                    • "countryCode":
                      object
                      Required | A CountryCode object.
                      {
                      • "content":
                        string
                      • "isoCountryCode":
                        string
                      }
                    • "areaOrCityCode":
                      string
                      Required
                    • "number":
                      string
                      Required
                    • "extension":
                      string
                    }
                  • "url":
                    object
                    A URL object.
                    {
                    • "content":
                      string
                    • "name":
                      string
                      The name of an element.
                    }
                  • "email":
                    object
                    A Email object.
                    {
                    • "content":
                      string
                    • "name":
                      string
                      The name of an element.
                    • "preferredLang":
                      string
                    }
                  • "name":
                    string
                    The name of an element.
                  }
                  ]
                • "url":
                  array
                  An array of URL objects.
                  [
                  URL
                  {
                  • "content":
                    string
                  • "name":
                    string
                    The name of an element.
                  }
                  ]
                • "idReference":
                  array
                  An array of IdReference objects.
                  [
                  IdReference
                  {
                  • "creator":
                    object
                    A Creator object.
                    {
                    • "content":
                      string
                    • "lang":
                      string
                    }
                  • "description":
                    object
                    A Description object.
                    {
                    • "content":
                      array
                      An array of object literals.
                    • "lang":
                      string
                    • "type":
                      string
                      The type of the object. This is normally a constant that can be used to differentiate objects by their type.
                    }
                  • "identifier":
                    string
                  • "domain":
                    string
                  }
                  ]
                • "extrinsic":
                  array
                  An array of Extrinsic objects.
                  [
                  Extrinsic
                  {
                  • "content":
                    array
                    An array of object literals.
                  • "name":
                    string
                    The name of an element.
                  }
                  ]
                • "role":
                  string
                • "addressID":
                  string
                • "addressIDDomain":
                  string
                }
                ]
              • "routing":
                object
                A Routing object.
                {
                • "destination":
                  string
                }
              • "extrinsic":
                array
                An array of Extrinsic objects.
                [
                Extrinsic
                {
                • "content":
                  array
                  An array of object literals.
                • "name":
                  string
                  The name of an element.
                }
                ]
              • "preferredLanguage":
                string
              }
            }
          • "sender":
            object
            Required | A Sender object.
            {
            • "credential":
              array
              Required | An array of Credential objects.
              [
              Credential
              {
              • "identity":
                object
                Required | A Identity object.
                {
                • "content":
                  array
                  An array of object literals.
                • "lastChangedTimestamp":
                  string
                }
              • "cxmlAuthentication":
                object
                {
                • "name":
                  object
                  The name of the returned element
                  {
                  • "namespaceURI":
                    string
                  • "localPart":
                    string
                  • "prefix":
                    string
                  }
                • "value":
                  object
                • "nil":
                  boolean
                • "typeSubstituted":
                  boolean
                • "globalScope":
                  boolean
                }
              • "domain":
                string
              • "type":
                string
                The type of the object. This is normally a constant that can be used to differentiate objects by their type.
              }
              ]
            • "userAgent":
              string
              Required
            }
          • "path":
            object
            A Path object.
            {
            • "node":
              array
              Required | An array of Node objects.
              [
              Node
              {
              • "credential":
                array
                Required | An array of Credential objects.
                [
                Credential
                {
                • "identity":
                  object
                  Required | A Identity object.
                  {
                  • "content":
                    array
                    An array of object literals.
                  • "lastChangedTimestamp":
                    string
                  }
                • "cxmlAuthentication":
                  object
                  {
                  • "name":
                    object
                    The name of the returned element
                    {
                    • "namespaceURI":
                      string
                    • "localPart":
                      string
                    • "prefix":
                      string
                    }
                  • "value":
                    object
                  • "nil":
                    boolean
                  • "typeSubstituted":
                    boolean
                  • "globalScope":
                    boolean
                  }
                • "domain":
                  string
                • "type":
                  string
                  The type of the object. This is normally a constant that can be used to differentiate objects by their type.
                }
                ]
              • "type":
                string
                The type of the object. This is normally a constant that can be used to differentiate objects by their type.
              • "itemDetailsRequired":
                string
              }
              ]
            }
          • "originalDocument":
            object
            A OriginalDocument object.
            {
            • "payloadID":
              string
            }
          }
        • "message":
          object
          A Message object.
          {
          • "status":
            object
            A Status object.
            {
            • "content":
              string
            • "code":
              string
            • "text":
              string
            • "lang":
              string
            }
          • "cxmlMessages":
            object
            {
            • "name":
              object
              The name of the returned element
              {
              • "namespaceURI":
                string
              • "localPart":
                string
              • "prefix":
                string
              }
            • "value":
              object
            • "nil":
              boolean
            • "typeSubstituted":
              boolean
            • "globalScope":
              boolean
            }
          • "deploymentMode":
            string
          • "inReplyTo":
            string
          • "id":
            string
          }
        • "request":
          object
          A Request object.
          {
          • "cxmlRequests":
            object
            {
            • "name":
              object
              The name of the returned element
              {
              • "namespaceURI":
                string
              • "localPart":
                string
              • "prefix":
                string
              }
            • "value":
              object
            • "nil":
              boolean
            • "typeSubstituted":
              boolean
            • "globalScope":
              boolean
            }
          • "deploymentMode":
            string
          • "id":
            string
          }
        • "response":
          object
          A Response object.
          {
          • "status":
            object
            A Status object.
            {
            • "content":
              string
            • "code":
              string
            • "text":
              string
            • "lang":
              string
            }
          • "profileResponse":
            object
            A ProfileResponse object.
            {
            • "option":
              array
              An array of Option objects.
              [
              Option
              {
              • "content":
                string
              • "name":
                string
                The name of an element.
              • "adtype":
                array
                An array of string literals.
              }
              ]
            • "transaction":
              array
              Required | An array of Transaction objects.
              [
              Transaction
              {
              • "url":
                object
                Required | A URL object.
                {
                • "content":
                  string
                • "name":
                  string
                  The name of an element.
                }
              • "option":
                array
                An array of Option objects.
                [
                Option
                {
                • "content":
                  string
                • "name":
                  string
                  The name of an element.
                • "adtype":
                  array
                  An array of string literals.
                }
                ]
              • "requestName":
                string
              • "adtype":
                array
                An array of string literals.
              }
              ]
            • "effectiveDate":
              string
            • "lastRefresh":
              string
            • "adtype":
              array
              An array of string literals.
            }
          • "punchOutSetupResponse":
            object
            A StartPageElement object.
            {
            • "startPage":
              object
              Required | A StartPage object.
              {
              • "url":
                object
                Required | A URL object.
                {
                • "content":
                  string
                • "name":
                  string
                  The name of an element.
                }
              }
            }
          • "providerSetupResponse":
            object
            A StartPageElement object.
            {
            • "startPage":
              object
              Required | A StartPage object.
              {
              • "url":
                object
                Required | A URL object.
                {
                • "content":
                  string
                • "name":
                  string
                  The name of an element.
                }
              }
            }
          • "getPendingResponse":
            object
            A GetPendingResponse object.
            {
            • "cxml":
              array
              Required | An array of CXML objects.
              [
              CXML
              {
              • "header":
                object
                A Header object.
                {
                • "from":
                  object
                  Required | A From object.
                  {
                  • "credential":
                    array
                    Required | An array of Credential objects.
                    [
                    Credential
                    {
                    • "identity":
                      object
                      Required | A Identity object.
                      {
                      • "content":
                        array
                        An array of object literals.
                      • "lastChangedTimestamp":
                        string
                      }
                    • "cxmlAuthentication":
                      object
                      {
                      • "name":
                        object
                        The name of the returned element
                        {
                        • "namespaceURI":
                          string
                        • "localPart":
                          string
                        • "prefix":
                          string
                        }
                      • "value":
                        object
                      • "nil":
                        boolean
                      • "typeSubstituted":
                        boolean
                      • "globalScope":
                        boolean
                      }
                    • "domain":
                      string
                    • "type":
                      string
                      The type of the object. This is normally a constant that can be used to differentiate objects by their type.
                    }
                    ]
                  • "correspondent":
                    object
                    A Correspondent object.
                    {
                    • "contact":
                      array
                      Required | An array of Contact objects.
                      [
                      Contact
                      {
                      • "name":
                        object
                        Required | A Name object.
                        {
                        • "content":
                          string
                        • "lang":
                          string
                        }
                      • "postalAddress":
                        array
                        An array of PostalAddress objects.
                        [
                        PostalAddress
                        {
                        • "deliverTo":
                          array
                          An array of string literals.
                        • "street":
                          array
                          Required | An array of string literals.
                        • "city":
                          object
                          Required | A City object.
                          {
                          • "content":
                            string
                          • "cityCode":
                            string
                          }
                        • "municipality":
                          object
                          A Municipality object.
                          {
                          • "content":
                            string
                          • "municipalityCode":
                            string
                          }
                        • "state":
                          object
                          A State object.
                          {
                          • "content":
                            string
                          • "isoStateCode":
                            string
                          }
                        • "postalCode":
                          string
                        • "country":
                          object
                          Required | A Country object.
                          {
                          • "content":
                            string
                          • "isoCountryCode":
                            string
                          }
                        • "extrinsic":
                          array
                          An array of Extrinsic objects.
                          [
                          Extrinsic
                          {
                          • "content":
                            array
                            An array of object literals.
                          • "name":
                            string
                            The name of an element.
                          }
                          ]
                        • "name":
                          string
                          The name of an element.
                        }
                        ]
                      • "email":
                        array
                        An array of Email objects.
                        [
                        Email
                        {
                        • "content":
                          string
                        • "name":
                          string
                          The name of an element.
                        • "preferredLang":
                          string
                        }
                        ]
                      • "phone":
                        array
                        An array of Phone objects.
                        [
                        Phone
                        {
                        • "telephoneNumber":
                          object
                          Required | A TelephoneNumber object.
                          {
                          • "countryCode":
                            object
                            Required | A CountryCode object.
                            {
                            • "content":
                              string
                            • "isoCountryCode":
                              string
                            }
                          • "areaOrCityCode":
                            string
                            Required
                          • "number":
                            string
                            Required
                          • "extension":
                            string
                          }
                        • "name":
                          string
                          The name of an element.
                        }
                        ]
                      • "fax":
                        array
                        An array of Fax objects.
                        [
                        Fax
                        {
                        • "telephoneNumber":
                          object
                          A TelephoneNumber object.
                          {
                          • "countryCode":
                            object
                            Required | A CountryCode object.
                            {
                            • "content":
                              string
                            • "isoCountryCode":
                              string
                            }
                          • "areaOrCityCode":
                            string
                            Required
                          • "number":
                            string
                            Required
                          • "extension":
                            string
                          }
                        • "url":
                          object
                          A URL object.
                          {
                          • "content":
                            string
                          • "name":
                            string
                            The name of an element.
                          }
                        • "email":
                          object
                          A Email object.
                          {
                          • "content":
                            string
                          • "name":
                            string
                            The name of an element.
                          • "preferredLang":
                            string
                          }
                        • "name":
                          string
                          The name of an element.
                        }
                        ]
                      • "url":
                        array
                        An array of URL objects.
                        [
                        URL
                        {
                        • "content":
                          string
                        • "name":
                          string
                          The name of an element.
                        }
                        ]
                      • "idReference":
                        array
                        An array of IdReference objects.
                        [
                        IdReference
                        {
                        • "creator":
                          object
                          A Creator object.
                          {
                          • "content":
                            string
                          • "lang":
                            string
                          }
                        • "description":
                          object
                          A Description object.
                          {
                          • "content":
                            array
                            An array of object literals.
                          • "lang":
                            string
                          • "type":
                            string
                            The type of the object. This is normally a constant that can be used to differentiate objects by their type.
                          }
                        • "identifier":
                          string
                        • "domain":
                          string
                        }
                        ]
                      • "extrinsic":
                        array
                        An array of Extrinsic objects.
                        [
                        Extrinsic
                        {
                        • "content":
                          array
                          An array of object literals.
                        • "name":
                          string
                          The name of an element.
                        }
                        ]
                      • "role":
                        string
                      • "addressID":
                        string
                      • "addressIDDomain":
                        string
                      }
                      ]
                    • "routing":
                      object
                      A Routing object.
                      {
                      • "destination":
                        string
                      }
                    • "extrinsic":
                      array
                      An array of Extrinsic objects.
                    • "preferredLanguage":
                      string
                    }
                  }
                • "to":
                  object
                  Required | A To object.
                • "sender":
                  object
                  Required | A Sender object.
                • "path":
                  object
                  A Path object.
                • "originalDocument":
                  object
                  A OriginalDocument object.
                }
              • "message":
                object
                A Message object.
              • "request":
                object
                A Request object.
              • "response":
                object
                A Response object.
              • "signature":
                array
                An array of Signature objects.
              • "version":
                string
              • "payloadID":
                string
              • "timestamp":
                string
              • "signatureVersion":
                string
              • "lang":
                string
              }
              ]
            }
          • "subscriptionListResponse":
            object
            A SubscriptionListResponse object.
          • "subscriptionContentResponse":
            object
            A SubscriptionContentResponse object.
          • "supplierListResponse":
            object
            A SupplierListResponse object.
          • "supplierDataResponse":
            object
            A SupplierDataResponse object.
          • "authResponse":
            object
            A AuthResponse object.
          • "dataResponse":
            object
            A DataResponse object.
          • "organizationDataResponse":
            object
            A OrganizationDataResponse object.
          • "id":
            string
          }
        • "signature":
          array
          An array of Signature objects.
        • "version":
          string
        • "payloadID":
          string
        • "timestamp":
          string
        • "signatureVersion":
          string
        • "lang":
          string
        }
        ]
      }
    • "subscriptionListResponse":
      object
      A SubscriptionListResponse object.
    • "subscriptionContentResponse":
      object
      A SubscriptionContentResponse object.
    • "supplierListResponse":
      object
      A SupplierListResponse object.
    • "supplierDataResponse":
      object
      A SupplierDataResponse object.
    • "authResponse":
      object
      A AuthResponse object.
    • "dataResponse":
      object
      A DataResponse object.
    • "organizationDataResponse":
      object
      A OrganizationDataResponse object.
    • "id":
      string
    }
  • "signature":
    array
    An array of Signature objects.
  • "version":
    string
  • "payloadID":
    string
  • "timestamp":
    string
  • "signatureVersion":
    string
  • "lang":
    string
}
CXMLSessionRO application/vnd.intershop.punchout.v2+json{
  • "operation":
    string
  • "basketId":
    string
  • "returnURL":
    string
  • "creationDate":
    string
    Format: date-time
  • "buyerCookie":
    string
  • "credentialFrom":
    object
    A CredentialRO object.
    {
    • "domain":
      string
    • "identity":
      string
    }
  • "credentialTo":
    object
    A CredentialRO object.
    {
    • "domain":
      string
    • "identity":
      string
    }
  • "credentialSender":
    object
    A CredentialRO object.
    {
    • "domain":
      string
    • "identity":
      string
    }
}
LinkRO application/vnd.intershop.punchout.v2+json{
  • "name":
    string
    the name of the returned element
  • "type":
    string
    Readonly | This is a constant: Link | Example: Link
  • "attributes":
    array
    An array of ResourceAttribute objects. the list of attributes
    [
    ResourceAttribute: An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
    ]
  • "uri":
    string
    The uri
  • "relation":
    string
    The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
  • "title":
    string
    The title of the link
  • "description":
    string
    The description of the link
  • "itemId":
    string
    the Id of the linked item
  • "attribute":
    object
    A ResourceAttribute object. An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
}
LinkROResourceCollectionRO application/vnd.intershop.punchout.v2+json{
  • "pageable":
    string
    The pageable ID
  • "total":
    integer
    The pageable amount total | Format: int32
  • "offset":
    integer
    The pageable offset | Format: int32
  • "amount":
    integer
    The pageable amount | Format: int32
  • "elements":
    array
    An array of LinkRO objects. The list of elements
    [
    LinkRO: A Link pointing to a resource
    {
    • "name":
      string
      the name of the returned element
    • "type":
      string
      Readonly | This is a constant: Link | Example: Link
    • "attributes":
      array
      An array of ResourceAttribute objects. the list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
      The uri
    • "relation":
      string
      The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
      The title of the link
    • "description":
      string
      The description of the link
    • "itemId":
      string
      the Id of the linked item
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
  • "type":
    string
    The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "sortKeys":
    array
    An array of string literals. The keys to sort for
  • "name":
    string
    The name of an element.
}
PunchoutConfigurationOptionsRO application/vnd.intershop.punchout.v2+json{
  • "name":
    string
    The name of an element.
  • "type":
    string
    The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "description":
    string
    The description of the configuration | Example: Show available configurations for OCI Punchout
  • "availableFormatters":
    array
    An array of PunchoutAvailableFormatterRO objects. The available formatters for the configuration as a collection of PunchoutAvailableFormatterROs
    [
    PunchoutAvailableFormatterRO: This resource holds the available formatters for the configuration as a collection of PunchoutAvailableFormatterROs.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: PunchoutAvailableFormatter
    • "id":
      string
      The ID of the formatter | Example: Trim
    }
    ]
  • "availablePlaceholders":
    array
    An array of PunchoutAvailablePlaceholderRO objects. The available placeholders for the configuration as a collection of PunchoutAvailablePlaceholderROs
    [
    PunchoutAvailablePlaceholderRO: This resource holds the available placeholders for the configuration as a collection of PunchoutAvailablePlaceholderROs.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: PunchoutAvailablePlaceholder
    • "id":
      string
      The ID of the placeholder | Example: Currency
    }
    ]
}
PunchoutConfigurationRO application/vnd.intershop.punchout.v2+json{
  • "name":
    string
    The name of an element.
  • "type":
    string
    The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "items":
    array
    An array of PunchoutConfigurationItemRO objects. The configuration items as a collection of PunchoutConfigurationItemROs
    [
    PunchoutConfigurationItemRO: This resource holds the configuration items as a collection of PunchoutConfigurationItemROs.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    • "field":
      string
      The field of the configuration item | Example: NEW_ITEM-MATGROUP
    • "transform":
      string
      The transform of the configuration Item | Example: {ManufacturerName}
    • "formatter":
      string
      The formatter for the configuration item | Example: UpperCase
    • "mappings":
      array
      An array of PunchoutConfigurationItemMappingRO objects. The configuration item mappings as collection of PunchoutConfigurationItemMappingROs
      [
      PunchoutConfigurationItemMappingRO: This resource holds the configuration item mappings as a collection of PunchoutConfigurationItemMappingROs.
      {
      • "name":
        string
        The name of an element.
      • "type":
        string
        The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: PunchoutConfigurationItemMapping
      • "mapFromValue":
        string
        The 'from' value for the configuration of the item mapping | Example: meter
      • "mapToValue":
        string
        The 'to' value for the configuration of the item mapping | Example: m
      }
      ]
    }
    ]
}
PunchoutItemRO application/vnd.intershop.punchout.v2+json{
  • "name":
    string
    The name of an element.
  • "type":
    string
    The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "punchoutType":
    string
    Required | The Punchout type | Example: oci
  • "version":
    string
    Required | The Punchout version | Example: ver5
  • "punchoutData":
    object
    A PunchoutDataRO object. This resource holds the Punchout data as PunchoutDataRO.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: PunchoutData
    • "punchoutDataItems":
      array
      An array of PunchoutDataItemRO objects.
      [
      PunchoutDataItemRO: This resource holds the Punchout data as a collection of PunchoutDataItemROs.
      {
      • "name":
        string
        The name of an element.
      • "type":
        string
        The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: PunchoutDataItem
      • "dataItemFields":
        array
        An array of PunchoutDataItemFieldRO objects. The data item fields as a collection of PunchoutDataItemFieldROs
        [
        PunchoutDataItemFieldRO
        {
        • "name":
          string
          The name of an element.
        • "type":
          string
          The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: PunchoutDataItemField
        • "value":
          string
          The value of the Data Item Field | Example: 0.0
        }
        ]
      • "punchoutDataItemFields":
        array
        An array of PunchoutDataItemFieldRO objects.
        [
        PunchoutDataItemFieldRO
        {
        • "name":
          string
          The name of an element.
        • "type":
          string
          The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: PunchoutDataItemField
        • "value":
          string
          The value of the Data Item Field | Example: 0.0
        }
        ]
      }
      ]
    • "dataItems":
      array
      An array of PunchoutDataItemRO objects. The Punchout data as a collection of PunchoutDataItemROs
      [
      PunchoutDataItemRO: This resource holds the Punchout data as a collection of PunchoutDataItemROs.
      {
      • "name":
        string
        The name of an element.
      • "type":
        string
        The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: PunchoutDataItem
      • "dataItemFields":
        array
        An array of PunchoutDataItemFieldRO objects. The data item fields as a collection of PunchoutDataItemFieldROs
        [
        PunchoutDataItemFieldRO
        {
        • "name":
          string
          The name of an element.
        • "type":
          string
          The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: PunchoutDataItemField
        • "value":
          string
          The value of the Data Item Field | Example: 0.0
        }
        ]
      • "punchoutDataItemFields":
        array
        An array of PunchoutDataItemFieldRO objects.
        [
        PunchoutDataItemFieldRO
        {
        • "name":
          string
          The name of an element.
        • "type":
          string
          The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: PunchoutDataItemField
        • "value":
          string
          The value of the Data Item Field | Example: 0.0
        }
        ]
      }
      ]
    }
}
PunchoutTransferContainerRO application/vnd.intershop.punchout.v2+json{
  • "data":
    array
    An array of PunchoutTransferDataItemFieldRO objects. The core data of the response object.
    [
    PunchoutTransferDataItemFieldRO: The core data of the response object.
    {
    • "name":
      string
      The name of an element.
    • "value":
      string
    }
    ]
  • "errors":
    array
    Readonly | An array of FeedbackRO_v1 objects. List of errors that occurred in relation to the request.
    [
    FeedbackRO_v1: An error or information representation regarding the current request.
    {
    • "causes":
      array
      An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
      [
      FeedbackCauseRO_v1: A representation for the common feedback informations.
      {
      • "code":
        string
        Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
      • "message":
        string
        Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
      • "parameters":
        object
        A map of several parameters that are used to assemble the message.
      • "paths":
        array
        An array of 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/JsonPath
      }
      ]
    • "code":
      string
      An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
    • "message":
      string
      A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
    • "parameters":
      object
      A map of several parameters that are used to assemble the message.
    • "paths":
      array
      An array of 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/JsonPath
    • "status":
      string
      The HTTP status code, that is applicable to this problem. | Example: 400
    }
    ]
  • "included":
    object
    Optionally included related data objects.
  • "infos":
    array
    Readonly | An array of 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.
    {
    • "causes":
      array
      An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
      [
      FeedbackCauseRO_v1: A representation for the common feedback informations.
      {
      • "code":
        string
        Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
      • "message":
        string
        Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
      • "parameters":
        object
        A map of several parameters that are used to assemble the message.
      • "paths":
        array
        An array of 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/JsonPath
      }
      ]
    • "code":
      string
      An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
    • "message":
      string
      A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
    • "parameters":
      object
      A map of several parameters that are used to assemble the message.
    • "paths":
      array
      An array of 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/JsonPath
    • "status":
      string
      The HTTP status code, that is applicable to this problem. | Example: 400
    }
    ]
  • "links":
    object
    Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
}
PunchoutUserRO application/vnd.intershop.punchout.v2+json{
  • "name":
    string
    The name of an element.
  • "type":
    string
    The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: PunchoutUser
  • "id":
    string
    Readonly | The ID of the user | Example: oci1
  • "login":
    string
    The login of the user | Example: ociuser1
  • "email":
    string
    The e-mail adress of the user | Example: ocitester@test.intershop.de
  • "password":
    string
    The password of the user | Example: !InterShop00!
  • "active":
    boolean
    Indicates whether the user is active | Example: true
}

Disclaimer

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.

Customer Support
Knowledge Base
Product Resources
Tickets