Skip to content

Commit

Permalink
Update List all gift cards endpoint description
Browse files Browse the repository at this point in the history
  • Loading branch information
ricardoaerobr committed Oct 24, 2024
1 parent 74dc243 commit 17c1c82
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion VTEX - Giftcard Provider Protocol.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"Gift Cards"
],
"summary": "List all gift cards",
"description": "Returns a list of all gift cards available from a gift card provider for a specific customer's cart.\r\n\r\n> ℹ️ This request is made from VTEX to the gift card payment provider.\r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed.",
"description": " Returns a list of all gift cards available from a gift card provider for a specific customer's cart.\r\n\r\nFor scenarios in which there is a gift card with no balance associated with the customer, the payment provider must choose one of the options below to display the information in the response body and implement it on the endpoint:\n\r\n\r1. **Response body returns the complete gift card data mentioning the balance field equal to 0** (`\"balance\": 0`): In this option, whenever the customer has associated a gift card without a balance, they will need to log in to the store to access the balance information.\n\r2. **The response body only returns an empty array** (`[]`): The customer does not need to log in to the store to access balance information when they have a gift card with no balance associated with it.\n\r\n\r> ℹ️ This request is made from VTEX to the gift card payment provider.\r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed.",
"operationId": "ListAllGiftCards",
"parameters": [
{
Expand Down

0 comments on commit 17c1c82

Please sign in to comment.