API Documentation

Request parameters:

• long organisationId - organisation id
• long customerId - customer id
• long addressId - address id

Request parameters:

• Int64 organisationId - organisation id
• Int64 customerId - customer id
• Int64 addressId - address id

Request parameters:

• Long organisationId - organisation id
• Long customerId - customer id
• Long addressId - address id

This method returns result of type 'SAOP.API.Models.Address.AddressModel'.

    /// Address details.
    public class AddressModel
    {
        // Address id.
        // Mandatory field. Ignored on create request.
        public long AddressId { get; set; }
        // Customer
        public mMApiFkField Customer { get; set; }
        // Address type:
        // <ul>
        //     <li>N=Addressee;</li>
        //     <li>P=Recipient</li>
        // </ul>
        //
        // Mandatory field. Max length: 1
        public string Type { get; set; }
        // Name.
        // Mandatory field. Max length: 250
        public string Name { get; set; }
        // GLN.
        public long? GLN { get; set; }
        // Address.
        // Max length: 250
        public string Address { get; set; }
        // Postal code.
        // Max length: 30
        public string PostalCode { get; set; }
        // City.
        // Max length: 250
        public string City { get; set; }
        // Country.
        public mMApiFkField Country { get; set; }
        // Country name.
        // Max length: 250
        public string CountryName { get; set; }
        // Default address for given address type:
        // <ul>
        //     <li>N – no,</li>
        //     <li>D – yes.</li>
        // </ul>
        //
        // Max length: 1
        public string Default { get; set; }
        public DateTime RecordDtModified { get; set; }
        // Row version is used for concurrency check.
        // Mandatory field. Ignored on create request.
        public string RowVersion { get; set; }
    
    }

        /// Link with id, name and url to related data.
        public class mMApiFkField
        {
            // Record id.
            public long? ID { get; set; }
            // Record name.
            public string Name { get; private set; }
            // Url to full record details.
            public string ResourceUrl { get; private set; }
        
        }

This method returns result of type 'SAOP.API.Models.Address.AddressModel'.

    /// Address details.
    class AddressModel
    {
        // Address id.
        // Mandatory field. Ignored on create request.
        public $AddressId;
        // Customer
        public $Customer;
        // Address type:
        // <ul>
        //     <li>N=Addressee;</li>
        //     <li>P=Recipient</li>
        // </ul>
        //
        // Mandatory field. Max length: 1
        public $Type;
        // Name.
        // Mandatory field. Max length: 250
        public $Name;
        // GLN.
        public $GLN;
        // Address.
        // Max length: 250
        public $Address;
        // Postal code.
        // Max length: 30
        public $PostalCode;
        // City.
        // Max length: 250
        public $City;
        // Country.
        public $Country;
        // Country name.
        // Max length: 250
        public $CountryName;
        // Default address for given address type:
        // <ul>
        //     <li>N – no,</li>
        //     <li>D – yes.</li>
        // </ul>
        //
        // Max length: 1
        public $Default;
        public $RecordDtModified;
        // Row version is used for concurrency check.
        // Mandatory field. Ignored on create request.
        public $RowVersion;
    
    }

        /// Link with id, name and url to related data.
        class mMApiFkField
        {
            // Record id.
            public $ID;
            // Record name.
            public $Name;
            // Url to full record details.
            public $ResourceUrl;
        
        }

This method returns result of type 'SAOP.API.Models.Address.AddressModel'.

    /// Address details.
    public class AddressModel
    {
        // Address id.
        // Mandatory field. Ignored on create request.
        public Long AddressId;
        // Customer
        public mMApiFkField Customer;
        // Address type:
        // <ul>
        //     <li>N=Addressee;</li>
        //     <li>P=Recipient</li>
        // </ul>
        //
        // Mandatory field. Max length: 1
        public String Type;
        // Name.
        // Mandatory field. Max length: 250
        public String Name;
        // GLN.
        public Long GLN;
        // Address.
        // Max length: 250
        public String Address;
        // Postal code.
        // Max length: 30
        public String PostalCode;
        // City.
        // Max length: 250
        public String City;
        // Country.
        public mMApiFkField Country;
        // Country name.
        // Max length: 250
        public String CountryName;
        // Default address for given address type:
        // <ul>
        //     <li>N – no,</li>
        //     <li>D – yes.</li>
        // </ul>
        //
        // Max length: 1
        public String Default;
        public Date RecordDtModified;
        // Row version is used for concurrency check.
        // Mandatory field. Ignored on create request.
        public String RowVersion;
    
    }

        /// Link with id, name and url to related data.
        public class mMApiFkField
        {
            // Record id.
            public Long ID;
            // Record name.
            public String Name;
            // Url to full record details.
            public String ResourceUrl;
        
        }