Show / Hide Table of Contents
    • Yort.Zip.InStore
      • CancelOrderRequest
      • CancelOrderResponse
      • CommitOrderRequest
      • CreateOrderRequest
      • CreateOrderResponse
      • EnrolRequest
      • EnrolResponse
      • IZipClient
      • OrderStatusRequest
      • OrderStatusResponse
      • RefundOrderRequest
      • RefundOrderResponse
      • RollbackOrderRequest
      • ZipApiException
      • ZipClient
      • ZipClientConfiguration
      • ZipEnvironment
      • ZipEnvironment.NewZealand
      • ZipErrorResponse
      • ZipOrder
      • ZipOrderItem
      • ZipOrderStatus
      • ZipPaymentFlow
      • ZipRequestOptionsBase
      • ZipValidationError

    Class OrderStatusRequest

    Represents details of a request to retrieve the current status of an order in the Zip system.

    Inheritance
    Object
    ZipRequestOptionsBase
    OrderStatusRequest
    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 OrderStatusRequest : ZipRequestOptionsBase

    Properties

    | Improve this Doc View Source

    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

    Methods

    | 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
    ZipRequestOptionsBase.Validate()
    Exceptions
    Type Condition
    ArgumentNullException

    Thrown if OrderId is null.

    ArgumentException

    Thrown if OrderId is blank or contains only whitespace.

    • Improve this Doc
    • View Source
    Back to top Copyright (c) 2020 Troy Willmot