Contents

module ShipCompliant
  # == ShipCompliant::GetSalesOrderExtended
  # 
  # This method takes in a Sales Order Key and returns detailed data about the
  # sales order, including compliance status.
  #
  # Use this method to query the full details of a sales order and the
  # shipments in the sales order.
  class GetSalesOrderExtended

    # Finds a +SalesOrder+ by the +SalesOrderKey+.
    #
    # Returns an instance of ShipCompliant::GetSalesOrderExtendedResult.
    def self.by_order_key(order_key)
      result = ShipCompliant.client.call(:get_sales_order_extended, {
        'SalesOrderKey' => order_key
      })

      GetSalesOrderExtendedResult.new(result)
    end

  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
ship_compliant-0.2.1	lib/ship_compliant/get_sales_order_extended.rb
ship_compliant-0.2.0	lib/ship_compliant/get_sales_order_extended.rb
ship_compliant-0.1.2	lib/ship_compliant/get_sales_order_extended.rb
ship_compliant-0.1.1	lib/ship_compliant/get_sales_order_extended.rb
ship_compliant-0.1.0	lib/ship_compliant/get_sales_order_extended.rb