ProductOrderController extends Controller
Table of Contents
Properties
- $freeAccessActions : mixed
Methods
- actionCancelItem() : array{name: string, message: string, code: int, status: int}
- Desc: Cancela un item de la orden.
- actionCheckAvailableStock() : mixed
- actionCheckout() : mixed
- Desc: Metodo para solicitar el estado del link de pago de CLIP
- actionCustomer() : array{name: string, status: int, total: int, pagination: array{pageCount: int, currentPage: int, pageSize: int}, data: array}
- Desc: Devuelve las ordenes asociadas al cliente/customer.
- actionIndex() : array{name: string, status: int, total: int, pagination: array{pageCount: int, currentPage: int, pageSize: int}, data: array}
- Desc: Retorna lista de elementos de ProductOrder. Funciona con método GET.
- actionNewPo() : array{name: string, message: string, code: int, status: int}
- Desc: Metodo para confirmar el PO actual y generar una copia exacta de este para que se guarde como historial.
- actionOptions() : void
- Desc: Método para brindar información al fronend sobre opciones de comunicación. Funciona con método OPTIONS.
- actionPdf() : void
- Desc: Genera un PDF del PO.
- actionReset() : ProductOrder}}
- Desc: Este metodo hace un reset/cancelacion a la modificacion del PO. Se asume que se esta siempre y cuando el PO este abierto.
- actionSendPaymentLink() : array{name: string, message: string, code: int, status: int}
- Desc: Envía el Link de pago al email. Funciona el método POST.
- actionTransaction() : mixed
- Desc: Metodo para verificar transacciones.
- actionUnlockPo() : mixed
- Desc: Metodo parea desbloquear la orden de pago y crear una backup en caso de que sea la primera "modificacion". Funciona con el método PATCH
- actionUpdate() : array{name: string, message: string, code: int, status: int}
- Desc: Actualiza un item de ProductOrder. Funciona con los métodos PUT, PATCH.
- actionUpdateDiscount() : array{name: string, message: string, code: int, status: int}
- Desc: Actualiza descuento de un item ProductOrder. Funciona con el método PATCH.
- actionView() : ProductOrder
- Desc: Item de ProductOrder. Funciona con método GET.
- actionWebhook() : void
- Desc: Endpoint para obtener las notificaciones de compra de Clip. Funciona con el método POST.
- behaviors() : array<string|int, mixed>
- Desc: Retorna lista de comportamientos que el controlador debe de seguir.
- init() : void
- Desc: Inicializa configuraciones para el controlador.
Properties
$freeAccessActions
public
mixed
$freeAccessActions
= ['webhook', 'pdf', 'options', 'paypal-testing']
Methods
actionCancelItem()
Desc: Cancela un item de la orden.
public
actionCancelItem(int $id) : array{name: string, message: string, code: int, status: int}
Notes: n/a, Ref: n/a
Date: 2025-08-07, Version: v0.2507.01
Example: n/a
Parameters
- $id : int
Return values
array{name: string, message: string, code: int, status: int}actionCheckAvailableStock()
public
actionCheckAvailableStock(int $id) : mixed
Parameters
- $id : int
actionCheckout()
Desc: Metodo para solicitar el estado del link de pago de CLIP
public
actionCheckout(string $payment_request_id) : mixed
Notes: n/a
Ref: Clip::getCheckout()
Date: 2025-08-07, Version: v0.2507.01
Example: n/a
Parameters
- $payment_request_id : string
-
ID de la solicitud
actionCustomer()
Desc: Devuelve las ordenes asociadas al cliente/customer.
public
actionCustomer() : array{name: string, status: int, total: int, pagination: array{pageCount: int, currentPage: int, pageSize: int}, data: array}
Notes: n/a, Ref: n/a
Date: 2025-08-07, Version: v0.2507.01
Example: n/a
Return values
array{name: string, status: int, total: int, pagination: array{pageCount: int, currentPage: int, pageSize: int}, data: array}actionIndex()
Desc: Retorna lista de elementos de ProductOrder. Funciona con método GET.
public
actionIndex() : array{name: string, status: int, total: int, pagination: array{pageCount: int, currentPage: int, pageSize: int}, data: array}
Notes: Los parámetros URL de filtro son: sort, search, status (po status), parent_id, type
Ref: ProductOrder
Date: 2025-08-07, Version: v0.2507.01
Example: n/a
Return values
array{name: string, status: int, total: int, pagination: array{pageCount: int, currentPage: int, pageSize: int}, data: array}actionNewPo()
Desc: Metodo para confirmar el PO actual y generar una copia exacta de este para que se guarde como historial.
public
actionNewPo(int $id) : array{name: string, message: string, code: int, status: int}
Notes: n/a, Ref: n/a
Date: 2025-08-07, Version: v0.2507.01
Example: n/a
Parameters
- $id : int
-
ID de la orden
Return values
array{name: string, message: string, code: int, status: int}actionOptions()
Desc: Método para brindar información al fronend sobre opciones de comunicación. Funciona con método OPTIONS.
public
actionOptions([mixed $id = null ]) : void
Notes: n/a,
Ref: https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Methods/OPTIONS
Date: 2025-08-07, Version: v0.2507.01
Example: n/a
Parameters
- $id : mixed = null
actionPdf()
Desc: Genera un PDF del PO.
public
actionPdf(int $id) : void
Notes: n/a, Ref: n/a
Date: 2025-08-07, Version: v0.2507.01
Example: n/a
Parameters
- $id : int
-
ID del PO
actionReset()
Desc: Este metodo hace un reset/cancelacion a la modificacion del PO. Se asume que se esta siempre y cuando el PO este abierto.
public
actionReset(int $id) : ProductOrder}}
Funciona co lo métodos PUT, PATCH
Notes: n/a, Ref: n/a
Date: 2025-08-07, Version: v0.2507.01
Example: n/a
Parameters
- $id : int
Return values
ProductOrder}}actionSendPaymentLink()
Desc: Envía el Link de pago al email. Funciona el método POST.
public
actionSendPaymentLink() : array{name: string, message: string, code: int, status: int}
Notes: n/a, Ref: n/a
Date: 2025-08-07, Version: v0.2507.01
Example: n/a
Return values
array{name: string, message: string, code: int, status: int}actionTransaction()
Desc: Metodo para verificar transacciones.
public
actionTransaction(string $receipt_no) : mixed
Notes: n/a
Date: 2025-08-07, Version: v0.2507.01
Example: n/a
Parameters
- $receipt_no : string
actionUnlockPo()
Desc: Metodo parea desbloquear la orden de pago y crear una backup en caso de que sea la primera "modificacion". Funciona con el método PATCH
public
actionUnlockPo(int $id) : mixed
Notes: n/a, Ref: n/a
Date: 2025-08-07, Version: v0.2507.01
Example: n/a
Parameters
- $id : int
actionUpdate()
Desc: Actualiza un item de ProductOrder. Funciona con los métodos PUT, PATCH.
public
actionUpdate(int $id) : array{name: string, message: string, code: int, status: int}
Notes: n/a, Ref: n/a
Date: 2025-08-07, Version: v0.2507.01
Example: n/a
Parameters
- $id : int
-
ID del item
Return values
array{name: string, message: string, code: int, status: int}actionUpdateDiscount()
Desc: Actualiza descuento de un item ProductOrder. Funciona con el método PATCH.
public
actionUpdateDiscount(int $id) : array{name: string, message: string, code: int, status: int}
Notes: Aplica el descuento individual y se recalcula el total de la orden o si se trata de un cupón, se aplical el cupón y se recalcula el total de la orden.
Ref: ProductOrder, ProductOrderDetail::calculateMultipleITemsReturns()
Date: 2025-08-07, Version: v0.2507.01
Example: n/a
Parameters
- $id : int
-
ID del item
Return values
array{name: string, message: string, code: int, status: int}actionView()
Desc: Item de ProductOrder. Funciona con método GET.
public
actionView(int $id) : ProductOrder
Notes: n/a.
Ref: ProductOrder
Date: 2025-08-07, Version: v0.2507.01
Example: n/a
Parameters
- $id : int
Return values
ProductOrderactionWebhook()
Desc: Endpoint para obtener las notificaciones de compra de Clip. Funciona con el método POST.
public
actionWebhook() : void
Notes: Actualiza el status de la orden ProductOrder,
Ref: https://developer.clip.mx/reference/webhookstransparent
Date: 2025-08-07, Version: v0.2507.01
Example: n/a
behaviors()
Desc: Retorna lista de comportamientos que el controlador debe de seguir.
public
behaviors() : array<string|int, mixed>
Notes: Contiene excepciones de auht, auhtenticator, filtros de cors, métodos HTTP permitidos.
Ref: https://www.yiiframework.com/doc/api/2.0/yii-rest-controller#behaviors()-detail
Date: 2025-08-07, Version: v0.2507.01
Example: n/a
Return values
array<string|int, mixed> —Configuraciones del comportamiento
init()
Desc: Inicializa configuraciones para el controlador.
public
init() : void
Notes: Se deshabilita la sesión (porque se comporta como un API rest).
Ref: https://www.yiiframework.com/doc/api/2.0/yii-rest-controller#init()-detail
Date: 2025-08-07, Version: v0.2507.01
Example: n/a