VTEX · Example Payload

Vtex Creategiftcardingiftcardprovider Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Creategiftcardingiftcardprovider Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "CreateGiftCardinGiftCardProvider",
  "method": "POST",
  "path": "/api/giftcardproviders/{giftCardProviderId}/giftcards",
  "summary": "VTex Create GiftCard in GiftCard Provider",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "38",
        "emissionDate": "2023-06-27T17:02:19.17",
        "expiringDate": "2023-09-27T17:02:19.17",
        "caption": "Loyalty Program",
        "provider": "GiftCardExample",
        "discount": "false",
        "currencyCode": "USD",
        "transactions": {
          "href": "cosmetics2/giftcardproviders/GiftCardExample/giftcards/38/transactions"
        }
      }
    }
  ]
}