Function ShippingApiAxiosParamCreator

ShippingApi - axios parameter creator

Export

  • ShippingApiAxiosParamCreator(
        configuration?: Configuration,
    ): {
        cancelShipment: (
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        createShipment: (
            body: CreateShipmentRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getAccount: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
        getRates: (
            body: GetRatesRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getShipment: (
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getTrackingInformation: (
            trackingId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        purchaseLabels: (
            shipmentId: string,
            body: PurchaseLabelsRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        purchaseShipment: (
            body: PurchaseShipmentRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        retrieveShippingLabel: (
            shipmentId: string,
            trackingId: string,
            body: RetrieveShippingLabelRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        cancelShipment: (
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        createShipment: (
            body: CreateShipmentRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getAccount: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
        getRates: (
            body: GetRatesRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getShipment: (
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getTrackingInformation: (
            trackingId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        purchaseLabels: (
            shipmentId: string,
            body: PurchaseLabelsRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        purchaseShipment: (
            body: PurchaseShipmentRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        retrieveShippingLabel: (
            shipmentId: string,
            trackingId: string,
            body: RetrieveShippingLabelRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

    • cancelShipment: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

      Cancel a shipment by the given shipmentId. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

      Throws

    • createShipment: (
          body: CreateShipmentRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Create a new shipment. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | 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 than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

      Throws

    • getAccount: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>

      Verify if the current account is valid. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

      Throws

    • getRates: (body: GetRatesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

      Get service rates. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

      Throws

    • getShipment: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

      Return the entire shipment object for the shipmentId. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

      Throws

    • getTrackingInformation: (trackingId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

      Return the tracking information of a shipment. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

      Throws

    • purchaseLabels: (
          shipmentId: string,
          body: PurchaseLabelsRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Purchase shipping labels based on a given rate. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

      Throws

    • purchaseShipment: (
          body: PurchaseShipmentRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Purchase shipping labels. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

      Throws

    • retrieveShippingLabel: (
          shipmentId: string,
          trackingId: string,
          body: RetrieveShippingLabelRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Retrieve shipping label based on the shipment id and tracking id. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

      Throws

Settings

Member Visibility