Related Documents
Reference - WebShop REST API 7.8
Document Properties
Kbid
2764N5
Last Modified
31-May-2022
Added to KB
29-Jun-2016
Public Access
Everyone
Status
Online
Doc Type
References
Product
ICM 7.10
REST API - Punchout - Get Punchout user details


Note

Starting with Intershop 7.10 our REST API is provided in the Open API 3.0 format, see Reference - Intershop Commerce Management 7.10 REST API.

URI

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

Http Method

GET

Short Description

Returns information on the given Punchout user

Query Parameters

none

Example Requests

/customers/AgroNet/punchouts/oci/users/oci1

HTTP Status Codes

200 OK

401 Unauthorized

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.punchout_user_not_found.error

Description

Returns information on the given Punchout user. The authenticated user must have the permissionAPP_B2B_MANAGE_PUNCHOUT.

Cartridge

app_sf_rest_b2b

ApplicationSMB Web Shop

Product Version

7.8

Product To Version

 
Status

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.PunchoutUserItemResource
com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutUserRO

Response Example

{
	"type": "PunchoutUser",
	"id": "oci1",
	"email": "ocitester@test.intershop.de",
	"login": "ociuser1"
}

XML

XML Request Data Format

n.a.

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.PunchoutUserItemResource
com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutUserRO

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<PunchoutUser type="PunchoutUser">
	<id>oci1</id>
	<email>ocitester@test.intershop.de</email>
	<login>ociuser1</login>
</PunchoutUser>
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