Class FirstMileManager

Hierarchy (View Summary)

BaseManager
- FirstMileManager

Index

Constructors

Properties

Methods

bindCourierDeliveryFirstMileTrackingNumber bindFirstMileTrackingNumber generateAndBindFirstMileTrackingNumber generateFirstMileTrackingNumber getChannelList getCourierDeliveryChannelList getCourierDeliveryDetail getCourierDeliveryTrackingNumberList getCourierDeliveryWaybill getDetail getTrackingNumberList getTransitWarehouseList getUnbindOrderList getWaybill unbindFirstMileTrackingNumber unbindFirstMileTrackingNumberAll

Constructors

constructor

new FirstMileManager(config: ShopeeConfig): FirstMileManager
Parameters
- config: ShopeeConfig
Returns FirstMileManager
Overrides BaseManager.constructor
- Defined in src/managers/first-mile.manager.ts:41

Properties

`Protected`config

config: ShopeeConfig

Methods

bindCourierDeliveryFirstMileTrackingNumber

bindCourierDeliveryFirstMileTrackingNumber(
params?: BindCourierDeliveryFirstMileTrackingNumberRequest,
): Promise<BindCourierDeliveryFirstMileTrackingNumberResponse>
Use this api to bind first mile tracking number for courier delivery method.
Parameters
- Optionalparams: BindCourierDeliveryFirstMileTrackingNumberRequest
  Request parameters
Returns Promise<BindCourierDeliveryFirstMileTrackingNumberResponse>
Promise resolving to the response
- Defined in src/managers/first-mile.manager.ts:50

bindFirstMileTrackingNumber

bindFirstMileTrackingNumber(
params?: BindFirstMileTrackingNumberRequest,
): Promise<BindFirstMileTrackingNumberResponse>
Use this api to bind first mile tracking number.
Parameters
- Optionalparams: BindFirstMileTrackingNumberRequest
  Request parameters
Returns Promise<BindFirstMileTrackingNumberResponse>
Promise resolving to the response
- Defined in src/managers/first-mile.manager.ts:69

generateAndBindFirstMileTrackingNumber

generateAndBindFirstMileTrackingNumber(
params?: GenerateAndBindFirstMileTrackingNumberRequest,
): Promise<GenerateAndBindFirstMileTrackingNumberResponse>
Use this api to generate first mile tracking number for courier delivery method.
Parameters
- Optionalparams: GenerateAndBindFirstMileTrackingNumberRequest
  Request parameters
Returns Promise<GenerateAndBindFirstMileTrackingNumberResponse>
Promise resolving to the response
- Defined in src/managers/first-mile.manager.ts:88

generateFirstMileTrackingNumber

generateFirstMileTrackingNumber(
params?: GenerateFirstMileTrackingNumberRequest,
): Promise<GenerateFirstMileTrackingNumberResponse>
Use this api to generate first mile tracking number.
Parameters
- Optionalparams: GenerateFirstMileTrackingNumberRequest
  Request parameters
Returns Promise<GenerateFirstMileTrackingNumberResponse>
Promise resolving to the response
- Defined in src/managers/first-mile.manager.ts:107

getChannelList

getChannelList(params?: GetChannelListRequest): Promise<GetChannelListResponse>
Use this api to get first mile channel list.
Parameters
- Optionalparams: GetChannelListRequest
  Request parameters
Returns Promise<GetChannelListResponse>
Promise resolving to the response
- Defined in src/managers/first-mile.manager.ts:126

getCourierDeliveryChannelList

getCourierDeliveryChannelList(
params?: GetCourierDeliveryChannelListRequest,
): Promise<GetCourierDeliveryChannelListResponse>
Use this api to get courier information for courier delivery method.
Parameters
- Optionalparams: GetCourierDeliveryChannelListRequest
  Request parameters
Returns Promise<GetCourierDeliveryChannelListResponse>
Promise resolving to the response
- Defined in src/managers/first-mile.manager.ts:139

getCourierDeliveryDetail

getCourierDeliveryDetail(
params?: GetCourierDeliveryDetailRequest,
): Promise<GetCourierDeliveryDetailResponse>
Use this api to get first mile detail for courier delivery method.
Parameters
- Optionalparams: GetCourierDeliveryDetailRequest
  Request parameters
Returns Promise<GetCourierDeliveryDetailResponse>
Promise resolving to the response
- Defined in src/managers/first-mile.manager.ts:158

getCourierDeliveryTrackingNumberList

getCourierDeliveryTrackingNumberList(
params?: GetCourierDeliveryTrackingNumberListRequest,
): Promise<GetCourierDeliveryTrackingNumberListResponse>
Use this api to get tracking number for courier delivery method.
Parameters
- Optionalparams: GetCourierDeliveryTrackingNumberListRequest
  Request parameters
Returns Promise<GetCourierDeliveryTrackingNumberListResponse>
Promise resolving to the response
- Defined in src/managers/first-mile.manager.ts:177

getCourierDeliveryWaybill

getCourierDeliveryWaybill(
params?: GetCourierDeliveryWaybillRequest,
): Promise<GetCourierDeliveryWaybillResponse>
Use this api to get first mile waybill file for courier delivery method.
Parameters
- Optionalparams: GetCourierDeliveryWaybillRequest
  Request parameters
Returns Promise<GetCourierDeliveryWaybillResponse>
Promise resolving to the response
- Defined in src/managers/first-mile.manager.ts:196

getDetail

getDetail(params?: GetDetailRequest): Promise<GetDetailResponse>
Use this api to get first mile detail.
Parameters
- Optionalparams: GetDetailRequest
  Request parameters
Returns Promise<GetDetailResponse>
Promise resolving to the response
- Defined in src/managers/first-mile.manager.ts:215

getTrackingNumberList

getTrackingNumberList(
params?: GetTrackingNumberListRequest,
): Promise<GetTrackingNumberListResponse>
Use this api to get first mile tracking number list.
Parameters
- Optionalparams: GetTrackingNumberListRequest
  Request parameters
Returns Promise<GetTrackingNumberListResponse>
Promise resolving to the response
- Defined in src/managers/first-mile.manager.ts:228

getTransitWarehouseList

getTransitWarehouseList(
params?: GetTransitWarehouseListRequest,
): Promise<GetTransitWarehouseListResponse>
Use this api to get transit warehouse list which is used for first mile tracking number generation for courier delivery method.
Parameters
- Optionalparams: GetTransitWarehouseListRequest
  Request parameters
Returns Promise<GetTransitWarehouseListResponse>
Promise resolving to the response
- Defined in src/managers/first-mile.manager.ts:247

getUnbindOrderList

getUnbindOrderList(
params?: GetUnbindOrderListRequest,
): Promise<GetUnbindOrderListResponse>
Use this api to get unbind order list. It will only return orders unbound to first-mile that were created within the past 6 months.
Parameters
- Optionalparams: GetUnbindOrderListRequest
  Request parameters
Returns Promise<GetUnbindOrderListResponse>
Promise resolving to the response
- Defined in src/managers/first-mile.manager.ts:266

getWaybill

getWaybill(params?: GetWaybillRequest): Promise<GetWaybillResponse>
Use this api to get first mile waybill file.
Parameters
- Optionalparams: GetWaybillRequest
  Request parameters
Returns Promise<GetWaybillResponse>
Promise resolving to the response
- Defined in src/managers/first-mile.manager.ts:285

unbindFirstMileTrackingNumber

unbindFirstMileTrackingNumber(
params?: UnbindFirstMileTrackingNumberRequest,
): Promise<UnbindFirstMileTrackingNumberResponse>
Use this api to unbind first mile.
Parameters
- Optionalparams: UnbindFirstMileTrackingNumberRequest
  Request parameters
Returns Promise<UnbindFirstMileTrackingNumberResponse>
Promise resolving to the response
- Defined in src/managers/first-mile.manager.ts:298

unbindFirstMileTrackingNumberAll

unbindFirstMileTrackingNumberAll(
params?: UnbindFirstMileTrackingNumberAllRequest,
): Promise<UnbindFirstMileTrackingNumberAllResponse>
Use this api to unbind orders from first mile tracking number or binding ID.
Parameters
- Optionalparams: UnbindFirstMileTrackingNumberAllRequest
  Request parameters
Returns Promise<UnbindFirstMileTrackingNumberAllResponse>
Promise resolving to the response
- Defined in src/managers/first-mile.manager.ts:317

Class FirstMileManager

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FirstMileManager

Properties

Protectedconfig

Methods

bindCourierDeliveryFirstMileTrackingNumber

Parameters

Returns Promise<BindCourierDeliveryFirstMileTrackingNumberResponse>

bindFirstMileTrackingNumber

Parameters

Returns Promise<BindFirstMileTrackingNumberResponse>

generateAndBindFirstMileTrackingNumber

Parameters

Returns Promise<GenerateAndBindFirstMileTrackingNumberResponse>

generateFirstMileTrackingNumber

Parameters

Returns Promise<GenerateFirstMileTrackingNumberResponse>

getChannelList

Parameters

Returns Promise<GetChannelListResponse>

getCourierDeliveryChannelList

Parameters

Returns Promise<GetCourierDeliveryChannelListResponse>

getCourierDeliveryDetail

Parameters

Returns Promise<GetCourierDeliveryDetailResponse>

getCourierDeliveryTrackingNumberList

Parameters

Returns Promise<GetCourierDeliveryTrackingNumberListResponse>

getCourierDeliveryWaybill

Parameters

Returns Promise<GetCourierDeliveryWaybillResponse>

getDetail

Parameters

Returns Promise<GetDetailResponse>

getTrackingNumberList

Parameters

Returns Promise<GetTrackingNumberListResponse>

getTransitWarehouseList

Parameters

Returns Promise<GetTransitWarehouseListResponse>

getUnbindOrderList

Parameters

Returns Promise<GetUnbindOrderListResponse>

getWaybill

Parameters

Returns Promise<GetWaybillResponse>

unbindFirstMileTrackingNumber

Parameters

Returns Promise<UnbindFirstMileTrackingNumberResponse>

unbindFirstMileTrackingNumberAll

Parameters

Returns Promise<UnbindFirstMileTrackingNumberAllResponse>

Settings

On This Page

`Protected`config