Class CancelOrderRequest

Represents a request to cancel an order that has not yet been approved by the consumer or reached a final status.

Inheritance

Object

ZipRequestOptionsBase

CancelOrderRequest

Inherited Members

ZipRequestOptionsBase.GetCustomHttpHeaders()

ZipRequestOptionsBase.ApplyDefaults(ZipClientConfiguration)

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Yort.Zip.InStore

Assembly: Yort.Zip.InStore.dll

Syntax

public class CancelOrderRequest : ZipRequestOptionsBase

Properties

Operator

A reference (name or id) of the staff person serving the customer at the POS. Required.

Declaration

public string Operator { get; set; }

Property Value

Type	Description
String

OrderId

The unique id of the order within the Zip system, as returned in OrderId.

Declaration

public string OrderId { get; set; }

Property Value

Type	Description
String

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

Validate()

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

Declaration

public override void Validate()

Overrides

ZipRequestOptionsBase.Validate()

Exceptions

Type	Condition
ArgumentNullException	Thrown if any required properties are null.
ArgumentException	Thrown if any of request properties are invalid.