Document Properties
Kbid
29999M
Last Modified
30-May-2023
Added to KB
28-Oct-2021
Public Access
Everyone
Status
Online
Doc Type
References
Product
ICM 7.10
Reference - Cost Center 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
Cost Center Version: 1.0.0

The Intershop Cost Center REST API contains resources for managing cost centers. This includes creating, reading, updating and deleting cost centers.
Also buyers for cost centers can be managed, including according budget information.

Cost Center API
/customers/{CustomerKey}/costcenters
GET: Returns all cost centers

Description

This operation returns a list of links to all cost centers of the customer as well as some of their properties.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.costcenter.capi.resource.CostCenterListResource.getCostCenters()

Request Body

--

Request Parameters

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

Response

200 - OK - The list of cost centers.

Array of LinkRO application/json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - The customer could not be found.

POST: Creates a new cost center

Description

This operation creates a new cost center.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.costcenter.capi.resource.CostCenterListResource.createCostCenter(com.intershop.sellside.rest.b2b.costcenter.capi.resourceobject.NewCostCenterRO)

Request Body

NewCostCenterRO application/json

Request Parameters

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

Response

201 - Created - The new cost center.

LinkRO application/json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - The customer could not be found.

/customers/{CustomerKey}/costcenters/{CostCenterKey}
GET: Returns cost center details

Description

This operation returns detail information about the cost center with the given ID.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.costcenter.capi.resource.CostCenterItemResource.getCostCenter()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCostCenterKeystring123456Required | The ID of the cost center. (For compatibility reasons, the UUID of the cost center is also supported)

Response

200 - OK - The cost center with the given ID.

CostCenterRO application/json

401 - Unauthorized Unathorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - The customer or the cost center could not be found.

DELETE: Removes the cost center

Description

This operation removes the cost center with the given ID.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.costcenter.capi.resource.CostCenterItemResource.deleteCostCenter()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCostCenterKeystring123456Required | The ID of the cost center. (For compatibility reasons, the UUID of the cost center is also supported)

Response

204 - No Content - The cost center was deleted.

401 - Unauthorized Unathorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - The customer or the cost center could not be found.

PATCH: Updates the cost center

Description

This operation updates the cost center information.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.costcenter.capi.resource.CostCenterItemResource.updateCostCenter(com.intershop.sellside.rest.b2b.costcenter.capi.resourceobject.UpdateCostCenterRO)

Request Body

UpdateCostCenterRO application/json

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCostCenterKeystring123456Required | The ID of the cost center. (For compatibility reasons, the UUID of the cost center is also supported)

Response

200 - OK - The updated cost center.

CostCenterRO application/json

401 - Unauthorized Unathorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - The customer or the cost center could not be found.

/customers/{CustomerKey}/costcenters/{CostCenterKey}/buyers
GET: Returns all buyers for the cost center

Description

This operation returns a list of links to all assigned buyers for the given cost center, as well as some of their properties.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.costcenter.capi.resource.CostCenterBuyerListResource.getCostCenterBuyers()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCostCenterKeystring123456Required | The ID of the cost center. (For compatibility reasons, the UUID of the cost center is also supported)

Response

200 - OK - The cost center buyers.

Array of LinkRO application/json

401 - Unauthorized Unathorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - The customer or cost center could not be found.

POST: Adds a new cost center buyer

Description

This operation adds a new buyer to the given cost center.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.costcenter.capi.resource.CostCenterBuyerListResource.addCostCenterBuyer(com.intershop.sellside.rest.b2b.costcenter.capi.resourceobject.NewCostCenterBuyerRO)

Request Body

NewCostCenterBuyerRO application/json

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCostCenterKeystring123456Required | The ID of the cost center. (For compatibility reasons, the UUID of the cost center is also supported)

Response

200 - OK - The added buyer.

CostCenterUserRO application/json

401 - Unauthorized Unathorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - The customer or cost center could not be found.

/customers/{CustomerKey}/costcenters/{CostCenterKey}/buyers/{CostCenterBuyerKey}
GET: Returns information about a buyer of the cost center

Description

This operation returns information about a buyer of the cost center.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.costcenter.capi.resource.CostCenterBuyerItemResource.getCostCenterBuyer()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCostCenterKeystring123456Required | The ID of the cost center. (For compatibility reasons, the UUID of the cost center is also supported)
in pathCostCenterBuyerKeystringpmiller@test.intershop.deRequired | The login of the cost center buyer

Response

200 - OK - The buyer information.

CostCenterUserRO application/json

401 - Unauthorized Unathorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - The customer, cost center or buyer could not be found.

DELETE: Removes the buyer from the cost center

Description

This operation removes the given buyer from the cost center.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.costcenter.capi.resource.CostCenterBuyerItemResource.removeCostCenterBuyer()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCostCenterKeystring123456Required | The ID of the cost center. (For compatibility reasons, the UUID of the cost center is also supported)
in pathCostCenterBuyerKeystringpmiller@test.intershop.deRequired | The login of the cost center buyer

Response

204 - No Content - The cost center buyer was removed.

401 - Unauthorized Unathorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - The customer, cost center or buyer could not be found.

PATCH: Updates the budget for a buyer of the cost center

Description

This operation updates the budget for a buyer of the cost center.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.costcenter.capi.resource.CostCenterBuyerItemResource.updateCostCenterBuyer(com.intershop.sellside.rest.b2b.costcenter.capi.resourceobject.UpdateCostCenterBuyerRO)

Request Body

UpdateCostCenterBuyerRO application/json

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCostCenterKeystring123456Required | The ID of the cost center. (For compatibility reasons, the UUID of the cost center is also supported)
in pathCostCenterBuyerKeystringpmiller@test.intershop.deRequired | The login of the cost center buyer

Response

200 - OK - The cost center buyer with the updated budget.

CostCenterUserRO application/json

401 - Unauthorized Unathorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - The customer, cost center or buyer could not be found.

/customers/{CustomerKey}/users/{CustomerItemUserKey}/costcenters
GET: Returns a list of cost centers of a business user

Description

This operation returns a list of all cost centers to which the user is assigned (as a buyer or approver).

Java Method

public com.intershop.application.storefront.rest.b2b.capi.user.costcenter.resourceobject.UserCostCenterLinkROCollection com.intershop.application.storefront.rest.b2b.capi.user.costcenter.resource.UserCostCenterListResource.getCostCenters()

Request Body

--

Request Parameters

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

Response

200 - OK - The list of cost centers.

UserCostCenterLinkROCollection application/json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - The customer or user could not be found or does not support cost centers.

/customers/{CustomerKey}/users/{CustomerItemUserKey}/costcenters/{UserCostCenterKey}
GET: Returns business user cost center details

Description

This operation returns the details of a specified cost center of a business user.

Java Method

public com.intershop.application.storefront.rest.b2b.capi.user.costcenter.resourceobject.UserCostCenterRO com.intershop.application.storefront.rest.b2b.capi.user.costcenter.resource.UserCostCenterItemResource.getUserCostCenter()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathCustomerItemUserKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathUserCostCenterKeystring100401Required | The cost center ID assigned by the customer

Response

200 - OK - The cost center details.

UserCostCenterRO application/json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - The customer or user could not be found, does not support cost centers or is not assigned to a cost center (as buyer or approver).

Request and Response Object Schemata
CostCenterRO application/json{
  • "name":
    string
    The name of the cost center | Example: my cost center
  • "type":
    string
    The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: CostCenter
  • "approvedOrders":
    integer
    The approved orders of the cost center | Format: int32 | Example: 2
  • "active":
    boolean
    Indicates whether the cost center is active | Example: true
  • "budget":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    • "currency":
      string
      Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    • "value":
      number
      The monetary value. | Example: 10.99
    }
  • "budgetPeriod":
    string
    The budget period of the cost center | Example: monthly
  • "buyers":
    array
    An array of CostCenterUserRO objects. The cost center buyers
    [
    CostCenterUserRO: This resource holds information about a cost center user.
    {
    • "approvedOrders":
      integer
      The approved orders of the cost center buyer | Format: int32 | Example: 8
    • "budget":
      object
      A MoneyRO_v1 object. Describes a money object.
      {
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      • "value":
        number
        The monetary value. | Example: 10.99
      }
    • "budgetPeriod":
      string
      The budget period of the cost center buyer | Example: monthly
    • "buyerDetails":
      object
      A LinkRO object. 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.
        }
      }
    • "email":
      string
      The e-mail address of the person represented by this user | Example: merkel@test.intershop.de
    • "firstName":
      string
      The given name (also known as a personal name, first name, forename) of the person represented by this user | Example: Peter
    • "lastName":
      string
      The surname (also known as a family name, last name) of the person represented by this user | Example: Merkel
    • "login":
      string
      The login of the person represented by this user | Example: merkel@test.intershop.de
    • "pendingOrders":
      integer
      The pending orders of the cost center buyer | Format: int32 | Example: 2
    • "remainingBudget":
      object
      A MoneyRO_v1 object. Describes a money object.
      {
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      • "value":
        number
        The monetary value. | Example: 10.99
      }
    • "spentBudget":
      object
      A MoneyRO_v1 object. Describes a money object.
      {
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      • "value":
        number
        The monetary value. | Example: 10.99
      }
    • "title":
      string
      The personal title, like Ms., Mr. | Example: Mr.
    }
    ]
  • "costCenterId":
    string
    The unique cost center ID assigned by the customer | Example: 007
  • "costCenterOwner":
    object
    A CostCenterUserRO object. This resource holds information about a cost center user.
    {
    • "approvedOrders":
      integer
      The approved orders of the cost center buyer | Format: int32 | Example: 8
    • "budget":
      object
      A MoneyRO_v1 object. Describes a money object.
      {
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      • "value":
        number
        The monetary value. | Example: 10.99
      }
    • "budgetPeriod":
      string
      The budget period of the cost center buyer | Example: monthly
    • "buyerDetails":
      object
      A LinkRO object. 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.
        }
      }
    • "email":
      string
      The e-mail address of the person represented by this user | Example: merkel@test.intershop.de
    • "firstName":
      string
      The given name (also known as a personal name, first name, forename) of the person represented by this user | Example: Peter
    • "lastName":
      string
      The surname (also known as a family name, last name) of the person represented by this user | Example: Merkel
    • "login":
      string
      The login of the person represented by this user | Example: merkel@test.intershop.de
    • "pendingOrders":
      integer
      The pending orders of the cost center buyer | Format: int32 | Example: 2
    • "remainingBudget":
      object
      A MoneyRO_v1 object. Describes a money object.
      {
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      • "value":
        number
        The monetary value. | Example: 10.99
      }
    • "spentBudget":
      object
      A MoneyRO_v1 object. Describes a money object.
      {
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      • "value":
        number
        The monetary value. | Example: 10.99
      }
    • "title":
      string
      The personal title, like Ms., Mr. | Example: Mr.
    }
  • "id":
    string
    The unique cost center ID assigned by the system | Example: q2QKAEsBiyQAAAFjXFBB6G14
  • "orders":
    array
    An array of OrderRO objects. The orders of the cost center
    [
    OrderRO: This resource holds information on an order of a cost center.
    {
    • "name":
      string
      The name of an element
    • "type":
      string
      The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Order
    • "buyer":
      object
      A LinkRO object. 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.
        }
      }
    • "items":
      number
      The order count | Example: 23
    • "order":
      object
      A LinkRO object. 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.
        }
      }
    • "orderDate":
      array
      An array of integer literals. The order date | Example: ["2020","5","27"]
    • "orderNo":
      string
      The order no | Example: 001
    • "orderStatus":
      string
      The order status | Example: new
    • "orderTotalGross":
      object
      A MoneyRO_v1 object. Describes a money object.
      {
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      • "value":
        number
        The monetary value. | Example: 10.99
      }
    • "orderTotalNet":
      object
      A MoneyRO_v1 object. Describes a money object.
      {
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      • "value":
        number
        The monetary value. | Example: 10.99
      }
    }
    ]
  • "pendingOrders":
    integer
    The amount of pending orders of the cost center | Format: int32 | Example: 2
  • "remainingBudget":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    • "currency":
      string
      Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    • "value":
      number
      The monetary value. | Example: 10.99
    }
  • "spentBudget":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    • "currency":
      string
      Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    • "value":
      number
      The monetary value. | Example: 10.99
    }
}
CostCenterUserRO application/json{
  • "approvedOrders":
    integer
    The approved orders of the cost center buyer | Format: int32 | Example: 8
  • "budget":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    • "currency":
      string
      Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    • "value":
      number
      The monetary value. | Example: 10.99
    }
  • "budgetPeriod":
    string
    The budget period of the cost center buyer | Example: monthly
  • "buyerDetails":
    object
    A LinkRO object. 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.
      }
    }
  • "email":
    string
    The e-mail address of the person represented by this user | Example: merkel@test.intershop.de
  • "firstName":
    string
    The given name (also known as a personal name, first name, forename) of the person represented by this user | Example: Peter
  • "lastName":
    string
    The surname (also known as a family name, last name) of the person represented by this user | Example: Merkel
  • "login":
    string
    The login of the person represented by this user | Example: merkel@test.intershop.de
  • "pendingOrders":
    integer
    The pending orders of the cost center buyer | Format: int32 | Example: 2
  • "remainingBudget":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    • "currency":
      string
      Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    • "value":
      number
      The monetary value. | Example: 10.99
    }
  • "spentBudget":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    • "currency":
      string
      Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    • "value":
      number
      The monetary value. | Example: 10.99
    }
  • "title":
    string
    The personal title, like Ms., Mr. | Example: Mr.
}
LinkRO application/json[
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.
    }
}
]
NewCostCenterBuyerRO application/json{
  • "budget":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    • "currency":
      string
      Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    • "value":
      number
      The monetary value. | Example: 10.99
    }
  • "budgetPeriod":
    string
    The budget period of the cost center buyer | Example: monthly
  • "login":
    string
    The login of the buyer | Example: abc@login.de
}
NewCostCenterRO application/json{
  • "name":
    string
    The name of the cost center | Example: my cost center
  • "type":
    string
    The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: NewCostCenter
  • "active":
    boolean
  • "budget":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    • "currency":
      string
      Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    • "value":
      number
      The monetary value. | Example: 10.99
    }
  • "budgetPeriod":
    string
    The budget period of the cost center | Example: monthly
  • "costCenterId":
    string
    The unique cost center ID assigned by the customer | Example: 007
  • "costCenterOwner":
    object
    A CostCenterUserRO object. This resource holds information about a cost center user.
    {
    • "approvedOrders":
      integer
      The approved orders of the cost center buyer | Format: int32 | Example: 8
    • "budget":
      object
      A MoneyRO_v1 object. Describes a money object.
      {
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      • "value":
        number
        The monetary value. | Example: 10.99
      }
    • "budgetPeriod":
      string
      The budget period of the cost center buyer | Example: monthly
    • "buyerDetails":
      object
      A LinkRO object. 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.
        }
      }
    • "email":
      string
      The e-mail address of the person represented by this user | Example: merkel@test.intershop.de
    • "firstName":
      string
      The given name (also known as a personal name, first name, forename) of the person represented by this user | Example: Peter
    • "lastName":
      string
      The surname (also known as a family name, last name) of the person represented by this user | Example: Merkel
    • "login":
      string
      The login of the person represented by this user | Example: merkel@test.intershop.de
    • "pendingOrders":
      integer
      The pending orders of the cost center buyer | Format: int32 | Example: 2
    • "remainingBudget":
      object
      A MoneyRO_v1 object. Describes a money object.
      {
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      • "value":
        number
        The monetary value. | Example: 10.99
      }
    • "spentBudget":
      object
      A MoneyRO_v1 object. Describes a money object.
      {
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      • "value":
        number
        The monetary value. | Example: 10.99
      }
    • "title":
      string
      The personal title, like Ms., Mr. | Example: Mr.
    }
  • "id":
    string
    The unique cost center ID assigned by the system | Example: q2QKAEsBiyQAAAFjXFBB6G14
}
UpdateCostCenterBuyerRO application/json{
  • "budget":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    • "currency":
      string
      Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    • "value":
      number
      The monetary value. | Example: 10.99
    }
  • "budgetPeriod":
    string
    The budget period of the cost center buyer | Example: monthly
}
UpdateCostCenterRO application/json{
  • "name":
    string
    The name of the cost center | Example: my cost center
  • "type":
    string
    The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: UpdateCostCenter
  • "active":
    boolean
    Indicates whether the cost center is active | Example: true
  • "budget":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    • "currency":
      string
      Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    • "value":
      number
      The monetary value. | Example: 10.99
    }
  • "budgetPeriod":
    string
    The budget period of the cost center | Example: monthly
  • "costCenterId":
    string
    The cost center ID of the cost center | Example: 007
  • "costCenterOwner":
    object
    A CostCenterUserRO object. This resource holds information about a cost center user.
    {
    • "approvedOrders":
      integer
      The approved orders of the cost center buyer | Format: int32 | Example: 8
    • "budget":
      object
      A MoneyRO_v1 object. Describes a money object.
      {
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      • "value":
        number
        The monetary value. | Example: 10.99
      }
    • "budgetPeriod":
      string
      The budget period of the cost center buyer | Example: monthly
    • "buyerDetails":
      object
      A LinkRO object. 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.
        }
      }
    • "email":
      string
      The e-mail address of the person represented by this user | Example: merkel@test.intershop.de
    • "firstName":
      string
      The given name (also known as a personal name, first name, forename) of the person represented by this user | Example: Peter
    • "lastName":
      string
      The surname (also known as a family name, last name) of the person represented by this user | Example: Merkel
    • "login":
      string
      The login of the person represented by this user | Example: merkel@test.intershop.de
    • "pendingOrders":
      integer
      The pending orders of the cost center buyer | Format: int32 | Example: 2
    • "remainingBudget":
      object
      A MoneyRO_v1 object. Describes a money object.
      {
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      • "value":
        number
        The monetary value. | Example: 10.99
      }
    • "spentBudget":
      object
      A MoneyRO_v1 object. Describes a money object.
      {
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      • "value":
        number
        The monetary value. | Example: 10.99
      }
    • "title":
      string
      The personal title, like Ms., Mr. | Example: Mr.
    }
  • "id":
    string
    The ID of the cost center | Example: q2QKAEsBiyQAAAFjXFBB6G14
}
UserCostCenterLinkROCollection 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 UserCostCenterLinkRO objects. The list of elements
    [
    UserCostCenterLinkRO: This resource holds a list of all cost centers assigned to the user.
    {
    • "name":
      string
      The name of the cost center | Example: Agro Net Central
    • "type":
      string
      The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: UserCostCenterLink
    • "id":
      string
      The ID of the cost center | Example: 511288
    • "roles":
      array
      An array of string literals. The roles assigned to the user | Example: ["Approver","Buyer"]
    • "link":
      object
      A LinkRO object. 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 element. This is normally a constant that can be used to differentiate elements by their type. | Example: UserCostCenterLinkROCollection
  • "sortKeys":
    array
    An array of string literals. The keys to sort for
  • "name":
    string
    The name of an element
}
UserCostCenterRO application/json{
  • "name":
    string
    The name of the cost center | Example: Agro Net Central
  • "type":
    string
    The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: UserCostCenter
  • "id":
    string
    The ID of the cost center | Example: 511288
  • "roles":
    array
    An array of string literals. The roles assigned to the user | Example: ["Approver","Buyer"]
}
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.