Build Version:

GET giftcards

Gets a list of gift cards.

Request Information

» Expands

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

» Filters

Name	Description	Usage
accountId	This will filter the request by account ID.	GET giftcards?filter=accountid~{operator}~{value}
amount	This will filter the request by amount.	GET giftcards?filter=amount~{operator}~{value}
cardNumber	This will filter the request by card number.	GET giftcards?filter=cardnumber~{operator}~{value}
createDate	This will filter the request by create date.	GET giftcards?filter=createdate~{operator}~{value}
createdBy	This will filter the request by created by.	GET giftcards?filter=createdby~{operator}~{value}
expirationDate	This will filter the request by expiration date.	GET giftcards?filter=expirationdate~{operator}~{value}
name	This will filter the request by name.	GET giftcards?filter=name~{operator}~{value}
orderLineItemId	This will filter the request by order line item ID.	GET giftcards?filter=orderlineitemid~{operator}~{value}
portalId	This will filter the request by portal ID.	GET giftcards?filter=portalid~{operator}~{value}

» Sorting

Name	Description	Usage
amount	This will sort the response by amount.	GET giftcards?sort=amount
cardNumber	This will sort the response by card number.	GET giftcards?sort=cardnumber
createDate	This will sort the response by create date.	GET giftcards?sort=createdate
expirationDate	This will sort the response by expiration date.	GET giftcards?sort=expirationdate
giftCardId	This will sort the response by gift card ID.	GET giftcards?sort=giftcardid
name	This will sort the response by name.	GET giftcards?sort=name

» Paging

Name	Description	Usage
index	The index to retrieve when requesting paged results.	GET giftcards?page=index~{value}
size	The size of the page when retrieving paged results.	GET giftcards?page=size~{value}

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:

	{
  "GiftCards": [
    {
      "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
    }
  ],
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "StackTrace": null,
  "AllowHtmlResponse": false,
  "HasError": false,
  "StringResponse": null
}