ebay-api/dist/api/restful/postOrder/case/index.d.ts

eBay API for Node and Browser

import Restful from '../../index.js';
import { AppealRequest, BuyerCloseCaseRequest, CaseSearchParams, ReturnAddressRequest, Text } from '../../../../types/index.js';
/**
 * Post-Order Case Management API
 */
export default class Case extends Restful {
    static id: string;
    get basePath(): string;
    get useIaf(): boolean;
    /**
     * Buyer or seller appeals a case decision.
     *
     * @param caseId The unique identifier of a case.
     * @param payload the AppealRequest
     */
    appealCaseDecision(caseId: string, payload?: AppealRequest): Promise<any>;
    /**
     * Check the eligibility of an order cancellation.
     *
     * @param caseId The unique identifier of a case.
     * @param payload the BuyerCloseCaseRequest
     */
    closeCase(caseId: string, payload: BuyerCloseCaseRequest): Promise<any>;
    /**
     * Retrieve the details related to a specific case.
     *
     * @param caseId The unique identifier of a case.
     */
    getCase(caseId: string): Promise<any>;
    /**
     * Seller issues a refund for a case.
     *
     * @param caseId The unique identifier of a case.
     * @param payload the CaseVoluntaryRefundRequest (Text)
     */
    issueCaseRefund(caseId: string, payload?: Text): Promise<any>;
    /**
     * This call allows the buyer to provide shipment tracking information for the item that is being returned to the
     * seller.
     *
     * @param caseId The unique identifier of a case.
     * @param shippingCarrierName The shipping carrier that is used to ship the item, such as 'FedEx', 'UPS', or
     *     'USPS'.
     * @param trackingNumber The tracking number assigned by the shipping carrier to the item shipment.
     */
    provideReturnShipmentInfo(caseId: string, { shippingCarrierName, trackingNumber }: {
        shippingCarrierName: string;
        trackingNumber: string;
    }): Promise<any>;
    /**
     * Seller provides a return address to the buyer.
     *
     * @param cancelId The unique eBay-assigned identifier of the cancellation request to be rejected.
     * @param payload the ReturnAddressRequest
     */
    providesReturnAddress(cancelId: string, payload?: ReturnAddressRequest): Promise<any>;
    /**
     * This call is used to search for cases using multiple filter types.
     *
     * @param params the SearchParams
     */
    search(params: CaseSearchParams): Promise<any>;
}