Related Documents
Document Properties
KbidU28439
Last Modified23-Jun-2020
Added to KB23-Aug-2017
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.9
  • ICM 7.10

REST API - Punchout - Get supported Punchout Standards


Note

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

URI

/customers/<customer-id>/punchouts

Http Method

GET

Short Description

Returns all supported Punchout standards

Query Parameters

none

Example Requests

/customers/OilCorp/punchouts

HTTP Status Codes

200 OK
401 Unauthorized
403 Forbidden

Description

Returns details on supported Punchout standards. Punchout standards are defined in the punchoutconfigurations.properties.

The authenticated user must have the permission APP_B2B_VIEW_PUNCHOUT or APP_B2B_SEND_OCI_BASKET.

Cartridge

app_sf_rest_b2b

ApplicationSMB Web Shop

Product Version

7.9

Product To Version

 
Status

final

JSON

Request Data Format

Request related java object

n/a

Request Example

n/a

Response Data Format

application/json

Response related java object

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

Response Example

{
	"elements":
	[
		{
			"type": "Link",
			"uri": "inSPIRED-inTRONICS_Business-Site/-/customers/AgroNet/punchouts/oci",
			"title": "oci"
		}
	],
	"type":"ResourceCollection",
	"name":"supportedPunchoutStandards"
}

XML

XML Request Data Format

XML Request Java Objects

n/a

XML Request Example

n/a

XML Response Data Format

text/xml

XML Response Java Objects

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

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResourceCollection name="supportedPunchoutStandards" type="ResourceCollection">
  <elements>
    <Link type="Link">
      <title>oci</title>
      <uri>inSPIRED-inTRONICS_Business-Site/-/customers/AgroNet/punchouts/oci</uri>
    </Link>
  </elements>
</ResourceCollection>

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
Support Tickets