Amazon Ads API

openapi: 3.1.0
info:
  title: Amazon Ads API
  version: '2026-10-14'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-14: 8 operation(s) read from 4 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Amazon Ads has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 4
    documentation: 4
    pages-with-code: 4
    pages-read: 4
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-14'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html
  - https://developer.amazon.com/docs/incentives-api/digital-gift-cards
  - https://developer.amazon.com/docs/incentives-api/por-guide
  - https://developer.amazon.com/docs/incentives-api/gift-codes-web-activation
servers:
- url: https://awscli.amazonaws.com
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl \" https://awscli.amazonaws.com/ awscli-exe-linux-x86_64.zip\" -o \"awscliv2.zip\"\nunzip awscliv2.zip\nsudo ./aws/install\
          \ \n Guided installation steps \n Download the installation file in one of the following\n ways: \n Use the"
  /ActivateGiftCard:
    post:
      operationId: post_ActivateGiftCard
      tags:
      - Activategiftcard
      summary: POST /ActivateGiftCard
      x-source: https://developer.amazon.com/docs/incentives-api/gift-codes-web-activation
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: http
        snippet: ' POST /ActivateGiftCard HTTP/1.1

          accept:charset=UTF-8

          content-type:charset=UTF-8

          host:agcod-v2-gamma.amazon.com

          x-amz-date:20140327T212600Z

          x-amz-target:com.amazonaws.agcod.AGCODService.ActivateGiftCard

          Authorization:AWS4-HMAC-SHA256

          Credential=REDACTED_AWS_ACCESS_KEY_ID/20140327/us-east-1/AGCODService/aws4_request,

          SignedHeaders=accept;content-type;host;x-amz-date;x-amz-target,

          Signature=bb4acbe8b115e2'
  /ActivationStatusCheck:
    post:
      operationId: post_ActivationStatusCheck
      tags:
      - Activationstatuscheck
      summary: Report's activation status of a physical gift card.
      x-source: https://developer.amazon.com/docs/incentives-api/gift-codes-web-activation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostActivationstatuscheckRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostActivationstatuscheckResponse'
      x-evidence:
        kind: documentation
  /CancelGiftCard:
    post:
      operationId: post_CancelGiftCard
      tags:
      - Cancelgiftcard
      summary: Digital Gift Cards | Incentives API
      x-source: https://developer.amazon.com/docs/incentives-api/digital-gift-cards
      parameters:
      - name: creationRequestId
        in: query
        required: true
        schema:
          type: string
        description: Identifier of the original CreateGiftCard request.
      - name: partnerId
        in: query
        required: true
        schema:
          type: string
        description: Amazon‑provided partner identifier.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCancelgiftcardRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostCancelgiftcardResponse'
      x-evidence:
        kind: documentation
  /CreateGiftCard:
    post:
      operationId: post_CreateGiftCard
      tags:
      - Creategiftcard
      summary: POST /CreateGiftCard
      x-source: https://developer.amazon.com/docs/incentives-api/digital-gift-cards
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: http
        snippet: ' POST /CreateGiftCard HTTP/1.1

          accept:application/x-www-form-urlencoded; charset=UTF-8

          content-type:application/x-www-form-urlencoded; charset=UTF-8

          host:agcod-v2-eu-gamma.amazon.com

          x-amz-date:20130910T221949Z

          x-amz-target:com.amazonaws.agcod.AGCODService.CreateGiftCard

          Authorization:AWS4-HMAC-SHA256 Credential=REDACTED_AWS_ACCESS_KEY_ID/20130910/us-east-1/AGCODService/aws4_request,

          SignedHeaders=accep'
  /DeactivateGiftCard:
    post:
      operationId: post_DeactivateGiftCard
      tags:
      - Deactivategiftcard
      summary: Puts a physical card into an inactive state, so it cannot be redeemed.
      x-source: https://developer.amazon.com/docs/incentives-api/gift-codes-web-activation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostDeactivategiftcardRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostDeactivategiftcardResponse'
      x-evidence:
        kind: documentation
  /GetGiftCard:
    post:
      operationId: post_GetGiftCard
      tags:
      - Getgiftcard
      summary: Digital Gift Cards | Incentives API
      x-source: https://developer.amazon.com/docs/incentives-api/digital-gift-cards
      parameters:
      - name: creationRequestId
        in: query
        required: true
        schema:
          type: string
        description: Identifier used in the original CreateGiftCard request.
      - name: partnerId
        in: query
        required: true
        schema:
          type: string
        description: Amazon‑provided partner identifier.
      - name: value
        in: query
        required: true
        schema:
          type: object
        description: Object holding currencyCode and amount.
      - name: currencyCode
        in: query
        required: true
        schema:
          type: string
        description: ISO‑4217 currency code.
      - name: amount
        in: query
        required: true
        schema:
          type: integer
        description: Card amount.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostGetgiftcardRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostGetgiftcardResponse'
      x-evidence:
        kind: documentation
  /v2/install.sh:
    get:
      operationId: get_v2_install_sh
      tags:
      - Install
      summary: GET /v2/install.sh
      x-source: https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -fsSL https://awscli.amazonaws.com/v2/install.sh | bash \n Note By default, the script installs to"
components:
  schemas:
    PostActivationstatuscheckRequest:
      type: object
      properties:
        statusCheckRequestId:
          type: string
          description: Unique identifier for the status check request. Max 40 characters, prefixed with partnerID.
        partnerId:
          type: string
          description: Amazon‑provided partner identifier.
        cardNumber:
          type: integer
          description: The 16‑digit WAC number.
        externalReference:
          type: string
          description: Optional tracking reference.
      required:
      - statusCheckRequestId
      - partnerId
      - cardNumber
    PostActivationstatuscheckResponse:
      type: object
      properties:
        statusCheckRequestId:
          type: string
          description: Echoed status check request identifier.
        cardInfo:
          type: object
          description: Contains card details.
        cardInfo.cardNumber:
          type: integer
          description: The 16‑digit WAC number.
        cardInfo.cardStatus:
          type: string
          description: Current status (Activated, AwaitingActivation, or Invalidated).
        cardInfo.expirationDate:
          type: string
          description: Expiration date if applicable.
        cardInfo.value:
          type: object
          description: Currency and amount (may be null).
        status:
          type: string
          description: Outcome of the operation (SUCCESS).
    PostCancelgiftcardRequest:
      type: object
      properties:
        creationRequestId:
          type: string
        partnerId:
          type: string
      required:
      - creationRequestId
      - partnerId
    PostCancelgiftcardResponse:
      type: object
      properties:
        creationRequestId:
          type: string
          description: Echoed request identifier.
        status:
          type: string
          description: Outcome of the operation (SUCCESS).
    PostDeactivategiftcardRequest:
      type: object
      properties:
        activationRequestId:
          type: string
          description: Unique identifier for the original activation request.
        partnerId:
          type: string
          description: Amazon‑provided partner identifier.
        cardNumber:
          type: integer
          description: The 16‑digit WAC number.
        externalReference:
          type: string
          description: Optional tracking reference.
      required:
      - activationRequestId
      - partnerId
      - cardNumber
    PostDeactivategiftcardResponse:
      type: object
      properties:
        activationRequestId:
          type: string
          description: Echoed activation request identifier.
        cardInfo:
          type: object
          description: Contains card details.
        cardInfo.cardNumber:
          type: integer
          description: The 16‑digit WAC number.
        cardInfo.cardStatus:
          type: string
          description: Status after deactivation (e.g., AwaitingActivation).
        cardInfo.expirationDate:
          type: string
          description: Expiration date if applicable.
        cardInfo.value:
          type: object
          description: Currency and amount (may be null).
        status:
          type: string
          description: Outcome of the operation (SUCCESS).
    PostGetgiftcardRequest:
      type: object
      properties:
        creationRequestId:
          type: string
        partnerId:
          type: string
        value:
          type: object
        currencyCode:
          type: string
        amount:
          type: integer
      required:
      - creationRequestId
      - partnerId
      - value
      - currencyCode
      - amount
    PostGetgiftcardResponse:
      type: object
      properties:
        gcClaimCode:
          type: string
          description: Code a customer can use for manual redemption.
        value:
          type: object
          description: Object holding currencyCode and amount.
        currencyCode:
          type: string
          description: ISO‑4217 currency code.
        amount:
          type: integer
          description: Card amount.
        cardStatus:
          type: string
          description: Status of card after operation (e.g., Fulfilled).
        gcId:
          type: string
          description: Unique gift card identifier.
        creationRequestId:
          type: string
          description: Echoed request identifier.
        gcExpirationDate:
          type: string
          description: Expiration date (if applicable).
        status:
          type: string
          description: Outcome of the operation (SUCCESS).
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Authorization
security:
- apiKey: []
tags:
- name: Activategiftcard
- name: Activationstatuscheck
- name: Api
- name: Cancelgiftcard
- name: Creategiftcard
- name: Deactivategiftcard
- name: Getgiftcard
- name: Install