{"note":"OpenAPI conversion -- returning structured metadata","name":"vtex-local-giftcard-api","description":"Giftcard API","version":"1.0","base_url":"https://apiexamples.vtexcommercestable.com.br/api","endpoints":11,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Giftcard API\n@base https://apiexamples.vtexcommercestable.com.br/api\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 11\n@toc giftcards(11)\n\n@endpoint POST /giftcards\n@desc Create a gift card\n@returns(200) {id: str, redemptionToken: str, redemptionCode: str, balance: num, relationName: str, emissionDate: str, expiringDate: str, caption: str, currencyCode: str, transactions: map{href: str}} # OK\n\n@endpoint GET /giftcards/{giftCardId}\n@desc Get a gift card by ID\n@required {giftCardId: str # Gift card identification.}\n@returns(200) {id: str, redemptionToken: str, redemptionCode: str, balance: num, emissionDate: str, expiringDate: str, currencyCode: str, transactions: map{href: str}} # OK\n\n@endpoint POST /giftcards/_search\n@desc List all gift cards\n@required {cart: map{grandTotal!: int, relationName!: str, redemptionCode!: str, discounts!: int, shipping!: int, taxes!: int, items!: [map], itemsTotal!: int} # Cart information., client: map{id!: str, email!: str, document!: str} # Client information.}\n@optional {REST-Range: str=resources=0-49 # Pagination control. This query variable must follow the format _resources={from}-{to}_.}\n@returns(200) {items: [map], paging: map{page: int, perPage: int, total: int, pages: int}} # OK\n\n@endpoint GET /giftcards/{giftCardId}/transactions\n@desc List all gift card transactions\n@required {giftCardId: str # Gift card identification.}\n@returns(200) OK\n\n@endpoint POST /giftcards/{giftCardId}/transactions\n@desc Create a gift card transaction\n@required {giftCardId: str # Gift card identification., operation: str # Type of operation. Possible values are: `Debit` or `Credit`., value: num(decimal) # Operation value., description: str # Description information., redemptionToken: str # Gift card redemption token., redemptionCode: str # Gift card identification code used at checkout. Minimum of 6 characters., requestId: str # Request identification of the transaction. You need to send a different `requestId` value every time you make a new transaction. If you send the same `requestId`two or more times with a specific `redemptionCode`or `redemptionToken`, the gift card balance will not be updated.}\n@optional {orderInfo: map{orderId: str, sequence: int, cart: map, clientProfile: map, shipping: map} # Order information.}\n@returns(200) {id: str, _self: map{href: str}} # OK\n\n@endpoint GET /giftcards/{giftCardId}/transactions/{transactionId}\n@desc Get a gift card transaction by ID\n@required {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 /giftcards/{giftCardId}/transactions/{transactionId}/authorization\n@desc Get a gift card transaction authorization\n@required {giftCardId: str # Gift card identification., transactionId: str # Transaction identification.}\n@returns(200) {oid: str, value: num, date: str} # OK\n\n@endpoint GET /giftcards/{giftCardId}/transactions/{transactionId}/cancellations\n@desc List all gift card transactions cancellations\n@required {giftCardId: str # Gift card identification., transactionId: str # Transaction identification.}\n@returns(200) OK\n\n@endpoint POST /giftcards/{giftCardId}/transactions/{transactionId}/cancellations\n@desc Cancel a gift card transaction\n@required {giftCardId: str # Gift card identification., transactionId: str # Transaction identification., value: num # Value information., requestId: str # VTEX request identifier.}\n@returns(200) {oid: str, value: num, date: str} # OK\n\n@endpoint GET /giftcards/{giftCardId}/transactions/{transactionId}/settlements\n@desc List all gift card transactions settlements\n@required {giftCardId: str # Gift card identification., transactionId: str # Transaction identification.}\n@returns(200) OK\n\n@endpoint POST /giftcards/{giftCardId}/transactions/{transactionId}/settlements\n@desc Settle a gift card transaction\n@required {giftCardId: str # Gift card identification., transactionId: str # Transaction identification., value: num # Value information., requestId: str # VTEX request identifier.}\n@returns(200) {oid: str, value: num, date: str} # OK\n@example_request {\"value\":17.4,\"requestId\":\"6360f98eb0cf6fd5afa77e39bba8c20fe5807d8c\"}\n\n@end\n"}