ship: Request / response parameters
Your api key:
daccab677d8df95b12af688e4a878837
Request Params (All fields required)
| Key | Type | Length | Rule | Value |
|---|---|---|---|---|
| api_key | String | 40 | 0-9a-f | Your API key |
| carrier_name | String | 3 - 10 | a-z | ups fedex |
| carrier_service | String | 8 - 15 | a-z |
ups_ground- UPS Ground fedex_ground- FedEx Ground |
| sender_name | String | 3 - 35 | 0-9A-Za-z\s\#\.\,\'\"\(\)\- | e.g. John Doe |
| sender_company | String | 2 | 0-9\- | e.g. 1234567890 |
| sender_address1 | String | 5 | 0-9A-Za-z\s\#\.\,\'\"\(\)\- | e.g. Sender Inc. / value can be empty string |
| sender_address2 | String | 2 | 0-9A-Za-z\s\#\.\,\'\"\(\)\- | e.g. 123 Main St |
| sender_city | String | 3 - 35 | 0-9A-Za-z\s\#\.\,\'\"\(\)\- | e.g. Detroit |
| sender_state | String | 10 - 15 | 0-9A-Za-z\s\’ | e.g. MI |
| sender_zip | String | 3 - 35 | A-Za-z | e.g. 48221 |
| sender_country | String | 3 - 35 | 0-9 | e.g. US |
| recipient_name | String | 10 - 15 | A-Z | e.g. Jane Doe |
| recipient_phone | String | 3 - 35 | 0-9A-Za-z\s\#\.\,\'\"\(\)\- | e.g. 9876543210 |
| recipient_company | String | 3 - 35 | 0-9 | e.g. Recipient Inc. / value can be empty string |
| recipient_address1 | String | 3 - 35 | 0-9A-Za-z\s\#\.\,\'\"\(\)\- | e.g. 321 Maple Street |
| recipient_address2 | String | 3 - 20 | 0-9A-Za-z\s\#\.\,\'\"\(\)\- | e.g. Miami / value can be empty string |
| recipient_city | String | 3 - 20 | 0-9A-Za-z\s\#\.\,\'\"\(\)\- | e.g. FL |
| recipient_state | String | 2 | 0-9A-Za-z\s\’ | e.g. 33101 |
| recipient_zip | String | 5 | 0-9A-Za-z\s\’ | e.g. US |
| recipient_country | String | 2 | 0-9A-Za-z\s\’ | value between 1 - 150 |
| package_weight | Integer | 1 - 3 | 0-9A-Za-z\s\’ | e.g. Sender Inc. / Value can be empty string |
Response Params (Success)
| Key | Type | Value |
|---|---|---|
| status | String | success |
| trans_id | String | e.g. 00000000-0000-0000-0000-000000000000-00000000 |
| balance | String | e.g. 10 |
| filetype | String | e.g. pdf |
| track | String | e.g. 123456789012 |
| image | String | base64 encoded file |
Response Params (Success)
| Key | Type | Value |
|---|---|---|
| status | String | error |
| balance | Integer | e.g. 1 (displays only if balance less than label cost) |
| message | String | error message |
ship: Request / response example
Request (PHP):
$api_key = '{YOUR_API_KEY}';
$endpoint = 'https://westweight.biz/api/ship';
$shipment = array( 'api_key' => $api_key, 'carrier_name' => 'ups', 'carrier_service' => 'ups_ground', 'sender_name' => 'John Doe', 'sender_phone' => '1234567890', 'sender_company' => '', 'sender_address1' => '123 Main St.', 'sender_address2' => '', 'sender_city' => 'Detroit', 'sender_state' => 'MI', 'sender_zip' => '48221', 'sender_country' => 'US', 'recipient_name' => 'Jane Doe', 'recipient_phone' => '9876543210', 'recipient_company' => '', 'recipient_address1' => '321 Maple Street', 'recipient_address2' => '', 'recipient_city' => 'Miami', 'recipient_state' => 'FL', 'recipient_zip' => '33101', 'recipient_country' => 'US', 'package_weight' => 10
);
$shipment = json_encode($shipment);
$curl = curl_init();
curl_setopt_array($curl, array( CURLOPT_URL => $endpoint, CURLOPT_POSTFIELDS => $shipment, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => array('Content-Type: application/json'), CURLOPT_SSL_VERIFYHOST => false, CURLOPT_SSL_VERIFYPEER => false, CURLOPT_RETURNTRANSFER => true, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1
));
$response = curl_exec($curl); $error = curl_error($curl);
if ($error) { echo 'cURL Error #:' . $error; } else { $json_response = json_decode($response);
if (json_last_error() === JSON_ERROR_NONE) { if ($json_response->status === 'success') { $filename = $json_response->track . $json_response->filetype; $image_data = base64_decode($json_response->image);
if (file_put_contents($filename, $image_data) === false) { echo 'File saving error'; } } elseif ($json_response->status === 'error') { echo $json_response->message; } else { var_dump($json_response); } } else { echo json_last_error_msg() . "\n\n"; var_dump($response); } } curl_close($curl);
$shipment = array( 'api_key' => $api_key, 'carrier_name' => 'ups', 'carrier_service' => 'ups_ground', 'sender_name' => 'John Doe', 'sender_phone' => '1234567890', 'sender_company' => '', 'sender_address1' => '123 Main St.', 'sender_address2' => '', 'sender_city' => 'Detroit', 'sender_state' => 'MI', 'sender_zip' => '48221', 'sender_country' => 'US', 'recipient_name' => 'Jane Doe', 'recipient_phone' => '9876543210', 'recipient_company' => '', 'recipient_address1' => '321 Maple Street', 'recipient_address2' => '', 'recipient_city' => 'Miami', 'recipient_state' => 'FL', 'recipient_zip' => '33101', 'recipient_country' => 'US', 'package_weight' => 10
);
$shipment = json_encode($shipment);
$curl = curl_init();
curl_setopt_array($curl, array( CURLOPT_URL => $endpoint, CURLOPT_POSTFIELDS => $shipment, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => array('Content-Type: application/json'), CURLOPT_SSL_VERIFYHOST => false, CURLOPT_SSL_VERIFYPEER => false, CURLOPT_RETURNTRANSFER => true, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1
));
$response = curl_exec($curl); $error = curl_error($curl);
if ($error) { echo 'cURL Error #:' . $error; } else { $json_response = json_decode($response);
if (json_last_error() === JSON_ERROR_NONE) { if ($json_response->status === 'success') { $filename = $json_response->track . $json_response->filetype; $image_data = base64_decode($json_response->image);
if (file_put_contents($filename, $image_data) === false) { echo 'File saving error'; } } elseif ($json_response->status === 'error') { echo $json_response->message; } else { var_dump($json_response); } } else { echo json_last_error_msg() . "\n\n"; var_dump($response); } } curl_close($curl);
Response (JSON/Success):
{
"status": "success",
"trans_id": "00000000-0000-0000-0000-000000000000-00000000",
"balance": 10,
"filetype": "pdf",
"track": "123456789012",
"image": "base64 hash"
}
Response (JSON/Error):
{
"status": "success",
"trans_id": "00000000-0000-0000-0000-000000000000-00000000",
"balance": 10,
"filetype": "pdf",
"track": "123456789012",
"image": "base64 hash"
}
