Documentation

AmazonOrderList extends AmazonOrderCore
in package
implements Iterator

Pulls a list of Orders and turn them into an array of AmazonOrder objects.

This Amazon Orders Core object can retrieve a list of orders from Amazon and store them in an array of AmazonOrder objects. A number of filters are available to narrow the number of orders returned, but none of them are required. This object can use tokens when retrieving the list.

Interfaces, Classes and Traits

Iterator

Table of Contents

$config  : mixed
$env  : mixed
$marketplaceId  : mixed
$mockFiles  : mixed
$mockIndex  : mixed
$mockMode  : mixed
$options  : mixed
$proxyInfo  : mixed
$rawResponses  : mixed
$storeName  : mixed
$throttleCount  : mixed
$throttleGroup  : mixed
$throttleLimit  : mixed
$throttleSafe  : mixed
$throttleStop  : mixed
$throttleTime  : mixed
$tokenFlag  : mixed
$tokenUseFlag  : mixed
$urlbase  : mixed
$urlbranch  : mixed
$i  : mixed
$index  : mixed
$orderList  : mixed
__construct()  : mixed
Amazon Order Lists pull a set of Orders and turn them into an array of <i>AmazonOrder</i> objects.
current()  : type
Iterator function
fetchItems()  : array<string|int, mixed>|AmazonOrderItemList
Returns array of item lists or a single item list.
fetchOrders()  : bool
Fetches orders from Amazon and puts them in an array of <i>AmazonOrder</i> objects.
fetchURL()  : array<string|int, mixed>
Get url or send POST data
getLastResponse()  : array<string|int, mixed>|bool
Gives the latest response data received from Amazon.
getList()  : array<string|int, mixed>|bool
Returns the list of orders.
getOptions()  : array<string|int, mixed>
Returns options array.
getRawResponses()  : array<string|int, mixed>|bool
Gives all response code received from Amazon.
getThrottleCountForLastRequest()  : int
Gives the number of times the last call to sendRequest was throttled
hasToken()  : bool
Returns whether or not a token is available.
key()  : type
Iterator function
next()  : mixed
Iterator function
resetOrderStatusFilter()  : mixed
Removes order status options.
resetPaymentMethodFilter()  : mixed
Removes payment method options.
rewind()  : mixed
Iterator function
setConfig()  : mixed
setEmailFilter()  : bool
Sets (or resets) the email address. (Optional)
setFulfillmentChannelFilter()  : bool
Sets (or resets) the Fulfillment Channel Filter
setLimits()  : bool
Sets the time frame for the orders fetched. (Optional)
setMaxResultsPerPage()  : bool
Sets the maximum response per page count. (Optional)
setMock()  : mixed
Enables or disables Mock Mode for the object.
setOrderStatusFilter()  : bool
Sets the order status(es). (Optional)
setPaymentMethodFilter()  : bool
Sets the payment method(s). (Optional)
setSellerOrderIdFilter()  : bool
Sets (or resets) the seller order ID(s). (Optional)
setStore()  : mixed
Sets the store values.
setThrottleStop()  : mixed
Enables or disables the throttle stop.
setUseToken()  : bool
Sets whether or not the object should automatically use tokens if it receives one.
valid()  : type
Iterator function
_calculateStringToSignV2()  : string
generates the string to sign, copied from Amazon
_getParametersAsString()  : string
Fuses all of the parameters together into a string, copied from Amazon
_sign()  : string
Runs the hash, copied from Amazon
_signParameters()  : string
validates signature and sets up signing of them, copied from Amazon
_urlencode()  : string
Reformats the provided string using rawurlencode while also replacing ~, copied from Amazon
checkResponse()  : bool
Checks whether or not the response is OK.
checkToken()  : bool
Checks for a token and changes the proper options
fetchMockFile()  : SimpleXMLObject|string|bool
Fetches the given mock file, or attempts to.
fetchMockResponse()  : bool|array<string|int, mixed>
Generates a fake HTTP response using the mock file list.
genQuery()  : string
Handles generation of the signed query string.
genTime()  : string
Generates timestamp in ISO8601 format.
log()  : bool
Writes a message to the log.
parseXML()  : bool
Parses XML response into array.
prepareToken()  : mixed
Sets up options for using tokens.
resetMock()  : mixed
Sets mock index back to 0.
sendRequest()  : array<string|int, mixed>
Sends a request to Amazon via cURL
sleep()  : mixed
Sleeps for the throttle time and records to the log.

Properties

$rawResponses

protected mixed $rawResponses = []

$throttleCount

protected mixed $throttleCount = 0

$throttleStop

protected mixed $throttleStop = false

Methods

__construct()

Amazon Order Lists pull a set of Orders and turn them into an array of <i>AmazonOrder</i> objects.

public __construct(string $s[, bool $mock = false ][, array<string|int, mixed>|string $m = null ]) : mixed

The parameters are passed to the parent constructor, which are in turn passed to the AmazonCore constructor. See it for more information on these parameters and common methods.

Parameters
$s : string

Name for the store you want to use.

$mock : bool = false

[optional]

This is a flag for enabling Mock Mode. This defaults to FALSE.

$m : array<string|int, mixed>|string = null

[optional]

The files (or file) to use in Mock Mode.

Return values
mixed —

current()

Iterator function

public current() : type
Return values
type —

fetchItems()

Returns array of item lists or a single item list.

public fetchItems([bool $token = false ][, int $i = null ]) : array<string|int, mixed>|AmazonOrderItemList

If $i is not specified, the method will fetch the items for every order in the list. Please note that for lists with a high number of orders, this operation could take a while due to throttling. (Two seconds per order when throttled.)

Parameters
$token : bool = false

[optional]

whether or not to automatically use tokens when fetching items.

$i : int = null

[optional]

List index to retrieve the value from. Defaults to null.

Return values
array<string|int, mixed>|AmazonOrderItemList —

AmazonOrderItemList object or array of objects, or FALSE if non-numeric index

fetchOrders()

Fetches orders from Amazon and puts them in an array of <i>AmazonOrder</i> objects.

public fetchOrders([mixed $r = true ]) : bool

Submits a ListOrders request to Amazon. Amazon will send the list back as a response, which can be retrieved using getList. This operation can potentially involve tokens.

Parameters
$r : mixed = true
Return values
bool —

FALSE if something goes wrong

fetchURL()

Get url or send POST data

public fetchURL(string $url, array<string|int, mixed> $param) : array<string|int, mixed>
Parameters
$url : string
$param : array<string|int, mixed>

['Header'] $param['Post']

Return values
array<string|int, mixed> —

$return['ok'] 1 - success, (0,-1) - fail $return['body'] - response $return['error'] - error, if "ok" is not 1 $return['head'] - http header

getLastResponse()

Gives the latest response data received from Amazon.

public getLastResponse([int $i = null ]) : array<string|int, mixed>|bool

Response arrays contain the following keys:

  • head - The raw HTTP head, including the response code and content length
  • body - The raw HTTP body, which will almost always be in XML format
  • code - The HTTP response code extracted from the head for convenience
  • answer - The HTTP response message extracted from the head for convenience
  • ok - Contains a 1 if the response was normal, or 0 if there was a problem
  • headarray - An associative array of the head data, for convenience
Parameters
$i : int = null

[optional]

If set, retrieves the specific response instead of the last one. If the index for the response is not used, FALSE will be returned.

Return values
array<string|int, mixed>|bool —

associative array of HTTP response or FALSE if not set yet

getList()

Returns the list of orders.

public getList() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool —

array of AmazonOrder objects, or FALSE if list not filled yet

getOptions()

Returns options array.

public getOptions() : array<string|int, mixed>

Gets the options for the object, for debugging or recording purposes. Note that this also includes key information such as your Amazon Access Key ID.

Return values
array<string|int, mixed> —

All of the options for the object.

getRawResponses()

Gives all response code received from Amazon.

public getRawResponses() : array<string|int, mixed>|bool
Tags
see
getLastResponse
Return values
array<string|int, mixed>|bool —

list of associative arrays of HTTP response or FALSE if not set yet

getThrottleCountForLastRequest()

Gives the number of times the last call to sendRequest was throttled

public getThrottleCountForLastRequest() : int
Tags
see
sendRequest
Return values
int —

hasToken()

Returns whether or not a token is available.

public hasToken() : bool
Return values
bool —

next()

Iterator function

public next() : mixed
Return values
mixed —

resetOrderStatusFilter()

Removes order status options.

public resetOrderStatusFilter() : mixed

Use this in case you change your mind and want to remove the Order Status parameters you previously set.

Return values
mixed —

resetPaymentMethodFilter()

Removes payment method options.

public resetPaymentMethodFilter() : mixed

Use this in case you change your mind and want to remove the Payment Method parameters you previously set.

Return values
mixed —

rewind()

Iterator function

public rewind() : mixed
Return values
mixed —

setConfig()

public setConfig() : mixed
Return values
mixed —

setEmailFilter()

Sets (or resets) the email address. (Optional)

public setEmailFilter(mixed $filter) : bool

This method sets the email address to be sent in the next request. Setting this parameter tells Amazon to only return Orders with addresses that match the address given. If this parameter is set, the following options will be removed: SellerOrderId, OrderStatus, PaymentMethod, FulfillmentChannel, LastUpdatedAfter, LastUpdatedBefore.

Parameters
$filter : mixed
Return values
bool —

FALSE if improper input

setFulfillmentChannelFilter()

Sets (or resets) the Fulfillment Channel Filter

public setFulfillmentChannelFilter(string $filter) : bool
Parameters
$filter : string

'AFN' or 'MFN' or NULL

Return values
bool —

FALSE on failure

setLimits()

Sets the time frame for the orders fetched. (Optional)

public setLimits(string $mode[, string $lower = null ][, string $upper = null ]) : bool

Sets the time frame for the orders fetched. If no times are specified, times default to the current time.

Parameters
$mode : string

"Created" or "Modified"

$lower : string = null

[optional]

A time string for the earliest time.

$upper : string = null

[optional]

A time string for the latest time.

Return values
bool —

FALSE if improper input

setMaxResultsPerPage()

Sets the maximum response per page count. (Optional)

public setMaxResultsPerPage(mixed $num) : bool

This method sets the maximum number of Feed Submissions for Amazon to return per page. If this parameter is not set, Amazon will send 100 at a time.

Parameters
$num : mixed
Return values
bool —

FALSE if improper input

setMock()

Enables or disables Mock Mode for the object.

public setMock([bool $b = true ][, array<string|int, mixed>|string|int $files = null ]) : mixed

Use this method when you want to test your object without sending actual requests to Amazon. When Mock Mode is enabled, responses are pulled from files you specify instead of sending the request. Be careful, as this means that the parameters you send will not necessarily match the response you get back. The files are pulled in order of the list, looping back to the first file after the last file is used. The log records every time a file is set or used, or if the file is missing. This method is also used to set response codes used by certain functions. Mock Mode is particularly useful when you need to test functions such as canceling orders or adding new products.

Parameters
$b : bool = true

[optional]

When set to TRUE, Mock Mode is enabled for the object. Defaults to TRUE.

$files : array<string|int, mixed>|string|int = null

[optional]

The list of files (or single file) to be used with Mock Mode. If a single string is given, this method will put it into an array. Integers can also be given, for use in fetchMockResponse. These numbers should only be response codes, such as 200 or 404.

Return values
mixed —

setOrderStatusFilter()

Sets the order status(es). (Optional)

public setOrderStatusFilter(mixed $list) : bool

This method sets the list of Order Statuses to be sent in the next request. Setting this parameter tells Amazon to only return Orders with statuses that match those in the list. If this parameter is not set, Amazon will return Orders of any status.

Parameters
$list : mixed
Return values
bool —

FALSE if improper input

setPaymentMethodFilter()

Sets the payment method(s). (Optional)

public setPaymentMethodFilter(mixed $list) : bool

This method sets the list of Payment Methods to be sent in the next request. Setting this parameter tells Amazon to only return Orders with payment methods that match those in the list. If this parameter is not set, Amazon will return Orders with any payment method.

Parameters
$list : mixed
Return values
bool —

FALSE if improper input

setSellerOrderIdFilter()

Sets (or resets) the seller order ID(s). (Optional)

public setSellerOrderIdFilter(mixed $filter) : bool

This method sets the list of seller order IDs to be sent in the next request. Setting this parameter tells Amazon to only return Orders with addresses that match those in the list. If this parameter is set, the following options will be removed: BuyerEmail, OrderStatus, PaymentMethod, FulfillmentChannel, LastUpdatedAfter, LastUpdatedBefore.

Parameters
$filter : mixed
Return values
bool —

FALSE if improper input

setStore()

Sets the store values.

public setStore(string $s) : mixed

This method sets a number of key values from the config file. These values include your Merchant ID, Access Key ID, and Secret Key, and are critical for making requests with Amazon. If the store cannot be found in the config file, or if any of the key values are missing, the incident will be logged.

Parameters
$s : string

The store name to look for.

Tags
throws
Exception

If the file can't be found.

Return values
mixed —

setThrottleStop()

Enables or disables the throttle stop.

public setThrottleStop([bool $b = true ]) : mixed

When the throttle stop is enabled, throttled requests will not be repeated. This setting is off by default.

Parameters
$b : bool = true

Defaults to TRUE.

Return values
mixed —

setUseToken()

Sets whether or not the object should automatically use tokens if it receives one.

public setUseToken([bool $b = true ]) : bool

If this option is set to TRUE, the object will automatically perform the necessary operations to retrieve the rest of the list using tokens. If this option is off, the object will only ever retrieve the first section of the list.

Parameters
$b : bool = true

[optional]

Defaults to TRUE

Return values
bool —

FALSE if improper input

valid()

Iterator function

public valid() : type
Return values
type —

_calculateStringToSignV2()

generates the string to sign, copied from Amazon

protected _calculateStringToSignV2(array<string|int, mixed> $parameters) : string
Parameters
$parameters : array<string|int, mixed>
Return values
string —

_getParametersAsString()

Fuses all of the parameters together into a string, copied from Amazon

protected _getParametersAsString(array<string|int, mixed> $parameters) : string
Parameters
$parameters : array<string|int, mixed>
Return values
string —

_sign()

Runs the hash, copied from Amazon

protected _sign(string $data, string $key, string $algorithm) : string
Parameters
$data : string
$key : string
$algorithm : string

'HmacSHA1' or 'HmacSHA256'

Tags
throws
Exception
Return values
string —

_signParameters()

validates signature and sets up signing of them, copied from Amazon

protected _signParameters(array<string|int, mixed> $parameters, string $key) : string
Parameters
$parameters : array<string|int, mixed>
$key : string
Tags
throws
Exception
Return values
string —

signed string

_urlencode()

Reformats the provided string using rawurlencode while also replacing ~, copied from Amazon

protected _urlencode(string $value) : string

Almost the same as using rawurlencode

Parameters
$value : string
Return values
string —

checkResponse()

Checks whether or not the response is OK.

protected checkResponse(array<string|int, mixed> $r) : bool

Verifies whether or not the HTTP response has the 200 OK code. If the code is not 200, the incident and error message returned are logged.

Parameters
$r : array<string|int, mixed>

The HTTP response array. Expects the array to have the fields code, body, and error.

Return values
bool —

TRUE if the status is 200 OK, FALSE otherwise.

checkToken()

Checks for a token and changes the proper options

protected checkToken(SimpleXMLObject $xml) : bool
Parameters
$xml : SimpleXMLObject

response data

Return values
bool —

FALSE if no XML data

fetchMockFile()

Fetches the given mock file, or attempts to.

protected fetchMockFile([bool $load = true ]) : SimpleXMLObject|string|bool

This method is only called when Mock Mode is enabled. This is where files from the mock file list are retrieved and passed back to the caller. The success or failure of the operation will be recorded in the log, including the name and path of the file involved. For retrieving response codes, see fetchMockResponse.

Parameters
$load : bool = true

[optional]

Set this to FALSE to prevent the method from loading the file's contents into a SimpleXMLObject. This is for when the contents of the file are not in XML format, or if you simply want to retrieve the raw string of the file.

Return values
SimpleXMLObject|string|bool —

A SimpleXMLObject holding the contents of the file, or a string of said contents if $load is set to FALSE. The return will be FALSE if the file cannot be fetched for any reason.

fetchMockResponse()

Generates a fake HTTP response using the mock file list.

protected fetchMockResponse() : bool|array<string|int, mixed>

This method uses the response codes in the mock file list to generate an HTTP response. The success or failure of this operation will be recorded in the log, including the response code returned. This is only used by a few operations. The response array will contain the following fields:

  • head - ignored, but set for the sake of completion
  • body - empty XML, also ignored
  • code - the response code fetched from the list
  • answer - answer message
  • error - error message, same value as answer, not set if status is 200
  • ok - 1 or 0, depending on if the status is 200
Return values
bool|array<string|int, mixed> —

An array containing the HTTP response, or simply the value FALSE if the response could not be found or does not match the list of valid responses.

genQuery()

Handles generation of the signed query string.

protected genQuery() : string

This method uses the secret key from the config file to generate the signed query string. It also handles the creation of the timestamp option prior.

Tags
throws
Exception

if config file or secret key is missing

Return values
string —

query string to send to cURL

genTime()

Generates timestamp in ISO8601 format.

protected genTime([string $time = false ]) : string

This method creates a timestamp from the provided string in ISO8601 format. The string given is passed through strtotime before being used. The value returned is actually 30 seconds early, to prevent it from tripping up Amazon. If no time is given, the current time is used.

Parameters
$time : string = false

[optional]

The time to use. Since this value is passed through strtotime first, values such as "-1 hour" are fine. Defaults to the current time.

Return values
string —

Unix timestamp of the time, minus 30 seconds.

log()

Writes a message to the log.

protected log(string $msg[, string $level = 'Info' ]) : bool

This method adds a message line to the log file defined by the config. This includes the priority level, user IP, and a backtrace of the call.

Parameters
$msg : string

The message to write to the log.

$level : string = 'Info'

[optional]

The priority level of the message. This is merely for the benefit of the user and does not affect how the code runs. The values used in this library are "Info", "Warning", "Urgent", and "Throttle".

Tags
throws
Exception

If the file can't be written to.

Return values
bool —

FALSE if the message is empty, NULL if logging is muted

parseXML()

Parses XML response into array.

protected parseXML(SimpleXMLObject $xml) : bool

This is what reads the response XML and converts it into an array.

Parameters
$xml : SimpleXMLObject

The XML response from Amazon.

Return values
bool —

FALSE if no XML data is found

prepareToken()

Sets up options for using tokens.

protected prepareToken() : mixed

This changes key options for switching between simply fetching a list and fetching the rest of a list using a token. Please note: because the operation for using tokens does not use any other parameters, all other parameters will be removed.

Return values
mixed —

resetMock()

Sets mock index back to 0.

protected resetMock([bool $mute = false ]) : mixed

This method is used for returning to the beginning of the mock file list.

Parameters
$mute : bool = false

[optional]

Set to TRUE to prevent logging.

Return values
mixed —

sendRequest()

Sends a request to Amazon via cURL

protected sendRequest(string $url[, array<string|int, mixed> $param = [] ]) : array<string|int, mixed>

This method will keep trying if the request was throttled.

Parameters
$url : string

URL to feed to cURL

$param : array<string|int, mixed> = []

parameter array to feed to cURL

Return values
array<string|int, mixed> —

cURL response array

sleep()

Sleeps for the throttle time and records to the log.

protected sleep() : mixed
Return values
mixed —

Search results