Build Version:

GET giftcards/{giftCardId}

Gets a gift card.

Request Information

» Parameters

Name	Description	Additional information
giftCardId	The ID of the gift card.	Define this parameter in the request URI.

» Expands

Name	Description	Usage
giftCardHistory	This will retrieve the related gift card history.	GET giftcards/{giftCardId}?expand=giftcardhistory
orderLineItem	This will retrieve the related order line item.	GET giftcards/{giftCardId}?expand=orderlineitem

Response Information

» Response Body Formats

If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.

application/json

Sample:

	{
  "GiftCard": {
    "AccountId": null,
    "Amount": 10.00,
    "CardNumber": "W4KO51LQ7G",
    "CreatedBy": 1,
    "CreateDate": "2013-09-01T00:00:00",
    "ExpirationDate": "2013-09-01T23:59:59.999",
    "GiftCardId": 1,
    "History": [
      {
        "GiftCardHistoryId": 1,
        "GiftCardNumber": null,
        "GiftCardId": 5,
        "OrderId": 123,
        "TransactionDate": "2013-09-01T13:17:43.446",
        "TransactionAmount": 56.12
      }
    ],
    "Name": "My Gift Card",
    "OrderLineItem": {
      "AppliedPromotion": null,
      "AutoGeneratedTracking": false,
      "CouponsApplied": null,
      "CreateDate": "2013-09-18T12:18:56.89",
      "CreatedBy": "znodeadmin1",
      "Custom1": null,
      "Custom2": null,
      "Custom3": null,
      "CustomText": null,
      "Description": "Packaging - Gift Basket",
      "DiscountAmount": 3.00,
      "DownloadLink": null,
      "ExternalId": null,
      "Gst": 0.00,
      "HasCustomArtwork": false,
      "Hst": 0.00,
      "IsRecurringBilling": null,
      "ModifiedBy": null,
      "ModifiedDate": null,
      "Name": "Strawberry",
      "OrderId": 2,
      "OrderLineItemId": 2,
      "OrderLineItemRelationshipTypeId": null,
      "OrderLineItemStateId": null,
      "OrderShipment": null,
      "OrderShipmentId": 1,
      "ParentOrderLineItemId": null,
      "PaymentStatusId": null,
      "Price": 2.95,
      "ProductNumber": "st3245",
      "PromotionDescription": null,
      "Pst": 0.00,
      "Quantity": 2.0,
      "RecurringBillingAmount": null,
      "RecurringBillingCycles": null,
      "RecurringBillingFrequency": null,
      "RecurringBillingPeriod": null,
      "ReturnDate": null,
      "SalesTax": 0.00,
      "ShipDate": null,
      "ShippingCost": 4.00,
      "ShipSeparately": false,
      "Sku": "st3245",
      "TrackingNumber": null,
      "TransactionNumber": null,
      "Vat": 0.00,
      "Weight": null,
      "ProductNum": null,
      "ShipName": null,
      "ShippingAddress": null,
      "Order": null,
      "DigitalAsset": null,
      "ArtworkID": null,
      "ArtworkOrderID": null,
      "ArtworkOrderLineItemID": null,
      "StateID": null,
      "CanvasOrderID": null,
      "CanvasOrderLineItemID": null,
      "IsHresPdfDownloadable": null,
      "ProductHeight": null,
      "ProductWidth": null,
      "IsTaxable": null,
      "TaxabilityTypeId": null,
      "ATEItemTaxRequestKeyGuid": null,
      "SavedCartLineItemID": 0,
      "DesignerType": null,
      "OrderLineItemFiles": null
    },
    "OrderLineItemId": null,
    "PortalId": 1,
    "DisplayAmount": null,
    "OrderId": 0
  },
  "ErrorCode": null,
  "ErrorMessage": null,
  "StackTrace": null,
  "AllowHtmlResponse": false,
  "HasError": false,
  "StringResponse": null
}