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:
The following operations for retrieving contract information are available:
/customers/{CustomerKey}/contracts
This operation returns a list of all contracts of a business customer. A user of the respective business customer must be authenticated.
If pageable
is null, a new pageable will be used and its ID returned to the caller.
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.storefront.rest.b2b.capi.resource.CustomerContractsResource.listContracts(java.lang.String,java.lang.Integer,java.lang.Integer)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID | |
in query | pageable | string | zVsKCgoEZ90AAAF1Og4DHYju | The pageable ID | |
in query | offset | integer int32 | 2 | The offset to start the contract listing at | |
in query | amount | integer int32 | 5 | The count of contracts to be returned |
200 - OK - The list of contracts for the given customer.
ResourceCollectionROLinkRO -> elements -> [..] -> itemId
can be used as {CustomerContractKey}
in subsequent requests. Links to item of type CustomerContractRO.401 - Unauthorized - The user could not be authenticated.
404 - Not Found - The customer could not be found.
/customers/{CustomerKey}/contracts/{CustomerContractKey}
This operation returns details of a customer contract. A user of the respective business customer must be authenticated. The return attributes for the current and the target revenue are specific for the contract type RevenueBased
. Other contract types are not supported.
public com.intershop.application.storefront.rest.b2b.capi.resourceobject.CustomerContractRO com.intershop.application.storefront.rest.b2b.capi.resource.CustomerContractItemResource.getContract()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID | |
in path | CustomerContractKey | string | 85cKCgoE5yoAAAF1ut8DHYjo | Required | The contract UUID |
200 - OK - The contract with the given ID.
401 - Unauthorized - The user could not be authenticated.
403 - Forbidden - The authenticated user does not belong to the requested customer.
404 - Not Found - The customer or the contract could not be found.
/customers/{CustomerKey}/contracts/{CustomerContractKey}/orders
This operation returns a pageable list of orders of a customer contract. A user of the respective business customer must be authenticated.
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.storefront.rest.b2b.capi.resource.CustomerContractOrdersResource.listOrders()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | OilCorp | Required | The customer ID | |
in path | CustomerContractKey | string | 85cKCgoE5yoAAAF1ut8DHYjo | Required | The contract UUID |
200 - OK - The list of orders for the given contract.
401 - Unauthorized - The user could not be authenticated.
403 - Forbidden - The authenticated user does not belong to the requested customer.
404 - Not Found - The customer or the contract could not be found.
Contract
ResourceAttribute
objects. The list of attributesResourceAttribute
: An attributeResourceAttribute
10% rebate on all graphics cards
This contract grants 10% rebate on all graphics cards.
RevenueBased
MoneyRO
object. Money combines a currency and a money amount.Money
10.99
USD
MoneyRO
object. Money combines a currency and a money amount.Money
10.99
USD
ZEcKDgBj5cEAAAFPlMgclI6M
ResourceAttribute
object. An attributeResourceAttribute
int32
int32
int32
LinkRO
objects. The list of elementsLinkRO
: 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
ResourceCollection
string
literals. The keys to sort for