Class: ShipmentManager
Extends
Constructors
Constructor
new ShipmentManager(transport,defaultFormat?):ShipmentManager
Parameters
Returns
ShipmentManager
Inherited from
BaseManager.constructor
Methods
addPartyRole()
addPartyRole(Assign a party to a shipment in the given role.id,__namedParameters,options?):Promise<any>
Parameters
Returns
Promise<any>
customFields()
customFields(id,options?):Promise<any>
Parameters
Returns
Promise<any>
deleteCustomField()
deleteCustomField(Remove a custom field value from a shipment.id,apiSlug,options?):Promise<any>
Parameters
Returns
Promise<any>
get()
get(id,includeContainers?,options?):Promise<any>
Parameters
Returns
Promise<any>
iterate()
iterate(filters?,options?):AsyncGenerator<Shipment,void,unknown>
Parameters
Returns
AsyncGenerator<Shipment, void, unknown>
list()
list(filters?,options?):Promise<any>
Parameters
Returns
Promise<any>
partyRoles()
partyRoles(List the party roles assigned to a shipment.id,options?):Promise<any>
Parameters
Returns
Promise<any>
removePartyRole()
removePartyRole(Remove a party role assignment from a shipment.id,partyRoleId,options?):Promise<any>
Parameters
Returns
Promise<any>
resumeTracking()
resumeTracking(id,options?):Promise<any>
Parameters
Returns
Promise<any>
setCustomField()
setCustomField(Create a custom field value on a shipment.id,apiSlug,value,options?):Promise<any>
Parameters
Returns
Promise<any>
stopTracking()
stopTracking(id,options?):Promise<any>
Parameters
Returns
Promise<any>
update()
update(id,attrs,options?):Promise<any>
Parameters
Returns
Promise<any>
updateCustomField()
updateCustomField(Update an existing custom field value on a shipment.id,apiSlug,value,options?):Promise<any>
Parameters
Returns
Promise<any>