Document Properties
Kbid29808F
Last Modified23-Feb-2021
Added to KB23-Feb-2021
Public AccessEveryone
StatusOnline
Doc TypeReferences
ProductICM 7.10

Reference - Punchout API 2.0.0


Product Version

7.10.28.0

Product To Version


Status

final


Download Specification 

This API specification is available for download as an Open API 3.0 YAML file: 

API Specification

Introduction

OpenAPI Version: 3.0.1
Punchout Version: 2.0.0-beta

The Intershop Punchout REST API contains resources for managing supported Punchout standards, Punchout configurations and Punchout users.
This includes updating configurations, creating, changing or deleting users or user data as well as retrieving information on available standards and options.

General API

This section covers operations for managing Punchout standards. This includes retrieving a list of available standards, details for a specific standard or available options for a chosen standard.

/customers/{CustomerKey}/punchouts
GET: Returns supported Punchout standards

Description

This operation returns details on supported Punchout standards. Punchout standards are defined in the punchoutconfiguration.properties and for REST API explicitly. The authenticated user requires the permission APP_B2B_VIEW_PUNCHOUT or APP_B2B_SEND_OCI_BASKET. The returned resource collection contains objects of type LinkRO with all available Punchout standards.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.resource.PunchoutListResourceV2.getAvailablePunchouts_V2()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The customer ID | Example: OilCorp

Response

200 - OK

- The punchout standards were successfully retrieved.
LinkROResourceCollectionRO application/json

401 - Unauthorized

- The user could not be authenticated.

403 - Forbidden

- The user does not have the required permissions.

404 - Not Found

- The customer with the given ID could not be found.

OCI - Configuration API

This section covers operations for managing OCI Punchout configurations. This includes retrieving customer-specific configurations as well as updating an existing configuration.

/customers/{CustomerKey}/punchouts/oci5/configurations
GET: Returns customer-specific OCI Punchout configurations

Description

This operation returns the customer-specific configuration for the OCI Punchout standard. The authenticated user must have the permission APP_B2B_MANAGE_PUNCHOUT.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutConfigurationListResource.getPunchoutConfiguration()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The customer ID | Example: OilCorp

Response

200 - OK

- The customer-specific configurations for the OCI Punchout were successfully retrieved.
PunchoutConfigurationRO application/json

401 - Unauthorized

- The user could not be authenticated.

403 - Forbidden

- The user does not have the required permissions.

404 - Not Found

- The customer could not be found or OCI Punchout is not supported.
PUT: Update the existing OCI Punchout configuration

Description

This operation updates existing OCI Punchout configurations. A configuration can be updated entirely or partially. The fields that are not provided remain untouched, e.g.: NEW_ITEM-CONTRACT. The authenticated user requires the permission APP_B2B_MANAGE_PUNCHOUT.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutConfigurationListResource.updatePunchoutConfiguration(com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutConfigurationRO)

Request Body

PunchoutConfigurationRO application/json

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The customer ID | Example: OilCorp

Response

200 - OK

- The customer-specific configurations for the OCI Punchout were successfully updated.
PunchoutConfigurationRO application/json

401 - Unauthorized

- The user could not be authenticated.

403 - Forbidden

- The user does not have the required permissions.

404 - Not Found

- The customer could not be found or OCI Punchout is not supported.

OCI - General API

This section covers operations for managing OCI Punchout. This includes retrieving details of OCI standard or available options.

/customers/{CustomerKey}/punchouts/oci5
GET: Returns details for the OCI Punchout

Description

This operation returns details of the OCI Punchout standard. The authenticated user requires the permission APP_B2B_VIEW_PUNCHOUT or APP_B2B_SEND_OCI_BASKET. An optional parameter basketId can be provided to get a list of OCI Punchout fields for the Basket with the given ID.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutItemResource.getPunchoutItemDetails(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The customer ID | Example: OilCorp
in querybasketIdstringReturns the basket line item data according to OCI Punchout configuration

Response

200 - OK

- The details for the OCI Punchout were successfully retrieved.
PunchoutItemRO application/json

401 - Unauthorized

- The user could not be authenticated.

403 - Forbidden

- The user does not have the required permissions.

404 - Not Found

- The customer could not be found or OCI Punchout is not supported.
OPTIONS: Shows configuration options for the OCI Punchout

Description

This operation returns all available configuration options for the OCI Punchout standard. The authenticated user requires the permission APP_B2B_VIEW_PUNCHOUT or the permission APP_B2B_SEND_OCI_BASKET.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutItemResource.getPunchoutConfigurationOptions()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The customer ID | Example: OilCorp

Response

200 - OK

- The configuration options for the OCI Punchout were successfully retrieved.
PunchoutConfigurationOptionsRO application/json

401 - Unauthorized

- The user could not be authenticated.

403 - Forbidden

- The user does not have the required permissions.

404 - Not Found

- The customer could not be found or OCI Punchout is not supported.
/customers/{CustomerKey}/punchouts/oci5/background-search
GET: [BETA] Searches for products

Description

This operation provides a background search functionality for products that can be utilized for cross-catalog searches of external systems like procurement systems.
For every found product matching the given search string a product record in the OCI Punchout format is returned. A record is a list of key-value pairs including all necessary transformations. Multiple records are concatinated and indexed. The fields have to be posted by the client to the external system.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutFunctionBackgroundSearchResource.searchProducs(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The customer ID | Example: OilCorp
in querysearchStringstringRequired | The search string to search products for | Example: Acer

Response

200 - OK

- The product search has been successfully executed
PunchoutTransferContainerRO application/json

400 - Bad Request

- The search string is missing or invalid.

401 - Unauthorized

- The user could not be authenticated.

403 - Forbidden

- The user does not have the required permissions.

404 - Not Found

- The customer could not be found or OCI Punchout is not supported.
/customers/{CustomerKey}/punchouts/oci5/transfer
POST: [BETA] Triggers the OCI Punchout basket transfer

Description

This operation triggers the transfer of the OCI Punchout basket back to the external system e.g. procurement system. The following steps are performed during this process:

  • For every line item of the basket a product record in the OCI Punchout format is returned. A record is a list of key-value pairs including all necessary transformations. Multiple records are concatinated and indexed. The fields have to be posted by the client to the external system.
  • All Punchout fields are returned as a list of key-value pairs including all necessary transformations; The fields have to be posted by the client to the procurement system.
  • The Punchout basket is closed and cannot be used anymore.
  • The Punchout workflow ends and is recorded for license purposes.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutTransferResource.transferBasket(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The customer ID | Example: OilCorp
in querybasketIdstringRequired | The ID of the OCI Punchout basket to be transfered

Response

200 - OK

- The OCI Punchout basket transfer has been successfully triggered.
PunchoutTransferContainerRO application/json

400 - Bad Request

- The basket ID is missing or invalid.

401 - Unauthorized

- The user could not be authenticated.

403 - Forbidden

- The user does not have the required permissions.

404 - Not Found

- The customer could not be found or OCI Punchout is not supported.
/customers/{CustomerKey}/punchouts/oci5/validate
GET: [BETA] Validates a product with given id and quantity

Description

The operation allows to retrieve up-to-date information for a specific product with a given quantity from the Intershop Commerce System. A possible use-case is the update of product data in external systems (e.g. procurement system).
If the product was found a single product record in the OCI Punchout format is returned. The record is a list of key-value pairs including all necessary transformations. The fields have to be posted by the client to the external system.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutFunctionValidateResource.validateProduct(java.lang.String,java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The customer ID | Example: OilCorp
in queryproductIdstringRequired | The id of the product (SKU) | Example: 6855851
in queryquantitystringThe requested quantity. If field is not set, then default "1" is used. | Example: 3

Response

200 - OK

- The product has been successfully validated
PunchoutTransferContainerRO application/json

400 - Bad Request

- The search string is missing or invalid.

401 - Unauthorized

- The user could not be authenticated.

403 - Forbidden

- The user does not have the required permissions.

404 - Not Found

- The customer could not be found or OCI Punchout is not supported.

OCI - User Management API

This section covers operations for managing OCI Punchout users. This includes retrieving information on users, creating a new user, updating user data as well as deleting specific users.

/customers/{CustomerKey}/punchouts/oci5/users
GET: Get OCI punchout users

Description

This operation returns all users for the OCI Punchout standard. The authenticated user requires the permission APP_B2B_MANAGE_PUNCHOUT. The response is of type ResourceCollectionRO and contains objects of type LinkRO.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutUserListResource.getPunchoutUsers()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The customer ID | Example: OilCorp

Response

200 - OK

- The OCI Punchout users were successfully retrieved.
LinkROResourceCollectionRO application/json

401 - Unauthorized

- The user could not be authenticated.

403 - Forbidden

- The user does not have the required permissions.

404 - Not Found

- The customer could not be found or OCI Punchout is not supported.
POST: Create an OCI Punchout user

Description

This operation creates a new OCI Punchout user. The ID property of Punchout user will be created automatically. The authenticated user must have the permission APP_B2B_MANAGE_PUNCHOUT.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutUserListResource.createPunchoutUser(com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutUserRO)

Request Body

PunchoutUserRO application/json

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The customer ID | Example: OilCorp

Response

201 - Created

- The OCI Punchout user was successfully created.
LinkRO application/json

400 - Bad Request

- At least one attribute is missing in the request body or the credentials are not valid regarding internal policies.

401 - Unauthorized

- The user could not be authenticated.

403 - Forbidden

- The user does not have the required permissions.

404 - Not Found

- The customer could not be found or OCI Punchout is not supported.

409 - Conflict

- The OCI Punchout user already exists.
Possible values for header 'error-key':
- punchout.login_already_exists.error
/customers/{CustomerKey}/punchouts/oci5/users/{OCIPunchoutUserKey}
GET: Returns information on the given OCI Punchout user

Description

This operation returns information on the given OCI Punchout user. The authenticated user requires the permission APP_B2B_MANAGE_PUNCHOUT.

Java Method

public com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutUserRO com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutUserItemResource.getUserDetails()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The customer ID | Example: OilCorp
in pathOCIPunchoutUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

- The details for the OCI Punchout user were successfully retrieved.
PunchoutUserRO application/json

401 - Unauthorized

- The user could not be authenticated.

403 - Forbidden

- The user does not have the required permissions.

404 - Not Found

- The customer/OCI Punchout user could not be found or OCI Punchout is not supported.
PUT: Updates OCI Punchout user data

Description

This operation updates the information of an OCI Punchout user. The authenticated user requires the permission APP_B2B_MANAGE_PUNCHOUT.

The following user attributes can be updated:

  • email - notifications for the OCI Punchout user are send to this email address

  • password - the configured password for the OCI Punchout user

  • active - flag to enable/disable the OCI Punchout user

All attributes are optional, see request code examples below.

Java Method

public com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutUserRO com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutUserItemResource.updatePunchoutUser(com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutUserRO)

Request Body

PunchoutUserRO application/json

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The customer ID | Example: OilCorp
in pathOCIPunchoutUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

- The OCI Punchout user data were successfully updated.
PunchoutUserRO application/json

400 - Bad Request

- If the credentials to update are not valid regarding internal policies.

401 - Unauthorized

- The user could not be authenticated.

403 - Forbidden

- The user does not have the required permissions.

404 - Not Found

- The customer/OCI Punchout user could not be found or OCI Punchout is not supported.
DELETE: Deletes an OCI Punchout specific user of a customer

Description

This operation deletes a OCI Punchout user of a customer. The executing user must be authenticated and requires the permission APP_B2B_MANAGE_PUNCHOUT.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.punchout.v2.capi.oci.resource.OCIPunchoutUserItemResource.deletePunchoutUser()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The customer ID | Example: OilCorp
in pathOCIPunchoutUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

204 - No Content

- The OCI Punchout user was successfully deleted.

401 - Unauthorized

- The user could not be authenticated.

403 - Forbidden

- The user does not have the required permissions.

404 - Not Found

- The customer/OCI Punchout user could not be found or OCI Punchout is not supported.

Request and Response Object Schemata

LinkRO application/json{
  • "name":
    string
    the name of the returned element
  • "type":
    string
    Readonly | This is a constant: Link | Example: Link
  • "attributes":
    array
    An array of ResourceAttribute objects. the list of attributes
    [
    ResourceAttribute: An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
    ]
  • "uri":
    string
    The uri
  • "relation":
    string
    The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
  • "title":
    string
    The title of the link
  • "description":
    string
    The description of the link
  • "itemId":
    string
    the Id of the linked item
  • "attribute":
    object
    A ResourceAttribute object. An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
}
LinkROResourceCollectionRO application/json{
  • "pageable":
    string
    The pageable ID
  • "total":
    integer
    The pageable amount total | Format: int32
  • "offset":
    integer
    The pageable offset | Format: int32
  • "amount":
    integer
    The pageable amount | Format: int32
  • "elements":
    array
    An array of LinkRO objects. The list of elements
    [
    LinkRO: A Link pointing to a resource
    {
    • "name":
      string
      the name of the returned element
    • "type":
      string
      Readonly | This is a constant: Link | Example: Link
    • "attributes":
      array
      An array of ResourceAttribute objects. the list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
      The uri
    • "relation":
      string
      The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
      The title of the link
    • "description":
      string
      The description of the link
    • "itemId":
      string
      the Id of the linked item
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
  • "type":
    string
    The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "sortKeys":
    array
    An array of string literals. The keys to sort for
  • "name":
    string
    The name of an element.
}
PunchoutConfigurationOptionsRO application/json{
  • "name":
    string
    The name of an element.
  • "type":
    string
    The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "description":
    string
    The description of the configuration | Example: Show available configurations for OCI Punchout
  • "availableFormatters":
    array
    An array of PunchoutAvailableFormatterRO objects. The available formatters for the configuration as collection of PunchoutAvailableFormatterROs
    [
    PunchoutAvailableFormatterRO: This resource holds the available formatters for the configuration as a collection of PunchoutAvailableFormatterROs.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: PunchoutAvailableFormatter
    • "id":
      string
      The ID of the formatter | Example: Trim
    }
    ]
  • "availablePlaceholders":
    array
    An array of PunchoutAvailablePlaceholderRO objects. The available placeholders for the configuration as collection of PunchoutAvailablePlaceholderROs
    [
    PunchoutAvailablePlaceholderRO: This resource holds the available placeholders for the configuration as collection of PunchoutAvailablePlaceholderROs.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: PunchoutAvailablePlaceholder
    • "id":
      string
      The ID of the placeholder | Example: Currency
    }
    ]
}
PunchoutConfigurationRO application/json{
  • "name":
    string
    The name of an element.
  • "type":
    string
    The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "items":
    array
    An array of PunchoutConfigurationItemRO objects. The configuration items as collection of PunchoutConfigurationItemROs
    [
    PunchoutConfigurationItemRO: This resource holds the configuration items as Collection of PunchoutConfigurationItemROs.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    • "field":
      string
      The field of the configuration item | Example: NEW_ITEM-MATGROUP
    • "transform":
      string
      The transform of the configuration Item | Example: {ManufacturerName}
    • "formatter":
      string
      The formatter for the configuration item | Example: UpperCase
    • "mappings":
      array
      An array of PunchoutConfigurationItemMappingRO objects. The configuration item mappings as collection of PunchoutConfigurationItemMappingROs
      [
      PunchoutConfigurationItemMappingRO: This resource holds the configuration item mappings as a collection of PunchoutConfigurationItemMappingROs.
      {
      • "name":
        string
        The name of an element.
      • "type":
        string
        The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: PunchoutConfigurationItemMapping
      • "mapFromValue":
        string
        The from value for the configuration of the item mapping | Example: meter
      • "mapToValue":
        string
        The to value for the configuration of the item mapping | Example: m
      }
      ]
    }
    ]
}
PunchoutItemRO application/json{
  • "name":
    string
    The name of an element.
  • "type":
    string
    The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "punchoutType":
    string
    Required | The Punchout type | Example: oci
  • "version":
    string
    Required | The Punchout version | Example: ver5
  • "punchoutData":
    object
    A PunchoutDataRO object. This resource holds the Punchout data as PunchoutDataRO.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: PunchoutData
    • "punchoutDataItems":
      array
      An array of PunchoutDataItemRO objects.
      [
      PunchoutDataItemRO: This resource holds the Punchout data as a collection of PunchoutDataItemROs.
      {
      • "name":
        string
        The name of an element.
      • "type":
        string
        The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: PunchoutDataItem
      • "dataItemFields":
        array
        An array of PunchoutDataItemFieldRO objects. The data item fields as a collection of PunchoutDataItemFieldROs
        [
        PunchoutDataItemFieldRO:
        {
        • "name":
          string
          The name of an element.
        • "type":
          string
          The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: PunchoutDataItemField
        • "value":
          string
          The value of the Data Item Field | Example: 0.0
        }
        ]
      • "punchoutDataItemFields":
        array
        An array of PunchoutDataItemFieldRO objects.
        [
        PunchoutDataItemFieldRO:
        {
        • "name":
          string
          The name of an element.
        • "type":
          string
          The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: PunchoutDataItemField
        • "value":
          string
          The value of the Data Item Field | Example: 0.0
        }
        ]
      }
      ]
    • "dataItems":
      array
      An array of PunchoutDataItemRO objects. The Punchout data as a collection of PunchoutDataItemROs
      [
      PunchoutDataItemRO: This resource holds the Punchout data as a collection of PunchoutDataItemROs.
      {
      • "name":
        string
        The name of an element.
      • "type":
        string
        The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: PunchoutDataItem
      • "dataItemFields":
        array
        An array of PunchoutDataItemFieldRO objects. The data item fields as a collection of PunchoutDataItemFieldROs
        [
        PunchoutDataItemFieldRO:
        {
        • "name":
          string
          The name of an element.
        • "type":
          string
          The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: PunchoutDataItemField
        • "value":
          string
          The value of the Data Item Field | Example: 0.0
        }
        ]
      • "punchoutDataItemFields":
        array
        An array of PunchoutDataItemFieldRO objects.
        [
        PunchoutDataItemFieldRO:
        {
        • "name":
          string
          The name of an element.
        • "type":
          string
          The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: PunchoutDataItemField
        • "value":
          string
          The value of the Data Item Field | Example: 0.0
        }
        ]
      }
      ]
    }
}
PunchoutTransferContainerRO application/json{
  • "data":
    array
    An array of PunchoutTransferDataItemFieldRO objects. The core data of the response object.
    [
    PunchoutTransferDataItemFieldRO: The core data of the response object.
    {
    • "name":
      string
      The name of an element.
    • "value":
      string
    }
    ]
  • "errors":
    array
    Readonly | An array of FeedbackRO_v1 objects. List of errors that occurred in relation to the request.
    [
    FeedbackRO_v1: An error or information representation regarding the current request.
    {
    • "causes":
      array
      An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
      [
      FeedbackCauseRO_v1: A representation for the common feedback informations.
      {
      • "code":
        string
        Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
      • "message":
        string
        Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
      • "parameters":
        object
        A map of several parameters that are used to assemble the message.
      • "paths":
        array
        An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
      }
      ]
    • "code":
      string
      An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
    • "message":
      string
      A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
    • "parameters":
      object
      A map of several parameters that are used to assemble the message.
    • "paths":
      array
      An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
    • "status":
      string
      The HTTP status code, that is applicable to this problem. | Example: 400
    }
    ]
  • "included":
    object
    Optionally included related data objects.
  • "infos":
    array
    Readonly | An array of FeedbackRO_v1 objects. List of informations regarding to the request (e.g. value adjustments).
    [
    FeedbackRO_v1: An error or information representation regarding the current request.
    {
    • "causes":
      array
      An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
      [
      FeedbackCauseRO_v1: A representation for the common feedback informations.
      {
      • "code":
        string
        Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
      • "message":
        string
        Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
      • "parameters":
        object
        A map of several parameters that are used to assemble the message.
      • "paths":
        array
        An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
      }
      ]
    • "code":
      string
      An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
    • "message":
      string
      A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
    • "parameters":
      object
      A map of several parameters that are used to assemble the message.
    • "paths":
      array
      An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
    • "status":
      string
      The HTTP status code, that is applicable to this problem. | Example: 400
    }
    ]
  • "links":
    object
    Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
}
PunchoutUserRO application/json{
  • "name":
    string
    The name of an element.
  • "type":
    string
    The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: PunchoutUser
  • "id":
    string
    Readonly | The ID of the user | Example: oci1
  • "login":
    string
    The login of the user | Example: ociuser1
  • "email":
    string
    The e-mail adress of the user | Example: ocitester@test.intershop.de
  • "password":
    string
    The password of the user | Example: !InterShop00!
  • "active":
    boolean
    Indicates whether the user is active | Example: true
}

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