Related Documents
Document Properties
KbidY27646
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 - Create a Punchout user


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

POST

Short Description

Create a Punchout user

Query Parameters

none

Example Requests

/customers/OilCorp/punchouts/oci/users

HTTP Status Codes

201 Created

400 Bad Request

Possible values for header 'error-key':
    • punchout.login_required.error
    • punchout.password_required.error
    • punchout.password_invalid.error
    • punchout.login_invalid.error

401 Unauthorized

403 Forbidden

409 Conflicted

Possible values for header 'error-key':
    • punchout.login_already_exists.error

Description

Create a new Punchout user. 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

application/json

Request related java object

com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutUserListResource
com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutUserRO

Request Example

{
	"login": "oci23",
	"password": "!InterShop00!",
    "email": "notifyMe@intershop.de"
}

Response Data Format

application/json

Response related java object

com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutUserItemResource
com.intershop.component.rest.capi.resourceobject.LinkRO

Response Example

{
	"type": "Link",
	"uri": "inSPIRED-inTRONICS_Business-Site/-/customers/OilCorp/punchouts/oci/users/oci23"
}

XML

XML Request Data Format

text/xml

XML Request Java Objects

com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutUserItemResource
com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutUserRO

XML Request Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<PunchoutUser type="PunchoutUser">
	<login>oci23</login>
	<password>!InterShop00!</password>
	<email>notifyMe@intershop.de</email>
</PunchoutUser>

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutUserItemResource
com.intershop.component.rest.capi.resourceobject.LinkRO

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Link type="Link">
	<uri>inSPIRED-inTRONICS_Business-Site/-/customers/OilCorp/punchouts/oci/users/oci23</uri>
</Link>

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