Function ExternalFulfillmentReturnsApiFp

Returns {
    getReturn(
        returnId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Return>,
    >;
    listReturns(
        returnLocationId?: string,
        rmaId?: string,
        status?: ListReturnsStatusEnum,
        reverseTrackingId?: string,
        createdSince?: string,
        createdUntil?: string,
        lastUpdatedSince?: string,
        lastUpdatedUntil?: string,
        lastUpdatedAfter?: string,
        lastUpdatedBefore?: string,
        maxResults?: number,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ReturnsResponse>,
    >;
}

• getReturn: function

  • getReturn(
        returnId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Return>,
    >

    Retrieve the return item with the specified ID.

    Parameters

    • returnId: string

      The ID of the return item you want.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• listReturns: function

  • listReturns(
        returnLocationId?: string,
        rmaId?: string,
        status?: ListReturnsStatusEnum,
        reverseTrackingId?: string,
        createdSince?: string,
        createdUntil?: string,
        lastUpdatedSince?: string,
        lastUpdatedUntil?: string,
        lastUpdatedAfter?: string,
        lastUpdatedBefore?: string,
        maxResults?: number,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ReturnsResponse>,
    >

    Retrieve a list of return items. You can filter results by location, RMA ID, status, or time.

    Parameters

    • OptionalreturnLocationId: string

      The SmartConnect location ID of the location from which you want to retrieve return items.

    • OptionalrmaId: string

      The RMA ID of the return items you want to list.

    • Optionalstatus: ListReturnsStatusEnum

      The status of return items you want to list. You can retrieve all new return items with the `CREATED` status.

    • OptionalreverseTrackingId: string

      The reverse tracking ID of the return items you want to list.

    • OptionalcreatedSince: string

      Return items created after the specified date are included in the response. In ISO 8601 date-time format.

    • OptionalcreatedUntil: string

      Return items created before the specified date are included in the response. In ISO 8601 date-time format.

    • OptionallastUpdatedSince: string

      Return items updated after the specified date are included in the response. In ISO 8601 date-time format. If you supply this parameter, you must also supply `returnLocationId` and `status`.

    • OptionallastUpdatedUntil: string

      Return items whose most recent update is before the specified date are included in the response. In ISO 8601 date-time format. If you supply this parameter, you must also supply `returnLocationId` and `status`.

    • OptionallastUpdatedAfter: string

      DEPRECATED. Use the `createdSince` parameter.

    • OptionallastUpdatedBefore: string

      DEPRECATED. Use the `createdUntil` parameter.

    • OptionalmaxResults: number

      The number of return items you want to include in the response. Default: 10 Maximum: 100

    • OptionalnextToken: string

      A token that you use to retrieve the next page of results. The response includes `nextToken` when there are multiple pages of results. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws