Document Properties
Kbid
29615G
Last Modified
17-Feb-2023
Added to KB
11-Sep-2020
Public Access
Everyone
Status
Online
Doc Type
References
Product
  • ICM 7.10
  • ICM 11
Reference - Organization REST API 1.0.0
Document View


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

References

The following page lists available REST APIs for ICM 7.10 and their version dependencies:

API Specification

Introduction
OpenAPI Version: 3.0.1
Organization Version: 1.0.0

This is Intershop ICM REST API documentation.

This reference lists the REST API for storefront development. The REST API covers features of both, the B2C (SMB - Small and Medium-sized businesses) and the B2B storefront development.
This reference is intended for developers who want to make use of an easy-to-use API when developing frontend solutions.
You can find more information at Intershop Communications. Contact our Intershop experts at Support - Intershop Communications

Introduction

This API is documented in OpenAPI format.

Cost Object Type API
/customers/{CustomerKey}/costobjecttypes
GET: (Deprecated) Returns cost object types Deprecated.

Description

This operation is deprecated. The Cost Object feature is no longer supported.

ResourceCollectionRO contains objects of type LinkRO

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.storefront.rest.b2b.capi.costobject.resource.CostObjectTypeListResource.getCostObjectTypes()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

200 - OK

ResourceCollectionROLinkRO application/json
ResourceCollectionROLinkRO -> elements -> [..] -> itemId can be used as {CostObjectTypeKey} in subsequent requests. Links to item of type CostObjectTypeRO.

401 - Unauthorized

403 - Forbidden Requires authentication with a user who has been assigned the following permissions:
- View Cost Object Types (APP_B2B_VIEW_COSTOBJECTTYPE)

POST: (Deprecated) Creates new cost object type Deprecated.

Description

This operation is deprecated. The Cost Object feature is no longer supported.

Java Method

public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.costobject.resource.CostObjectTypeListResource.createCostObjectType(com.intershop.application.storefront.rest.b2b.capi.costobject.resourceobject.CostObjectTypeRO)

Request Body

CostObjectTypeRO application/json

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

201 - Created

400 - Bad Request possible values for header error-key:
- cost_object_type.missing_body.error
- cost_object_type.missing_attributes.error
- cost_object_type.invalid_attributes.error
- cost_object_type.already_exists.error

401 - Unauthorized

403 - Forbidden Requires authentication with a user who has been assigned the following permissions:
- Create Cost Object Types (APP_B2B_CREATE_COSTOBJECTTYPE)

/customers/{CustomerKey}/costobjecttypes/{CostObjectTypeKey}
GET: (Deprecated) Returns cost object type Deprecated.

Description

This operation is deprecated. The Cost Object feature is no longer supported.

Java Method

public com.intershop.application.storefront.rest.b2b.capi.costobject.resourceobject.CostObjectTypeRO com.intershop.application.storefront.rest.b2b.capi.costobject.resource.CostObjectTypeItemResource.getCostObjectType()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCostObjectTypeKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

200 - OK

CostObjectTypeRO application/json

401 - Unauthorized

403 - Forbidden Requires authentication with a user who has been assigned the following permissions:
- View Cost Object Types (APP_B2B_VIEW_COSTOBJECTTYPE)

404 - Not Found

PUT: (Deprecated) Updates cost object type Deprecated.

Description

This operation is deprecated. The Cost Object feature is no longer supported.

Java Method

public com.intershop.application.storefront.rest.b2b.capi.costobject.resourceobject.CostObjectTypeRO com.intershop.application.storefront.rest.b2b.capi.costobject.resource.CostObjectTypeItemResource.updateCostObjectType(com.intershop.application.storefront.rest.b2b.capi.costobject.resourceobject.CostObjectTypeRO)

Request Body

CostObjectTypeRO application/json

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCostObjectTypeKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

200 - OK

CostObjectTypeRO application/json

400 - Bad Request possible values for header error-key:
- cost_object_type.missing_body.error
- cost_object_type.missing_attributes.error
- cost_object_type.invalid_attributes.error

401 - Unauthorized

403 - Forbidden Requires authentication with a user who has been assigned the following permissions:
- Create Cost Object Types (APP_B2B_CREATE_COSTOBJECTTYPE)

404 - Not Found

DELETE: (Deprecated) Deletes cost object type Deprecated.

Description

This operation is deprecated. The Cost Object feature is no longer supported.

Deletes the cost object type with the same ID as the resource name

Java Method

public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.costobject.resource.CostObjectTypeItemResource.deleteCostObjectType()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCostObjectTypeKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

204 - No Content

401 - Unauthorized

403 - Forbidden Requires authentication with a user who has been assigned the following permissions:
- Delete Cost Object Types (APP_B2B_DELETE_COSTOBJECTTYPE)

404 - Not Found

Request and Response Object Schemata
CostObjectTypeRO application/json{
  • "name":
    string
    The name of an element | Example: Project
  • "displayName":
    string
    the display name of the cost object type | Example: Project
  • "description":
    string
    the description of the cost object type | Example: Project object type
}
ResourceCollectionROLinkRO 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
    This is a constant: ResourceCollection | Example: ResourceCollection
  • "sortKeys":
    array
    An array of string literals. The keys to sort for
  • "name":
    string
    The name of the returned element
}
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.
The Intershop Knowledge Portal uses only technically necessary cookies. We do not track visitors or have visitors tracked by 3rd parties. Please find further information on privacy in the Intershop Privacy Policy and Legal Notice.
Home
Knowledge Base
Product Releases
Log on to continue
This Knowledge Base document is reserved for registered customers.
Log on with your Intershop Entra ID to continue.
Write an email to supportadmin@intershop.de if you experience login issues,
or if you want to register as customer.