{"note":"OpenAPI conversion -- returning structured metadata","name":"vtex-local-giftcard-hub-api","description":"Giftcard Hub API","version":"1.0","base_url":"https://apiexamples.vtexcommercestable.com.br","endpoints":15,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Giftcard Hub API\n@base https://apiexamples.vtexcommercestable.com.br\n@version 1.0\n@auth ApiKey X-VTEX-API-AppKey in header | ApiKey X-VTEX-API-AppToken in header | ApiKey VtexIdclientAutCookie in header\n@common_fields {Content-Type: str=application/json # Type of the content being sent., Accept: str=application/json # HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.}\n@endpoints 15\n@toc api(15)\n\n@endpoint GET /api/giftcardproviders\n@desc List all gift card providers\n@optional {REST-Range: str=resources=0-49 # Pagination control. This query variable must follow the format `_resources={from}-{to}_`.}\n@returns(200) OK\n\n@endpoint GET /api/giftcardproviders/{giftCardProviderId}\n@desc Get a gift card provider by ID\n@required {giftCardProviderId: str # Gift card provider identification.}\n@returns(200) {id: str, serviceUrl: str, oauthProvider: str, caption: str, preAuthEnabled: bool, cancelEnabled: bool, _self: map} # OK\n@errors {500: Object reference not set to an instance of an object (The gift card provider described does not exist).}\n\n@endpoint PUT /api/giftcardproviders/{giftCardProviderId}\n@desc Create or update a gift card provider by ID\n@required {giftCardProviderId: str # Gift card provider identification.}\n@returns(200) {id: str, serviceUrl: str, oauthProvider: str, preAuthEnabled: bool, cancelEnabled: bool, _self: map} # OK\n\n@endpoint DELETE /api/giftcardproviders/{giftCardProviderId}\n@desc Delete a gift card provider by ID\n@required {giftCardProviderId: str # Gift card provider identification.}\n@returns(200) OK. This endpoint does not return any data in the response body.\n@errors {404: Not Found}\n\n@endpoint POST /api/giftcardproviders/{giftCardProviderId}/giftcards\n@desc Create a gift card at a gift card provider\n@required {giftCardProviderId: str # Gift card provider identification.}\n@returns(200) {id: str, emissionDate: str, expiringDate: str, caption: str, provider: str, discount: bool, currencyCode: str, transaction: map{href: str}} # OK\n\n@endpoint POST /api/giftcardproviders/{giftCardProviderId}/giftcards/_search\n@desc Get a gift card from a gift card provider\n@required {giftCardProviderId: str # Gift card provider identification.}\n@optional {REST-Range: str=resources=0-49 # Pagination control. This query variable must follow the format `_resources={from}-{to}_`.}\n@returns(200) OK\n\n@endpoint GET /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}\n@desc Get a gift card from a gift card provider by ID\n@required {giftCardProviderId: str # Gift card provider identification., giftCardId: str # Gift card identification.}\n@returns(200) {id: str, redemptionToken: str, redemptionCode: str, balance: num, emissionDate: str, expiringDate: str, currencyCode: str, discount: bool, transactions: map{href: str}} # OK\n\n@endpoint GET /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions\n@desc List all gift card transactions\n@required {giftCardProviderId: str # Gift card provider identification., giftCardId: str # Gift card identification.}\n@returns(200) OK\n\n@endpoint POST /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions\n@desc Create a gift card transaction\n@required {giftCardProviderId: str # Gift card provider identification., giftCardId: str # Gift card identification.}\n@returns(200) {cardId: str, id: str, _self: map{href: str}} # OK\n\n@endpoint GET /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{transactionId}\n@desc Get a gift card transaction by ID\n@required {giftCardProviderId: str # Gift card provider identification., giftCardId: str # Gift card identification., transactionId: str # Transaction identification.}\n@returns(200) {value: num, description: str, date: str, requestId: str, settlement: map{href: str}, cancellation: map{href: str}, authorization: map{href: str}, operation: str} # OK\n\n@endpoint GET /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{tId}/authorization\n@desc Get a gift card transaction authorization\n@required {giftCardProviderId: str # Gift card provider identification., giftCardId: str # Gift card identification., tId: str # Transaction ID generated by the provider. It is different from the `transactionId` generated by VTEX.}\n@returns(200) {oid: str, value: num, date: str} # OK\n\n@endpoint GET /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{tId}/settlements\n@desc List all gift card transactions settlements\n@required {giftCardProviderId: str # Gift card provider identification., giftCardId: str # Gift card identification., tId: str # Transaction ID generated by the provider. It is different from the `transactionId` generated by VTEX.}\n@returns(200) OK\n\n@endpoint POST /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{tId}/settlements\n@desc Settle a gift card transaction\n@required {giftCardProviderId: str # Gift card provider identification., giftCardId: str # Gift card identification., tId: str # Transaction ID generated by the provider. It is different from the `transactionId` generated by VTEX., value: num # Transaction value., requestId: str # Request identification of the transaction.}\n@returns(200) OK\n\n@endpoint GET /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{tId}/cancellations\n@desc List all gift card transactions cancellations\n@required {giftCardProviderId: str # Gift card provider identification., giftCardId: str # Gift card identification., tId: str # Transaction ID generated by the provider. It is different from the `transactionId` generated by VTEX.}\n@returns(200) OK\n\n@endpoint POST /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{tId}/cancellations\n@desc Cancel a gift card transaction\n@required {giftCardProviderId: str # Gift card provider identification., giftCardId: str # Gift card identification., tId: str # Transaction ID generated by the provider. It is different from the `transactionId` generated by VTEX.}\n@returns(200) {oid: str, value: num, date: str} # OK\n\n@end\n"}