This API specification is available for download as an Open API 3.0 YAML file:
/customers/{CustomerKey}/contracts
Using the authentication of currently logged in user of a business customer this resource will return all contracts.
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 | Description |
---|---|---|---|
in path | CustomerKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
in query | pageable | string | the pageable-ID |
in query | offset | integer | the size of a page | Format: int32 |
in query | amount | integer | the offset of the first element of the current page | Format: int32 |
200 - OK
ResourceCollectionROLinkRO -> elements -> [..] -> itemId
can be used as {CustomerContractKey}
in subsequent requests. Links to item of type CustomerContractRO.401 - Unauthorized
/customers/{CustomerKey}/contracts/{CustomerContractKey}
Using the authentication of currently logged in user of a business customer this resource will respond with details of a customer contract. 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 | Description |
---|---|---|---|
in path | CustomerKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
in path | CustomerContractKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
/customers/{CustomerKey}/contracts/{CustomerContractKey}/orders
Using the authentication of currently logged in user of a business customer this resource will respond orders of a customer contract.
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.storefront.rest.b2b.capi.resource.CustomerContractOrdersResource.listOrders()
Location | Name | Format | Description |
---|---|---|---|
in path | CustomerKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
in path | CustomerContractKey | string | Required | The key or UUID to resolve a single item | Example: ExampleKey |
200 - OK
400 - Bad Request
403 - Forbidden
404 - Not Found
Contract
ResourceAttribute
objects. the list of attributesResourceAttribute
: An attributeResourceAttribute
10% Rebate on all Graphics Cards
This contract gives 10% rebate on all graphics cards.
RevenueBased
2015-01-01T00:00:00.000Z
2015-12-31T23:59:00.000Z
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 forThe 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.