Related Documents
Document Properties
Kbid28Z438
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 type


Note

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

URI

/customers/-/costobjecttypes/<cost-object-type-id>

Http Method

GET

Short Description

Returns a specific cost object type

Query Parameters

none

Example Requests

/customers/-/costobjecttypes/A0wKDAB_cmoAAAFScGoZ4KdJ

HTTP Status Codes

200 OK

401 Unauthorized

403 Forbidden

404 Not Found

Description

Returns a specific cost object type by its ID

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.CostObjectTypeItemResource

Request data example

n/a

Response data format

application/json

Response related java object

com.intershop.application.storefront.rest.b2b.capi.costobject.resourceobject.CostObjectTypeRO
com.intershop.application.storefront.rest.b2b.capi.costobject.resource.CostObjectTypeItemResource

Response data example

Without query parameters:

200 OK
{
	"name": "Project",
	"displayName": "Project",
	"description": "Project object type"
}

XML

Request data format

text/xml

Request related java object

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

Request data example

n/a

Response data format

text/xml

Response related java object

com.intershop.application.storefront.rest.b2b.capi.costobject.resourceobject.CostObjectTypeRO
com.intershop.application.storefront.rest.b2b.capi.costobject.resource.CostObjectTypeItemResource

Response data example

Without query parameters:

200 OK
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CostObjectType>
	<description>Project object type</description>
	<displayName>Project</displayName>
	<name>Project</name>
</CostObjectType>

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