Pakkelabels.dk's official PHP library

This SDK supports Pakkelabels.dk API v3.

Specification: https://app.pakkelabels.dk/api/public/v3/specification

The previous SDK supporting Pakkelabels.dk API v2 can be found under the branch for_api_v2

Getting started

Below is a simple PHP script which illustrate the minimum amount of code needed to getting started.

<?php
  try {
    $client = new Pakkelabels('api_user', 'api_key');
  } catch (PakkelabelsException $e) {
    echo $e->getMessage();
  }
?>

Once the $client object is created, you can begin to use the API.

Examples

Get current balance

<?php
  echo $client->account_balance();
?>

Get outstanding payment requests

<?php
  $params = array(
    'created_at_min' => '2017-06-19',
    'page' => 1
  );
  echo $client->account_payment_requests($params);
?>

Get available products

<?php
  $params = array(
    'country_code' => 'DK',
    'carrier_code' => 'gls',
    'page' => 1
  );
  echo $client->products($params);
?>

Pagination is supported

Get available / nearest pickup points

<?php
  $params = array(
    'country_code' => 'DK',
    'carrier_code' => 'gls',
    'zipcode' => '5000'
  );
  echo $client->pickup_points($params);
?>

Get shipments

<?php
  $params = array(
    'page' => 1,
    'carrier_code' => 'dao'
  );
  echo $client->shipments($params);
?>

Pagination is supported

Get shipment by id:

<?php
  $id = 5545625;
  echo $client->shipment($id);  
?>

Get label(s) for shipment

<?php
  $shipment_id = 5545625;
  $params = array(
    'label_format' => '10x19_pdf'
  );
  echo $client->shipment_labels($shipment_id, $params);  
?>

Create shipment

<?php
  $params = array(
    "test_mode" => true,
    "own_agreement" => true,
    "label_format" => "a4_pdf",
    "product_code" => "GLSDK_HD",
    "service_codes" => "EMAIL_NT,SMS_NT",
    "order_id" => "10001",
    "reference" => "Webshop 10001",
    "sender" => array(
      "name" => "Pakkelabels.dk ApS",
      "address1" => "Strandvejen 6",
      "address2" => null,
      "country_code" => "DK",
      "zipcode" => "5240",
      "city" => "Odense NØ",
      "attention" => null,
      "email" => "[email protected]",
      "telephone" => "70400407",
      "mobile" => "70400407"       
    ),
    "receiver" => array(
      "name" => "Lene Jensen",
      "address1" => "Vindegade 112",
      "address2" => null,
      "country_code" => "DK",
      "zipcode" => "5000",
      "city" => "Odense C",
      "attention" => null,
      "email" => "[email protected]",
      "telephone" => "50607080",
      "mobile" => "50607080",
      "instruction" => null
    ),
    "parcels" => array(
      array(
      "weight" => 1000
      )
    ),
  );
  echo $client->create_shipment($params);
?>

Get shipment monitor statuses

<?php
  $params = array(
    'ids' => '5546689,5546696',
    'page' => 1
  );
  echo $client->shipment_monitor_statuses($params);  
?>

Get print queue entries

<?php
  $params = array(
    'page' => 1
  );
  echo print_r($client->print_queue_entries($params);
?>

Get return portals

<?php
  $params = array(
    'page' => 1
  );
  echo $client->return_portals($params);  
?>

Get return portal by id

<?php
  $id = 4766;
  echo $client->return_portal($id);  
?>

Get return shipments for return portal

<?php
  $return_portal_id = 4766;
  $params = array(
    'page' => 1
  );
  echo $client->return_portal_shipments($return_portal_id, $params);  
?>

Pagination is supported

Get imported shipments

<?php
  $params = array(
    'page' => 1
  );
  echo $client->imported_shipments($params);
?>

Pagination is supported

Get imported shipment by id

<?php
  $id = 75545625;
  echo $client->imported_shipment($id);
?>

Create imported shipment

<?php
  $params = array(
    "carrier_code" => "gls",
    "product_code" => "GLSDK_HD",
    "service_codes" => "EMAIL_NT,SMS_NT",
    "order_id" => "10001",
    "reference" => "Webshop 10001",
    "sender" => array(
      "name" => "Pakkelabels.dk ApS",
      "address1" => "Strandvejen 6",
      "address2" => null,
      "country_code" => "DK",
      "zipcode" => "5240",
      "city" => "Odense NØ",
      "attention" => null,
      "email" => "[email protected]",
      "telephone" => "70400407",
      "mobile" => "70400407"       
    ),
    "receiver" => array(
      "name" => "Lene Jensen",
      "address1" => "Vindegade 112",
      "address2" => null,
      "country_code" => "DK",
      "zipcode" => "5000",
      "city" => "Odense C",
      "attention" => null,
      "email" => "[email protected]",
      "telephone" => "50607080",
      "mobile" => "50607080",
      "instruction" => null
    )
  );
  echo $client->create_imported_shipment($params);
?>

Update imported shipment by id

<?php
  $id = 75545625;
  $params = array(
    "carrier_code" => "gls",
    "product_code" => "GLSDK_HD",
    "service_codes" => "EMAIL_NT,SMS_NT",
    "order_id" => "10001",
    "reference" => "Webshop 10001",
    "sender" => array(
      "name" => "Pakkelabels.dk ApS",
      "address1" => "Strandvejen 6",
      "address2" => null,
      "country_code" => "DK",
      "zipcode" => "5240",
      "city" => "Odense NØ",
      "attention" => null,
      "email" => "[email protected]",
      "telephone" => "70400407",
      "mobile" => "70400407"       
    ),
    "receiver" => array(
      "name" => "Lene Jensen",
      "address1" => "Vindegade 112",
      "address2" => null,
      "country_code" => "DK",
      "zipcode" => "5000",
      "city" => "Odense C",
      "attention" => null,
      "email" => "[email protected]",
      "telephone" => "50607080",
      "mobile" => "50607080",
      "instruction" => null
    )
  );
  echo $client->update_imported_shipment($id, $params);
?>

Delete/archive an imported shipment by id

<?php
  $id = 75545625;
  echo $client->delete_imported_shipment($id);
?>

rainman0607 / pakkelabels-php-sdk Goto Github PK

pakkelabels-php-sdk's Introduction

Pakkelabels.dk's official PHP library

Getting started

Examples

Get current balance

Get outstanding payment requests

Get available products

Get available / nearest pickup points

Get shipments

Get shipment by id:

Get label(s) for shipment

Create shipment

Get shipment monitor statuses

Get print queue entries

Get return portals

Get return portal by id

Get return shipments for return portal

Get imported shipments

Get imported shipment by id

Create imported shipment

Update imported shipment by id

Delete/archive an imported shipment by id

Recommend Projects

Recommend Topics

Recommend Org