Documentation

AmazonShipment extends AmazonInboundCore
in package

Application

Submits a shipment to Amazon or updates it.

This Amazon Inbound Core object submits a request to create an inbound shipment with Amazon. It can also update existing shipments. In order to create or update a shipment, information from a Shipment Plan is required. Use the AmazonShipmentPlanner object to retrieve this information.

$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
$urlbase : mixed
$urlbranch : mixed
$shipmentId : mixed
__construct() : mixed: AmazonShipment ubmits a shipment to Amazon or updates it.
createShipment() : bool: Sends a request to Amazon to create an Inbound Shipment.
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.
getOptions() : array<string|int, mixed>: Returns options array.
getRawResponses() : array<string|int, mixed>|bool: Gives all response code received from Amazon.
getShipmentId() : string|bool: Returns the shipment ID of the newly created/modified order.
getThrottleCountForLastRequest() : int: Gives the number of times the last call to sendRequest was throttled
setAddress() : bool: Sets the address. (Required)
setConfig() : mixed
setItems() : bool: Sets the items. (Required)
setMock() : mixed: Enables or disables Mock Mode for the object.
setShipmentId() : bool: Sets the shipment ID. (Required)
setStatus() : bool: Sets the shipment status. (Required)
setStore() : mixed: Sets the store values.
setThrottleStop() : mixed: Enables or disables the throttle stop.
updateShipment() : bool: Sends a request to Amazon to create an Inbound Shipment.
usePlan() : bool: Automatically fills in the necessary fields using a planner array.
_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.
resetAddress() : mixed: Resets the address options.
resetMock() : mixed: Sets mock index back to 0.
sendRequest() : array<string|int, mixed>: Sends a request to Amazon via cURL
setCases() : mixed: Set whether or not cases are required. (Required if cases used)
sleep() : mixed: Sleeps for the throttle time and records to the log.
resetItems() : mixed: Resets the item options.

$config


    protected
        mixed
    $config

$env


    protected
        mixed
    $env

$marketplaceId


    protected
        mixed
    $marketplaceId

$mockFiles


    protected
        mixed
    $mockFiles

$mockIndex


    protected
        mixed
    $mockIndex
     = 0

$mockMode


    protected
        mixed
    $mockMode
     = false

$options


    protected
        mixed
    $options

$proxyInfo


    protected
        mixed
    $proxyInfo
     = []

$rawResponses


    protected
        mixed
    $rawResponses
     = []

$storeName


    protected
        mixed
    $storeName

$throttleCount


    protected
        mixed
    $throttleCount
     = 0

$throttleGroup


    protected
        mixed
    $throttleGroup

$throttleLimit


    protected
        mixed
    $throttleLimit

$throttleSafe


    protected
        mixed
    $throttleSafe

$throttleStop


    protected
        mixed
    $throttleStop
     = false

$throttleTime


    protected
        mixed
    $throttleTime

$urlbase


    protected
        mixed
    $urlbase

$urlbranch


    protected
        mixed
    $urlbranch

$shipmentId


    private
        mixed
    $shipmentId

__construct()

AmazonShipment ubmits a shipment to Amazon or updates it.


    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 —

createShipment()

Sends a request to Amazon to create an Inbound Shipment.


    public
                createShipment() : bool

Submits a CreateInboundShipment request to Amazon. In order to do this, all parameters must be set. Data for these headers can be generated using an AmazonShipmentPlanner object. Amazon will send back the Shipment ID as a response, which can be retrieved using getShipmentId.

Return values

bool —

TRUE if success, 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

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

Return values

array<string|int, mixed>|bool —

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

getShipmentId()

Returns the shipment ID of the newly created/modified order.


    public
                getShipmentId() : string|bool

Return values

string|bool —

single value, or FALSE if Shipment ID not fetched yet

getThrottleCountForLastRequest()

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


    public
                getThrottleCountForLastRequest() : int

Return values

int —

setAddress()

Sets the address. (Required)


    public
                setAddress(array<string|int, mixed> $a) : bool

This method sets the destination address to be sent in the next request. This parameter is required for creating a fulfillment order with Amazon. The array provided should have the following fields:

Name - max: 50 char
AddressLine1 - max: 180 char
AddressLine2 (optional) - max: 60 char
City - max: 30 char
DistrictOrCounty (optional) - max: 25 char
StateOrProvinceCode (recommended) - 2 digits
CountryCode - 2 digits
PostalCode - max: 30 char

Parameters

$a : array<string|int, mixed>: See above.

Return values

bool —

FALSE if improper input

setConfig()


    public
                setConfig() : mixed

Return values

mixed —

setItems()

Sets the items. (Required)


    public
                setItems(array<string|int, mixed> $a) : bool

This method sets the Fulfillment Order ID to be sent in the next request. This parameter is required for creating a fulfillment order with Amazon. The array provided should contain a list of arrays, each with the following fields:

SellerSKU - max: 50 char
Quantity - numeric
QuantityInCase (optional) - numeric

Parameters

$a : array<string|int, mixed>: See above.

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 —

setShipmentId()

Sets the shipment ID. (Required)


    public
                setShipmentId(string $s) : bool

Parameters

$s : string: Shipment ID

Return values

bool —

FALSE if improper input

setStatus()

Sets the shipment status. (Required)


    public
                setStatus(string $s) : bool

Parameters

$s : string: "WORKING", "SHIPPED", or "CANCELLED" (updating only)

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.

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 —

updateShipment()

Sends a request to Amazon to create an Inbound Shipment.


    public
                updateShipment() : bool

Submits a UpdateInboundShipment request to Amazon. In order to do this, all parameters must be set. Data for these headers can be generated using an AmazonShipmentPlanner object. Amazon will send back the Shipment ID as a response, which can be retrieved using getShipmentId.

Return values

bool —

TRUE if success, FALSE if something goes wrong

usePlan()

Automatically fills in the necessary fields using a planner array.


    public
                usePlan(array<string|int, mixed> $x) : bool

This information is required to submit a shipment.

Parameters

$x : array<string|int, mixed>: plan array from AmazonShipmentPlanner

Return values

bool —

FALSE if improper input

_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'

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

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.

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".

Return values

bool —

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

resetAddress()

Resets the address options.


    protected
                resetAddress() : mixed

Since address is a required parameter, these options should not be removed without replacing them, so this method is not public.

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

setCases()

Set whether or not cases are required. (Required if cases used)


    protected
                setCases([bool $b = true ]) : mixed

Parameters

$b : bool = true: Defaults to TRUE.

Return values

mixed —

sleep()

Sleeps for the throttle time and records to the log.


    protected
                sleep() : mixed

Return values

mixed —

resetItems()

Resets the item options.


    private
                resetItems() : mixed

Since the list of items is a required parameter, these options should not be removed without replacing them, so this method is not public.

Return values

mixed —