Class CreateOrderRequest

Contains details of an order (request for payment) to be created within the Zip system.

Inheritance
Object
ZipRequestOptionsBase
CreateOrderRequest
Inherited Members
Namespace: Yort.Zip.InStore
Assembly: Yort.Zip.InStore.dll
Syntax
public class CreateOrderRequest : ZipRequestOptionsBase

Properties

| Improve this Doc View Source

EnableUniqueMerchantReferenceCheck

Determines if Zip is instructed to check if the MerchantReference has already been used and if so behave in an idempotent fashion (return the original response instead of creating a duplicate order).

Declaration
public bool EnableUniqueMerchantReferenceCheck { get; set; }
Property Value
Type Description
Boolean
Remarks

The default value is true, which enables the duplicate checking and idempotent responses. Set to false only if you want to allow duplicate orders with the same merchant reference to be created.

If this is set to false and a merchant reference is reused, a new order with a new Zip order id will be created.

| Improve this Doc View Source

Order

Specifies the details of the new Zip order to be created.

Declaration
public ZipOrder Order { get; set; }
Property Value
Type Description
ZipOrder
| Improve this Doc View Source

StoreId

Optional. When using a merchant level authentication scope this is supposed to give traceability from which store the order originated in.

Declaration
public string StoreId { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

TerminalId

Required. A value that uniquley identifies the point of sale terminal being used as part of this request.

Declaration
public string TerminalId { get; set; }
Property Value
Type Description
String

Methods

| Improve this Doc View Source

ApplyDefaults(ZipClientConfiguration)

Applies the default store id, terminal id and operator if appropriate.

Declaration
public override void ApplyDefaults(ZipClientConfiguration config)
Parameters
Type Name Description
ZipClientConfiguration config

A ZipClientConfiguration instance containing the default values to use.
Overrides
| Improve this Doc View Source

GetCustomHttpHeaders()

Returns custom header values for StoreId (if not null or empty) and TerminalId.

Declaration
public override Dictionary<string, string> GetCustomHttpHeaders()
Returns
Type Description
Dictionary<String, String>
Overrides
| Improve this Doc View Source

Validate()

Validates this request as much as possible prior to sending it to the Zip API.

Declaration
public override void Validate()
Overrides
Exceptions
Type Condition
ArgumentNullException

Thrown if Order or any of it's required sub-properties are null.
ArgumentException

Thrown if any of the sub-properties of Order are determined to be invalid.

See Also