TerminalOrder

Type: Struct

Abstract: no

Status: Active

Java Class: TerminalOrder

Represents information about the terminal order shipping settings.

Available Fields:

contactName
email
fulfillmentCenterCode
id
notes
paymentArrangementType
phone

responseMessage
shipmentNumber
shippingCity
shippingCountryCode
shippingDate
shippingMethodCode
shippingName

shippingState
shippingStreet
shippingStreet2
shippingZipCode
terminalOrderType
terminalSupportNumber
trackingNumber

References: Terminal Order.Id

XML Representation: attribute

Attributes:

Default Value

Identifier of the object used for references; auto-incremented integer value.

shippingName

References: Terminal Order.Shipping Name

XML Representation: attribute

Attributes: Required

Default Value

Pattern:

Name of the person/organization indicated as a merchant to receive the order.

shippingStreet

References: Terminal Order.Shipping Street 1

XML Representation: attribute

Attributes: Required

Default Value

Pattern:

Street name of the user's shipping address for terminal order shipping (line 2).

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).

shippingCity

References: Terminal Order.Shipping City

XML Representation: attribute

Attributes: Required

Default Value

Pattern:

City name of the user's shipping address for terminal order shipping.

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.

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:

Country code of the user's shipping address for terminal order shipping.

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:

Any additional information provided by the client.

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.

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.

phone

References: Terminal Order.Phone

XML Representation: attribute

Attributes: Required

Default Value

Pattern:

Phone number of the client that made the order.

References: Terminal Order.Email

XML Representation: attribute

Attributes: Required

Default Value

Pattern:

Email address of the client that made the order.

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.

terminalSupportNumber

References: Terminal Order.Terminal Support Number

XML Representation: attribute

Attributes:

Default Value

Pattern:

Terminal support telephone number for discussing any processing issues.

responseMessage

References: Terminal Order.Response Message

XML Representation: attribute

Attributes: ReadOnly

Default Value

Response message generated by the system.

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