VTEX Gift List API

openapi: 3.0.0
info:
  title: VTex Anti-fraud Provider Account Gift List API
  description: ">ℹ️ Onboarding guide\r\n>\r\n> Check the new [Payments onboarding guide](https://developers.vtex.com/docs/guides/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey.\r\n\r\nThe Anti-fraud Provider Protocol is a set of definitions to help you integrate your anti-fraud service API into VTEX platform.\r\n\r\nTo achieve this, you need to implement a web API (REST) following the specifications described in this documentation.\r\n\r\n>⚠️ You can also access our [template on GitHub](https://github.com/vtex-apps/antifraud-provider-example) to help you quickly develop your anti-fraud connector using the Anti-fraud Provider Protocol and VTEX IO.\r\n\r\nTo learn more about the Anti-fraud Provider Protocol, check our [developer guide](https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works).\r\n\r\n## Anti-fraud Provider API Index\r\n\r\n### Anti-fraud  Flow\r\n\r\n- `POST` [Send Anti-fraud Pre-Analysis Data (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/pre-analysis)\r\n- `POST` [Send Anti-fraud Data](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/transactions)\r\n- `PUT` [Update Anti-fraud Transactions (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#put-/transactions/-transactionId-)\r\n- `GET` [List Anti-fraud Provider Manifest](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/manifest)\r\n- `GET` [Get Anti-fraud Status](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/transactions/-transactions.id-)\r\n- `DELETE` [Stop Anti-fraud Analysis (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#delete-/transactions/-transactions.Id-)\r\n\r\n### OAuth Flow\r\n\r\n1. `POST` [Retrieve Token](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/authorization/token)\r\n2. `GET` [Redirect](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/redirect)\r\n3. `GET` [Return to VTEX](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorizationCode)\r\n4. `GET` [Get Credentials](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorization/credentials)"
  version: '1.0'
servers:
- url: https://{providerApiEndpoint}
  description: Anti-fraud provider endpoint URL.
  variables:
    providerApiEndpoint:
      description: Anti-fraud provider endpoint URL.
      default: '{providerApiEndpoint}'
tags:
- name: Gift List
paths:
  /api/addon/pvt/giftlist/get/{listId}:
    get:
      tags:
      - Gift List
      summary: VTex Get Gift list
      description: Retrieves information about a Gift list by its ID.
      operationId: GetGiftList
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - name: listId
        in: path
        required: true
        description: Gift list unique numerical identifier.
        schema:
          type: integer
          example: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                description: Object with information about the Gift list.
                example:
                  giftListId: 1
                  name: My list
                  userId: 010956A4-A74A-4375-8B7B-3B3B7B89B483
                  clientId: 3
                  fileId: null
                  giftListTypeId: 1
                  giftListTypeName: Lista de Casamento
                  giftCardId: 2
                  message: mensageeeem
                  urlFolder: lili
                  dateCreated: '2011-05-04T13:23:00'
                  profileSystemUserAddressName: CASA
                  profileSystemUserId: 010956A4-A74A-4375-8B7B-3B3B7B89B483
                  eventDate: '2012-12-21T00:00:00'
                  eventLocation: ''
                  eventCity: ''
                  eventState: ''
                  telemarketingId: null
                  telemarketingObservation: ''
                  IsPublic: false
                  isActive: false
                  shipsToOwner: false
                  isAddressOk: true
                  version: 1
                  giftCardRechargeSkuId: null
                  memberNames: sei lá
                  giftListMembers: []
                  giftListSkuIds: []
                  address: null
                  fileUrl: null
                properties:
                  giftListId:
                    type: integer
                    description: Gift list ID.
                    example: 1
                  name:
                    type: string
                    description: Gift list name.
                    example: My list
                  userId:
                    type: string
                    description: User ID.
                    example: a6e7d995-e884-409d-911f-36b25c40169a
                  fileId:
                    type: integer
                    description: File ID.
                    example: 155233
                    nullable: true
                  giftListTypeId:
                    type: integer
                    description: Gift list Type ID.
                    example: 1
                  giftListTypeName:
                    type: string
                    description: Gift list Type name.
                    example: Wedding list
                  giftCardId:
                    type: integer
                    description: Gift Card ID.
                    example: 2
                  message:
                    type: string
                    description: Gift list message.
                    example: This is a gift list for my wedding.
                  urlFolder:
                    type: string
                    description: Slug of the gift list that will be part of its URL.
                    example: myweddinglist
                  dateCreated:
                    type: string
                    description: Date when the gift list was created.
                    example: '2013-10-31T19:03:00'
                  profileSystemUserAddressName:
                    type: string
                    description: Name of the user's address.
                    example: CASA
                  profileSystemUserId:
                    type: string
                    description: User ID on Profile System.
                    example: a6e7d995-e884-409d-911f-36b25c40169a
                  eventDate:
                    type: string
                    description: Date of the event associated with the Gift list.
                    example: '2014-07-20T00:00:00'
                  eventLocation:
                    type: string
                    description: Location of the event associated with the Gift list.
                    example: Botafogo
                  eventCity:
                    type: string
                    description: City of the event associated with the Gift list.
                    example: Rio de Janeiro
                  eventState:
                    type: string
                    description: State of the event associated with the Gift list.
                    example: RJ
                  telemarketingId:
                    type: integer
                    description: Telemarketing ID.
                    example: 1
                    nullable: true
                  telemarketingObservation:
                    type: string
                    description: Telemarketing observation.
                    example: ''
                  IsPublic:
                    type: boolean
                    description: Defines if the gift list is public.
                    example: true
                  isActive:
                    type: boolean
                    description: Defines if the gift list is active.
                    example: true
                  shipsToOwner:
                    type: boolean
                    description: Defines if items purchased from the gift list will be shipped to the owner of the gift list.
                    example: false
                  isAddressOk:
                    type: boolean
                    description: Validates the address of the gift list.
                    example: false
                  version:
                    type: integer
                    description: Version of the gift list.
                    example: 1
                  giftCardRechargeSkuId:
                    type: integer
                    description: ID of the SKU that recharges the gift card.
                    example: 1
                    nullable: true
                  memberNames:
                    type: string
                    description: Name of the members of the gift list.
                    example: Rafael Villa-Verde
                  giftListMembers:
                    type: array
                    description: Array of members of the gift list.
                    items:
                      type: object
                      description: Object with information about each gift list member.
                      properties:
                        giftListMemberId:
                          type: integer
                          description: Gift list member ID.
                        giftListId:
                          type: integer
                          description: Gift list ID.
                        userId:
                          type: string
                          description: User ID.
                        clientId:
                          type: string
                          description: Client ID.
                          nullable: true
                        title:
                          type: string
                          description: Title of the Gift list member.
                          nullable: true
                        name:
                          type: string
                          description: Name of the Gift list member.
                        surname:
                          type: string
                          description: Surname of the Gift list member.
                        isAdmin:
                          type: boolean
                          description: Defines if the Gift list member is an administrator of the Gift list or not.
                        isActive:
                          type: boolean
                          description: Defines if the Gift list user is active or not.
                        text1:
                          type: string
                          description: Complementary text.
                          nullable: true
                        text2:
                          type: string
                          description: Complementary text.
                          nullable: true
                      example:
                        giftListMemberId: 1
                        giftListId: 2
                        userId: 010956A4-A74A-4375-8B7B-3B3B7B89B483
                        clientId: null
                        title: null
                        name: Rafael
                        surname: Villa-Verde
                        isAdmin: true
                        isActive: true
                        text1: null
                        text2: null
                  giftListSkuIds:
                    type: array
                    description: Array with the IDs of SKUs that are part of the gift list.
                    items:
                      type: string
                      description: SKU ID.
                  address:
                    type: string
                    description: Address of the gift list.
                    example: Botafogo
                    nullable: true
                  fileUrl:
                    type: string
                    description: File URL.
                    example: /arquivos/ids/155233-800-800/gl-0_635266293044683588.jpg
                    nullable: true
components:
  parameters:
    Accept:
      name: Accept
      in: header
      description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
      required: true
      style: simple
      schema:
        type: string
        default: application/json
    Content-Type:
      name: Content-Type
      in: header
      description: Type of the content being sent.
      required: true
      style: simple
      schema:
        type: string
        default: application/json
  securitySchemes:
    VtexIdclientAutCookie:
      type: apiKey
      in: header
      name: VtexIdclientAutCookie
      description: '[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.'