{ "opencollection": "1.0.0", "info": { "name": "VTex Anti-fraud Provider Account Gift Card API", "version": "1.0" }, "items": [ { "info": { "name": "Gift Card", "type": "folder" }, "items": [ { "info": { "name": "VTex Create a gift card", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/giftcards", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a gift card for a specific user.\r\n\r\n>⚠️ The `redemptionCode` field is auto-generated during gift card creation and cannot be set to an arbitrary value.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwi" }, { "info": { "name": "VTex Get a gift card by ID", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/giftcards/:giftCardId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "giftCardId", "value": "", "type": "path", "description": "Gift card identification." } ] }, "docs": "Returns information for a specific gift card.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Produ" }, { "info": { "name": "VTex List all gift cards", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/giftcards/_search", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" }, { "name": "REST-Range", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns a list of all gift cards available for a specific customer's cart.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources fo" } ] } ], "bundled": true }