Function VendorShippingApiAxiosParamCreator

VendorShippingApi - axios parameter creator

Export

  • VendorShippingApiAxiosParamCreator(
        configuration?: Configuration,
    ): {
        createShippingLabels: (
            purchaseOrderNumber: string,
            body: CreateShippingLabelsRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getCustomerInvoice: (
            purchaseOrderNumber: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getCustomerInvoices: (
            createdAfter: string,
            createdBefore: string,
            shipFromPartyId?: string,
            limit?: number,
            sortOrder?: GetCustomerInvoicesSortOrderEnum,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getPackingSlip: (
            purchaseOrderNumber: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getPackingSlips: (
            createdAfter: string,
            createdBefore: string,
            shipFromPartyId?: string,
            limit?: number,
            sortOrder?: GetPackingSlipsSortOrderEnum,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getShippingLabel: (
            purchaseOrderNumber: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getShippingLabels: (
            createdAfter: string,
            createdBefore: string,
            shipFromPartyId?: string,
            limit?: number,
            sortOrder?: GetShippingLabelsSortOrderEnum,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        submitShipmentConfirmations: (
            body: SubmitShipmentConfirmationsRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        submitShipmentStatusUpdates: (
            body: SubmitShipmentStatusUpdatesRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        submitShippingLabelRequest: (
            body: SubmitShippingLabelsRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        createShippingLabels: (
            purchaseOrderNumber: string,
            body: CreateShippingLabelsRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getCustomerInvoice: (
            purchaseOrderNumber: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getCustomerInvoices: (
            createdAfter: string,
            createdBefore: string,
            shipFromPartyId?: string,
            limit?: number,
            sortOrder?: GetCustomerInvoicesSortOrderEnum,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getPackingSlip: (
            purchaseOrderNumber: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getPackingSlips: (
            createdAfter: string,
            createdBefore: string,
            shipFromPartyId?: string,
            limit?: number,
            sortOrder?: GetPackingSlipsSortOrderEnum,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getShippingLabel: (
            purchaseOrderNumber: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getShippingLabels: (
            createdAfter: string,
            createdBefore: string,
            shipFromPartyId?: string,
            limit?: number,
            sortOrder?: GetShippingLabelsSortOrderEnum,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        submitShipmentConfirmations: (
            body: SubmitShipmentConfirmationsRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        submitShipmentStatusUpdates: (
            body: SubmitShipmentStatusUpdatesRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        submitShippingLabelRequest: (
            body: SubmitShippingLabelsRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

    • createShippingLabels: (
          purchaseOrderNumber: string,
          body: CreateShippingLabelsRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Creates shipping labels for a purchase order and returns the labels. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

      Throws

    • getCustomerInvoice: (
          purchaseOrderNumber: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Returns a customer invoice based on the purchaseOrderNumber that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

      Throws

    • getCustomerInvoices: (
          createdAfter: string,
          createdBefore: string,
          shipFromPartyId?: string,
          limit?: number,
          sortOrder?: GetCustomerInvoicesSortOrderEnum,
          nextToken?: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

      Throws

    • getPackingSlip: (
          purchaseOrderNumber: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Returns a packing slip based on the purchaseOrderNumber that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

      Throws

    • getPackingSlips: (
          createdAfter: string,
          createdBefore: string,
          shipFromPartyId?: string,
          limit?: number,
          sortOrder?: GetPackingSlipsSortOrderEnum,
          nextToken?: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

      Throws

    • getShippingLabel: (
          purchaseOrderNumber: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Returns a shipping label for the purchaseOrderNumber that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

      Throws

    • getShippingLabels: (
          createdAfter: string,
          createdBefore: string,
          shipFromPartyId?: string,
          limit?: number,
          sortOrder?: GetShippingLabelsSortOrderEnum,
          nextToken?: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

      Throws

    • submitShipmentConfirmations: (
          body: SubmitShipmentConfirmationsRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Submits one or more shipment confirmations for vendor orders. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

      Throws

    • submitShipmentStatusUpdates: (
          body: SubmitShipmentStatusUpdatesRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      This operation is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API submits a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

      Throws

    • submitShippingLabelRequest: (
          body: SubmitShippingLabelsRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Creates a shipping label for a purchase order and returns a transactionId for reference. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

      Throws

Settings

Member Visibility