Personal Library

Kbid	2765U1
Last Modified	23-Jun-2020
Added to KB	29-Jun-2016
Public Access	Everyone
Status	Online
Doc Type	References
Product	ICM 7.8 ICM 7.9 ICM 7.10

REST API - Punchout - Update Punchout configuration

https://support.intershop.com/kb/2765U1

Note

Starting with 7.10 our REST API is documented using Redoc accessible at docs.intershop.com.

URI	/customers/<customer-id>/punchouts/<punchout-id>/configurations
Http Method	PUT
Short Description	Update the existing Punchout configuration
Query Parameters	none
Example Requests	/customers/AgroNet/punchouts/oci/configurations
HTTP Status Codes	200 OK 401 Not Authorized 403 Forbidden
Description	Update the existing Punchout configurations. The configuration can be updated entirely and partially. The fields not present remain untouched. (e.g.: NEW_ITEM-CONTRACT) The authenticated user must have the permission `APP_B2B_MANAGE_PUNCHOUT`.
Cartridge	app_sf_rest_b2b
Application	SMB Web Shop

Product Version	7.8
Product To Version
Status	final

JSON

Request data format

application/json

Request related java object

com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutConfigurationListResource
com.intershop.application.storefront.rest.b2b.capi.punchout.handler.PunchoutConfigurationHandler
com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutConfigurationRO
com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutConfigurationItemRO

Request data example

The PunchoutConfigurationItem has the following attributes:

Attribute	Description
transform	Provides fixed string or any placeholder defined in the system (see REST API - Punchout - Return available configuration options (7.8))
formatter	Set a string with a ID of an existing formatter (see REST API - Punchout - Return available configuration options (7.8))

{
    "type": "PunchoutConfiguration",
	"items":
	[
		{
			"type": "PunchoutConfigurationItem",
			"field":"NEW_ITEM-MATGROUP",
			"transform":"{ManufacturerName}",
			"formatter":"UpperCase"
		},
		{
			"type": "PunchoutConfigurationItem",
			"field":"NEW_ITEM-UNIT",
			"transform":"box",
			"formatter":""
		}
	]
}

Response data format

application/json

Response related java object

com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutConfigurationListResource
com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutConfigurationRO
com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutConfigurationItemRO
com.intershop.component.rest.capi.resourceobject.LinkRO
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO<LinkRO>

Response data example

{
  "type": "PunchoutConfiguration",
  "items": [
    {
      "type": "PunchoutConfigurationItem",
      "field": "NEW_ITEM-UNIT",
      "transform": "box",
      "formatter": ""
    },
    {
      "type": "PunchoutConfigurationItem",
      "field": "NEW_ITEM-MATGROUP",
      "transform": "{ManufacturerName}",
      "formatter": "UpperCase"
    },
    ...
  ]
}

XML

Request data format	text/xml
Request related java object	com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutConfigurationListResource com.intershop.application.storefront.rest.b2b.capi.punchout.handler.PunchoutConfigurationHandler com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutConfigurationRO com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutConfigurationItemRO
Request data example	<PunchoutConfiguration type="PunchoutConfiguration"> <items> <PunchoutConfigurationItem type="PunchoutConfigurationItem"> <field>NEW_ITEM-MATGROUP</field> <transform>{ManufacturerName}</transform> <formatter>UpperCase</formatter> </PunchoutConfigurationItem > <PunchoutConfigurationItem type="PunchoutConfigurationItem"> <field>NEW_ITEM-UNIT</field> <transform>box</transform> <formatter></formatter> </PunchoutConfigurationItem> </items> </PunchoutConfiguration>
Response data format	text/xml
Response related java object	com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutConfigurationListResource com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutConfigurationRO com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutConfigurationItemRO com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO<LinkRO>
Response data example	<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <PunchoutConfiguration type="PunchoutConfiguration"> <items> <PunchoutConfigurationItem type="PunchoutConfigurationItem"> <field>NEW_ITEM-UNIT</field> <formatter></formatter> <transform>box</transform> </PunchoutConfigurationItem> <PunchoutConfigurationItem type="PunchoutConfigurationItem"> <field>NEW_ITEM-MATGROUP</field> <formatter>UpperCase</formatter> <transform>{ManufacturerName}</transform> </PunchoutConfigurationItem> ... </items> </PunchoutConfiguration>

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.