TerminalOrder

Type:  Struct
Abstract:  no
Status:  Active
Java Class:  TerminalOrder
Represents information about the terminal order shipping settings.
Available Fields:
id
References: Terminal Order.Id
XML Representation: attribute
Attributes:
Default Value
Identifier of the object used for references; auto-incremented integer value.

System identifier of a merchant.
shippingName
References: Terminal Order.Shipping Name
XML Representation: attribute
Attributes: Required
Default Value
Pattern: TEXT
Name of the person/organization indicated as a merchant to receive the order.

Name of the account that an order is assigned to.
shippingStreet
References: Terminal Order.Shipping Street 1
XML Representation: attribute
Attributes: Required
Default Value
Pattern: STREET
Street name of the user's shipping address for terminal order shipping (line 2).

Street (line 1) associated with the shipping address.
shippingStreet2
References: Terminal Order.Shipping Street 2
XML Representation: attribute
Attributes:
Default Value
Street name of the user's shipping address for terminal order shipping (line 1).

Street (line 2) associated with the shipping address.
shippingCity
References: Terminal Order.Shipping City
XML Representation: attribute
Attributes: Required
Default Value
Pattern: ALPHANUMERIC_EXTENDED
City name of the user's shipping address for terminal order shipping.

City associated with the shipping address.
shippingState
References: Terminal Order.Shipping State
XML Representation: attribute
Attributes: Required
Default Value
State code of the user's shipping address for terminal order shipping.

State associated with the shipping address.
shippingZipCode
References: Terminal Order.Shipping ZIP Code
XML Representation: attribute
Attributes: Required
Default Value
ZIP/Postal code of the user's shipping address for terminal order shipping.
shippingCountryCode
References: Terminal Order.Shipping Country Code
XML Representation: attribute
Attributes:
Default Value
Pattern: ALPHA
Country code of the user's shipping address for terminal order shipping.

Country code of the recipient.
shippingDate
References: Terminal Order.Shipping Date
XML Representation: attribute
Attributes:
Default Value
Date when the order was shipped from the fulfillment center.
notes
References: Terminal Order.Notes
XML Representation: attribute
Attributes:
Default Value
Pattern: TEXT
Any additional information provided by the client.

Used to store short generic notes about the order.
trackingNumber
References: Terminal Order.Tracking Number
XML Representation: attribute
Attributes:
Default Value
Number assigned by the fulfillment center to track the location of the order.

Identifier of the order within the tracking system.
fulfillmentCenterCode
Type: Long
XML Representation: attribute
Attributes:
Default Value
Code of the fulfillment center associated with the order.
contactName
References: Terminal Order.Contact Name
XML Representation: attribute
Attributes: Required
Default Value
Contact name of the client that is to receive a terminal for usage.

Name of the recipient of the order.
phone
References: Terminal Order.Phone
XML Representation: attribute
Attributes: Required
Default Value
Pattern: NUMERIC
Phone number of the client that made the order.

Recipient's contact phone.
email
References: Terminal Order.Email
XML Representation: attribute
Attributes: Required
Default Value
Pattern: EMAIL
Email address of the client that made the order.

Recipient's contact email.
terminalOrderType
References: Terminal Order.Terminal Order CL
XML Representation: attribute
Attributes:
Default Value
Reference to the entity that represents enumeration of possible terminal order types.

Type of the order. The values can be the following:
'purchase' - purchase of the terminal
'exchange' - exchange of the terminal on other terminal
'return' - return of the previously purchased terminal
shippingMethodCode
Type: String
XML Representation: attribute
Attributes:
Default Value
Type of the sipping method used for the order delivery.
paymentArrangementType
References: Terminal Order.Payment Arrangement CL
XML Representation: attribute
Attributes:
Default Value
Reference to the entity that represents enumeration of possible payment arrangement types available within the system.

Type of the payment arrangement.
The values can be the following:
'purchase' - a full purchase
'rental' - a rental for a particular period of time
shipmentNumber
References: Terminal Order.Shipment Number
XML Representation: attribute
Attributes:
Default Value
Additional number of the order when it was shipped.

Identifier of the shipment within the system.
terminalSupportNumber
References: Terminal Order.Terminal Support Number
XML Representation: attribute
Attributes:
Default Value
Pattern: NUMERIC
Terminal support telephone number for discussing any processing issues.

Support phone assigned to the order.
responseMessage
References: Terminal Order.Response Message
XML Representation: attribute
Attributes: ReadOnly
Default Value
Response message generated by the system.

Status of the order received from the fulfillment center.

XML Sample:

<terminalOrder
    id="2000" 
    shippingName="Sample Merchant Account" 
    shippingStreet="11 Broadway" 
    shippingStreet2="Suite #3" 
    shippingCity="New York" 
    shippingState="NY" 
    shippingZipCode="123456789" 
    shippingCountryCode="US" 
    notes="Some sample notes about the merchant" 
    trackingNumber="1234554321" 
    fulfillmentCenterCode="fulfullment001" 
    contactName="John Smith" 
    phone="1234567890" 
    email="john.smith@samplemerchant.com" 
    terminalOrderType="purchase" 
    shippingMethodCode="GROUND" 
    paymentArrangementType="purchase" 
    shipmentNumber="001001001" 
    terminalSupportNumber="0987654321" />
"<terminalOrder id=\"2000\" shippingName=\"Sample Merchant Account\" shippingStreet=\"11 Broadway\" shippingStreet2=\"Suite #3\" shippingCity=\"New York\" shippingState=\"NY\" shippingZipCode=\"123456789\" shippingCountryCode=\"US\" notes=\"Some sample notes about the merchant\" trackingNumber=\"1234554321\" fulfillmentCenterCode=\"fulfullment001\" contactName=\"John Smith\" phone=\"1234567890\" email=\"john.smith@samplemerchant.com\" terminalOrderType=\"purchase\" shippingMethodCode=\"GROUND\" paymentArrangementType=\"purchase\" shipmentNumber=\"001001001\" terminalSupportNumber=\"0987654321\" />"

JSON Sample:

{
  "id": "2000",
  "shippingName": "Sample Merchant Account",
  "shippingStreet": "11 Broadway",
  "shippingStreet2": "Suite #3",
  "shippingCity": "New York",
  "shippingState": "NY",
  "shippingZipCode": "123456789",
  "shippingCountryCode": "US",
  "notes": "Some sample notes about the merchant",
  "trackingNumber": "1234554321",
  "fulfillmentCenterCode": "fulfullment001",
  "contactName": "John Smith",
  "phone": "1234567890",
  "email": "john.smith@samplemerchant.com",
  "terminalOrderType": "purchase",
  "shippingMethodCode": "GROUND",
  "paymentArrangementType": "purchase",
  "shipmentNumber": "001001001",
  "terminalSupportNumber": "0987654321"
}

XURL Sample:

?id=2000&shippingName=Sample+Merchant+Account&shippingStreet=11+Broadway&shippingStreet2=Suite+%233&shippingCity=New+York&shippingState=NY&shippingZipCode=123456789&shippingCountryCode=US&notes=Some+sample+notes+about+the+merchant&trackingNumber=1234554321&fulfillmentCenterCode=fulfullment001&contactName=John+Smith&phone=1234567890&email=john.smith%40samplemerchant.com&terminalOrderType=purchase&shippingMethodCode=GROUND&paymentArrangementType=purchase&shipmentNumber=001001001&terminalSupportNumber=0987654321&
id=2000
shippingName=Sample Merchant Account
shippingStreet=11 Broadway
shippingStreet2=Suite #3
shippingCity=New York
shippingState=NY
shippingZipCode=123456789
shippingCountryCode=US
notes=Some sample notes about the merchant
trackingNumber=1234554321
fulfillmentCenterCode=fulfullment001
contactName=John Smith
phone=1234567890
email=john.smith@samplemerchant.com
terminalOrderType=purchase
shippingMethodCode=GROUND
paymentArrangementType=purchase
shipmentNumber=001001001
terminalSupportNumber=0987654321
Copyright © Constellation Payments. All Rights Reserved.
All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.