iOS SDK - Orders Objects

Orders Domain Objects

PDOrder

Defines all relevant detail related to a specific remote order placed through the mobile wallet.

Property Description
additionalAttributes Dictionary
A dictionary object of key/value pairs that provide additional information about the order, as defined by the app developer. For example, the order may need to include a tip or delivery information.
amount PDOrderAmount
Defines the ultimate cost of the order.
lineItems Array
PDOrderItem objects, each of which represents a specific line item of the order.
number String
The unique identifier of the order within the retailer’s order tracking system.
orderDeliveryOrPickupDate NSDate
Date when the order is expected to be ready.
orderId String
The unique identifier of the order generated by Paydiant.
promotions Array
The set of PDPromotion objects, each of which represents a marketing promotion that is displayed in order screens of the app.
status String
The state of completion of the order at the time of the call, such as paid, refunded, voided, etc.
storeAddress PDAddressInformation
Defines a physical address of the relevant person or entity.
storeId String
The unique identifier of the acceptance location at which the order was placed.

PDOrderAmount

The breakdown of the calculated cost of the order.

Property Description
total String
The total amount due for the order.
subTotal String
The price of the order before any adjustments such as tax, tip, or discounts.
taxLineItems Array
The set of PDOrderItemTax objects that define the taxes applied to the order.
currency String
The monetary unit that applies to the amount, as represented by the ISO 4217 standard, for example, USD = United States Dollar.
additionalAttributes Dictionary
A set of key/value pairs that provides additional information relevant to the amount of the order. For example, this field may define a property for an applied discount.

PDOrderItem

An individual line item purchased within a specific order.

Property Description
name String
The name of the product represented by the line item.
options Array
An array of dictionary name/value pairs, each of which represents a specific option available for the item being ordered and the value of that option for the order. For example:
{name: "pickles" value: "extra"},
{name: "cheese", value "swiss"}
quantity String
The number of instances of this item that is included in the order.
price String
The unit cost of the individual line item.
currency String
The monetary unit that applies to the amount, as represented by the ISO 4217 standard, for example, USD = United States Dollar.
additionalAttributes Dictionary
A set of key/value pairs that provides additional information about the item, as defined by the app developer. For example, the item may require a surcharge attribute for certain options.

PDOrderItemTax

The details about a tax that was applied to a line item within an order.

Property Description
name String
The specific type of tax represented; for example, sales tax.
amount String
The dollar amount added to the item cost for this tax.
currency String
The monetary unit that applies to the amount, as represented by the ISO 4217 standard, for example, USD = United States Dollar.
additionalAttributes Dictionary
A set of key/value pairs that defines custom data relevant to the tax, such as the whether it is state, federal or local or the tax rate.

PDPromotion

Identifies a specific deal that is promoted in the mobile wallet app in the order screen flow during a transaction.

Property Description
additionalAttributes Dictionary
A set of key/value pairs that define custom data relevant to the promotion, such as a unique identifier or a sponsor reference.
currency String
The monetary unit that applies to the amount, as represented by the ISO 4217 standard, for example, USD = United States Dollar.
disclaimer String
Any text appended to the promotion that limits or clarifies its valid use.
discount String
The dollar amount by which the total will be reduced when the promotion is applied.
name String
The identifying title of the promotion.

Orders Message Objects

PDretrieveOrderSummaryResponse

Returns the list of previously placed orders for the current mobile wallet user.

Property Description
listofOrders Array
The set of PDOrder objects that represents all orders that have been previously placed for the merchant by the currently logged-in user.

PDRetrieveOrderDetailResponse

Returns the list of previously placed orders for the current mobile wallet user.

Property Description
order PDOrder
Defines the particular order specified in the request call.
Feedback