Inheritance diagram for Shipments:

Collaboration diagram for Shipments:

Public Member Functions
	__construct ()
	Constructor.

	get ($id)
	Get properties of a shipment object. More...

	index ($sortfield="t.rowid", $sortorder= 'ASC', $limit=100, $page=0, $thirdparty_ids= '', $sqlfilters= '')
	List shipments. More...

	post ($request_data=null)
	Create shipment object. More...

	deleteLine ($id, $lineid)
	Get lines of an shipment. More...

	put ($id, $request_data=null)
	Update shipment general fields (won't touch lines of shipment) More...

	delete ($id)
	Delete shipment. More...

	validate ($id, $notrigger=0)
	Validate a shipment. More...

Public Member Functions inherited from DolibarrApi
	__construct ($db, $cachedir= '', $refreshCache=false)
	Constructor. More...

Protected Member Functions
	_cleanObjectDatas ($object)
	Classify the shipment as invoiced. More...

Protected Member Functions inherited from DolibarrApi
	_cleanObjectDatas ($object)
	Executed method when API is called without parameter. More...

	_checkFilters ($sqlfilters)
	Return if a $sqlfilters parameter is valid. More...

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

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 user access to a resource. More...

static	_forge_criteria_callback ($matches)
	Function to forge a SQL criteria. More...

Detailed Description

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

Member Function Documentation

Shipments::_cleanObjectDatas ( $object )

protected

Classify the shipment as invoiced.

Parameters

int $id Id of the shipment

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

POST /createfromorder/{orderid}

Returns: int

Exceptions

RestException	400
RestException	401
RestException	404
RestException	405 Clean sensible object datas

Parameters

Object $object Object to clean

Returns: Object Object with cleaned properties

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

Referenced by get(), index(), and 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 655 of file api_shipments.class.php.

Referenced by post().

Shipments::delete ( $id )

Delete shipment.

Parameters

int $id Shipment ID

Returns: array

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

References DolibarrApi\_checkAccessToResource().

Shipments::deleteLine	(	$id,
		$lineid
	)

Get lines of an shipment.

Parameters

int $id Id of shipment

GET {id}/lines

Returns: int Add a line to given shipment

Parameters

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

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

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

DELETE {id}/lines/{lineid}

Returns: int

Exceptions

RestException	401
RestException	404

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

References DolibarrApi\_checkAccessToResource().

Shipments::get ( $id )

Get properties of a shipment object.

Return an array with shipment informations

Parameters

int $id ID of shipment

Returns: array|mixed data without useless information

Exceptions

RestException

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

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

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

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') { /^[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')"

Returns: array Array of shipment objects

Exceptions

RestException

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

References DolibarrApi\_checkFilters(), _cleanObjectDatas(), db, and dol_syslog().

Shipments::post ( $request_data = null )

Create shipment object.

Parameters

array $request_data Request data

Returns: int ID of shipment

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

References _validate().

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: int

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

References DolibarrApi\_checkAccessToResource().

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

POST {id}/validate

Returns: array

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

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

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

htdocs/expedition/class/api_shipments.class.php

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation