​

Class: TrackingRequestManager

​

Extends

• BaseManager

​

Constructors

​

Constructor

new TrackingRequestManager(transport, defaultFormat?): TrackingRequestManager

​

Parameters

​

Returns

TrackingRequestManager

​

Inherited from

BaseManager.constructor

​

Methods

​

cancel()

cancel(id, options?): Promise<any>

Cancel a tracking request that is still pending or awaiting_manifest. It moves to status cancelled. Any other status returns 422.

​

Parameters

​

Returns

Promise<any>

---

​

create()

create(params): Promise<any>

​

Parameters

​

Returns

Promise<any>

---

​

createFromInfer()

createFromInfer(number, options?): Promise<{ infer: any; trackingRequest: any; }>

​

Parameters

​

Returns

Promise<{ infer: any; trackingRequest: any; }>

---

​

customFields()

customFields(id, options?): Promise<any>

List custom field values set on a tracking request, with their definitions.

​

Parameters

​

Returns

Promise<any>

---

​

deleteCustomField()

deleteCustomField(id, apiSlug, options?): Promise<any>

Remove a custom field value from a tracking request.

​

Parameters

​

Returns

Promise<any>

---

​

get()

get(id, options?): Promise<any>

​

Parameters

​

Returns

Promise<any>

---

​

inferNumber()

inferNumber(number): Promise<any>

​

Parameters

​

Returns

Promise<any>

---

​

iterate()

iterate(filters?, options?): AsyncGenerator<TrackingRequest, void, unknown>

​

Parameters

​

Returns

AsyncGenerator<TrackingRequest, void, unknown>

---

​

list()

list(filters?, options?): Promise<any>

​

Parameters

​

Returns

Promise<any>

---

​

setCustomField()

setCustomField(id, apiSlug, value, options?): Promise<any>

Create a custom field value on a tracking request.

​

Parameters

​

Returns

Promise<any>

---

​

update()

update(id, attrs, options?): Promise<any>

​

Parameters

​

Returns

Promise<any>

---

​

updateCustomField()

updateCustomField(id, apiSlug, value, options?): Promise<any>

Update an existing custom field value on a tracking request.

​

Parameters

​

Returns

Promise<any>