Function ShippingApiFp

Returns {
    cancelShipment(
        shipmentId: string,
        xAmznShippingBusinessId?: CancelShipmentXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CancelShipmentResponse>,
    >;
    createClaim(
        body: CreateClaimRequest,
        xAmznShippingBusinessId?: CreateClaimXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateClaimResponse>,
    >;
    directPurchaseShipment(
        body: DirectPurchaseRequest,
        xAmznIdempotencyKey?: string,
        locale?: string,
        xAmznShippingBusinessId?: DirectPurchaseShipmentXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<DirectPurchaseResponse>,
    >;
    generateCollectionForm(
        body: GenerateCollectionFormRequest,
        xAmznIdempotencyKey?: string,
        xAmznShippingBusinessId?: GenerateCollectionFormXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GenerateCollectionFormResponse>,
    >;
    getAccessPoints(
        accessPointTypes: GetAccessPointsAccessPointTypesEnum[],
        countryCode: string,
        postalCode: string,
        xAmznShippingBusinessId?: GetAccessPointsXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetAccessPointsResponse>,
    >;
    getAdditionalInputs(
        requestToken: string,
        rateId: string,
        xAmznShippingBusinessId?: GetAdditionalInputsXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetAdditionalInputsResponse>,
    >;
    getCarrierAccountFormInputs(
        xAmznShippingBusinessId?: GetCarrierAccountFormInputsXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetCarrierAccountFormInputsResponse>,
    >;
    getCarrierAccounts(
        body: GetCarrierAccountsRequest,
        xAmznShippingBusinessId?: GetCarrierAccountsXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetCarrierAccountsResponse>,
    >;
    getCollectionForm(
        collectionFormId: string,
        xAmznShippingBusinessId?: GetCollectionFormXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetCollectionFormResponse>,
    >;
    getCollectionFormHistory(
        body: GetCollectionFormHistoryRequest,
        xAmznShippingBusinessId?: GetCollectionFormHistoryXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetCollectionFormHistoryResponse>,
    >;
    getRates(
        body: GetRatesRequest,
        xAmznShippingBusinessId?: GetRatesXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetRatesResponse>,
    >;
    getShipmentDocuments(
        shipmentId: string,
        packageClientReferenceId: string,
        format?: string,
        dpi?: number,
        xAmznShippingBusinessId?: GetShipmentDocumentsXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetShipmentDocumentsResponse>,
    >;
    getTracking(
        trackingId: string,
        carrierId: string,
        xAmznShippingBusinessId?: GetTrackingXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetTrackingResponse>,
    >;
    getUnmanifestedShipments(
        body: GetUnmanifestedShipmentsRequest,
        xAmznShippingBusinessId?: GetUnmanifestedShipmentsXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetUnmanifestedShipmentsResponse>,
    >;
    linkCarrierAccount(
        carrierId: string,
        body: LinkCarrierAccountRequest,
        xAmznShippingBusinessId?: LinkCarrierAccountXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<LinkCarrierAccountResponse>,
    >;
    linkCarrierAccount_1(
        carrierId: string,
        body: LinkCarrierAccountRequest,
        xAmznShippingBusinessId?: LinkCarrierAccount0XAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<LinkCarrierAccountResponse>,
    >;
    oneClickShipment(
        body: OneClickShipmentRequest,
        xAmznShippingBusinessId?: OneClickShipmentXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<OneClickShipmentResponse>,
    >;
    purchaseShipment(
        body: PurchaseShipmentRequest,
        xAmznIdempotencyKey?: string,
        xAmznShippingBusinessId?: PurchaseShipmentXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PurchaseShipmentResponse>,
    >;
    submitNdrFeedback(
        body: SubmitNdrFeedbackRequest,
        xAmznShippingBusinessId?: SubmitNdrFeedbackXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    unlinkCarrierAccount(
        carrierId: string,
        body: UnlinkCarrierAccountRequest,
        xAmznShippingBusinessId?: UnlinkCarrierAccountXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UnlinkCarrierAccountResponse>,
    >;
}

• cancelShipment: function

  • cancelShipment(
        shipmentId: string,
        xAmznShippingBusinessId?: CancelShipmentXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CancelShipmentResponse>,
    >

    Cancels a purchased shipment. Returns an empty object if the shipment is successfully cancelled. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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.

    Parameters

    • shipmentId: string

      The shipment identifier originally returned by the purchaseShipment operation.

    • OptionalxAmznShippingBusinessId: CancelShipmentXAmznShippingBusinessIdEnum

      Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• createClaim: function

  • createClaim(
        body: CreateClaimRequest,
        xAmznShippingBusinessId?: CreateClaimXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateClaimResponse>,
    >

    This API will be used to create claim for single eligible shipment. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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.

    Parameters

    • body: CreateClaimRequest

      Request body for the createClaim operation

    • OptionalxAmznShippingBusinessId: CreateClaimXAmznShippingBusinessIdEnum

      Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• directPurchaseShipment: function

  • directPurchaseShipment(
        body: DirectPurchaseRequest,
        xAmznIdempotencyKey?: string,
        locale?: string,
        xAmznShippingBusinessId?: DirectPurchaseShipmentXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<DirectPurchaseResponse>,
    >

    Purchases the shipping service for a shipment using the best fit service offering. Returns purchase related details and documents. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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.

    Parameters

    • body: DirectPurchaseRequest

      DirectPurchaseRequest body

    • OptionalxAmznIdempotencyKey: string

      A unique value which the server uses to recognize subsequent retries of the same request.

    • Optionallocale: string

      The IETF Language Tag. Note that this only supports the primary language subtag with one secondary language subtag (i.e. en-US, fr-CA). The secondary language subtag is almost always a regional designation. This does not support additional subtags beyond the primary and secondary language subtags.

    • OptionalxAmznShippingBusinessId: DirectPurchaseShipmentXAmznShippingBusinessIdEnum

      Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• generateCollectionForm: function

  • generateCollectionForm(
        body: GenerateCollectionFormRequest,
        xAmznIdempotencyKey?: string,
        xAmznShippingBusinessId?: GenerateCollectionFormXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GenerateCollectionFormResponse>,
    >

    This API Call to generate the collection form. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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.

    Parameters

    • body: GenerateCollectionFormRequest

      GenerateCollectionFormRequest body

    • OptionalxAmznIdempotencyKey: string

      A unique value which the server uses to recognize subsequent retries of the same request.

    • OptionalxAmznShippingBusinessId: GenerateCollectionFormXAmznShippingBusinessIdEnum

      Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getAccessPoints: function

  • getAccessPoints(
        accessPointTypes: GetAccessPointsAccessPointTypesEnum[],
        countryCode: string,
        postalCode: string,
        xAmznShippingBusinessId?: GetAccessPointsXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetAccessPointsResponse>,
    >

    Returns a list of access points in proximity of input postal code. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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.

    Parameters

    • accessPointTypes: GetAccessPointsAccessPointTypesEnum[]

      Access point types

    • countryCode: string

      Country code for access point

    • postalCode: string

      postal code for access point

    • OptionalxAmznShippingBusinessId: GetAccessPointsXAmznShippingBusinessIdEnum

      Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getAdditionalInputs: function

  • getAdditionalInputs(
        requestToken: string,
        rateId: string,
        xAmznShippingBusinessId?: GetAdditionalInputsXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetAdditionalInputsResponse>,
    >

    Returns the JSON schema to use for providing additional inputs when needed to purchase a shipping offering. Call the getAdditionalInputs operation when the response to a previous call to the getRates operation indicates that additional inputs are required for the rate (shipping offering) that you want to purchase. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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.

    Parameters

    • requestToken: string

      The request token returned in the response to the getRates operation.

    • rateId: string

      The rate identifier for the shipping offering (rate) returned in the response to the getRates operation.

    • OptionalxAmznShippingBusinessId: GetAdditionalInputsXAmznShippingBusinessIdEnum

      Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getCarrierAccountFormInputs: function

  • getCarrierAccountFormInputs(
        xAmznShippingBusinessId?: GetCarrierAccountFormInputsXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetCarrierAccountFormInputsResponse>,
    >

    This API will return a list of input schema required to register a shipper account with the carrier. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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.

    Parameters

    • OptionalxAmznShippingBusinessId: GetCarrierAccountFormInputsXAmznShippingBusinessIdEnum

      Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getCarrierAccounts: function

  • getCarrierAccounts(
        body: GetCarrierAccountsRequest,
        xAmznShippingBusinessId?: GetCarrierAccountsXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetCarrierAccountsResponse>,
    >

    This API will return Get all carrier accounts for a merchant. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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.

    Parameters

    • body: GetCarrierAccountsRequest

      GetCarrierAccountsRequest body

    • OptionalxAmznShippingBusinessId: GetCarrierAccountsXAmznShippingBusinessIdEnum

      Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getCollectionForm: function

  • getCollectionForm(
        collectionFormId: string,
        xAmznShippingBusinessId?: GetCollectionFormXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetCollectionFormResponse>,
    >

    This API reprint a collection form. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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.

    Parameters

    • collectionFormId: string

      collection form Id to reprint a collection.

    • OptionalxAmznShippingBusinessId: GetCollectionFormXAmznShippingBusinessIdEnum

      Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getCollectionFormHistory: function

  • getCollectionFormHistory(
        body: GetCollectionFormHistoryRequest,
        xAmznShippingBusinessId?: GetCollectionFormHistoryXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetCollectionFormHistoryResponse>,
    >

    This API Call to get the history of the previously generated collection forms. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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.

    Parameters

    • body: GetCollectionFormHistoryRequest

      GetCollectionFormHistoryRequest body

    • OptionalxAmznShippingBusinessId: GetCollectionFormHistoryXAmznShippingBusinessIdEnum

      Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getRates: function

  • getRates(
        body: GetRatesRequest,
        xAmznShippingBusinessId?: GetRatesXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetRatesResponse>,
    >

    Returns the available shipping service offerings. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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.

    Parameters

    • body: GetRatesRequest

      GetRatesRequest body

    • OptionalxAmznShippingBusinessId: GetRatesXAmznShippingBusinessIdEnum

      Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getShipmentDocuments: function

  • getShipmentDocuments(
        shipmentId: string,
        packageClientReferenceId: string,
        format?: string,
        dpi?: number,
        xAmznShippingBusinessId?: GetShipmentDocumentsXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetShipmentDocumentsResponse>,
    >

    Returns the shipping documents associated with a package in a shipment. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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.

    Parameters

    • shipmentId: string

      The shipment identifier originally returned by the purchaseShipment operation.

    • packageClientReferenceId: string

      The package client reference identifier originally provided in the request body parameter for the getRates operation.

    • Optionalformat: string

      The file format of the document. Must be one of the supported formats returned by the getRates operation.

    • Optionaldpi: number

      The resolution of the document (for example, 300 means 300 dots per inch). Must be one of the supported resolutions returned in the response to the getRates operation.

    • OptionalxAmznShippingBusinessId: GetShipmentDocumentsXAmznShippingBusinessIdEnum

      Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getTracking: function

  • getTracking(
        trackingId: string,
        carrierId: string,
        xAmznShippingBusinessId?: GetTrackingXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetTrackingResponse>,
    >

    Returns tracking information for a purchased shipment. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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.

    Parameters

    • trackingId: string

      A carrier-generated tracking identifier originally returned by the purchaseShipment operation.

    • carrierId: string

      A carrier identifier originally returned by the getRates operation for the selected rate.

    • OptionalxAmznShippingBusinessId: GetTrackingXAmznShippingBusinessIdEnum

      Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getUnmanifestedShipments: function

  • getUnmanifestedShipments(
        body: GetUnmanifestedShipmentsRequest,
        xAmznShippingBusinessId?: GetUnmanifestedShipmentsXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetUnmanifestedShipmentsResponse>,
    >

    This API Get all unmanifested carriers with shipment locations. Any locations which has unmanifested shipments with an eligible carrier for manifesting shall be returned. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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.

    Parameters

    • body: GetUnmanifestedShipmentsRequest

      GetUmanifestedShipmentsRequest body

    • OptionalxAmznShippingBusinessId: GetUnmanifestedShipmentsXAmznShippingBusinessIdEnum

      Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• linkCarrierAccount: function

  • linkCarrierAccount(
        carrierId: string,
        body: LinkCarrierAccountRequest,
        xAmznShippingBusinessId?: LinkCarrierAccountXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<LinkCarrierAccountResponse>,
    >

    This API associates/links the specified carrier account with the merchant. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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.

    Parameters

    • carrierId: string

      An identifier for the carrier with which the seller&#39;s account is being linked.

    • body: LinkCarrierAccountRequest

      LinkCarrierAccountRequest body

    • OptionalxAmznShippingBusinessId: LinkCarrierAccountXAmznShippingBusinessIdEnum

      Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• linkCarrierAccount_1: function

  • linkCarrierAccount_1(
        carrierId: string,
        body: LinkCarrierAccountRequest,
        xAmznShippingBusinessId?: LinkCarrierAccount0XAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<LinkCarrierAccountResponse>,
    >

    This API associates/links the specified carrier account with the merchant. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 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.

    Parameters

    • carrierId: string

      An identifier for the carrier with which the seller&#39;s account is being linked.

    • body: LinkCarrierAccountRequest

      LinkCarrierAccountRequest body

    • OptionalxAmznShippingBusinessId: LinkCarrierAccount0XAmznShippingBusinessIdEnum

      Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• oneClickShipment: function

  • oneClickShipment(
        body: OneClickShipmentRequest,
        xAmznShippingBusinessId?: OneClickShipmentXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<OneClickShipmentResponse>,
    >

    Purchases a shipping service identifier and returns purchase-related details and documents. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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.

    Parameters

    • body: OneClickShipmentRequest

      OneClickShipmentRequest body

    • OptionalxAmznShippingBusinessId: OneClickShipmentXAmznShippingBusinessIdEnum

      Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• purchaseShipment: function

  • purchaseShipment(
        body: PurchaseShipmentRequest,
        xAmznIdempotencyKey?: string,
        xAmznShippingBusinessId?: PurchaseShipmentXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PurchaseShipmentResponse>,
    >

    Purchases a shipping service and returns purchase related details and documents. Note: You must complete the purchase within 10 minutes of rate creation by the shipping service provider. If you make the request after the 10 minutes have expired, you will receive an error response with the error code equal to "TOKEN_EXPIRED". If you receive this error response, you must get the rates for the shipment again. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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.

    Parameters

    • body: PurchaseShipmentRequest

      PurchaseShipmentRequest body

    • OptionalxAmznIdempotencyKey: string

      A unique value which the server uses to recognize subsequent retries of the same request.

    • OptionalxAmznShippingBusinessId: PurchaseShipmentXAmznShippingBusinessIdEnum

      Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• submitNdrFeedback: function

  • submitNdrFeedback(
        body: SubmitNdrFeedbackRequest,
        xAmznShippingBusinessId?: SubmitNdrFeedbackXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    This API submits the NDR (Non-delivery Report) Feedback for any eligible shipment. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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.

    Parameters

    • body: SubmitNdrFeedbackRequest

      Request body for ndrFeedback operation

    • OptionalxAmznShippingBusinessId: SubmitNdrFeedbackXAmznShippingBusinessIdEnum

      Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• unlinkCarrierAccount: function

  • unlinkCarrierAccount(
        carrierId: string,
        body: UnlinkCarrierAccountRequest,
        xAmznShippingBusinessId?: UnlinkCarrierAccountXAmznShippingBusinessIdEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UnlinkCarrierAccountResponse>,
    >

    This API Unlink the specified carrier account with the merchant. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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.

    Parameters

    • carrierId: string

      carrier Id to unlink with merchant.

    • body: UnlinkCarrierAccountRequest

      UnlinkCarrierAccountRequest body

    • OptionalxAmznShippingBusinessId: UnlinkCarrierAccountXAmznShippingBusinessIdEnum

      Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws