Function ServiceApiFp

ServiceApi - functional programming interface

Export

  • ServiceApiFp(
        configuration?: Configuration,
    ): {
        addAppointmentForServiceJobByServiceJobId(
            serviceJobId: string,
            body: AddAppointmentRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SetAppointmentResponse>,
        >;
        assignAppointmentResources(
            serviceJobId: string,
            appointmentId: string,
            body: AssignAppointmentResourcesRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<AssignAppointmentResourcesResponse>,
        >;
        cancelReservation(
            reservationId: string,
            marketplaceIds: string[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CancelReservationResponse>,
        >;
        cancelServiceJobByServiceJobId(
            serviceJobId: string,
            cancellationReasonCode: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CancelServiceJobByServiceJobIdResponse>,
        >;
        completeServiceJobByServiceJobId(
            serviceJobId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CompleteServiceJobByServiceJobIdResponse>,
        >;
        createReservation(
            marketplaceIds: string[],
            body: CreateReservationRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateReservationResponse>,
        >;
        createServiceDocumentUploadDestination(
            body: ServiceUploadDocument,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateServiceDocumentUploadDestination>,
        >;
        getAppointmentSlots(
            asin: string,
            storeId: string,
            marketplaceIds: string[],
            startTime?: string,
            endTime?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetAppointmentSlotsResponse>,
        >;
        getAppointmmentSlotsByJobId(
            serviceJobId: string,
            marketplaceIds: string[],
            startTime?: string,
            endTime?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetAppointmentSlotsResponse>,
        >;
        getFixedSlotCapacity(
            resourceId: string,
            marketplaceIds: string[],
            body: FixedSlotCapacityQuery,
            nextPageToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<FixedSlotCapacity>,
        >;
        getRangeSlotCapacity(
            resourceId: string,
            marketplaceIds: string[],
            body: RangeSlotCapacityQuery,
            nextPageToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<RangeSlotCapacity>,
        >;
        getServiceJobByServiceJobId(
            serviceJobId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetServiceJobByServiceJobIdResponse>,
        >;
        getServiceJobs(
            marketplaceIds: string[],
            serviceOrderIds?: string[],
            serviceJobStatus?: GetServiceJobsServiceJobStatusEnum[],
            pageToken?: string,
            pageSize?: number,
            sortField?: GetServiceJobsSortFieldEnum,
            sortOrder?: GetServiceJobsSortOrderEnum,
            createdAfter?: string,
            createdBefore?: string,
            lastUpdatedAfter?: string,
            lastUpdatedBefore?: string,
            scheduleStartDate?: string,
            scheduleEndDate?: string,
            asins?: string[],
            requiredSkills?: string[],
            storeIds?: string[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetServiceJobsResponse>,
        >;
        rescheduleAppointmentForServiceJobByServiceJobId(
            serviceJobId: string,
            appointmentId: string,
            body: RescheduleAppointmentRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SetAppointmentResponse>,
        >;
        setAppointmentFulfillmentData(
            serviceJobId: string,
            appointmentId: string,
            body: SetAppointmentFulfillmentDataRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>,
        >;
        updateReservation(
            reservationId: string,
            marketplaceIds: string[],
            body: UpdateReservationRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<UpdateReservationResponse>,
        >;
        updateSchedule(
            resourceId: string,
            marketplaceIds: string[],
            body: UpdateScheduleRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<UpdateScheduleResponse>,
        >;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        addAppointmentForServiceJobByServiceJobId(
            serviceJobId: string,
            body: AddAppointmentRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SetAppointmentResponse>,
        >;
        assignAppointmentResources(
            serviceJobId: string,
            appointmentId: string,
            body: AssignAppointmentResourcesRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<AssignAppointmentResourcesResponse>,
        >;
        cancelReservation(
            reservationId: string,
            marketplaceIds: string[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CancelReservationResponse>,
        >;
        cancelServiceJobByServiceJobId(
            serviceJobId: string,
            cancellationReasonCode: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CancelServiceJobByServiceJobIdResponse>,
        >;
        completeServiceJobByServiceJobId(
            serviceJobId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CompleteServiceJobByServiceJobIdResponse>,
        >;
        createReservation(
            marketplaceIds: string[],
            body: CreateReservationRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateReservationResponse>,
        >;
        createServiceDocumentUploadDestination(
            body: ServiceUploadDocument,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateServiceDocumentUploadDestination>,
        >;
        getAppointmentSlots(
            asin: string,
            storeId: string,
            marketplaceIds: string[],
            startTime?: string,
            endTime?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetAppointmentSlotsResponse>,
        >;
        getAppointmmentSlotsByJobId(
            serviceJobId: string,
            marketplaceIds: string[],
            startTime?: string,
            endTime?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetAppointmentSlotsResponse>,
        >;
        getFixedSlotCapacity(
            resourceId: string,
            marketplaceIds: string[],
            body: FixedSlotCapacityQuery,
            nextPageToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<FixedSlotCapacity>,
        >;
        getRangeSlotCapacity(
            resourceId: string,
            marketplaceIds: string[],
            body: RangeSlotCapacityQuery,
            nextPageToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<RangeSlotCapacity>,
        >;
        getServiceJobByServiceJobId(
            serviceJobId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetServiceJobByServiceJobIdResponse>,
        >;
        getServiceJobs(
            marketplaceIds: string[],
            serviceOrderIds?: string[],
            serviceJobStatus?: GetServiceJobsServiceJobStatusEnum[],
            pageToken?: string,
            pageSize?: number,
            sortField?: GetServiceJobsSortFieldEnum,
            sortOrder?: GetServiceJobsSortOrderEnum,
            createdAfter?: string,
            createdBefore?: string,
            lastUpdatedAfter?: string,
            lastUpdatedBefore?: string,
            scheduleStartDate?: string,
            scheduleEndDate?: string,
            asins?: string[],
            requiredSkills?: string[],
            storeIds?: string[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetServiceJobsResponse>,
        >;
        rescheduleAppointmentForServiceJobByServiceJobId(
            serviceJobId: string,
            appointmentId: string,
            body: RescheduleAppointmentRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SetAppointmentResponse>,
        >;
        setAppointmentFulfillmentData(
            serviceJobId: string,
            appointmentId: string,
            body: SetAppointmentFulfillmentDataRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>,
        >;
        updateReservation(
            reservationId: string,
            marketplaceIds: string[],
            body: UpdateReservationRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<UpdateReservationResponse>,
        >;
        updateSchedule(
            resourceId: string,
            marketplaceIds: string[],
            body: UpdateScheduleRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<UpdateScheduleResponse>,
        >;
    }

    • addAppointmentForServiceJobByServiceJobId:function
      • addAppointmentForServiceJobByServiceJobId(
            serviceJobId: string,
            body: AddAppointmentRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SetAppointmentResponse>,
        >

      • Adds an appointment to the service job indicated by the service job identifier specified. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | 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.

        Parameters

        • serviceJobId: string

          An Amazon defined service job identifier.

        • body: AddAppointmentRequest

          Add appointment operation input details.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • assignAppointmentResources:function
      • assignAppointmentResources(
            serviceJobId: string,
            appointmentId: string,
            body: AssignAppointmentResourcesRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<AssignAppointmentResourcesResponse>,
        >

      • Assigns new resource(s) or overwrite/update the existing one(s) to a service job appointment. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 2 | 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.

        Parameters

        • serviceJobId: string

          An Amazon-defined service job identifier. Get this value by calling the `getServiceJobs` operation of the Services API.

        • appointmentId: string

          An Amazon-defined identifier of active service job appointment.

        • body: AssignAppointmentResourcesRequest
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • cancelReservation:function
      • cancelReservation(
            reservationId: string,
            marketplaceIds: string[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CancelReservationResponse>,
        >

      • Cancel a reservation. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | 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.

        Parameters

        • reservationId: string

          Reservation Identifier

        • marketplaceIds: string[]

          An identifier for the marketplace in which the resource operates.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • cancelServiceJobByServiceJobId:function
      • cancelServiceJobByServiceJobId(
            serviceJobId: string,
            cancellationReasonCode: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CancelServiceJobByServiceJobIdResponse>,
        >

      • Cancels the service job indicated by the service job identifier specified. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | 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.

        Parameters

        • serviceJobId: string

          An Amazon defined service job identifier.

        • cancellationReasonCode: string

          A cancel reason code that specifies the reason for cancelling a service job.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • completeServiceJobByServiceJobId:function
      • completeServiceJobByServiceJobId(
            serviceJobId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CompleteServiceJobByServiceJobIdResponse>,
        >

      • Completes the service job indicated by the service job identifier specified. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | 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.

        Parameters

        • serviceJobId: string

          An Amazon defined service job identifier.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • createReservation:function
      • createReservation(
            marketplaceIds: string[],
            body: CreateReservationRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateReservationResponse>,
        >

      • Create a reservation. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | 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.

        Parameters

        • marketplaceIds: string[]

          An identifier for the marketplace in which the resource operates.

        • body: CreateReservationRequest

          Reservation details

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • createServiceDocumentUploadDestination:function
      • createServiceDocumentUploadDestination(
            body: ServiceUploadDocument,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateServiceDocumentUploadDestination>,
        >

      • Creates an upload destination. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | 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.

        Parameters

        • body: ServiceUploadDocument

          Upload document operation input details.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • getAppointmentSlots:function
      • getAppointmentSlots(
            asin: string,
            storeId: string,
            marketplaceIds: string[],
            startTime?: string,
            endTime?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetAppointmentSlotsResponse>,
        >

      • Gets appointment slots as per the service context specified. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 20 | 40 | 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.

        Parameters

        • asin: string

          ASIN associated with the service.

        • storeId: string

          Store identifier defining the region scope to retrive appointment slots.

        • marketplaceIds: string[]

          An identifier for the marketplace for which appointment slots are queried

        • OptionalstartTime: string

          A time from which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If `startTime` is provided, `endTime` should also be provided. Default value is as per business configuration.

        • OptionalendTime: string

          A time up to which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If `endTime` is provided, `startTime` should also be provided. Default value is as per business configuration. Maximum range of appointment slots can be 90 days.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • getAppointmmentSlotsByJobId:function
      • getAppointmmentSlotsByJobId(
            serviceJobId: string,
            marketplaceIds: string[],
            startTime?: string,
            endTime?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetAppointmentSlotsResponse>,
        >

      • Gets appointment slots for the service associated with the service job id specified. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | 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.

        Parameters

        • serviceJobId: string

          A service job identifier to retrive appointment slots for associated service.

        • marketplaceIds: string[]

          An identifier for the marketplace in which the resource operates.

        • OptionalstartTime: string

          A time from which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If `startTime` is provided, `endTime` should also be provided. Default value is as per business configuration.

        • OptionalendTime: string

          A time up to which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If `endTime` is provided, `startTime` should also be provided. Default value is as per business configuration. Maximum range of appointment slots can be 90 days.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • getFixedSlotCapacity:function
      • getFixedSlotCapacity(
            resourceId: string,
            marketplaceIds: string[],
            body: FixedSlotCapacityQuery,
            nextPageToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<FixedSlotCapacity>,
        >

      • Provides capacity in fixed-size slots. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | 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.

        Parameters

        • resourceId: string

          Resource Identifier.

        • marketplaceIds: string[]

          An identifier for the marketplace in which the resource operates.

        • body: FixedSlotCapacityQuery

          Request body.

        • OptionalnextPageToken: string

          Next page token returned in the response of your previous request.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • getRangeSlotCapacity:function
      • getRangeSlotCapacity(
            resourceId: string,
            marketplaceIds: string[],
            body: RangeSlotCapacityQuery,
            nextPageToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<RangeSlotCapacity>,
        >

      • Provides capacity slots in a format similar to availability records. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | 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.

        Parameters

        • resourceId: string

          Resource Identifier.

        • marketplaceIds: string[]

          An identifier for the marketplace in which the resource operates.

        • body: RangeSlotCapacityQuery

          Request body.

        • OptionalnextPageToken: string

          Next page token returned in the response of your previous request.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • getServiceJobByServiceJobId:function
      • getServiceJobByServiceJobId(
            serviceJobId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetServiceJobByServiceJobIdResponse>,
        >

      • Gets details of service job indicated by the provided serviceJobID. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 20 | 40 | 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.

        Parameters

        • serviceJobId: string

          A service job identifier.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • getServiceJobs:function
      • getServiceJobs(
            marketplaceIds: string[],
            serviceOrderIds?: string[],
            serviceJobStatus?: GetServiceJobsServiceJobStatusEnum[],
            pageToken?: string,
            pageSize?: number,
            sortField?: GetServiceJobsSortFieldEnum,
            sortOrder?: GetServiceJobsSortOrderEnum,
            createdAfter?: string,
            createdBefore?: string,
            lastUpdatedAfter?: string,
            lastUpdatedBefore?: string,
            scheduleStartDate?: string,
            scheduleEndDate?: string,
            asins?: string[],
            requiredSkills?: string[],
            storeIds?: string[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetServiceJobsResponse>,
        >

      • Gets service job details for the specified filter query. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 40 | 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.

        Parameters

        • marketplaceIds: string[]

          Used to select jobs that were placed in the specified marketplaces.

        • OptionalserviceOrderIds: string[]

          List of service order ids for the query you want to perform.Max values supported 20.

        • OptionalserviceJobStatus: GetServiceJobsServiceJobStatusEnum[]

          A list of one or more job status by which to filter the list of jobs.

        • OptionalpageToken: string

          String returned in the response of your previous request.

        • OptionalpageSize: number

          A non-negative integer that indicates the maximum number of jobs to return in the list, Value must be 1 - 20. Default 20.

        • OptionalsortField: GetServiceJobsSortFieldEnum

          Sort fields on which you want to sort the output.

        • OptionalsortOrder: GetServiceJobsSortOrderEnum

          Sort order for the query you want to perform.

        • OptionalcreatedAfter: string

          A date used for selecting jobs created at or after a specified time. Must be in ISO 8601 format. Required if `LastUpdatedAfter` is not specified. Specifying both `CreatedAfter` and `LastUpdatedAfter` returns an error.

        • OptionalcreatedBefore: string

          A date used for selecting jobs created at or before a specified time. Must be in ISO 8601 format.

        • OptionallastUpdatedAfter: string

          A date used for selecting jobs updated at or after a specified time. Must be in ISO 8601 format. Required if `createdAfter` is not specified. Specifying both `CreatedAfter` and `LastUpdatedAfter` returns an error.

        • OptionallastUpdatedBefore: string

          A date used for selecting jobs updated at or before a specified time. Must be in ISO 8601 format.

        • OptionalscheduleStartDate: string

          A date used for filtering jobs schedules at or after a specified time. Must be in ISO 8601 format. Schedule end date should not be earlier than schedule start date.

        • OptionalscheduleEndDate: string

          A date used for filtering jobs schedules at or before a specified time. Must be in ISO 8601 format. Schedule end date should not be earlier than schedule start date.

        • Optionalasins: string[]

          List of Amazon Standard Identification Numbers (ASIN) of the items. Max values supported is 20.

        • OptionalrequiredSkills: string[]

          A defined set of related knowledge, skills, experience, tools, materials, and work processes common to service delivery for a set of products and/or service scenarios. Max values supported is 20.

        • OptionalstoreIds: string[]

          List of Amazon-defined identifiers for the region scope. Max values supported is 50.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • rescheduleAppointmentForServiceJobByServiceJobId:function
      • rescheduleAppointmentForServiceJobByServiceJobId(
            serviceJobId: string,
            appointmentId: string,
            body: RescheduleAppointmentRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SetAppointmentResponse>,
        >

      • Reschedules an appointment for the service job indicated by the service job identifier specified. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | 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.

        Parameters

        • serviceJobId: string

          An Amazon defined service job identifier.

        • appointmentId: string

          An existing appointment identifier for the Service Job.

        • body: RescheduleAppointmentRequest

          Reschedule appointment operation input details.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • setAppointmentFulfillmentData:function
      • setAppointmentFulfillmentData(
            serviceJobId: string,
            appointmentId: string,
            body: SetAppointmentFulfillmentDataRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>,
        >

      • Updates the appointment fulfillment data related to a given jobID and appointmentID. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | 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.

        Parameters

        • serviceJobId: string

          An Amazon-defined service job identifier. Get this value by calling the `getServiceJobs` operation of the Services API.

        • appointmentId: string

          An Amazon-defined identifier of active service job appointment.

        • body: SetAppointmentFulfillmentDataRequest

          Appointment fulfillment data collection details.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • updateReservation:function
      • updateReservation(
            reservationId: string,
            marketplaceIds: string[],
            body: UpdateReservationRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<UpdateReservationResponse>,
        >

      • Update a reservation. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | 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.

        Parameters

        • reservationId: string

          Reservation Identifier

        • marketplaceIds: string[]

          An identifier for the marketplace in which the resource operates.

        • body: UpdateReservationRequest

          Reservation details

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • updateSchedule:function
      • updateSchedule(
            resourceId: string,
            marketplaceIds: string[],
            body: UpdateScheduleRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<UpdateScheduleResponse>,
        >

      • Update the schedule of the given resource. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | 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.

        Parameters

        • resourceId: string

          Resource (store) Identifier

        • marketplaceIds: string[]

          An identifier for the marketplace in which the resource operates.

        • body: UpdateScheduleRequest

          Schedule details

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

Settings

Member Visibility