Sendo.lv API documentation

Size: px

Start display at page:

Download "Sendo.lv API documentation"

Penelope Lawson
6 years ago
Views:

Sendo.lv API documentation REST JSON v1.0 Table of contents Sendo API documentation... 1 Test credentials:... 1 Production credentials:... 1 AVAILABLE-SERVICES... 2 Request... 2 Response.

1 Sendo.lv API documentation REST JSON v1.0 Table of contents Sendo API documentation... 1 Test credentials:... 1 Production credentials:... 1 AVAILABLE-SERVICES... 2 Request... 2 Response... 3 NEW-SHIPMENT... 4 Request... 4 Response... 6 REQUEST-LABEL... 6 Request... 6 Response... 7 Send_request function... 8 Appendix... 9 Test credentials: Test user: Test token: UxDnS6DQfzGSuZkVmnnE Production credentials: Production user and token can be found on in Profile tab. Sendo API v1.0 1

2 AVAILABLE-SERVICES This function should be used to get the list of available services for specific address. Request /** The function that generates the right array structure can be found below. After the array is * Get available service codes (used in NEW-SHIPMENT request and their descriptions filled up with correct data, it can be passed to the send_request function. array * on success return list of service codes and description */ function create_available_services_request( { $request = array( 'user' => 10000, 'token' => 'UxDnS6DQfzGSuZkVmnnE', 'function' => 'AVAILABLE-SERVICES', // REQUIRED, user id // REQUIRED, auth token // REQUIRED, request code 'request_data' => array( 'country' => 'GB', // REQUIRED, 2 letter ISO country code 'pack_type' => 'envelope', // available values 'pack' / 'envelope' 'post_code' => 'N13 6JU', // REQUIRED, post code, max len 10 'items' => array( 0 => array( 'weight' => 0.5, // REQUIRED, weight in KG 'length' => 10, // REQUIRED, length in CM 'width' => 10, // REQUIRED, width in CM 'height' => 10 // REQUIRED, height in CM ; return $request; Sendo API v1.0 2

3 Response Sendo API v1.0 3

4 NEW-SHIPMENT This function should be used to submit new shipment. Request /** * Submit shipment data array * on success returns shipment id */ function create_new_shipment_request( { $boxes = array( 0 => array( 'weight' => 2.5, 'length' => 10, 'width' => 15, 'height' => 33 1 => array( 'weight' => 2.5, 'length' => 10, 'width' => 15, 'height' => 44, 2 => array( 'weight' => 2.5, 'length' => 10, 'width' => 15, 'height' => 44 ; // REQUIRED, weight in KG // REQUIRED, length in CM // REQUIRED, width in CM // REQUIRED, height in CM // REQUIRED, weight in KG // REQUIRED, length in CM // REQUIRED, width in CM // REQUIRED, height in CM // REQUIRED, weight in KG // REQUIRED, length in CM // REQUIRED, width in CM // REQUIRED, height in CM $test_address = array( 'name' => 'SIA Leonardo', // REQUIRED, receiver company or person name, max len 35 address_line_1 => 'Katlakalna 9', // REQUIRED, address, max len 100 address_line_2 => '', // OPTIONAL, address, max len 100 address_line_3 => '', // OPTIONAL, address, max len 100 'city' => 'Riga', // REQUIRED, city name, max len 35 'state_or_province' => '', // province/state, REQUIRED for US and Canada 'post_code' => '1021', // REQUIRED, post code, max len 10 'country' => 'LV', // REQUIRED, country code 'contact_name' => 'Dave Cross', // REQUIRED, contact, max len 35 'contact_phone_no' => ' ', // REQUIRED, contact phone no, max len 15 'contact_ ' => 'test@test.zz' // OPTIONAL, receivers , max len 100 ; Sendo API v1.0 4

5 $test_address2 = array( 'name' => 'test comp name', // REQUIRED, receiver company or person name, max len 35 address_line_1 => '56B Green Lanes', // REQUIRED, address, max len 100 address_line_2 => '56B Green Lanes', // OPTIONAL, address, max len 100 address_line_3 => '56B Green Lanes', // OPTIONAL, address, max len 100 'city' => 'London', // REQUIRED, city name, max len 35 'state_or_province' => '', // province/state, REQUIRED for US and Canada 'post_code' => 'N13 6JU', // REQUIRED, post code, max len 10 'country' => 'GB', // REQUIRED, country code 'contact_name' => 'John Doe', // REQUIRED, contact, max len 35 'contact_phone_no' => ' ', // REQUIRED, contact phone no, max len 15 'contact_ ' => 'test@test.zz' // OPTIONAL, receivers , max len 100 ; $request = array( 'user' => 10000, // REQUIRED, user id 'token' => 'UxDnS6DQfzGSuZkVmnnE', // REQUIRED, auth token 'function' => 'NEW-SHIPMENT', // REQUIRED, request code 'request_data' => array( 'service_code' => 'SLV-FEDEX-STANDARD', // REQUIRED, service code 'pack_type' => 'pack', // available values 'pack' / 'envelope' 'items' => $boxes, // REQUIRED, boxes dimensions and weight 'pickup_address' => $test_address, // OPTIONAL 'receivers_address' => $test_address2, // REQUIRED 'description' => 'spare parts', // REQUIRED, goods description, max len 50 /*REQUIRED*/ 'shipment_value' => array( 'currency' => 'EUR', // REQUIRED, EUR only 'value' => '15.55', // REQUIRED, decimal value, 'reason_for_export' => 'SOLD', // REQUIRED, allowed values are SOLD, GIFT, PERSONAL_EFFECTS // REPAIR_AND_RETURN, SAMPLE, NOT_SOLD 'reference' => 'ABC1235', // OPTIONAL, shipment reference, max len 35 'shipper_on_label' => 'CUSTOM', // OPTIONAL, shipper name on label, max len 35 'pickup_time' => ' :00', // OPTIONAL, pickup time for shipment ; Sendo API v1.0 5

6 Response REQUEST-LABEL This function should be used to get PDF format labels that must be printed out and placed on the packages cover. Request /** * Request base64 encoded PDF label data for shipment created by create_new_shipment_request array */ function create_get_label_request( { $request = array( 'user' => 10000, // REQUIRED, user id 'token' => 'UxDnS6DQfzGSuZkVmnnE', // REQUIRED, auth token 'function' => 'REQUEST-LABEL', // REQUIRED, request code /*REQUIRED*/ 'request_data' => array( 'shipment_id' => 'SLV ' // shipment_id returned by create_new_shipment_request ; return $request; Sendo API v1.0 6

7 Response Sendo API v1.0 7

8 Send_request function This function might be used to send the request to Sendo.lv webserver. /** * Send request using CURL type $request */ function send_request($request { $url = ; $content = json_encode($request; $curl = curl_init($url; curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST"; curl_setopt($curl, CURLOPT_POSTFIELDS, $content; curl_setopt($curl, CURLOPT_RETURNTRANSFER, true; curl_setopt($curl, CURLOPT_PROTOCOLS, CURLPROTO_HTTP; if (DEVELOPMENT_ENVIRONMENT { curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false; $json_response = curl_exec($curl; $status = curl_getinfo($curl, CURLINFO_HTTP_CODE; If ( $status!= 200 { echo "Error: call to URL $url failed with status $status,". " response $json_response,". " curl_error ". curl_error($curl. ",". " curl_errno ". curl_errno($curl; else { echo 'Response: '; echo "<pre>"; print_r(json_decode($json_response, TRUE; echo "</pre>"; curl_close($curl; Sendo API v1.0 8

9 Appendix For more information or assistance please contact us by s below: Developer "Sendo" Response in 24 hours, working days. Sendo API v1.0 9

PonyExpress API V1. The PonyExpress API allows you to perform operations that you do with our web client.

PonyExpress API V1. The PonyExpress API allows you to perform operations that you do with our web client. PonyExpress API V1 INTRODUCTION The PonyExpress API allows you to perform operations that you do with our web client. GETTING STARTED APIs requires a minimum of two mandatory headers. Content-Type : application/json