REST API - Get customer contracts


Note

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

URI

/customers/-/contracts

Http Method

GET

Short Description

Gets all contracts of a customer

Query Parameters

optional:

  • pageable – the pageable-ID
  • amount – the size of a page
  • offset – the offset of the first element of the current page

Example Requests

/customers/-/contracts

HTTP Status Codes

200 OK
401 Unauthorized

Description

Using the authentication of currently logged in user of a business customer this resource will return all contracts.

Cartridge

app_sf_rest_b2b

ApplicationSMB Web Shop, SMB Responsive Shop

Product Version

7.6

Product To Version


Status

final

JSON

Request Data Format

Request related java objectn/a
Request Examplen/a
Response Data Format

application/json

Response related java object
 
com.intershop.application.storefront.rest.b2b.capi.resource.CustomerContractsResource
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO<LinkRO>
Response Example
{
    "pageable": "UrIKDgBjxxEAAAFPKMc_eO_8",
    "total": 18,
    "offset": 0,
    "amount": 2,
    "elements": [
        {
            "type": "Link",
            "description": "This contract gives 10% rebate on all graphic cards.",
            "uri": "inSPIRED-inTRONICS_Business-Site/-/customers/-/contracts/ZEcKDgBj5cEAAAFPlMgclI6M",
            "title": "10% Rebate on all Graphic Cards"
        },
        {
            "type": "Link",
            "uri": "inSPIRED-inTRONICS_Business-Site/-/customers/-/contracts/TsoKDgBjRrsAAAFPhwQclI6Q",
            "title": "Samsung Tablets 2015"
        }
    ],   
    "type": "ResourceCollection",
    "name": "contracts"
}
 

XML

XML Request Data Format

XML Request Java Objectsn/a
XML Request Examplen/a
XML Response Data Format

text/xml

XML Response Java Objects
com.intershop.application.storefront.rest.b2b.capi.resource.CustomerContractsResource
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO<LinkRO>
XML Response Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResourceCollection name="contracts" type="ResourceCollection">
    <amount>2</amount>
    <elements>
        <Link type="Link">
            <description>This contract gives 10% rebate on all graphic cards.</description>
            <title>10% Rebate on all Graphic Cards</title>
            <uri>inSPIRED-inTRONICS_Business-Site/-/customers/-/contracts/ZEcKDgBj5cEAAAFPlMgclI6M</uri>
        </Link>
        <Link type="Link">
            <title>Samsung Tablets 2015</title>
            <uri>inSPIRED-inTRONICS_Business-Site/-/customers/-/contracts/TsoKDgBjRrsAAAFPhwQclI6Q</uri>
        </Link>
    </elements>
    <offset>0</offset>
    <pageable>ILcKDgBjfwgAAAFPIi8_eO_1</pageable>
    <total>18</total>
</ResourceCollection>

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