Related Documents
Document Properties
Kbid252Z47
Last Modified23-Jun-2020
Added to KB08-Oct-2013
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.6
  • ICM 7.7
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10

REST API - Get the gift cards and certificates B2C


Note

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

URI

/customers/-/giftcardsandcertificates

Http Method

GET

Short Description

Gets a list of URIs to the gift cards and certificates

Query Parameters

none

Example Requests

/customers/-/giftcardsandcertificates

HTTP Status Codes

200 OK

401 Unauthorized

404 Not Found

       Possible values for header ‘error-key’:

    • merchandise.giftcard_and_certificate_service_not_found.error

Description

Gets a list of of URIs to the gift cards and certificates which are bound to the user's account

Cartridge

app_sf_rest, app_sf_rest_b2c

Application

B2C Web Shop

Product Version

7.4

Product To Version

 

Status

final

 

JSON

Request Data Format

Request related java object

n/a

Request Example

n/a

Response Data Format

application/json

Response related java object

com.intershop.sellside.rest.common.capi.resource.customer.giftcardsandcertificates.CustomerGiftCardsAndCertificatesResource
com.intershop.sellside.rest.common.capi.resourceobject.GiftCardAndCertificateRO

Response Example

{
    "elements": [
        {
            "type": "Link",
            "description": "A physical gift card for 25 $",
            "uri": "PrimeTech-PrimeTechSpecials-Site/-/customers/-/giftcardsandcertificates/11111111111",
            "title": "Gift Card Blank 25 $"
        },
        {
            "type": "Link",
            "description": "A physical gift card in Christmas edition for 10 $",
            "uri": "PrimeTech-PrimeTechSpecials-Site/-/customers/-/giftcardsandcertificates/18311368235",
            "title": "Gift Card Christmas Edition 10 $"
        }
    ],
    "type": "ResourceCollection"
}

XML

XML Request Data Format

XML Request Java Objects

n/a

XML Request Example

n/a

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.sellside.rest.common.capi.resource.customer.giftcardsandcertificates.CustomerGiftCardsAndCertificatesResource
com.intershop.sellside.rest.common.capi.resourceobject.GiftCardAndCertificateRO

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResourceCollection type="ResourceCollection">
    <elements>
        <Link type="Link">
            <description>A physical gift card for 25 $</description>
            <title>Gift Card Blank 25 $</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/-/customers/-/giftcardsandcertificates/11111111111</uri>
        </Link>
        <Link type="Link">
            <description>A physical gift card in Christmas edition for 10 $</description>
            <title>Gift Card Christmas Edition 10 $</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/-/customers/-/giftcardsandcertificates/18311368235</uri>
        </Link>
    </elements>
</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