Skip to content

Instantly share code, notes, and snippets.

@infynyxx

infynyxx/soap_sample.php

Created September 6, 2009 06:52
Show Gist options
  • Save infynyxx/181692 to your computer and use it in GitHub Desktop.
Save infynyxx/181692 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
soap_sample.php
<?php
class ConsignmentClient extends SoapClient {
public function __construct($wsdl, $options) {
parent::__construct($wsdl, $options);
}
}
class Consignment {
/**
* The goods are already on a pallet
*
* @var boolean
*/
public $alreadyPalletisedGoodsFlag = FALSE;
/**
* The credit card or loyalty card number.
*
* @var string
*/
public $cardNumber;
/**
* The code of the assigned carrier. This is populated by DM as a result of a carrier allocation.
* @var string
*/
public $carrierCode;
/**
* The code by which the carrier refers to this consignment (chosen by the carrier). This is populated by DM as a result of a carrier allocation.
*
* @var string
*/
public $carrierConsignmentCode;
/**
* The name of the assigned carrier. This is populated by DM as a result of a carrier allocation.
*
* @var string
*/
public $carrierName;
/**
* The code of the allocated carrier service. This is populated by DM as a result of a carrier allocation.
*
* @var string
*/
public $carrierServiceCode;
/**
* The name of the allocated carrier service. This is populated by DM as a result of a carrier allocation.
*
* @var string
*/
public $carrierServiceName;
/**
* The reference code for the carton.
*
* @var string
*/
public $cartonNumber;
/**
* The unique number of this consignment (DMC...) generated by Delivery Manager.
*
* @var string
*/
public $consignmentCode;
/**
* Flag indicating that details are held at the consignment-level. When details are held at the parcel-level, parameters such as consignment weight, maximum dimension etc. are automatically calculated.
*
* @var boolean
*/
public $consignmentLevelDetailsFlag = FALSE;
/**
* The value of the consignment (in GBP).
*
* @var double
*/
public $consignmentValue;
/**
* The total weight of the consignment (in KG).
*
* @var double
*/
public $consignmentWeight;
/**
* (For your own use). The contents of this field can be sought for in the MetaPack GUI.
*
* @var string
*/
public $custom1;
/**
* (For your own use). The contents of this field can be sought for in the MetaPack GUI.
*
* @var string
*/
public $custom2;
/**
* (For your own use). The contents of this field can be sought for in the MetaPack GUI.
*
* @var string
*/
public $custom3;
/**
* (For your own use). The contents of this field can be sought for in the MetaPack GUI.
*
* @var string
*/
public $custom5;
/**
* (For your own use). The contents of this field can be sought for in the MetaPack GUI.
*
* @var string
*/
public $custom6;
/**
* (For your own use). The contents of this field can be sought for in the MetaPack GUI.
*
* @var string
*/
public $custom7;
/**
* (For your own use). The contents of this field can be sought for in the MetaPack GUI.
*
* @var string
*/
public $custom8;
/**
* (For your own use). The contents of this field can be sought for in the MetaPack GUI.
*
* @var string
*/
public $custom9;
/**
* (For your own use). The contents of this field can be sought for in the MetaPack GUI.
*
* @var string
*/
public $custom10;
/**
* The date & time the consignment needs to be manifested by. This is populated by DM as a result of a carrier allocation.
*
* @var DateTime
*/
public $cutOffDate;
/**
* The price (in GBP) of the delivery. This is populated by DM as a result of a carrier allocation.
*
*
* @var double
*/
public $deliveryPrice;
/**
* The date & time the consignment will be despatched (or has been despatched). This is populated by DM as a result of a carrier allocation.
*
*
* @var DateTime
*/
public $despatchDate;
/**
* The earliest date & time the consignment will be delivered. This is populated by DM as a result of a carrier allocation.
*
*
* @var DateTime
*/
public $earliestDeliveryDate;
/**
* Flag indicating that some of the contents are fragile.
*
*
* @var boolean
*/
public $fragileGoodsFlag = FALSE;
/**
* The latest date & time the consignment will be delivered. This is populated by DM as a result of a carrier allocation.
*
*
* @var DateTime
*/
public $guaranteedDeliveryDate;
/**
* Flag indicating that some of the contents are hazardous.
*
*
* @var DateTime
*/
public $hazardousGoodsFlag;
/**
* The value of the consignment for insurance purposes (in GBP).
*
*
* @var double
*/
public $insuranceValue = 0.00;
/**
* Flag indicating that some of the contents are liquid.
*
*
* @var boolean
*/
public $liquidGoodsFlag = FALSE;
/**
* The length of the longest side (in CM).
*
* @var double
*/
public $maxDimension = 0;
/**
* Flag indicating that at least one of the parcels is more than 1m wide.
*
*
* @var boolean
*/
public $moreThanOneMetreGoodsFlag = FALSE;
/**
* Flag indicating that the consignment is heavier than 25KG.
*
*
* @var boolean
*/
public $moreThanTwentyFiveKgGoodsFlag = FALSE;
/**
* The order reference number (your reference - not necessarily unique).
*
*
* @var string
*/
public $orderNumber;
/**
* The number of parcels in the consignment. This must match the number of objects you pass in as parcels (see below).
*
*
* @var integer
*/
public $parcelCount;
/**
* The details about each parcel. These are only relevant if you are providing parcel-level details. You should, however, provide empty details when passing the array around in the API.
*
*
* @var Array of Parcel
*/
public $parcels = array();
/**
* The pick-ticket reference code.
*
*
* @var string
*/
public $pickTicketNumber;
/**
* The pickup point instructions for the driver.
*
*
* @var String
*/
public $pickupPoint;
/**
* The type of proof-of-delivery required. This is one of "none", "non-signature", "signature" or "any".
*
*
* @var string
*/
public $podRequired = 'none';
/**
* Additional properties of consignments. You cannot search by any of these terms, but you are free to make use of them for your own purposes. We do, however, expect you to start the name with "custom." so it can be easily distinguished.
*
*
* @var Array of properties
*/
public $properties;
/**
* The address of the destination.
*
*
* @var Address
*/
public $recipientAddress;
/**
* The code number of the recipient.
*
*
* @var String
*/
public $recipientCode;
/**
* The contact phone number of the recipient.
*
*
* @var string
*/
public $recipientContactPhone;
/**
* The email address of the recipient.
*
*
* @var string
*/
public $recipientEmail;
/**
* The contact phone number of the recipient.
*
*
* @var string
*/
public $recipientMobilePhone;
/**
* The name of the recipient.
*
*
* @var string
*/
public $recipientName;
/**
* The method by which the recipient wishes to be notified of deliveries etc.
*
*
* @var string
*/
public $recipientNotificationType = 'N';
/**
* The phone number of the recipient.
*
*
* @var string
*/
public $recipientPhone;
/**
* The VAT registration number of the recipient.
*
*
* @var string
*/
public $recipientVatNumber;
/**
* The address of the sender. For deliveries, this is the address of the warehouse.
*
*
* @var Address
*/
public $senderAddress;
/**
* The code number of the sender (usually the warehouse code).
*
*
* @var string
*/
public $senderCode;
/**
* The contact phone number of the sender.
*
*
* @var string
*/
public $senderContactPhone;
/**
* The email address of the sender.
*
*
* @var string
*/
public $senderEmail;
/**
* The mobile phone number of the sender.
*
*
* @var string
*/
public $senderMobilePhone;
/**
* The name of the sender.
*
*
* @var string
*/
public $senderName;
/**
* The method by which the sender wishes to be notified of deliveries etc.
*
*
* @var string
*/
public $senderNotificationType = 'N';
/**
* The phone number of the sender.
*
*
* @var string
*/
public $senderPhone;
/**
* The VAT registration number of the sender.
*
*
* @var string
*/
public $senderVatNumber;
/**
* The type of products in this shipment. This value can be SAMPLES, GIFTS, POSSESSIONS or MERCHANDISE, and is not case-sensitive.
*
*
* @var string
*/
public $shipmentTypeCode = 'MERCHANDISE';
/**
* (Reserved for future use)
*
*
* @var string
*/
public $shippingAccount;
/**
* The signatory on the customs documentation.
*
*
* @var string %
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment