Related Documents
Document Properties
Kbid25245D
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 balance of a specific gift card or certificate B2C


Note

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

URI

/customers/-/giftcardsandcertificates/<CardNumber>

Http Method

GET

Short Description

Returns information about a specific gift card or certificate

Query Parameters

none

Example Requests

/customers/-/giftcardsandcertificates/42583613004

HTTP Status Codes

200 OK
400 Bad Request
401 Unauthorized
404 Not found

       Possible values for header ‘error-key’:

    • merchandise.giftcard_and_certificate_service_not_found.error
    • merchandise.giftcard_and_certificate_not_found.error

Description

Returns information about a specific gift card or certificate

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.balance.CustomerGiftCardAndCertificateResource
com.intershop.sellside.rest.common.capi.resourceobject.GiftCardAndCertificateRO 

Response Example

{
    "type": "GiftCardAndCertificate",
    "amount": 10,
    "currency": "USD",
    "amountRemaining": 0
}

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.balance.CustomerGiftCardAndCertificateResource
com.intershop.sellside.rest.common.capi.resourceobject.GiftCardAndCertificateRO 

XML Response Example

<GiftCardAndCertificate type="GiftCardAndCertificate">
    <amount>10</amount>
    <amountRemaining>0.00000</amountRemaining>
    <currency>USD</currency>
</GiftCardAndCertificate>

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