File: /home4/cca63905/public_html/guiaweb/htdocs/expedition/class/api_shipments.class.php
<?php
/* Copyright (C) 2015 Jean-François Ferry <jfefe@aternatik.fr>
* Copyright (C) 2016 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2025 MDW <mdeweerd@users.noreply.github.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
use Luracast\Restler\RestException;
require_once DOL_DOCUMENT_ROOT.'/expedition/class/expedition.class.php';
/**
* API class for shipments
*
* @access protected
* @class DolibarrApiAccess {@requires user,external}
*/
class Shipments extends DolibarrApi
{
/**
* @var string[] Mandatory fields, checked when create and update object
*/
public static $FIELDS = array(
'socid',
'origin_id',
'origin_type',
);
/**
* @var Expedition {@type Expedition}
*/
public $shipment;
/**
* Constructor
*/
public function __construct()
{
global $db, $conf;
$this->db = $db;
$this->shipment = new Expedition($this->db);
}
/**
* Get properties of a shipment object
*
* Return an array with shipment information
*
* @param int $id ID of shipment
* @return Object Object with cleaned properties
*
* @throws RestException
*/
public function get($id)
{
if (!DolibarrApiAccess::$user->hasRight('expedition', 'lire')) {
throw new RestException(403);
}
$result = $this->shipment->fetch($id);
if (!$result) {
throw new RestException(404, 'Shipment not found');
}
if (!DolibarrApi::_checkAccessToResource('expedition', $this->shipment->id)) {
throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
}
$this->shipment->fetchObjectLinked();
return $this->_cleanObjectDatas($this->shipment);
}
/**
* List shipments
*
* Get a list of shipments
*
* @param string $sortfield Sort field
* @param string $sortorder Sort order
* @param int $limit Limit for list
* @param int $page Page number
* @param string $thirdparty_ids Thirdparty ids to filter shipments of (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}
* @param string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')"
* @param string $properties Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names
* @param bool $pagination_data If this parameter is set to true the response will include pagination data. Default value is false. Page starts from 0*
* @return array Array of shipment objects
* @phan-return Expedition[]
* @phpstan-return Expedition[]
*
* @throws RestException
*/
public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $thirdparty_ids = '', $sqlfilters = '', $properties = '', $pagination_data = false)
{
if (!DolibarrApiAccess::$user->hasRight('expedition', 'lire')) {
throw new RestException(403);
}
$obj_ret = array();
// case of external user, $thirdparty_ids param is ignored and replaced by user's socid
$socids = DolibarrApiAccess::$user->socid ?: $thirdparty_ids;
// If the internal user must only see his customers, force searching by him
$search_sale = 0;
if (!DolibarrApiAccess::$user->hasRight('societe', 'client', 'voir') && !$socids) {
$search_sale = DolibarrApiAccess::$user->id;
}
$sql = "SELECT t.rowid";
$sql .= " FROM ".MAIN_DB_PREFIX."expedition AS t";
$sql .= " LEFT JOIN ".MAIN_DB_PREFIX."expedition_extrafields AS ef ON (ef.fk_object = t.rowid)"; // Modification VMR Global Solutions to include extrafields as search parameters in the API GET call, so we will be able to filter on extrafields
$sql .= ' WHERE t.entity IN ('.getEntity('expedition').')';
if ($socids) {
$sql .= " AND t.fk_soc IN (".$this->db->sanitize($socids).")";
}
// Search on sale representative
if ($search_sale && $search_sale != '-1') {
if ($search_sale == -2) {
$sql .= " AND NOT EXISTS (SELECT sc.fk_soc FROM ".MAIN_DB_PREFIX."societe_commerciaux as sc WHERE sc.fk_soc = t.fk_soc)";
} elseif ($search_sale > 0) {
$sql .= " AND EXISTS (SELECT sc.fk_soc FROM ".MAIN_DB_PREFIX."societe_commerciaux as sc WHERE sc.fk_soc = t.fk_soc AND sc.fk_user = ".((int) $search_sale).")";
}
}
// Add sql filters
if ($sqlfilters) {
$errormessage = '';
$sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
if ($errormessage) {
throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
}
}
//this query will return total shipments with the filters given
$sqlTotals = str_replace('SELECT t.rowid', 'SELECT count(t.rowid) as total', $sql);
$sql .= $this->db->order($sortfield, $sortorder);
if ($limit) {
if ($page < 0) {
$page = 0;
}
$offset = $limit * $page;
$sql .= $this->db->plimit($limit + 1, $offset);
}
dol_syslog("API Rest request");
$result = $this->db->query($sql);
if ($result) {
$num = $this->db->num_rows($result);
$min = min($num, ($limit <= 0 ? $num : $limit));
$i = 0;
while ($i < $min) {
$obj = $this->db->fetch_object($result);
$shipment_static = new Expedition($this->db);
if ($shipment_static->fetch($obj->rowid)) {
$obj_ret[] = $this->_filterObjectProperties($this->_cleanObjectDatas($shipment_static), $properties);
}
$i++;
}
} else {
throw new RestException(503, 'Error when retrieve commande list : '.$this->db->lasterror());
}
//if $pagination_data is true the response will contain element data with all values and element pagination with pagination data(total,page,limit)
if ($pagination_data) {
$totalsResult = $this->db->query($sqlTotals);
$total = $this->db->fetch_object($totalsResult)->total;
$tmp = $obj_ret;
$obj_ret = [];
$obj_ret['data'] = $tmp;
$obj_ret['pagination'] = [
'total' => (int) $total,
'page' => $page, //count starts from 0
'page_count' => ceil((int) $total / $limit),
'limit' => $limit
];
}
return $obj_ret;
}
/**
* Create shipment object
*
* @param array $request_data Request data
* @phan-param ?array<string,string|array<string,string|array<string,string>>> $request_data
* @phpstan-param ?array<string,string|array<string,string|array<string,string>>> $request_data
* @return int ID of shipment created
*/
public function post($request_data = null)
{
if (!DolibarrApiAccess::$user->hasRight('expedition', 'creer')) {
throw new RestException(403, "Insuffisant rights");
}
// Check mandatory fields
$result = $this->_validate($request_data);
foreach ($request_data as $field => $value) {
if ($field === 'caller') {
// Add a mention of caller so on trigger called after action, we can filter to avoid a loop if we try to sync back again with the caller
$this->shipment->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
continue;
}
$this->shipment->$field = $this->_checkValForAPI($field, $value, $this->shipment);
}
if (isset($request_data["lines"])) {
$lines = array();
foreach ($request_data["lines"] as $line) {
$shipmentline = new ExpeditionLigne($this->db);
$shipmentline->entrepot_id = (int) $line['entrepot_id'];
$shipmentline->fk_element = (int) ($line['fk_element'] ?? $line['origin_id']); // example: order id. this->origin is 'commande'
$shipmentline->origin_line_id = (int) ($line['fk_elementdet'] ?? $line['origin_line_id']); // example: order id
$shipmentline->fk_elementdet = (int) ($line['fk_elementdet'] ?? $line['origin_line_id']); // example: order line id
$shipmentline->origin_type = $line['element_type'] ?? $line['origin_type']; // example 'commande' or 'order'
$shipmentline->element_type = $line['element_type'] ?? $line['origin_type']; // example 'commande' or 'order'
$shipmentline->qty = (float) $line['qty'];
$shipmentline->rang = (int) $line['rang'];
$array_options = $line['array_options'];
if (is_array($array_options)) {
$shipmentline->array_options = $array_options;
}
$detail_batch = $line['detail_batch'];
if (is_array($detail_batch) || is_object($detail_batch)) {
$shipmentline->detail_batch = $detail_batch;
}
$lines[] = $shipmentline;
}
$this->shipment->lines = $lines;
}
if ($this->shipment->create(DolibarrApiAccess::$user) < 0) {
throw new RestException(500, "Error creating shipment", array_merge(array($this->shipment->error), $this->shipment->errors));
}
return $this->shipment->id;
}
// /**
// * Get lines of an shipment
// *
// * @param int $id Id of shipment
// *
// * @url GET {id}/lines
// *
// * @return int
// */
/*
public function getLines($id)
{
if(! DolibarrApiAccess::$user->hasRight('expedition', 'lire')) {
throw new RestException(403);
}
$result = $this->shipment->fetch($id);
if( ! $result ) {
throw new RestException(404, 'Shipment not found');
}
if( ! DolibarrApi::_checkAccessToResource('expedition',$this->shipment->id)) {
throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
}
$this->shipment->getLinesArray();
$result = array();
foreach ($this->shipment->lines as $line) {
array_push($result,$this->_cleanObjectDatas($line));
}
return $result;
}
*/
// /**
// * Add a line to given shipment
// *
// * @param int $id Id of shipment to update
// * @param array $request_data ShipmentLine data
// * @phan-param ?array<string,string> $request_data
// * @phpstan-param ?array<string,string> $request_data
// *
// * @url POST {id}/lines
// *
// * @return int
// */
/*
public function postLine($id, $request_data = null)
{
if(! DolibarrApiAccess::$user->hasRight('expedition', 'creer')) {
throw new RestException(403);
}
$result = $this->shipment->fetch($id);
if ( ! $result ) {
throw new RestException(404, 'Shipment not found');
}
if( ! DolibarrApi::_checkAccessToResource('expedition',$this->shipment->id)) {
throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
}
$request_data = (object) $request_data;
$request_data->desc = sanitizeVal($request_data->desc, 'restricthtml');
$request_data->label = sanitizeVal($request_data->label);
$updateRes = $this->shipment->addline(
$request_data->desc,
$request_data->subprice,
$request_data->qty,
$request_data->tva_tx,
$request_data->localtax1_tx,
$request_data->localtax2_tx,
$request_data->fk_product,
$request_data->remise_percent,
$request_data->info_bits,
$request_data->fk_remise_except,
'HT',
0,
$request_data->date_start,
$request_data->date_end,
$request_data->product_type,
$request_data->rang,
$request_data->special_code,
$fk_parent_line,
$request_data->fk_fournprice,
$request_data->pa_ht,
$request_data->label,
$request_data->array_options,
$request_data->fk_unit,
$request_data->origin,
$request_data->origin_id,
$request_data->multicurrency_subprice
);
if ($updateRes > 0) {
return $updateRes;
}
return false;
}*/
// /**
// * Update a line to given shipment
// *
// * @param int $id Id of shipment to update
// * @param int $lineid Id of line to update
// * @param array $request_data ShipmentLine data
// *
// * @url PUT {id}/lines/{lineid}
// *
// * @return object
// */
/*
public function putLine($id, $lineid, $request_data = null)
{
if (! DolibarrApiAccess::$user->hasRight('expedition', 'creer')) {
throw new RestException(403);
}
$result = $this->shipment->fetch($id);
if ( ! $result ) {
throw new RestException(404, 'Shipment not found');
}
if( ! DolibarrApi::_checkAccessToResource('expedition',$this->shipment->id)) {
throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
}
$request_data = (object) $request_data;
$request_data->desc = sanitizeVal($request_data->desc, 'restricthtml');
$request_data->label = sanitizeVal($request_data->label);
$updateRes = $this->shipment->updateline(
$lineid,
$request_data->desc,
$request_data->subprice,
$request_data->qty,
$request_data->remise_percent,
$request_data->tva_tx,
$request_data->localtax1_tx,
$request_data->localtax2_tx,
'HT',
$request_data->info_bits,
$request_data->date_start,
$request_data->date_end,
$request_data->product_type,
$request_data->fk_parent_line,
0,
$request_data->fk_fournprice,
$request_data->pa_ht,
$request_data->label,
$request_data->special_code,
$request_data->array_options,
$request_data->fk_unit,
$request_data->multicurrency_subprice
);
if ($updateRes > 0) {
$result = $this->get($id);
unset($result->line);
return $this->_cleanObjectDatas($result);
}
return false;
}*/
/**
* Delete a line to given shipment
*
*
* @param int $id Id of shipment to update
* @param int $lineid Id of line to delete
*
* @url DELETE {id}/lines/{lineid}
*
* @return array
* @phan-return array{success:array{code:int,message:string}}
* @phpstan-return array{success:array{code:int,message:string}}
*
* @throws RestException 401
* @throws RestException 404
*/
public function deleteLine($id, $lineid)
{
if (!DolibarrApiAccess::$user->hasRight('expedition', 'creer')) {
throw new RestException(403);
}
$result = $this->shipment->fetch($id);
if (!$result) {
throw new RestException(404, 'Shipment not found');
}
if (!DolibarrApi::_checkAccessToResource('expedition', $this->shipment->id)) {
throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
}
// TODO Check the lineid $lineid is a line of object
$updateRes = $this->shipment->deleteLine(DolibarrApiAccess::$user, $lineid);
if ($updateRes > 0) {
return array(
'success' => array(
'code' => 200,
'message' => 'line ' .$lineid. ' deleted'
)
);
} else {
throw new RestException(405, $this->shipment->error);
}
}
/**
* Update shipment general fields (won't touch lines of shipment)
*
* @param int $id Id of shipment to update
* @param array $request_data Data
* @phan-param ?array<string,string> $request_data
* @phpstan-param ?array<string,string> $request_data
* @return Object Updated object
*/
public function put($id, $request_data = null)
{
if (!DolibarrApiAccess::$user->hasRight('expedition', 'creer')) {
throw new RestException(403);
}
$result = $this->shipment->fetch($id);
if (!$result) {
throw new RestException(404, 'Shipment not found');
}
if (!DolibarrApi::_checkAccessToResource('expedition', $this->shipment->id)) {
throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
}
foreach ($request_data as $field => $value) {
if ($field == 'id') {
continue;
}
if ($field === 'caller') {
// Add a mention of caller so on trigger called after action, we can filter to avoid a loop if we try to sync back again with the caller
$this->shipment->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
continue;
}
if ($field == 'array_options' && is_array($value)) {
foreach ($value as $index => $val) {
$this->shipment->array_options[$index] = $this->_checkValForAPI($field, $val, $this->shipment);
}
continue;
}
$this->shipment->$field = $this->_checkValForAPI($field, $value, $this->shipment);
}
if ($this->shipment->update(DolibarrApiAccess::$user) > 0) {
return $this->get($id);
} else {
throw new RestException(500, $this->shipment->error);
}
}
/**
* Delete shipment
*
* @param int $id Shipment ID
*
* @return array
* @phan-return array{success:array{code:int,message:string}}
* @phpstan-return array{success:array{code:int,message:string}}
*/
public function delete($id)
{
if (!DolibarrApiAccess::$user->hasRight('expedition', 'supprimer')) {
throw new RestException(403);
}
$result = $this->shipment->fetch($id);
if (!$result) {
throw new RestException(404, 'Shipment not found');
}
if (!DolibarrApi::_checkAccessToResource('expedition', $this->shipment->id)) {
throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
}
if (!$this->shipment->delete(DolibarrApiAccess::$user)) {
throw new RestException(500, 'Error when deleting shipment : '.$this->shipment->error);
}
return array(
'success' => array(
'code' => 200,
'message' => 'Shipment deleted'
)
);
}
/**
* Validate a shipment
*
* This may record stock movements if module stock is enabled and option to
* decrease stock on shipment is on.
*
* @param int $id Shipment ID
* @param int $notrigger 1=Does not execute triggers, 0= execute triggers
*
* @url POST {id}/validate
*
* @return object
* \todo An error 403 is returned if the request has an empty body.
* Error message: "Forbidden: Content type `text/plain` is not supported."
* Workaround: send this in the body
* {
* "notrigger": 0
* }
*/
public function validate($id, $notrigger = 0)
{
if (!DolibarrApiAccess::$user->hasRight('expedition', 'creer')) {
throw new RestException(403);
}
$result = $this->shipment->fetch($id);
if (!$result) {
throw new RestException(404, 'Shipment not found');
}
if (!DolibarrApi::_checkAccessToResource('expedition', $this->shipment->id)) {
throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
}
$result = $this->shipment->valid(DolibarrApiAccess::$user, $notrigger);
if ($result == 0) {
throw new RestException(304, 'Error nothing done. May be object is already validated');
}
if ($result < 0) {
throw new RestException(500, 'Error when validating Shipment: '.$this->shipment->error);
}
// Reload shipment
$result = $this->shipment->fetch($id);
$this->shipment->fetchObjectLinked();
return $this->_cleanObjectDatas($this->shipment);
}
// /**
// * Classify the shipment as invoiced
// *
// * @param int $id Id of the shipment
// *
// * @url POST {id}/setinvoiced
// *
// * @return int
// *
// * @throws RestException 400
// * @throws RestException 401
// * @throws RestException 404
// * @throws RestException 405
// */
/*
public function setinvoiced($id)
{
if(! DolibarrApiAccess::$user->hasRight('expedition', 'creer')) {
throw new RestException(403);
}
if(empty($id)) {
throw new RestException(400, 'Shipment ID is mandatory');
}
$result = $this->shipment->fetch($id);
if( ! $result ) {
throw new RestException(404, 'Shipment not found');
}
$result = $this->shipment->classifyBilled(DolibarrApiAccess::$user);
if( $result < 0) {
throw new RestException(400, $this->shipment->error);
}
return $result;
}
*/
// /**
// * Create a shipment using an existing order.
// *
// * @param int $orderid Id of the order
// *
// * @url POST /createfromorder/{orderid}
// *
// * @return int
// * @throws RestException 400
// * @throws RestException 401
// * @throws RestException 404
// * @throws RestException 405
// */
/*
public function createShipmentFromOrder($orderid)
{
require_once DOL_DOCUMENT_ROOT . '/commande/class/commande.class.php';
if(! DolibarrApiAccess::$user->hasRight('expedition', 'lire')) {
throw new RestException(403);
}
if(! DolibarrApiAccess::$user->hasRight('expedition', 'creer')) {
throw new RestException(403);
}
if(empty($proposalid)) {
throw new RestException(400, 'Order ID is mandatory');
}
$order = new Commande($this->db);
$result = $order->fetch($proposalid);
if( ! $result ) {
throw new RestException(404, 'Order not found');
}
$result = $this->shipment->createFromOrder($order, DolibarrApiAccess::$user);
if( $result < 0) {
throw new RestException(405, $this->shipment->error);
}
$this->shipment->fetchObjectLinked();
return $this->_cleanObjectDatas($this->shipment);
}
*/
/**
* Close a shipment (Classify it as "Delivered")
*
* @param int $id Expedition ID
* @param int $notrigger Disabled triggers
*
* @url POST {id}/close
*
* @return object
*/
public function close($id, $notrigger = 0)
{
if (!DolibarrApiAccess::$user->hasRight('expedition', 'creer')) {
throw new RestException(403);
}
$result = $this->shipment->fetch($id);
if (!$result) {
throw new RestException(404, 'Shipment not found');
}
if (!DolibarrApi::_checkAccessToResource('expedition', $this->shipment->id)) {
throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
}
$result = $this->shipment->setClosed();
if ($result == 0) {
throw new RestException(304, 'Error nothing done. May be object is already closed');
}
if ($result < 0) {
throw new RestException(500, 'Error when closing Order: '.$this->shipment->error);
}
// Reload shipment
$result = $this->shipment->fetch($id);
$this->shipment->fetchObjectLinked();
return $this->_cleanObjectDatas($this->shipment);
}
// phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
/**
* Clean sensible object datas
*
* @param Object $object Object to clean
* @return Object Object with cleaned properties
*/
protected function _cleanObjectDatas($object)
{
// phpcs:enable
$object = parent::_cleanObjectDatas($object);
unset($object->canvas);
unset($object->thirdparty); // id already returned
unset($object->note);
unset($object->address);
unset($object->barcode_type);
unset($object->barcode_type_code);
unset($object->barcode_type_label);
unset($object->barcode_type_coder);
if (!empty($object->lines) && is_array($object->lines)) {
foreach ($object->lines as $line) {
if (is_array($line->detail_batch)) {
foreach ($line->detail_batch as $keytmp2 => $valtmp2) {
unset($line->detail_batch[$keytmp2]->db);
}
}
unset($line->canvas);
unset($line->tva_tx);
unset($line->vat_src_code);
unset($line->total_ht);
unset($line->total_ttc);
unset($line->total_tva);
unset($line->total_localtax1);
unset($line->total_localtax2);
unset($line->remise_percent);
}
}
return $object;
}
/**
* Validate fields before create or update object
*
* @param ?array<string,string> $data Array with data to verify
* @return array<string,string>
* @throws RestException
*/
private function _validate($data)
{
if ($data === null) {
$data = array();
}
$shipment = array();
foreach (Shipments::$FIELDS as $field) {
if (!isset($data[$field])) {
throw new RestException(400, "$field field missing");
}
$shipment[$field] = $data[$field];
}
return $shipment;
}
}