OrderDetailsApi
extends BaseApi
in package
Table of Contents
Constants
- ADDRESS_STATUSES = ['Failed', 'Verified', 'Corrected']
- MAILED_STATUSES = ['Mailed', 'Completed', 'Processing']
Properties
Methods
- __construct() : mixed
- BaseApi constructor.
- allContacts() : array{message: string, data: array}
- Get order contacts <code> <?php $response = $olc->orderDetails()->allContacts(9759, [ //'search' => 'NY', //'addressStatus' => 'Verified', //'mailedStatus' => 'Completed', ]); ?> </code>
- analytics() : array{message: string, data: array}
- Get order analytics <code> <?php $response = $olc->orderDetails()->analytics(9759); ?> </code>
- get() : array{message: string, data: array}
- Get order details <code> <?php $response = $olc->orderDetails()->get(9759); ?> </code>
- getInstance() : OlcInstance
- Gets the OlcInstance that this API is associated with.
Constants
ADDRESS_STATUSES
private
mixed
ADDRESS_STATUSES
= ['Failed', 'Verified', 'Corrected']
MAILED_STATUSES
private
mixed
MAILED_STATUSES
= ['Mailed', 'Completed', 'Processing']
Properties
$_olcInstance
private
OlcInstance
$_olcInstance
Methods
__construct()
BaseApi constructor.
public
__construct(OlcInstance $_olcInstance) : mixed
Parameters
- $_olcInstance : OlcInstance
-
OlcInstance that this API is associated with
allContacts()
Get order contacts <code> <?php $response = $olc->orderDetails()->allContacts(9759, [ //'search' => 'NY', //'addressStatus' => 'Verified', //'mailedStatus' => 'Completed', ]); ?> </code>
public
allContacts(int $orderId[, array{startDate: string, endDate: string} $params = [] ]) : array{message: string, data: array}
Parameters
- $orderId : int
-
The order ID
- $params : array{startDate: string, endDate: string} = []
-
['deliveredDate'] - Filter results by delivered date range
Tags
Return values
array{message: string, data: array} —The response data.
analytics()
Get order analytics <code> <?php $response = $olc->orderDetails()->analytics(9759); ?> </code>
public
analytics(int $orderId) : array{message: string, data: array}
Parameters
- $orderId : int
-
The order ID
Tags
Return values
array{message: string, data: array} —The response data.
get()
Get order details <code> <?php $response = $olc->orderDetails()->get(9759); ?> </code>
public
get(int $orderId) : array{message: string, data: array}
Parameters
- $orderId : int
-
The order ID
Tags
Return values
array{message: string, data: array} —The response data.
getInstance()
Gets the OlcInstance that this API is associated with.
protected
getInstance() : OlcInstance