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

REST API - Punchout - Return available configuration options for Punchout


Note

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

URI

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

Http Method

OPTIONS

Short Description

Returns all available configuration options for the selected Punchout standard

Query Parameters

 

Example Requests

/customers/AgroNet/punchouts/oci

HTTP Status Codes

200 OK

401 Unauthorized (not authenticated)

403 Forbidden (authenticated with valid credentials but is not an account admin)

Description

Returns all available configuration options for the selected Punchout standard

The authenticated user must have the permission APP_B2B_VIEW_PUNCHOUT or the permission 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.PunchoutItemResource
com.intershop.application.storefront.rest.b2b.capi.punchout.handler.PunchoutHandler
com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutConfigurationOptionsRO
com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutAvailableFormatterRO
com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutAvailablePlaceholderRO

Response Example

{
    "type": "PunchoutConfigurationOptions",
    "description": "Show available configurations for OCI punchout.",
    "availableFormatters": [
        {
            "type": "PunchoutAvailableFormatter",
            "id": "LowerCase"
        },
        {
            "type": "PunchoutAvailableFormatter",
            "id": "Trim"
        },
        {
            "type": "PunchoutAvailableFormatter",
            "id": "UpperCase"
        }
    ],
    "availablePlaceholders": [
        {
            "type": "PunchoutAvailablePlaceholder",
            "id": "Currency"
        },
        {
            "type": "PunchoutAvailablePlaceholder",
            "id": "Description"
        },
        {
            "type": "PunchoutAvailablePlaceholder",
            "id": "ManufacturerName"
        },
        {
            "type": "PunchoutAvailablePlaceholder",
            "id": "ManufacturerSku"
        },
        {
            "type": "PunchoutAvailablePlaceholder",
            "id": "Price"
        },
        {
            "type": "PunchoutAvailablePlaceholder",
            "id": "ProductName"
        },
        {
            "type": "PunchoutAvailablePlaceholder",
            "id": "Quantity"
        },
        {
            "type": "PunchoutAvailablePlaceholder",
            "id": "Sku"
        },
        {
            "type": "PunchoutAvailablePlaceholder",
            "id": "SupplierName"
        },
        {
            "type": "PunchoutAvailablePlaceholder",
            "id": "SupplierSku"
        },
        {
            "type": "PunchoutAvailablePlaceholder",
            "id": "Unit"
        },
        {
            "type": "PunchoutAvailablePlaceholder",
            "id": "Discarded"
        }
    ]
}

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.PunchoutItemResource
com.intershop.application.storefront.rest.b2b.capi.punchout.handler.PunchoutHandler
com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutConfigurationOptionsRO
com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutAvailableFormatterRO
com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutAvailablePlaceholderRO

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<PunchoutConfigurationOptions type="PunchoutConfigurationOptions">
    <availableFormatters>
        <PunchoutAvailableFormatter type="PunchoutAvailableFormatter">
            <id>LowerCase</id>
        </PunchoutAvailableFormatter>
        <PunchoutAvailableFormatter type="PunchoutAvailableFormatter">
            <id>Trim</id>
        </PunchoutAvailableFormatter>
        <PunchoutAvailableFormatter type="PunchoutAvailableFormatter">
            <id>UpperCase</id>
        </PunchoutAvailableFormatter>
    </availableFormatters>
    <availablePlaceholders>
        <PunchoutAvailablePlaceholder type="PunchoutAvailablePlaceholder">
            <id>Currency</id>
        </PunchoutAvailablePlaceholder>
        <PunchoutAvailablePlaceholder type="PunchoutAvailablePlaceholder">
            <id>Description</id>
        </PunchoutAvailablePlaceholder>
        <PunchoutAvailablePlaceholder type="PunchoutAvailablePlaceholder">
            <id>ManufacturerName</id>
        </PunchoutAvailablePlaceholder>
        <PunchoutAvailablePlaceholder type="PunchoutAvailablePlaceholder">
            <id>ManufacturerSku</id>
        </PunchoutAvailablePlaceholder>
        <PunchoutAvailablePlaceholder type="PunchoutAvailablePlaceholder">
            <id>Price</id>
        </PunchoutAvailablePlaceholder>
        <PunchoutAvailablePlaceholder type="PunchoutAvailablePlaceholder">
            <id>ProductName</id>
        </PunchoutAvailablePlaceholder>
        <PunchoutAvailablePlaceholder type="PunchoutAvailablePlaceholder">
            <id>Quantity</id>
        </PunchoutAvailablePlaceholder>
        <PunchoutAvailablePlaceholder type="PunchoutAvailablePlaceholder">
            <id>Sku</id>
        </PunchoutAvailablePlaceholder>
        <PunchoutAvailablePlaceholder type="PunchoutAvailablePlaceholder">
            <id>SupplierName</id>
        </PunchoutAvailablePlaceholder>
        <PunchoutAvailablePlaceholder type="PunchoutAvailablePlaceholder">
            <id>SupplierSku</id>
        </PunchoutAvailablePlaceholder>
        <PunchoutAvailablePlaceholder type="PunchoutAvailablePlaceholder">
            <id>Unit</id>
        </PunchoutAvailablePlaceholder>
        <PunchoutAvailablePlaceholder type="PunchoutAvailablePlaceholder">
            <id>Discarded</id>
        </PunchoutAvailablePlaceholder>
    </availablePlaceholders>
    <description>Show available configurations for OCI punchout.</description>
</PunchoutConfigurationOptions>

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