This API specification is available for download as an Open API 3.0 YAML file:
The following page lists available REST APIs for ICM 7.10 and their version dependencies:
/customers/{CustomerKey}/costcenters
This operation returns a list of links to all cost centers of the customer as well as some of their properties.
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.costcenter.capi.resource.CostCenterListResource.getCostCenters()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK - The list of cost centers.
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.
This operation creates a new cost center.
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)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
201 - Created - The new cost center.
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}
This operation returns detail information about the cost center with the given ID.
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.costcenter.capi.resource.CostCenterItemResource.getCostCenter()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CostCenterKey | string | 123456 | Required | The ID of the cost center. (For compatibility reasons, the UUID of the cost center is also supported) |
200 - OK - The cost center with the given ID.
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.
This operation removes the cost center with the given ID.
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.costcenter.capi.resource.CostCenterItemResource.deleteCostCenter()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CostCenterKey | string | 123456 | Required | The ID of the cost center. (For compatibility reasons, the UUID of the cost center is also supported) |
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.
This operation updates the cost center information.
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)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CostCenterKey | string | 123456 | Required | The ID of the cost center. (For compatibility reasons, the UUID of the cost center is also supported) |
200 - OK - The updated cost center.
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
This operation returns a list of links to all assigned buyers for the given cost center, as well as some of their properties.
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.costcenter.capi.resource.CostCenterBuyerListResource.getCostCenterBuyers()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CostCenterKey | string | 123456 | Required | The ID of the cost center. (For compatibility reasons, the UUID of the cost center is also supported) |
200 - OK - The cost center buyers.
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.
This operation adds a new buyer to the given cost center.
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)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CostCenterKey | string | 123456 | Required | The ID of the cost center. (For compatibility reasons, the UUID of the cost center is also supported) |
200 - OK - The added buyer.
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}
This operation returns information about a buyer of the cost center.
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.costcenter.capi.resource.CostCenterBuyerItemResource.getCostCenterBuyer()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CostCenterKey | string | 123456 | Required | The ID of the cost center. (For compatibility reasons, the UUID of the cost center is also supported) | |
in path | CostCenterBuyerKey | string | pmiller@test.intershop.de | Required | The login of the cost center buyer |
200 - OK - The buyer information.
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.
This operation removes the given buyer from the cost center.
public javax.ws.rs.core.Response com.intershop.sellside.rest.b2b.costcenter.capi.resource.CostCenterBuyerItemResource.removeCostCenterBuyer()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CostCenterKey | string | 123456 | Required | The ID of the cost center. (For compatibility reasons, the UUID of the cost center is also supported) | |
in path | CostCenterBuyerKey | string | pmiller@test.intershop.de | Required | The login of the cost center buyer |
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.
This operation updates the budget for a buyer of the cost center.
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)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CostCenterKey | string | 123456 | Required | The ID of the cost center. (For compatibility reasons, the UUID of the cost center is also supported) | |
in path | CostCenterBuyerKey | string | pmiller@test.intershop.de | Required | The login of the cost center buyer |
200 - OK - The cost center buyer with the updated budget.
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
This operation returns a list of all cost centers to which the user is assigned (as a buyer or approver).
public com.intershop.application.storefront.rest.b2b.capi.user.costcenter.resourceobject.UserCostCenterLinkROCollection com.intershop.application.storefront.rest.b2b.capi.user.costcenter.resource.UserCostCenterListResource.getCostCenters()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK - The list of cost centers.
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}
This operation returns the details of a specified cost center of a business user.
public com.intershop.application.storefront.rest.b2b.capi.user.costcenter.resourceobject.UserCostCenterRO com.intershop.application.storefront.rest.b2b.capi.user.costcenter.resource.UserCostCenterItemResource.getUserCostCenter()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | UserCostCenterKey | string | 100401 | Required | The cost center ID assigned by the customer |
200 - OK - The cost center details.
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).
my cost center
CostCenter
int32
| Example: 2
true
MoneyRO_v1
object. Describes a money object.USD
10.99
monthly
CostCenterUserRO
objects. The cost center buyersCostCenterUserRO
: This resource holds information about a cost center user.true
int32
| Example: 8
MoneyRO_v1
object. Describes a money object.USD
10.99
monthly
LinkRO
object. A Link pointing to a resourceLink
ResourceAttribute
objects. The list of attributesResourceAttribute
: An attributeResourceAttribute
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
ResourceAttribute
object. An attributeResourceAttribute
merkel@test.intershop.de
Peter
Merkel
merkel@test.intershop.de
int32
| Example: 2
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
Mr.
007
CostCenterUserRO
object. This resource holds information about a cost center user.true
int32
| Example: 8
MoneyRO_v1
object. Describes a money object.USD
10.99
monthly
LinkRO
object. A Link pointing to a resourceLink
ResourceAttribute
objects. The list of attributesResourceAttribute
: An attributeResourceAttribute
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
ResourceAttribute
object. An attributeResourceAttribute
merkel@test.intershop.de
Peter
Merkel
merkel@test.intershop.de
int32
| Example: 2
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
Mr.
q2QKAEsBiyQAAAFjXFBB6G14
OrderRO
objects. The orders of the cost centerOrderRO
: This resource holds information on an order of a cost center.Order
LinkRO
object. A Link pointing to a resourceLink
ResourceAttribute
objects. The list of attributesResourceAttribute
: An attributeResourceAttribute
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
ResourceAttribute
object. An attributeResourceAttribute
23
LinkRO
object. A Link pointing to a resourceLink
ResourceAttribute
objects. The list of attributesResourceAttribute
: An attributeResourceAttribute
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
ResourceAttribute
object. An attributeResourceAttribute
integer
literals. The order date | Example: ["2020","5","27"]
001
new
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
int32
| Example: 2
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
true
int32
| Example: 8
MoneyRO_v1
object. Describes a money object.USD
10.99
monthly
LinkRO
object. A Link pointing to a resourceLink
ResourceAttribute
objects. The list of attributesResourceAttribute
: An attributeResourceAttribute
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
ResourceAttribute
object. An attributeResourceAttribute
merkel@test.intershop.de
Peter
Merkel
merkel@test.intershop.de
int32
| Example: 2
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
Mr.
LinkRO
: A Link pointing to a resourceLink
ResourceAttribute
objects. The list of attributesResourceAttribute
: An attributeResourceAttribute
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
ResourceAttribute
object. An attributeResourceAttribute
MoneyRO_v1
object. Describes a money object.USD
10.99
monthly
abc@login.de
my cost center
NewCostCenter
MoneyRO_v1
object. Describes a money object.USD
10.99
monthly
007
CostCenterUserRO
object. This resource holds information about a cost center user.true
int32
| Example: 8
MoneyRO_v1
object. Describes a money object.USD
10.99
monthly
LinkRO
object. A Link pointing to a resourceLink
ResourceAttribute
objects. The list of attributesResourceAttribute
: An attributeResourceAttribute
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
ResourceAttribute
object. An attributeResourceAttribute
merkel@test.intershop.de
Peter
Merkel
merkel@test.intershop.de
int32
| Example: 2
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
Mr.
q2QKAEsBiyQAAAFjXFBB6G14
MoneyRO_v1
object. Describes a money object.USD
10.99
monthly
my cost center
UpdateCostCenter
true
MoneyRO_v1
object. Describes a money object.USD
10.99
monthly
007
CostCenterUserRO
object. This resource holds information about a cost center user.true
int32
| Example: 8
MoneyRO_v1
object. Describes a money object.USD
10.99
monthly
LinkRO
object. A Link pointing to a resourceLink
ResourceAttribute
objects. The list of attributesResourceAttribute
: An attributeResourceAttribute
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
ResourceAttribute
object. An attributeResourceAttribute
merkel@test.intershop.de
Peter
Merkel
merkel@test.intershop.de
int32
| Example: 2
MoneyRO_v1
object. Describes a money object.USD
10.99
MoneyRO_v1
object. Describes a money object.USD
10.99
Mr.
q2QKAEsBiyQAAAFjXFBB6G14
int32
int32
int32
UserCostCenterLinkRO
objects. The list of elementsUserCostCenterLinkRO
: This resource holds a list of all cost centers assigned to the user.Agro Net Central
UserCostCenterLink
511288
string
literals. The roles assigned to the user | Example: ["Approver","Buyer"]
LinkRO
object. A Link pointing to a resourceLink
ResourceAttribute
objects. The list of attributesResourceAttribute
: An attributeResourceAttribute
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
ResourceAttribute
object. An attributeResourceAttribute
UserCostCenterLinkROCollection
string
literals. The keys to sort forAgro Net Central
UserCostCenter
511288
string
literals. The roles assigned to the user | Example: ["Approver","Buyer"]