Shipments Class Reference

Inheritance diagram for Shipments:

Collaboration diagram for Shipments:

Public Member Functions
	__construct ()
	Constructor.
	get ($id)
	Get properties of a shipment object.
	index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $thirdparty_ids='', $sqlfilters='', $properties='')
	List shipments.
	post ($request_data=null)
	Create shipment object.
	deleteLine ($id, $lineid)
	Get lines of an shipment.
	put ($id, $request_data=null)
	Update shipment general fields (won't touch lines of shipment)
	delete ($id)
	Delete shipment.
	validate ($id, $notrigger=0)
	Validate a shipment.
	close ($id, $notrigger=0)
	Classify the shipment as invoiced.
Public Member Functions inherited from DolibarrApi
	__construct ($db, $cachedir='', $refreshCache=false)
	Constructor.

Protected Member Functions
	_cleanObjectDatas ($object)
	Clean sensible object datas.
Protected Member Functions inherited from DolibarrApi
	_checkValForAPI ($field, $value, $object)
	Check and convert a string depending on its type/name.
	_filterObjectProperties ($object, $properties)
	Filter properties that will be returned on object.
	_checkFilters ($sqlfilters, &$error='')
	Return if a $sqlfilters parameter is valid Function no more used.

Private Member Functions
	_validate ($data)
	Validate fields before create or update object.

Additional Inherited Members
Static Protected Member Functions inherited from DolibarrApi
static	_checkAccessToResource ($resource, $resource_id=0, $dbtablename='', $feature2='', $dbt_keyfield='fk_soc', $dbt_select='rowid')
	Check access by user to a given resource.
static	_forge_criteria_callback ($matches)
	Function to forge a SQL criteria from a Generic filter string.

Detailed Description

Definition at line 29 of file api_shipments.class.php.

Member Function Documentation

_cleanObjectDatas()

Shipments::_cleanObjectDatas ( $object )

protected

Clean sensible object datas.

Parameters

Object

$object

Object to clean

Returns

Object Object with cleaned properties

Reimplemented from DolibarrApi.

Definition at line 688 of file api_shipments.class.php.

References $object.

Referenced by close(), get(), index(), and validate().

_validate()

Shipments::_validate ( $data )

private

Validate fields before create or update object.

Parameters

array

$data

Array with data to verify

Returns

array

Exceptions

RestException

Definition at line 734 of file api_shipments.class.php.

Referenced by post().

close()

Shipments::close	(		$id,
			$notrigger = 0 )

Classify the shipment as invoiced.

Parameters

int

$id

Id of the shipment

@url POST {id}/setinvoiced

Returns

int

Exceptions

RestException	400
RestException	401
RestException	404
RestException	405 Create a shipment using an existing order.

Parameters

int

$orderid

Id of the order

@url POST /createfromorder/{orderid}

Returns

int

Exceptions

RestException	400
RestException	401
RestException	404
RestException	405 Close a shipment (Classify it as "Delivered")

Parameters

int	$id	Expedition ID
int	$notrigger	Disabled triggers

@url POST {id}/close

Returns

object

Definition at line 650 of file api_shipments.class.php.

References DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().

delete()

Shipments::delete

(

$id

)

Delete shipment.

Parameters

int

$id

Shipment ID

Returns

array

Definition at line 483 of file api_shipments.class.php.

References DolibarrApi\_checkAccessToResource().

deleteLine()

Shipments::deleteLine	(		$id,
			$lineid )

Get lines of an shipment.

Parameters

int

$id

Id of shipment

@url GET {id}/lines

Returns

int Add a line to given shipment

Parameters

int	$id	Id of shipment to update
array	$request_data	ShipmentLine data

@url POST {id}/lines

Returns

int Update a line to given shipment

Parameters

int	$id	Id of shipment to update
int	$lineid	Id of line to update
array	$request_data	ShipmentLine data

@url PUT {id}/lines/{lineid}

Returns

object Delete a line to given shipment

Parameters

int	$id	Id of shipment to update
int	$lineid	Id of line to delete

@url DELETE {id}/lines/{lineid}

Returns

array

Exceptions

RestException	401
RestException	404

Definition at line 405 of file api_shipments.class.php.

References DolibarrApi\_checkAccessToResource().

get()

Shipments::get

(

$id

)

Get properties of a shipment object.

Return an array with shipment information

Parameters

int

$id

ID of shipment

Returns

Object Object with cleaned properties

Exceptions

RestException

Definition at line 65 of file api_shipments.class.php.

References DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().

index()

Shipments::index	(		$sortfield = "t.rowid",
			$sortorder = 'ASC',
			$limit = 100,
			$page = 0,
			$thirdparty_ids = '',
			$sqlfilters = '',
			$properties = '' )

List shipments.

Get a list of shipments

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit for list
int	$page	Page number
string	$thirdparty_ids	Thirdparty ids to filter shipments of (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')"
string	$properties	Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names

Returns

array Array of shipment objects

Exceptions

RestException

Definition at line 102 of file api_shipments.class.php.

References _cleanObjectDatas(), DolibarrApi\_filterObjectProperties(), dol_syslog(), and forgeSQLFromUniversalSearchCriteria().

post()

Shipments::post

(

$request_data = null

)

Create shipment object.

Parameters

array

$request_data

Request data

Returns

int ID of shipment created

Definition at line 181 of file api_shipments.class.php.

References DolibarrApi\_checkValForAPI(), _validate(), and sanitizeVal().

put()

Shipments::put	(		$id,
			$request_data = null )

Update shipment general fields (won't touch lines of shipment)

Parameters

int	$id	Id of shipment to update
array	$request_data	Datas

Returns

Object Updated object

Definition at line 442 of file api_shipments.class.php.

References DolibarrApi\_checkAccessToResource(), DolibarrApi\_checkValForAPI(), and sanitizeVal().

validate()

Shipments::validate	(		$id,
			$notrigger = 0 )

Validate a shipment.

This may record stock movements if module stock is enabled and option to decrease stock on shipment is on.

Parameters

int	$id	Shipment ID
int	$notrigger	1=Does not execute triggers, 0= execute triggers

@url POST {id}/validate

Returns

object

Definition at line 528 of file api_shipments.class.php.

References DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().

---

The documentation for this class was generated from the following file:

• dolibarr_20.0/htdocs/expedition/class/api_shipments.class.php