openapi: 3.0.1 info: title: Punchout description: "This version is deprecated. Please use the newer version which covers\ \ all supported operations from this version and also additional functionality.\ \ \n\nThe Intershop Punchout REST API contains resources for managing supported\ \ Punchout standards, Punchout configurations and Punchout users.\nThis includes\ \ updating configurations, creating, changing or deleting users or user data as\ \ well as retrieving information on available standards and options.\n" contact: name: Intershop Communications AG url: http://intershop.com version: 1.0.0 servers: - url: "/INTERSHOP/rest/{serverGroup}/{siteName}/{appUrl}" description: Intershop ICM Server variables: serverGroup: description: The server group default: WFS siteName: description: The site name default: inSPIRED-inTRONICS-Site appUrl: description: The application URL identifier enum: - smb-responsive - "-" default: smb-responsive tags: - name: Configuration description: | This section covers operations for managing Punchout configurations. This includes retrieving customer-specific configurations as well as updating an existing configuration. x-origin-class: com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutConfigurationListResource - name: General description: "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.\n" x-origin-class: com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutItemResource - name: User Management description: "This section covers operations for managing Punchout users. This includes\ \ retrieving information on users, creating a new user, updating user data as\ \ well as deleting specific users.\n" x-origin-class: com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutUserItemResource paths: /customers/{CustomerKey}/punchouts: get: tags: - General summary: Returns supported Punchout standards description: | This operation returns details on supported Punchout standards. Punchout standards are defined in the punchoutconfiguration.properties. 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. operationId: getAvailablePunchouts parameters: - name: CustomerKey in: path description: The customer ID required: true schema: type: string description: The customer ID example: OilCorp example: OilCorp x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource responses: "200": description: Ok - The punchout standards were successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/LinkROResourceCollectionRO' text/xml: schema: $ref: '#/components/schemas/LinkROResourceCollectionRO' "401": description: Unauthorized - The user could not be authenticated. "403": description: Forbidden - The user does not have the required permissions. "404": description: Not found - The customer with the given ID could not be found. deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutListResource.getAvailablePunchouts() x-origin-class: com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutListResource /customers/{CustomerKey}/punchouts/{PunchoutKey}: get: tags: - General summary: Returns details for the selected Punchout standard description: | This operation returns details of the selected Punchout standard. The authenticated user requires the permission APP_B2B_VIEW_PUNCHOUT or APP_B2B_SEND_OCI_BASKET. __Either__ `basketId` __or__ `searchTerm` is allowed. operationId: getPunchoutItemDetails parameters: - name: basketId in: query description: Returns the basket line item data according to Punchout configuration schema: type: string description: Returns the basket line item data according to Punchout configuration - name: searchTerm in: query description: Returns data of products that match the search term schema: type: string description: Returns data of products that match the search term example: Sony example: Sony - name: CustomerKey in: path description: The customer ID required: true schema: type: string description: The customer ID example: OilCorp example: OilCorp x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource - name: PunchoutKey in: path description: The type of the Punchout required: true schema: type: string description: The type of the Punchout example: oci example: oci x-item-key: com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutListResource responses: "200": description: Ok - The details for the Punchout standard were successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/PunchoutItemRO' text/xml: schema: $ref: '#/components/schemas/PunchoutItemRO' "401": description: Unauthorized - The user could not be authenticated. "403": description: Forbidden - The user does not have the required permissions. "404": description: Not found - The customer or Punchout with the given ID could not be found. deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: "public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutItemResource.getPunchoutItemDetails(java.lang.String,java.lang.String)" x-origin-class: com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutItemResource options: tags: - General summary: Shows configuration options for the selected Punchout standard description: | This operation returns all available configuration options for the selected Punchout standard. The authenticated user requires the permission APP_B2B_VIEW_PUNCHOUT or the permission APP_B2B_SEND_OCI_BASKET. operationId: getPunchoutConfigurationOptions parameters: - name: CustomerKey in: path description: The customer ID required: true schema: type: string description: The customer ID example: OilCorp example: OilCorp x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource - name: PunchoutKey in: path description: The type of the Punchout required: true schema: type: string description: The type of the Punchout example: oci example: oci x-item-key: com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutListResource responses: "200": description: Ok - The configuration options for the Punchout standard were successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/PunchoutConfigurationOptionsRO' text/xml: schema: $ref: '#/components/schemas/PunchoutConfigurationOptionsRO' "401": description: Unauthorized - The user could not be authenticated. "403": description: Forbidden - The user does not have the required permissions. "404": description: Not found - The customer or Punchout with the given ID could not be found. deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutItemResource.getPunchoutConfigurationOptions() x-origin-class: com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutItemResource /customers/{CustomerKey}/punchouts/{PunchoutKey}/configurations: get: tags: - Configuration summary: Returns customer-specific Punchout configurations description: | This operation returns the customer-specific configuration for the selected Punchout standard. The authenticated user must have the permission APP_B2B_MANAGE_PUNCHOUT. operationId: getPunchoutConfiguration parameters: - name: CustomerKey in: path description: The customer ID required: true schema: type: string description: The customer ID example: OilCorp example: OilCorp x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource - name: PunchoutKey in: path description: The type of the Punchout required: true schema: type: string description: The type of the Punchout example: oci example: oci x-item-key: com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutListResource responses: "200": description: Ok - The customer-specific configurations for the Punchout standard were successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/PunchoutConfigurationRO' text/xml: schema: $ref: '#/components/schemas/PunchoutConfigurationRO' "401": description: Unauthorized - The user could not be authenticated. "403": description: Forbidden - The user does not have the required permissions. "404": description: Not found - The customer or Punchout with the given ID could not be found. deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutConfigurationListResource.getPunchoutConfiguration() x-origin-class: com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutConfigurationListResource put: tags: - Configuration summary: Update the existing Punchout configuration description: "This operation updates existing Punchout configurations. The 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.\n" operationId: updatePunchoutConfiguration parameters: - name: CustomerKey in: path description: The customer ID required: true schema: type: string description: The customer ID example: OilCorp example: OilCorp x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource - name: PunchoutKey in: path description: The type of the Punchout required: true schema: type: string description: The type of the Punchout example: oci example: oci x-item-key: com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/PunchoutConfigurationRO' text/xml: schema: $ref: '#/components/schemas/PunchoutConfigurationRO' responses: "200": description: Ok - The customer-specific configurations for the Punchout standard were successfully updated. content: application/json: schema: $ref: '#/components/schemas/PunchoutConfigurationRO' text/xml: schema: $ref: '#/components/schemas/PunchoutConfigurationRO' "401": description: Unauthorized - The user could not be authenticated. "403": description: Forbidden - The user does not have the required permissions. "404": description: Not found - The customer or Punchout with the given ID could not be found. deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutConfigurationListResource.updatePunchoutConfiguration(com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutConfigurationRO) x-origin-class: com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutConfigurationListResource /customers/{CustomerKey}/punchouts/{PunchoutKey}/users: get: tags: - User Management summary: Get Punchout users description: | This operation returns all users for the selected Punchout standard. The authenticated user requires the permission APP_B2B_MANAGE_PUNCHOUT. The response is of type ResourceCollectionRO and contains objects of type LinkRO. operationId: getPunchoutUsers parameters: - name: CustomerKey in: path description: The customer ID required: true schema: type: string description: The customer ID example: OilCorp example: OilCorp x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource - name: PunchoutKey in: path description: The type of the Punchout required: true schema: type: string description: The type of the Punchout example: oci example: oci x-item-key: com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutListResource responses: "200": description: Ok - The Punchout users were successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/LinkROResourceCollectionRO' text/xml: schema: $ref: '#/components/schemas/LinkROResourceCollectionRO' "401": description: Unauthorized - The user could not be authenticated. "403": description: Forbidden - The user does not have the required permissions. "404": description: Not found - The customer or punchout with the given ID could not be found. deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutUserListResource.getPunchoutUsers() x-origin-class: com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutUserListResource post: tags: - User Management summary: Create a Punchout user description: | This operation creates a new Punchout user. The ID property of PunchoutUser will be created automatically. The authenticated user must have the permission APP_B2B_MANAGE_PUNCHOUT. operationId: createPunchoutUser parameters: - name: CustomerKey in: path description: The customer ID required: true schema: type: string description: The customer ID example: OilCorp example: OilCorp x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource - name: PunchoutKey in: path description: The type of the Punchout required: true schema: type: string description: The type of the Punchout example: oci example: oci x-item-key: com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/PunchoutUserRO' text/xml: schema: $ref: '#/components/schemas/PunchoutUserRO' responses: "201": description: Created - The Punchout user was successfully created. content: application/json: schema: $ref: '#/components/schemas/LinkRO' text/xml: schema: $ref: '#/components/schemas/LinkRO' "400": description: Bad request - At least one attribute is missing in the request body or the credentials are not valid regarding internal policies. "401": description: Unauthorized - The user could not be authenticated. "403": description: Forbidden - The user does not have the required permissions. "404": description: Not found - The customer or Punchout with the given ID could not be found. "409": description: |- Conflict - The Punchout user already exists. Possible values for header 'error-key': - punchout.login_already_exists.error deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutUserListResource.createPunchoutUser(com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutUserRO) x-origin-class: com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutUserListResource /customers/{CustomerKey}/punchouts/{PunchoutKey}/users/{PunchoutUserKey}: get: tags: - User Management summary: Returns information on the given Punchout user description: | This operation returns information on the given Punchout user. The authenticated user requires the permissionAPP_B2B_MANAGE_PUNCHOUT. operationId: getUserDetails parameters: - name: CustomerKey in: path description: The customer ID required: true schema: type: string description: The customer ID example: OilCorp example: OilCorp x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource - name: PunchoutKey in: path description: The type of the Punchout required: true schema: type: string description: The type of the Punchout example: oci example: oci x-item-key: com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutListResource - name: PunchoutUserKey in: path description: The ID of the Punchout user required: true schema: type: string description: The ID of the Punchout user example: ociuser@test.intershop.de example: ociuser@test.intershop.de x-item-key: com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutUserListResource responses: "200": description: Ok - The details for the Punchout user were successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/PunchoutUserRO' text/xml: schema: $ref: '#/components/schemas/PunchoutUserRO' "401": description: Unauthorized - The user could not be authenticated. "403": description: Forbidden - The user does not have the required permissions. "404": description: "Not found - The customer, Punchout or Punchout user with the\ \ given ID could not be found." deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutUserRO com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutUserItemResource.getUserDetails() x-origin-class: com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutUserItemResource put: tags: - User Management summary: Updates Punchout user data description: "This operation updates the information of a Punchout user. The\ \ authenticated user requires the permission APP_B2B_MANAGE_PUNCHOUT.\n\n\ The following user attributes can be updated:\n* `email` - notifications for\ \ the Punchout user are send to this email address\n\n* `password` - the configured\ \ password for the Punchout user\n\n* `active` - flag to enable/disable the\ \ Punchout user\n\nAll attributes are optional, see request code examples\ \ below.\n" operationId: updatePunchoutUser parameters: - name: CustomerKey in: path description: The customer ID required: true schema: type: string description: The customer ID example: OilCorp example: OilCorp x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource - name: PunchoutKey in: path description: The type of the Punchout required: true schema: type: string description: The type of the Punchout example: oci example: oci x-item-key: com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutListResource - name: PunchoutUserKey in: path description: The ID of the Punchout user required: true schema: type: string description: The ID of the Punchout user example: ociuser@test.intershop.de example: ociuser@test.intershop.de x-item-key: com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutUserListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/PunchoutUserRO' text/xml: schema: $ref: '#/components/schemas/PunchoutUserRO' responses: "200": description: Ok - The Punchout user data was successfully updated. content: application/json: schema: $ref: '#/components/schemas/PunchoutUserRO' text/xml: schema: $ref: '#/components/schemas/PunchoutUserRO' "400": description: Bad request - If the credentials to update are not valid regarding internal policies. "401": description: Unauthorized - The user could not be authenticated. "403": description: Forbidden - The user does not have the required permissions. "404": description: "Not found - The customer, Punchout or Punchout user with the\ \ given ID could not be found." deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutUserRO com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutUserItemResource.updatePunchoutUser(com.intershop.application.storefront.rest.b2b.capi.punchout.resourceobject.PunchoutUserRO) x-origin-class: com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutUserItemResource delete: tags: - User Management summary: Deletes a specific Punchout user of a customer description: | This operation deletes a Punchout-specific user of a customer. The executing user must be authenticated and requires the permission APP_B2B_MANAGE_PUNCHOUT. operationId: deletePunchoutUser parameters: - name: CustomerKey in: path description: The customer ID required: true schema: type: string description: The customer ID example: OilCorp example: OilCorp x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource - name: PunchoutKey in: path description: The type of the Punchout required: true schema: type: string description: The type of the Punchout example: oci example: oci x-item-key: com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutListResource - name: PunchoutUserKey in: path description: The ID of the Punchout user required: true schema: type: string description: The ID of the Punchout user example: ociuser@test.intershop.de example: ociuser@test.intershop.de x-item-key: com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutUserListResource responses: "204": description: No content - The Punchout user was successfully deleted. "401": description: Unauthorized - The user could not be authenticated. "403": description: Forbidden - The user does not have the required permissions. "404": description: "Not found - The customer, Punchout or Punchout user with the\ \ given ID could not be found." deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutUserItemResource.deletePunchoutUser() x-origin-class: com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutUserItemResource components: schemas: LinkRO: title: Link type: object properties: name: type: string description: The name of the returned element xml: attribute: true type: type: string description: "This is a constant: **Link**" readOnly: true example: Link xml: attribute: true attributes: type: array description: The list of attributes xml: wrapped: true items: $ref: '#/components/schemas/ResourceAttribute' uri: type: string description: The URI relation: type: string description: The relation of the link externalDocs: description: Link Relations (www.iana.org) url: http://www.iana.org/assignments/link-relations/link-relations.xml enum: - about - alternate - appendix - archives - author - bookmark - canonical - chapter - collection - contents - copyright - create-form - current - describedby - describes - disclosure - duplicate - edit - edit-form - edit-media - enclosure - first - glossary - help - hosts - hub - icon - index - item - last - latest-version - license - lrdd - monitor - monitor-group - next - next-archive - nofollow - noreferrer - payment - predecessor-version - prefetch - prev - preview - previous - prev-archive - privacy-policy - profile - related - replies - search - section - self - service - start - stylesheet - subsection - successor-version - tag - terms-of-service - type - up - version-history - via - working-copy - working-copy-of title: type: string description: The title of the link description: type: string description: The description of the link itemId: type: string description: The ID of the linked item attribute: $ref: '#/components/schemas/ResourceAttribute' description: A Link pointing to a resource xml: name: Link LinkROResourceCollectionRO: type: object properties: pageable: type: string description: The pageable ID total: type: integer description: The pageable amount total format: int32 offset: type: integer description: The pageable offset format: int32 amount: type: integer description: The pageable amount format: int32 elements: type: array description: The list of elements xml: wrapped: true items: $ref: '#/components/schemas/LinkRO' type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' xml: attribute: true sortKeys: uniqueItems: true type: array description: The keys to sort for xml: wrapped: true items: type: string description: The keys to sort for xml: name: sortKey name: type: string description: The name of an element xml: attribute: true description: This resource holds a list of Link-ResourceObjects. xml: name: ResourceCollection ResourceAttribute: title: Attribute type: object properties: name: type: string description: The attribute's name xml: attribute: true type: type: string description: "This is a constant: **ResourceAttribute**" example: ResourceAttribute xml: attribute: true value: type: object description: The attribute's value. description: An attribute xml: name: ResourceAttribute PunchoutAvailableFormatterRO: title: PunchoutAvailableFormatter type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: PunchoutAvailableFormatter xml: attribute: true id: type: string description: The ID of the formatter example: Trim description: This resource holds the available formatters for the configuration as a collection of PunchoutAvailableFormatterROs. xml: name: PunchoutAvailableFormatter PunchoutAvailablePlaceholderRO: title: PunchoutAvailablePlaceholder type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: PunchoutAvailablePlaceholder xml: attribute: true id: type: string description: The ID of the placeholder example: Currency description: This resource holds the available placeholders for the configuration as a collection of PunchoutAvailablePlaceholderROs. xml: name: PunchoutAvailablePlaceholder PunchoutConfigurationOptionsRO: title: PunchoutConfigurationOptions type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' xml: attribute: true description: type: string description: The description of the configuration example: Show available configurations for OCI Punchout availableFormatters: type: array description: The available formatters for the configuration as a collection of PunchoutAvailableFormatterROs xml: wrapped: true items: $ref: '#/components/schemas/PunchoutAvailableFormatterRO' availablePlaceholders: type: array description: The available placeholders for the configuration as a collection of PunchoutAvailablePlaceholderROs xml: wrapped: true items: $ref: '#/components/schemas/PunchoutAvailablePlaceholderRO' description: This resource holds configuration options for OCI Punchout as a collection of PunchoutConfigurationOptionsROs. xml: name: PunchoutConfigurationOptions PunchoutDataItemFieldRO: title: PunchoutDataItemField type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: PunchoutDataItemField xml: attribute: true value: type: string description: The value of the Data Item Field example: "0.0" xml: name: PunchoutDataItemField PunchoutDataItemRO: title: PunchoutDataItem type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: PunchoutDataItem xml: attribute: true dataItemFields: type: array description: The data item fields as a collection of PunchoutDataItemFieldROs xml: name: PunchoutDataItemField items: $ref: '#/components/schemas/PunchoutDataItemFieldRO' punchoutDataItemFields: type: array writeOnly: true items: $ref: '#/components/schemas/PunchoutDataItemFieldRO' description: This resource holds the Punchout data as a collection of PunchoutDataItemROs. xml: name: PunchoutDataItem PunchoutDataRO: title: PunchoutData type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: PunchoutData xml: attribute: true punchoutDataItems: type: array writeOnly: true items: $ref: '#/components/schemas/PunchoutDataItemRO' dataItems: type: array description: The Punchout data as a collection of PunchoutDataItemROs xml: wrapped: true items: $ref: '#/components/schemas/PunchoutDataItemRO' description: This resource holds the Punchout data as PunchoutDataRO. xml: name: PunchoutData PunchoutItemRO: title: PunchoutItem required: - punchoutType - version type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' xml: attribute: true punchoutType: type: string description: The Punchout type example: oci version: type: string description: The Punchout version example: ver5 punchoutData: $ref: '#/components/schemas/PunchoutDataRO' xml: name: PunchoutItem PunchoutConfigurationItemMappingRO: title: PunchoutConfigurationItemMapping type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: PunchoutConfigurationItemMapping xml: attribute: true mapFromValue: type: string description: The 'from' value for the configuration of the item mapping example: meter mapToValue: type: string description: The 'to' value for the configuration of the item mapping example: m description: This resource holds the configuration item mappings as a collection of PunchoutConfigurationItemMappingROs. xml: name: PunchoutConfigurationItemMapping PunchoutConfigurationItemRO: title: PunchoutConfigurationItem type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' xml: attribute: true field: type: string description: The field of the configuration item example: NEW_ITEM-MATGROUP transform: type: string description: The transform of the configuration Item example: "{ManufacturerName}" formatter: type: string description: The formatter for the configuration item example: UpperCase mappings: type: array description: The configuration item mappings as collection of PunchoutConfigurationItemMappingROs xml: wrapped: true items: $ref: '#/components/schemas/PunchoutConfigurationItemMappingRO' description: This resource holds the configuration items as a collection of PunchoutConfigurationItemROs. xml: name: PunchoutConfigurationItem PunchoutConfigurationRO: title: PunchoutConfiguration type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' xml: attribute: true items: type: array description: The configuration items as a collection of PunchoutConfigurationItemROs xml: wrapped: true items: $ref: '#/components/schemas/PunchoutConfigurationItemRO' description: This resource serves as a container for configuration data. xml: name: PunchoutConfiguration PunchoutUserRO: title: PunchoutUser type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: PunchoutUser xml: attribute: true id: type: string description: The ID of the user readOnly: true example: oci1 login: type: string description: The login of the user example: ociuser1 email: type: string description: The e-mail adress of the user example: ocitester@test.intershop.de password: type: string description: The password of the user example: '!InterShop00!' active: type: boolean description: Indicates whether the user is active example: true xml: name: PunchoutUser responses: "200": description: OK "201": description: Created "202": description: Accepted "204": description: No Content "205": description: Reset Content "206": description: Partial Content "301": description: Moved Permanently "302": description: Found "303": description: See Other "304": description: Not Modified "305": description: Use Proxy "307": description: Temporary Redirect "400": description: Bad Request "401": description: Unauthorized "402": description: Payment Required "403": description: Forbidden "404": description: Not Found "405": description: Method Not Allowed "406": description: Not Acceptable "407": description: Proxy Authentication Required "408": description: Request Timeout "409": description: Conflict "410": description: Gone "411": description: Length Required "412": description: Precondition Failed "413": description: Request Entity Too Large "414": description: Request-URI Too Long "415": description: Unsupported Media Type "416": description: Requested Range Not Satisfiable "417": description: Expectation Failed "428": description: Precondition Required "429": description: Too Many Requests "431": description: Request Header Fields Too Large "500": description: Internal Server Error "501": description: Not Implemented "502": description: Bad Gateway "503": description: Service Unavailable "504": description: Gateway Timeout "505": description: HTTP Version Not Supported "511": description: Network Authentication Required parameters: loc: name: loc in: path description: "The locale ID (submitted as optional matrix parameter ```;loc=```).\ \ If omitted, the priority is as follows (from high to low): Locale ID parameter,\ \ user's default locale, site's default locale. The available locales depend\ \ on your individual Intershop Commerce Management installation. Use IANA\ \ language definitions for languages and regions and combine them using a\ \ underscore, e. g. ```en_US```." required: false style: matrix schema: type: string description: "The locale ID (submitted as optional matrix parameter ```;loc=```).\ \ If omitted, the priority is as follows (from high to low): Locale ID parameter,\ \ user's default locale, site's default locale. The available locales depend\ \ on your individual Intershop Commerce Management installation. Use IANA\ \ language definitions for languages and regions and combine them using\ \ a underscore, e. g. ```en_US```." default: en_US examples: en_US: description: English (United States) value: en_US fr_FR: description: French (France) value: fr_FR de_DE: description: German (Germany) value: de_DE x-matrixParamPath: / cur: name: cur in: path description: "The currency code (submitted as optional matrix parameter ```;cur=```).\ \ If omitted, the site's or user's default currency is used." required: false style: matrix schema: type: string description: "The currency code (submitted as optional matrix parameter ```;cur=```).\ \ If omitted, the site's or user's default currency is used." default: USD examples: FJD: description: Fiji Dollar value: FJD STD: description: São Tomé / Príncipe Dobra value: STD MXN: description: Mexican Peso value: MXN SCR: description: Seychelles Rupee value: SCR LVL: description: Latvian Lats value: LVL CDF: description: Congolese Franc value: CDF GTQ: description: Guatemalan Quetzal value: GTQ BBD: description: Barbados Dollar value: BBD CLP: description: Chilean Peso value: CLP UGX: description: Ugandan Shilling value: UGX HNL: description: Honduran Lempira value: HNL ZAR: description: South African Rand value: ZAR TND: description: Tunisian Dinar value: TND SLL: description: Sierra Leonean Leone value: SLL BSD: description: Bahamian Dollar value: BSD SDG: description: Sudanese Pound value: SDG IQD: description: Iraqi Dinar value: IQD GMD: description: Gambian Dalasi value: GMD CUP: description: Cuban Peso value: CUP TWD: description: New Taiwan Dollar value: TWD RSD: description: Serbian Dinar value: RSD ZRZ: description: Zaire value: ZRZ DOP: description: Dominican Peso value: DOP KMF: description: Comoro Franc value: KMF MYR: description: Malaysian Ringgit value: MYR FKP: description: Falkland Islands Pound value: FKP XOF: description: CFA Franc BCEAO value: XOF GEL: description: Lari value: GEL UYU: description: Uruguayan Peso value: UYU MAD: description: Moroccan Dirham value: MAD CVE: description: Cape Verde Escudo value: CVE TOP: description: Tongan Pa'anga value: TOP PGK: description: Papua New Guinean Kina value: PGK OMR: description: Omani Rial value: OMR AZN: description: Azerbaijanian Manat value: AZN SEK: description: Swedish Krona value: SEK KES: description: Kenyan Shilling value: KES UAH: description: Ukrainian Hryvnia value: UAH BTN: description: Ngultrum value: BTN GNF: description: Guinea Franc value: GNF MZN: description: Mozambican Metical value: MZN ERN: description: Nakfa value: ERN SVC: description: Salvadoran Colón value: SVC ARS: description: Argentine Peso value: ARS QAR: description: Qatari Riyal value: QAR NLG: description: Dutch Guilder value: NLG IRR: description: Iranian Rial value: IRR MRO: description: Mauritanian Ouguiya value: MRO XPF: description: CFP Franc value: XPF UZS: description: Uzbekistani Som value: UZS THB: description: Thai Baht value: THB CNY: description: Yuan Renminbi value: CNY BDT: description: Bangladeshi Taka value: BDT LYD: description: Libyan Dinar value: LYD BMD: description: Bermudian Dollar value: BMD PHP: description: Philippine Peso value: PHP KWD: description: Kuwaiti Dinar value: KWD RUB: description: Russian Ruble value: RUB PYG: description: Paraguayan Guarani value: PYG JMD: description: Jamaican Dollar value: JMD ISK: description: Iceland Krona value: ISK GWP: description: Guinea Peso value: GWP BEF: description: Belgian Franc value: BEF ESP: description: Spanish Peseta value: ESP COP: description: Colombian Peso value: COP USD: description: US Dollar value: USD MKD: description: Denar value: MKD DZD: description: Algerian Dinar value: DZD PAB: description: Panamanian Balboa value: PAB SGD: description: Singapore Dollar value: SGD ETB: description: Ethiopian Birr value: ETB VUV: description: Vanuatu Vatu value: VUV VEF: description: Venezuelan Bolivar Fuerte value: VEF SOS: description: Somali Shilling value: SOS KGS: description: Som value: KGS LAK: description: Lao Kip value: LAK ZMK: description: Zambian Kwacha value: ZMK BND: description: Brunei Dollar value: BND XAF: description: CFA Franc BEAC value: XAF LRD: description: Liberian Dollar value: LRD ITL: description: Italian Lira value: ITL HRK: description: Croatian Kuna value: HRK CHF: description: Swiss Franc value: CHF ATS: description: Austrian Schilling value: ATS DJF: description: Djibouti Franc value: DJF ALL: description: Albanian Lek value: ALL MTL: description: Maltese Lira value: MTL TZS: description: Tanzanian Shilling value: TZS VND: description: Vietnamese Dong value: VND AUD: description: Australian Dollar value: AUD ILS: description: New Israeli Sheqel value: ILS KPW: description: North Korean Won value: KPW GYD: description: Guyanese Dollar value: GYD GHS: description: Ghanaian Cedi value: GHS MDL: description: Moldovan Leu value: MDL KHR: description: Cambodian Riel value: KHR BOB: description: Boliviano value: BOB IDR: description: Indonesian Rupiah value: IDR KYD: description: Cayman Islands Dollar value: KYD AMD: description: Armenian Dram value: AMD TRY: description: Turkish Lira value: TRY SHP: description: Saint Helena Pound value: SHP BWP: description: Botswana Pula value: BWP LBP: description: Lebanese Pound value: LBP CYP: description: Cyprus Pound value: CYP TJS: description: Tajikistani Somoni value: TJS JOD: description: Jordanian Dinar value: JOD RWF: description: Rwanda Franc value: RWF HKD: description: Hong Kong Dollar value: HKD AED: description: United Arab Emirates Dirham value: AED EUR: description: Euro value: EUR LSL: description: Lesotho Loti value: LSL DKK: description: Danish Krone value: DKK CAD: description: Canadian Dollar value: CAD BGN: description: Bulgarian Lev value: BGN MMK: description: Kyat value: MMK EEK: description: Estonian Kroon value: EEK SYP: description: Syrian Pound value: SYP NOK: description: Norwegian Krone value: NOK MUR: description: Mauritian Rupee value: MUR ZWL: description: Zimbabwean Dollar value: ZWL GIP: description: Gibraltar Pound value: GIP RON: description: Romanian New Leu value: RON LKR: description: Sri Lankan Rupee value: LKR NGN: description: Nigerian Naira value: NGN IEP: description: Irish Pound value: IEP CZK: description: Czech Koruna value: CZK CRC: description: Costa Rican Colon value: CRC PKR: description: Pakistani Rupee value: PKR XCD: description: East Carribean Dollar value: XCD GRD: description: Greek Drachma value: GRD HTG: description: Haitian Gourde value: HTG ANG: description: Netherlands Antillian Guilder value: ANG SIT: description: Slovenian Tolar value: SIT BHD: description: Bahraini Dinar value: BHD PTE: description: Portuguese Escudo value: PTE BPP: description: Bonus Point Price value: BPP SZL: description: Swazi Lilangeni value: SZL SRD: description: Surinam Dollar value: SRD KZT: description: Kazakhstani Tenge value: KZT TTD: description: Trinidad and Tobago Dollar value: TTD SAR: description: Saudi Riyal value: SAR LTL: description: Lithuanian Litas value: LTL YER: description: Yemeni Rial value: YER MVR: description: Maldivian Rufiyaa value: MVR BPV: description: Bonus Point Value value: BPV AFN: description: Afghani value: AFN INR: description: Indian Rupee value: INR NPR: description: Nepalese Rupee value: NPR KRW: description: South Korean Won value: KRW AWG: description: Aruban Florin value: AWG MNT: description: Mongolian Tugrik value: MNT JPY: description: Japanese Yen value: JPY PLN: description: Polish Złoty value: PLN AOA: description: Angolan Kwanza value: AOA SBD: description: Solomon Islands Dollar value: SBD GBP: description: Pound Sterling value: GBP HUF: description: Hungarian Forint value: HUF BYR: description: Belarussian Ruble value: BYR LUF: description: Luxembourgian Franc value: LUF BIF: description: Burundi Franc value: BIF MWK: description: Malawian Kwacha value: MWK MGA: description: Malagasy Ariary value: MGA FIM: description: Finnish Mark value: FIM DEM: description: Deutsche Mark value: DEM BZD: description: Belize Dollar value: BZD BAM: description: Convertible Marks value: BAM MOP: description: Macanese Pataca value: MOP EGP: description: Egyptian Pound value: EGP NAD: description: Namibian Dollar value: NAD SKK: description: Slovakian Krona value: SKK NIO: description: Cordoba Oro value: NIO PEN: description: Peruvian Nuevo Sol value: PEN WST: description: Samoan Tala value: WST NZD: description: New Zealand Dollar value: NZD TMT: description: Turkmenistani Manat value: TMT FRF: description: French Franc value: FRF BRL: description: Brazilian Real value: BRL x-matrixParamPath: / regionals: name: regionals in: path required: false style: matrix schema: type: object properties: loc: type: string description: The locale ID example: en_US cur: type: string description: The currency code example: EUR x-matrixParamPath: / pgid: name: pgid in: path description: "The personalization group identifier, submitted as matrix parameter\ \ ```;pgid=```. Required if you want to work with customer-specific\ \ content." required: false style: matrix schema: type: string description: "The personalization group identifier, submitted as matrix parameter\ \ ```;pgid=```. Required if you want to work with customer-specific\ \ content." example: FUOGrzQ_VjORpGaN8DRGmLLE0000 example: FUOGrzQ_VjORpGaN8DRGmLLE0000 spgid: name: spgid in: path description: "The secure personalization group identifier, submitted as matrix\ \ parameter ```;spgid=```. Required if you want to work with customer-specific\ \ content." required: false style: matrix schema: type: string description: "The secure personalization group identifier, submitted as matrix\ \ parameter ```;spgid=```. Required if you want to work with customer-specific\ \ content." example: FUOGrzQ_VjORpGaN8DRGmLLE0000 example: FUOGrzQ_VjORpGaN8DRGmLLE0000 securitySchemes: basicAuth: type: http description: "Basic access authentication. In basic authentication, a request\ \ contains a header field in the form of authorization: ```Basic ```,\ \ where credentials is the Base64 encoding of ID and password joined by a\ \ single colon :." scheme: basic authToken: type: apiKey description: User authentication token to authenticate the request. The token is a string generated by the ICM server in the same header in every response of an REST endpoint. name: authentication-token in: header bearerAuth: type: http description: "Bearer token authentication. A request contains a header field\ \ in the form of authorization: ```Bearer ```, where is a string\ \ generated by an authentication service in response to a login request." scheme: bearer bearerFormat: JWT x-apiID: punchout x-origin-class: "com.intershop.component.rest.capi.resource.RootResource,com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutItemResource,com.intershop.application.storefront.rest.b2b.capi.punchout.resource.PunchoutItemResource"