Amazon Selling Partner API (SP-API) SDK for TypeScript
    Preparing search index...
    • DeliveryByAmazonDeliveryShipmentInvoiceV20220701Api - functional programming interface

      Parameters

      • Optionalconfiguration: Configuration

      Returns {
          getInvoiceStatus(
              marketplaceId: string,
              invoiceType: "Outbound",
              programType: GetInvoiceStatusProgramTypeEnum,
              orderId?: string,
              shipmentId?: string,
              invoiceId?: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<GetInvoiceStatusResponse>,
          >;
          submitInvoice(
              body: SubmitInvoiceRequest,
              orderId?: string,
              shipmentId?: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<SubmitInvoiceResponse>,
          >;
      }

      • getInvoiceStatus: function
        • Returns the invoice status for the order or shipment you specify. You must specify either an orderId, shipmentId, or invoiceId as a query parameter. If multiple parameters are supplied, orderId takes precedence over shipmentId, which takes precedence over invoiceId. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1.133 | 25 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

          Parameters

          • marketplaceId: string

            The Amazon store identifier.

          • invoiceType: "Outbound"

            The invoice&#39;s type.

          • programType: GetInvoiceStatusProgramTypeEnum

            The Amazon program that seller is currently enrolled.

          • OptionalorderId: string

            The order identifier.

          • OptionalshipmentId: string

            The shipment identifier.

          • OptionalinvoiceId: string

            The invoice access key (NF-e access key for Brazilian invoices). Use this to retrieve the status of a specific invoice.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<GetInvoiceStatusResponse>,
          >

      • submitInvoice: function
        • Submits a shipment invoice for a given order or shipment. You must specify either an orderId or shipmentId as query parameter. If both parameters are supplied, orderId takes precedence over shipmentId. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1.133 | 25 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

          Parameters

          • body: SubmitInvoiceRequest

            The request body that specifies invoice, program and `marketplaceId` values.

          • OptionalorderId: string

            The identifier for the order.

          • OptionalshipmentId: string

            The identifier for the shipment.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<SubmitInvoiceResponse>,
          >