Related Documents
Document Properties
Kbid28435D
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 Punchout item details


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

GET

Short Description

Returns details for the selected Punchout standard

Query Parameters

  • basketId - returns the basket line item data according to punchout configuration
  • searchTerm - returns data of products that match the search term

Example Requests

/customers/AgroNet/punchouts/oci

/customers/AgroNet/punchouts/oci?basketId=<the oci user basket id>

/customers/AgroNet/punchouts/oci?searchTerm=Sony

HTTP Status Codes

200 OK

401 Unauthorized (not authenticated)

403 Forbidden (authenticated with valid credentials but doesn't have access)

Description

Returns details to the selected Punchout standard. 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 data 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.resourceobject.PunchoutItemRO
com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutDataRO
com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutDataItemRO
com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutDataItemFieldRO

Response data example

Response example without a basketId.

{
  "type": "PunchoutItem",
  "punchoutType": "oci",
  "version": "ver5",
  "punchoutData": {
    "type": "PunchoutData"
  }
}

Response example with given basketId or searchTerm.

{
  "type": "PunchoutItem",
  "punchoutType": "oci",
  "version": "ver5",
  "punchoutData": {
    "type": "PunchoutData",
    "dataItems": [
      {
        "type": "PunchoutDataItem",
        "dataItemFields": [
          {
            "name": "NEW_ITEM-PRICE",
            "type": "PunchoutDataItemField",
            "value": "0.0"
          },
          {
            "name": "NEW_ITEM-UNIT",
            "type": "PunchoutDataItemField",
            "value": ""
          },
          {
            "name": "NEW_ITEM-MATNR",
            "type": "PunchoutDataItemField",
            "value": ""
          },
          {
            "name": "NEW_ITEM-DESCRIPTION",
            "type": "PunchoutDataItemField",
            "value": "Sony VPL-SW225"
          },
          {
            "name": "NEW_ITEM-QUANTITY",
            "type": "PunchoutDataItemField",
            "value": "1"
          },
          {
            "name": "NEW_ITEM-CURRENCY",
            "type": "PunchoutDataItemField",
            "value": "N/A"
          },
          {
            "name": "NEW_ITEM-PRICEUNIT",
            "type": "PunchoutDataItemField",
            "value": ""
          },
          {
            "name": "NEW_ITEM-LEADTIME",
            "type": "PunchoutDataItemField",
            "value": ""
          },
          {
            "name": "NEW_ITEM-LONGTEXT",
            "type": "PunchoutDataItemField",
            "value": "Sony VPL-SW225, 2600 ANSI lumens, 3LCD, WXGA (1280x800), 6000h, 210W, UHP"
          },
          {
            "name": "NEW_ITEM-VENDOR",
            "type": "PunchoutDataItemField",
            "value": ""
          },
          {
            "name": "NEW_ITEM-VENDORMAT",
            "type": "PunchoutDataItemField",
            "value": ""
          },
          {
            "name": "NEW_ITEM-MANUFACTCODE",
            "type": "PunchoutDataItemField",
            "value": "Sony"
          },
          {
            "name": "NEW_ITEM-MANUFACTMAT",
            "type": "PunchoutDataItemField",
            "value": "VPL-SW225+TM-ST2"
          },
          {
            "name": "NEW_ITEM-MATGROUP",
            "type": "PunchoutDataItemField",
            "value": ""
          },
          {
            "name": "NEW_ITEM-CONTRACT",
            "type": "PunchoutDataItemField",
            "value": ""
          },
          {
            "name": "NEW_ITEM-CONTRACT_ITEM",
            "type": "PunchoutDataItemField",
            "value": ""
          },
          {
            "name": "NEW_ITEM-CUST_FIELD1",
            "type": "PunchoutDataItemField",
            "value": "external"
          },
          {
            "name": "NEW_ITEM-CUST_FIELD2",
            "type": "PunchoutDataItemField",
            "value": "AA_0027242869158"
          },
          {
            "name": "NEW_ITEM-CUST_FIELD3",
            "type": "PunchoutDataItemField",
            "value": ""
          },
          {
            "name": "NEW_ITEM-CUST_FIELD4",
            "type": "PunchoutDataItemField",
            "value": ""
          },
          {
            "name": "NEW_ITEM-CUST_FIELD5",
            "type": "PunchoutDataItemField",
            "value": ""
          },
          {
            "name": "NEW_ITEM-EXT_PRODUCT_ID",
            "type": "PunchoutDataItemField",
            "value": "0027242869158"
          }
        ]
      }
    ]
  }
}

XML

Request data format

Request related java object

n/a

Request data example

n/a

Response data format

text/xml

Response related java object

com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutItemResource
com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutItemRO
com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutDataRO
com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutDataItemRO
com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutDataItemFieldRO

Response data example

Response example without a basketId.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<PunchoutItem type="PunchoutItem"><punchoutData type="PunchoutData"/>
<punchoutType>oci</punchoutType>
<version>ver5</version>
</PunchoutItem>

Response example with given basketId or searchTerm.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<PunchoutItem type="PunchoutItem">
    <punchoutType>oci</punchoutType>
    <version>ver5</version>
    <PunchoutData type="PunchoutData">
        <dataItems>
            <PunchoutDataItem type="PunchoutDataItem">
                <PunchoutDataItemField name="NEW_ITEM-PRICE" type="PunchoutDataItemField">
                    <value>0.0</value>
                </PunchoutDataItemField>
                <PunchoutDataItemField name="NEW_ITEM-UNIT" type="PunchoutDataItemField">
                    <value/>
                </PunchoutDataItemField>
                <PunchoutDataItemField name="NEW_ITEM-MATNR" type="PunchoutDataItemField">
                    <value/>
                </PunchoutDataItemField>
                <PunchoutDataItemField name="NEW_ITEM-DESCRIPTION" type="PunchoutDataItemField">
                    <value>Sony VPL-SW225</value>
                </PunchoutDataItemField>
                <PunchoutDataItemField name="NEW_ITEM-QUANTITY" type="PunchoutDataItemField">
                    <value>1</value>
                </PunchoutDataItemField>
                <PunchoutDataItemField name="NEW_ITEM-CURRENCY" type="PunchoutDataItemField">
                    <value>N/A</value>
                </PunchoutDataItemField>
                <PunchoutDataItemField name="NEW_ITEM-PRICEUNIT" type="PunchoutDataItemField">
                    <value/>
                </PunchoutDataItemField>
                <PunchoutDataItemField name="NEW_ITEM-LEADTIME" type="PunchoutDataItemField">
                    <value/>
                </PunchoutDataItemField>
                <PunchoutDataItemField name="NEW_ITEM-LONGTEXT" type="PunchoutDataItemField">
                    <value>Sony VPL-SW225, 2600 ANSI lumens, 3LCD, WXGA (1280x800), 6000h, 210W, UHP</value>
                </PunchoutDataItemField>
                <PunchoutDataItemField name="NEW_ITEM-VENDOR" type="PunchoutDataItemField">
                    <value/>
                </PunchoutDataItemField>
                <PunchoutDataItemField name="NEW_ITEM-VENDORMAT" type="PunchoutDataItemField">
                    <value/>
                </PunchoutDataItemField>
                <PunchoutDataItemField name="NEW_ITEM-MANUFACTCODE" type="PunchoutDataItemField">
                    <value>Sony</value>
                </PunchoutDataItemField>
                <PunchoutDataItemField name="NEW_ITEM-MANUFACTMAT" type="PunchoutDataItemField">
                    <value>VPL-SW225+TM-ST2</value>
                </PunchoutDataItemField>
                <PunchoutDataItemField name="NEW_ITEM-MATGROUP" type="PunchoutDataItemField">
                    <value/>
                </PunchoutDataItemField>
                <PunchoutDataItemField name="NEW_ITEM-CONTRACT" type="PunchoutDataItemField">
                    <value/>
                </PunchoutDataItemField>
                <PunchoutDataItemField name="NEW_ITEM-CONTRACT_ITEM" type="PunchoutDataItemField">
                    <value/>
                </PunchoutDataItemField>
                <PunchoutDataItemField name="NEW_ITEM-CUST_FIELD1" type="PunchoutDataItemField">
                    <value>external</value>
                </PunchoutDataItemField>
                <PunchoutDataItemField name="NEW_ITEM-CUST_FIELD2" type="PunchoutDataItemField">
                    <value>AA_0027242869158</value>
                </PunchoutDataItemField>
                <PunchoutDataItemField name="NEW_ITEM-CUST_FIELD3" type="PunchoutDataItemField">
                    <value/>
                </PunchoutDataItemField>
                <PunchoutDataItemField name="NEW_ITEM-CUST_FIELD4" type="PunchoutDataItemField">
                    <value/>
                </PunchoutDataItemField>
                <PunchoutDataItemField name="NEW_ITEM-CUST_FIELD5" type="PunchoutDataItemField">
                    <value/>
                </PunchoutDataItemField>
                <PunchoutDataItemField name="NEW_ITEM-EXT_PRODUCT_ID" type="PunchoutDataItemField">
                    <value>0027242869158</value>
                </PunchoutDataItemField>
            </PunchoutDataItem>
        </dataItems>
    </PunchoutData>
</PunchoutItem>

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