Amazon Selling Partner API (SP-API) SDK for TypeScript
    Preparing search index...
    • PromotionsApi - axios parameter creator

      Parameters

      • Optionalconfiguration: Configuration

      Returns {
          getPromotion: (
              promotionId: string,
              includedData?: GetPromotionIncludedDataEnum[],
              locale?: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getSelection: (
              promotionId: string,
              selectionId: string,
              revisionId: number,
              locale?: string,
              paginationToken?: string,
              limit?: number,
              includedData?: "ISSUES"[],
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          searchPromotions: (
              marketplaceIds: string[],
              locale?: string,
              statuses?: SearchPromotionsStatusesEnum[],
              asins?: string[],
              skus?: string[],
              promotionTypes?: SearchPromotionsPromotionTypesEnum[],
              startDateBefore?: string,
              startDateAfter?: string,
              endDateBefore?: string,
              endDateAfter?: string,
              updateDateAfter?: string,
              updateDateBefore?: string,
              paginationToken?: string,
              revision?: SearchPromotionsRevisionEnum,
              limit?: number,
              includedData?: SearchPromotionsIncludedDataEnum[],
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
      }

      • getPromotion: (
            promotionId: string,
            includedData?: GetPromotionIncludedDataEnum[],
            locale?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Retrieve details of a specified promotion.

      • getSelection: (
            promotionId: string,
            selectionId: string,
            revisionId: number,
            locale?: string,
            paginationToken?: string,
            limit?: number,
            includedData?: "ISSUES"[],
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Retrieve up to 100 product items that are associated with a specified promotion. This operation only supports items found in SelectionType.ITEMS. Items found in SelectionType.CATALOG are not supported. Selection objects always include selectionDetails with item information.

      • searchPromotions: (
            marketplaceIds: string[],
            locale?: string,
            statuses?: SearchPromotionsStatusesEnum[],
            asins?: string[],
            skus?: string[],
            promotionTypes?: SearchPromotionsPromotionTypesEnum[],
            startDateBefore?: string,
            startDateAfter?: string,
            endDateBefore?: string,
            endDateAfter?: string,
            updateDateAfter?: string,
            updateDateBefore?: string,
            paginationToken?: string,
            revision?: SearchPromotionsRevisionEnum,
            limit?: number,
            includedData?: SearchPromotionsIncludedDataEnum[],
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Search and filter promotions based on various criteria. Returns a paginated list of promotion summaries.