GroupId Property

The Group Id that will be associated with the shipment.

Object Oriented Interface

public function getGroupId();
public function setGroupId($value);

Procedural Interface

inship_canadapostship_get($res, 12 );
inship_canadapostship_set($res, 12, $value );

Default Value

''

Remarks

This property is used to specify the Group Id that will be associated with the shipment.

This is a user specified value and may be a number or string up to 32 characters in length. It is used by Canada Post to group shipments together for reporting purposes. If the specified group does not exist, it will be created automatically by the Canada Post service.

This value is required when CanadaPostContractId is specified.

Data Type

String