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

      Parameters

      • Optionalconfiguration: Configuration

      Returns {
          createGovernmentInvoice: (
              body: GovernmentInvoiceRequest,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          createInvoicesExport: (
              body: ExportInvoicesRequest,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getGovernmentInvoiceDocument: (
              marketplaceId: string,
              transactionType: string,
              shipmentId: string,
              invoiceType: string,
              inboundPlanId?: string,
              fileFormat?: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getGovernmentInvoiceStatus: (
              marketplaceId: string,
              transactionType: string,
              shipmentId: string,
              invoiceType: string,
              inboundPlanId?: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getInvoice: (
              marketplaceId: string,
              invoiceId: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getInvoices: (
              marketplaceId: string,
              transactionIdentifierName?: string,
              pageSize?: number,
              dateEnd?: string,
              transactionType?: string,
              transactionIdentifierId?: string,
              dateStart?: string,
              series?: string,
              nextToken?: string,
              sortOrder?: GetInvoicesSortOrderEnum,
              invoiceType?: string,
              statuses?: string[],
              externalInvoiceId?: string,
              sortBy?: "START_DATE_TIME",
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getInvoicesAttributes: (
              marketplaceId: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getInvoicesDocument: (
              invoicesDocumentId: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getInvoicesExport: (
              exportId: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getInvoicesExports: (
              marketplaceId: string,
              dateStart?: string,
              nextToken?: string,
              pageSize?: number,
              dateEnd?: string,
              status?: GetInvoicesExportsStatusEnum,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
      }

      • createGovernmentInvoice: (
            body: GovernmentInvoiceRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Submit an asynchronous request to create a government invoice.

      • createInvoicesExport: (
            body: ExportInvoicesRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Creates an invoice export request.

      • getGovernmentInvoiceDocument: (
            marketplaceId: string,
            transactionType: string,
            shipmentId: string,
            invoiceType: string,
            inboundPlanId?: string,
            fileFormat?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Retrieve the URL of an invoice document.

      • getGovernmentInvoiceStatus: (
            marketplaceId: string,
            transactionType: string,
            shipmentId: string,
            invoiceType: string,
            inboundPlanId?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Retrieve the status of an invoice generation request.

      • getInvoice: (
            marketplaceId: string,
            invoiceId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Returns invoice data for the specified invoice. This operation returns only a subset of the invoices data; refer to the response definition to get all the possible attributes. To get the full invoice, use the createInvoicesExport operation to start an export request.

      • getInvoices: (
            marketplaceId: string,
            transactionIdentifierName?: string,
            pageSize?: number,
            dateEnd?: string,
            transactionType?: string,
            transactionIdentifierId?: string,
            dateStart?: string,
            series?: string,
            nextToken?: string,
            sortOrder?: GetInvoicesSortOrderEnum,
            invoiceType?: string,
            statuses?: string[],
            externalInvoiceId?: string,
            sortBy?: "START_DATE_TIME",
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Returns invoice details for the invoices that match the filters that you specify.

      • getInvoicesAttributes: (marketplaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

        Returns marketplace-dependent schemas and their respective set of possible values.

      • getInvoicesDocument: (
            invoicesDocumentId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Returns the invoice document's ID and URL. Use the URL to download the ZIP file, which contains the invoices from the corresponding createInvoicesExport request.

      • getInvoicesExport: (exportId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

        Returns invoice export details (including the exportDocumentId, if available) for the export that you specify.

      • getInvoicesExports: (
            marketplaceId: string,
            dateStart?: string,
            nextToken?: string,
            pageSize?: number,
            dateEnd?: string,
            status?: GetInvoicesExportsStatusEnum,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Returns invoice exports details for exports that match the filters that you specify.