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

REST API - Get cost object types


Note

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

URI

/customers/-/costobjecttypes

Http Method

GET

Short Description

Returns cost object types

Query Parameters

none

Example Requests

/customers/-/costobjecttypes

HTTP Status Codes

200 OK

401 Unauthorized

403 Forbidden

Description

Returns a list of links to the cost object types available to the current customer

Cartridge

app_sf_rest_b2b
Application

SMB Responsive Shop

Access Restrictions

Requires authentication with user having assigned the following permissions:

  • View Cost Object Types (APP_B2B_VIEW_COSTOBJECTTYPE)

Product Version

7.9

Product To Version

 
Status

final

JSON

Request data format

application/json

Request related java object

com.intershop.application.storefront.rest.b2b.capi.costobject.resource.CostObjectTypeListResource

Request data example

n/a

Response data format

application/json

Response related java object

com.intershop.component.rest.capi.resourceobject.LinkRO
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO<LinkRO>
com.intershop.application.storefront.rest.b2b.capi.costobject.resource.CostObjectTypeListResource

Response data example

200 OK
{
   "elements":
   [
       {
           "type": "Link",
           "uri": "inSPIRED-inTRONICS_Business-Site/-/customers/-/costobjecttypes/A0wKDAB_cmoAAAFScGoZ4KdJ",
           "title": "Project"
       },
       {
           "type": "Link",
           "uri": "inSPIRED-inTRONICS_Business-Site/-/customers/-/costobjecttypes/FOsKDAB_2a0AAAFScmoZ4KdJ",
           "title": "PurchaseOrderNumber"
       }
   ],
   "type": "ResourceCollection"
}

XML

Request data format

text/xml

Request related java object

com.intershop.application.storefront.rest.b2b.capi.costobject.resource.CostObjectTypeListResource

Request data example

n/a

Response data format

text/xml

Response related java object

com.intershop.component.rest.capi.resourceobject.LinkRO
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO<LinkRO>
com.intershop.application.storefront.rest.b2b.capi.costobject.resource.CostObjectTypeListResource

Response data example

200 OK
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResourceCollection name="costobjecttypes" type="ResourceCollection">
  <elements>
    <Link type="Link">
      <title>Project</title>
      <uri>inSPIRED-inTRONICS_Business-Site/-/customers/-/costobjecttypes/A0wKDAB_cmoAAAFScGoZ4KdJ</uri>
    </Link>
    <Link type="Link">
      <title>PurchaseOrderNumber</title>
      <uri>inSPIRED-inTRONICS_Business-Site/-/customers/-/costobjecttypes/FOsKDAB_2a0AAAFScmoZ4KdJ</uri>
    </Link>
  </elements>
</ResourceCollection>

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