Related Documents
Document Properties
Kbid276G52
Last Modified23-Jun-2020
Added to KB29-Jun-2016
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10

REST API - Punchout - Get punchout users


Note

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

URI

/customers/<customer-id>/punchouts/<punchout-id>/users

Http Method

GET

Short Description

Returns all users for the selected Punchout standard

Query Parameters

none

Example Requests

/customers/OilCorp/punchouts/oci/users

HTTP Status Codes

200 OK

401 Unauthorized (not authenticated)

403 Forbidden (authenticated with valid credentials but doesn't have access)
Possible values for header 'error-key':

    • punchoutrequest.no_view_permission

404 Not Found
Possible values for header 'error-key':

    • punchout.type_unknown.error

Description

The request returns all users for the selected Punchout standard. The authenticated user must have the permission APP_B2B_MANAGE_PUNCHOUT.

Cartridge

app_sf_rest_b2b

ApplicationSMB Web Shop

Product Version

7.8

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.PunchoutUserListResource
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/OilCorp/punchouts/oci/users/oci1",
			"title": "oci1"
		},
		{
			"type": "Link",
			"uri": "inSPIRED-inTRONICS_Business-Site/-/customers/OilCorp/punchouts/oci/users/oci2",
			"title": "oci2"
		},
		{
			"type": "Link",
			"uri": "inSPIRED-inTRONICS_Business-Site/-/customers/OilCorp/punchouts/oci/users/oci3",
			"title": "oci3"
		}
	],
	"type":"ResourceCollection",
	"name":"Punchout Users"
}

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.PunchoutUserListResource
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="Punchout Users" type="ResourceCollection">
  <elements>
    <Link type="Link">
      <title>oci1</title>
      <uri>inSPIRED-inTRONICS_Business-Site/-/customers/OilCorp/punchouts/oci/users/oci1</uri>
    </Link>
    <Link type="Link">
      <title>oci2</title>
      <uri>inSPIRED-inTRONICS_Business-Site/-/customers/OilCorp/punchouts/oci/users/oci2</uri>
    </Link>
    <Link type="Link">
      <title>oci3</title>
      <uri>inSPIRED-inTRONICS_Business-Site/-/customers/OilCorp/punchouts/oci/users/oci3</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