Function ShopOrderApiFactory

Returns {
    shopOrderControllerCancel(id: string, options?: RawAxiosRequestConfig): AxiosPromise<ShopOrderOutputDTOAPI>;
    shopOrderControllerClaim(id: string, options?: RawAxiosRequestConfig): AxiosPromise<ShopOrderOutputDTOAPI>;
    shopOrderControllerCreate(shopOrderCreateDTO?: ShopOrderCreateDTO, options?: RawAxiosRequestConfig): AxiosPromise<ShopOrderOutputDTOAPI>;
    shopOrderControllerGetOne(id: string, options?: RawAxiosRequestConfig): AxiosPromise<ShopOrderOutputDTOAPI>;
    shopOrderControllerSearch(shopOrderSearchInputDTO?: ShopOrderSearchInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<ShopOrderOutputArrayDTOAPI>;
}

• shopOrderControllerCancel:function

  • shopOrderControllerCancel(id, options?): AxiosPromise<ShopOrderOutputDTOAPI>

  • Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ShopOrderOutputDTOAPI>

    Summary

    Cancel

    Throws

• shopOrderControllerClaim:function

  • shopOrderControllerClaim(id, options?): AxiosPromise<ShopOrderOutputDTOAPI>

  • Claiming an order will mark it as completed and give the user the item in-game

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ShopOrderOutputDTOAPI>

    Summary

    Claim an order

    Throws

• shopOrderControllerCreate:function

  • shopOrderControllerCreate(shopOrderCreateDTO?, options?): AxiosPromise<ShopOrderOutputDTOAPI>

  • Parameters

    • OptionalshopOrderCreateDTO: ShopOrderCreateDTO

      ShopOrderCreateDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ShopOrderOutputDTOAPI>

    Summary

    Create

    Throws

• shopOrderControllerGetOne:function

  • shopOrderControllerGetOne(id, options?): AxiosPromise<ShopOrderOutputDTOAPI>

  • Get an order by its ID. This endpoint only returns orders that belong to the caller. When the caller has permission to view all orders, they can get any order.

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ShopOrderOutputDTOAPI>

    Summary

    Get order by ID

    Throws

• shopOrderControllerSearch:function

  • shopOrderControllerSearch(shopOrderSearchInputDTO?, options?): AxiosPromise<ShopOrderOutputArrayDTOAPI>

  • Search for orders. By default, this endpoint only returns your own orders. When the caller has permission to view all orders, they can search for all orders.

    Parameters

    • OptionalshopOrderSearchInputDTO: ShopOrderSearchInputDTO

      ShopOrderSearchInputDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ShopOrderOutputArrayDTOAPI>

    Summary

    Search orders

    Throws