Example Config file¶
Example¶
Here is the config.php file used to produced the examples on this site:
<?php
return array(
//{{GENERIC
/**
* This is used to set generic defaults. I.e. They are
* not carrier-specific.
*
* These defaults will be used across all carriers. They can be
* overwritten on the
* shipment/package level.
*/
'generic' => array(
// 1 for Debug mode, 0 for normal operations
// This also changes from testing to production mode
'debugMode' => 1,
// Default timezone
// You can find out which timezones are available here:
// http://php.net/manual/en/timezones.php
'timezone' => 'America/Denver',
// Your company name
'shipper' => 'RocketShipIt',
// Key shipping contact individual at your company
'shipContact' => 'Mark Sanborn',
'shipAddr1' => '201 1/2 W 2nd St.',
'shipAddr2' => '',
'shipCity' => 'Whitehall',
// the two-letter State or Province code
// ex. MT => Montana, ON => Ontario
'shipState' => 'MT',
// The Zip or Postal code
'shipCode' => '59759',
// The two-letter country code
'shipCountry' => 'US',
// Phone number in this format: 1234567890
'shipPhone' => '7077262676',
'toCountry' => 'US',
// General currency for things like COD
'currency' => 'USD',
),
//}}
//{{FEDEX
/**
* This is used to set FedEx specfic defaults.
*
* These defaults will be used for FedEx calls only. They can be
* overwritten on the
* shipment/package level using the setParameter() function.
*/
'fedex' => array(
// Your FedEx developer key
'key' => 'SETTHIS',
// Your FedEx developer password
'password' => 'SETTHIS',
// Your FedEx accountNumber
'accountNumber' => 'SETTHIS',
// Your FedEx meter number
'meterNumber' => 'SETTHIS',
// Allowed packaging types:
// FEDEX_10KG_BOX
// FEDEX_25KG_BOX
// FEDEX_BOX
// FEDEX_ENVELOPE
// FEDEX_PAK
// FEDEX_TUBE
// YOUR_PACKAGING
'packagingType' => 'YOUR_PACKAGING',
// The two possible weight units are LB and KG
'weightUnit' => 'LB',
// The two possible length units are IN and CM
'lengthUnit' => 'IN',
// EUROPE_FIRST_INTERNATIONAL_PRIORITY
// FEDEX_1_DAY_FREIGHT
// FEDEX_2_DAY
// FEDEX_2_DAY_FREIGHT
// FEDEX_3_DAY_FREIGHT
// FEDEX_EXPRESS_SAVER
// FEDEX_GROUND
// FIRST_OVERNIGHT
// GROUND_HOME_DELIVERY
// INTERNATIONAL_ECONOMY
// INTERNATIONAL_ECONOMY_FREIGHT
// INTERNATIONAL_FIRST
// INTERNATIONAL_PRIORITY
// INTERNATIONAL_PRIORITY_FREIGHT
// PRIORITY_OVERNIGHT
// SMART_POST
// STANDARD_OVERNIGHT
// FEDEX_FREIGHT
// FEDEX_NATIONAL_FREIGHT
'service' => 'FEDEX_GROUND',
// REGULAR_PICKUP
// REQUEST_COURIER
// DROP_BOX
// BUSINESS_SERVICE_CENTER
// STATION
'dropoffType' => 'REGULAR_PICKUP',
// COLLECT
// RECIPIENT
// SENDER
// THIRD_PARTY
'paymentType' => 'SENDER',
// COMMON2D
// LABEL_DATA_ONLY
'labelFormatType' => 'COMMON2D',
// DPL
// EPL2
// PDF
// PNG
// ZPLII
'imageType' => 'PNG',
// PAPER_4X6
// PAPER_4X8
// PAPER_4X9
// PAPER_7X4.75
// PAPER_8.5X11_BOTTOM_HALF_LABEL
// PAPER_8.5X11_TOP_HALF_LABEL
// STOCK_4X6
// STOCK_4X6.75_LEADING_DOC_TAB
// STOCK_4X6.75_TRAILING_DOC_TAB
// STOCK_4X8
// STOCK_4X9_LEADING_DOC_TAB
// STOCK_4X9_TRAILING_DOC_TAB
'labelStockType' => 'PAPER_4X6',
// BILL_OF_LADING
// COD_RETURN_TRACKING_NUMBER
// CUSTOMER_AUTHORIZATION_NUMBER
// CUSTOMER_REFERENCE
// DEPARTMENT
// FREE_FORM_REFERENCE
// GROUND_SHIPMENT_ID
// GROUND_MPS
// INVOICE
// PARTNER_CARRIER_NUMBER
// PART_NUMBER
// PURCHASE_ORDER
// RETURN_MATERIALS_AUTHORIZATION
// TRACKING_CONTROL_NUMBER
// TRACKING_NUMBER_OR_DOORTAG
// SHIPPER_REFERENCE
// STANDARD_MPS
'trackingIdType' => 'TRACKING_NUMBER_OR_DOORTAG',
// Currency for Insurance
'insuredCurrency' => 'USD',
// COD (Collect On Delivery) - YES or NO
'collectOnDelivery' => 'NO',
// Hold at Location - YES or NO
'holdAtLocation' => 'NO',
// Saturday Delivery - YES or NO
'saturdayDelivery' => 'NO',
// ANY
// CASH
// GUARANTEED_FUNDS
'codCollectionType' => 'ANY',
),
//}}
//{{UPS
/**
* This is used to set UPS specfic defaults.
*
* These defaults will be used for UPS calls only. They can be
* overwritten on the
* shipment/package level using the setParameter() function.
*/
'ups' => array(
// Your UPS Developer license
// your UPS XML Access Key TODO: Insert link to get one
'license' => 'SETTHIS',
// your UPS Developer username
'username' => 'SETTHIS',
// your ups Developer password
'password' => 'SETTHIS',
// Make sure addresses are valid before label creation
// validate, nonvalidate
'verifyAddress' => 'validate',
// The following variables govern the way the system functions
// Options
// ZPL - Zebra UPS Thermal Printers
// EPL - Eltron UPS Thermal Printers
// GIF - Image based, desktop inkjet printers
// STARPL
// SPL
'labelPrintMethodCode' => 'GIF',
// Used when printing GIF images
'httpUserAgent' => 'Mozilla/4.5',
// Only valid option for ZPL, EPL, STARPL, and SPL is 4
// When using inches use whole numbers only
'labelHeight' => '4',
// Options are 6 or 8 inches
'labelWidth' => '8',
// Options
// GIF - A gif image
'labelImageFormat' => 'GIF',
// The following variables are for your UPS account
// They typically don't change from shipment to shipment, although,
// you may set any of them directly.
// Your UPS Account number
'accountNumber' => 'SETTHIS',
// Options
// 01 - Daily Pickup
// 03 - Customer Counter
// 06 - One Time Pickup
// 07 - On Call Air
// 11 - Suggested Retail Rates
// 19 - Letter Center
// 20 - Air Service Center
'PickupType' => '01',
// LBS or KGS
'weightUnit' => 'LBS',
// IN, or CM
'lengthUnit' => 'IN',
// See the ups manual for a list of all currency types
'insuredCurrency' => 'USD',
// two-letter country code
'toCountryCode' => 'US',
// The following variables set the defaults for individual shipments
// you may set them here to save time, or you may set them explicitly
// each time you use the classes.
'shipmentDescription' => 'My Shipment',
// Options
// 01 - UPS Next Day Air
// 02 - UPS Second Day Air
// 03 - UPS Ground
// 07 - UPS Worldwide Express
// 08 - UPS Worldwide Expedited
// 11 - UPS Standard
// 12 - UPS Three-Day Select
// 13 - Next Day Air Saver
// 14 - UPS Next Day Air Early AM
// 54 - UPS Worldwide Express Plus
// 59 - UPS Second Day Air AM
// 65 - UPS Saver
'service' => '03',
// Options
// 01 - UPS Letter
// 02 - Your Packaging
// 03 - Tube
// 04 - PAK
// 21 - Express Box
// 24 - 25KG Box
// 25 - 10KG Box
// 30 - Pallet
// 2a - Small Express Box
// 2b - Medium Express Box
// 2c - Large Express Box
'packagingType' => '02',
'packageDescription' => 'Rate',
// Set '0' for commercial '1' for residential
'residentialAddressIndicator' => '1',
// Set '0' for retail rates '1' for negotiated
// You must turn this on with your UPS account rep
'negotiatedRates' => '0',
// Options
// AJ Accounts Receivable Customer Account
// AT Appropriation Number
// BM Bill of Lading Number
// 9V Collect on Delivery (COD) Number
// ON Dealer Order Number
// DP Department Number
// 3Q Food and Drug Administration (FDA) Product Code
// IK Invoice Number
// MK Manifest Key Number
// MJ Model Number
// PM Part Number
// PC Production Code
// PO Purchase Order Number
// RQ Purchase Request Number
// RZ Return Authorization Number
// SA Salesperson Number
// SE Serial Number
// ST Store Number
// TN Transaction Reference Number
'referenceCode' => '02',
// Options
// 2 - UPS Print and Mail (PNM)
// 3 - UPS Return Service 1-Attempt (RS1)
// 5 - UPS Return Service 3-Attempt (RS3)
// 8 - UPS Electronic Return Label (ERL)
// 9 - UPS Print Return Label (PRL)
'returnCode' => '',
// Options
// 00 - Rates Associated with Shipper Number
// 01 - Daily Rates
// 04 - Retail Rates
// 53 - Standard List Rates
'customerClassification' => '',
),
//}}
//{{USPS
/**
* This is used to set USPS specfic defaults.
*
* These defaults will be used for USPS calls only. They can be
* overwritten on the
* shipment/package level using the setParameter() function.
*/
'usps' => array(
// USPS userID
'userid' => 'SETTHIS',
'service' => 'Priority',
'imageType' => 'PDF',
),
//}}
//{{STAMPS
/**
* This is used to set Stamps.com specfic defaults.
*
* These defaults will be used for Stamps.com calls only. They can be
* overwritten on the
* shipment/package level using the setParameter() function.
*/
'stamps' => array(
// USPS Stamps.com Credentials
'username' => 'SETTHIS',
'password' => 'SETTHIS',
// Label Image Type
// Zpl
// EncryptedPngUrl
// PrintOncePdf
// Jpg
// Epl
// Pdf
// Gif
// Png
// Auto
'imageType' => 'Png',
'packagingType' => 'Package',
),
//}}
//{{DHL
'dhl' => array(
'siteId' => 'SETTHIS',
'password' => 'SETTHIS',
'accountNumber' => '803921577',
// The two possible length units are IN and CM
'lengthUnit' => 'IN',
// The two possible length units are LB and KG
'weightUnit' => 'LB',
// AWBNumber or LPNumber
'trackingIdType' => 'AWBNumber',
// EPL2, PDF, ZPL2, LP2
'labelPrintMethodCode' => 'PDF',
),
//}}
//{{CANADA
'canada' => array(
'username' => 'SETTHIS',
'password' => 'SETTHIS',
'accountNumber' => 'SETTHIS',
'service' => 'DOM.EP',
),
//}}
//{{PUROLATOR
'purolator' => array(
'username' => 'SETTHIS',
'password' => 'SETTHIS',
'accountNumber' => '9999999999',
// lb or kg
'weightUnit' => 'lb',
// DropOff or PreScheduled
'pickupType' => 'PreScheduled',
'service' => 'PurolatorExpress',
),
//}}
);