OrderSnapshotDTO Object

Overview

The REST API makes extensive use of the OrderSnapshotDTO object whenever working with a list of orders.  This article will help you to know the various members of this object.

Requirements

The following pre-requisites will be necessary to accomplish the goals of this article:

  • General understanding of REST and API’s
  • Understanding of C# and/or JavaScript

Getting Started

There are no tasks needed to get started with understanding this object. 

OrderSnapshotDTO

The OrderSnapshotDTO object will contain all of the most common details details of a single order for your Hotcakes Commerce store.  It is basically a smaller version of the OrderDTO object. Due to the smaller size of OrderSnapshotDTO, it is most commonly returned when lists of orders are requested from the REST API.

Members

The following table gives you details on the various members of the OrderSnapshotDTO object.  The descriptions are based upon default functionality and the default Viewset included with Hotcakes.

Member Default Description
AffiliateID null If the order is being attributed to an affiliate, this ID will not be null.
BillingAddress new AddressDTO Address object for who is being billed for the order.
bvin (empty string) This is the primary key to uniquely identify a single order.
CustomProperties new List of CustomPropertyDTO A collection of custom properties that contain additional meta data about the order.  This is an extension point for developers to use for integration, as well as Hotcakes related meta data.
FraudScore -1.0 The value determined by the fraud screening configuration.
Id null Integer This is an ID that is used primarily for the SQL data source.  
Instructions (empty string) Special instructions saved by the customer that submitted the order.
IsPlaced False The order is not placed until the order is submitted from "New" to the "ToDo" state.  This value should not be changed manually. The value will always return true for orders that successfully are processed during checkout.
ItemsTax 0 Total amount of tax for the line items in the order.
LastUpdatedUtc UtcNow The date and time that the order was last updated, in UTC format
OrderNumber (empty string) This is a text version of the order number and is assigned once the order reaches the "ToDo" state.  This is assigned during the AssignOrderNumber() workflow task. If a value doesn't exist, this order is likely an abandoned cart.
PaymentStatus Unknown (0) This is an object that describes the current status of payment for the order.  Possible values include:
  • Unknown = 0
  • Unpaid = 1
  • PartiallyPaid = 2
  • Paid = 3
  • Overpaid = 4
ShippingAddress new AddressDTO Address object for who is receiving the order, when shipped.
ShippingMethodDisplayName (empty string) A localized display name matching the shipping method ID.
ShippingMethodId (empty string) Unique ID of the chosen shipping method.
ShippingProviderId (empty string) Unique ID of the provider to be used for shipment.
ShippingProviderServiceCode (empty string) A code used by the shipping provider to indicate the type of service.
ShippingStatus Unknown (0) This is an object that describes the current shipping status of the order.  This value should not be manually set, as it will be set conditionally based upon actions taken by the merchant.  Possible values include:
  • Unknown = 0
  • Unshipped = 1
  • PartiallyShipped = 2
  • FullyShipped = 3
  • NonShipping = 4
ShippingTax 0 Amount of tax for shipping.
StatusCode (empty string) This is the ID of the payment status code of the order.  This should match the bvin property of the OrderPaymentStatus object.
StatusName (empty string) The name of the status that matches the StatusCode property as well as the store administration views.
StoreId 0 The identifier of the store that this order belongs to.  This value will always be the same, except in multi-tenant store scenarios.
ThirdPartyOrderId (empty string) This property is primarily used for third party payment providers and other integrations, such as PayPal Express that have their own order numbers.  Currently used with the out of the box PayPal Express payment provider.
TimeOfOrderUtc DateTime.MinValue The date and time that the order was placed, in UTC format
TotalGrand 0 The order grand total that includes all discounts, shipping, and VAT.
TotalHandling 0 Total amount for handling charges.
TotalOrderBeforeDiscounts 0 The order total without discounts applied, but with user supplied price line items included. This does not include shipping charges.
TotalOrderDiscounts 0 The sum of the discounts being applied to this order, excluding shipping discounts.
TotalShippingBeforeDiscounts 0 Total amount for shipping before discounts are applied.
TotalShippingDiscounts 0 Returns a sum of all of the shipping discounts applied to the order.
TotalTax 0 Total amount of tax for the order.
UserEmail (empty string) The email address of the person placing the order.  Either pulled from the user account email address property, or from the guest checkout email address field.
UserId (empty string) The ID that will map to the user in the Hotcakes customer repository.  This does not match the CMS UserID. If empty, this is likely a guest checkout.

 

Example of OrderSnapshotDTO

{
   "Errors":[

   ],
   "Content":[
      {
         "Id":1,
         "bvin":"4140928c-e2c8-4f2f-bb65-167fc912adcc",
         "StoreId":1,
         "LastUpdatedUtc":"\/Date(1406628188953)\/",
         "TimeOfOrderUtc":"\/Date(1406628187407)\/",
         "OrderNumber":"1",
         "ThirdPartyOrderId":"",
         "UserEmail":"host@change.me",
         "UserID":"1",
         "CustomProperties":[
            {
               "DeveloperId":"hcc",
               "Key":"ApplyVATRules",
               "Value":"False"
            }
         ],
         "PaymentStatus":3,
         "ShippingStatus":1,
         "IsPlaced":true,
         "StatusCode":"F37EC405-1EC6-4a91-9AC4-6836215FBBBC",
         "StatusName":"Received",
         "BillingAddress":{
            "Bvin":null,
            "LastUpdatedUtc":"\/Date(1398100982630)\/",
            "StoreId":0,
            "NickName":"",
            "FirstName":"Ursa",
            "MiddleInitial":"",
            "LastName":"Morgan",
            "Company":"Wilkinson Walls Trading",
            "Line1":"0718 Kvfjkpxfc Ohaoja Street",
            "Line2":"9892 Wjeicticu Wgxhtu Street",
            "Line3":"",
            "City":"San Carlos",
            "RegionName":"California",
            "RegionBvin":"CA",
            "PostalCode":"94070",
            "CountryName":"United States",
            "CountryBvin":"bf7389a2-9b21-4d33-b276-23c9c18ea0c0",
            "Phone":"+614-19-8078020",
            "Fax":"",
            "WebSiteUrl":"",
            "UserBvin":"",
            "AddressType":0
         },
         "ShippingAddress":{
            "Bvin":null,
            "LastUpdatedUtc":"\/Date(1398100982630)\/",
            "StoreId":0,
            "NickName":"",
            "FirstName":"Ursa",
            "MiddleInitial":"",
            "LastName":"Morgan",
            "Company":"Wilkinson Walls Trading",
            "Line1":"0718 Kvfjkpxfc Ohaoja Street",
            "Line2":"9892 Wjeicticu Wgxhtu Street",
            "Line3":"",
            "City":"San Carlos",
            "RegionName":"California",
            "RegionBvin":"CA",
            "PostalCode":"94070",
            "CountryName":"United States",
            "CountryBvin":"bf7389a2-9b21-4d33-b276-23c9c18ea0c0",
            "Phone":"+614-19-8078020",
            "Fax":"",
            "WebSiteUrl":"",
            "UserBvin":"",
            "AddressType":0
         },
         "ItemsTax":0.0000000000,
         "ShippingTax":0.0000000000,
         "TotalTax":0.0000000000,
         "TotalOrderBeforeDiscounts":1299.0000000000,
         "TotalShippingBeforeDiscounts":0.0000000000,
         "TotalShippingDiscounts":0.0000000000,
         "TotalOrderDiscounts":0.0000000000,
         "TotalHandling":0.0000000000,
         "TotalGrand":1299.0000000000,
         "AffiliateID":null,
         "FraudScore":0.00,
         "Instructions":"Aut voluptatem. Voluptatem, at quis rerum eius in dolorem voluptas molestias magni voluptatem, aspernatur magna quibusdam fugiat, consequuntur quos dicta.",
         "ShippingMethodId":"UNKNOWN",
         "ShippingMethodDisplayName":"To Be Determined. Contact Store for Details",
         "ShippingProviderId":"",
         "ShippingProviderServiceCode":""
      },
      {
         "Id":2,
         "bvin":"0918ef42-c234-42bb-88e7-59b335f4ea2b",
         "StoreId":1,
         "LastUpdatedUtc":"\/Date(1403158774580)\/",
         "TimeOfOrderUtc":"\/Date(1403158774580)\/",
         "OrderNumber":"",
         "ThirdPartyOrderId":"",
         "UserEmail":"",
         "UserID":"",
         "CustomProperties":[
            {
               "DeveloperId":"hcc",
               "Key":"ApplyVATRules",
               "Value":"False"
            }
         ],
         "PaymentStatus":0,
         "ShippingStatus":0,
         "IsPlaced":false,
         "StatusCode":"",
         "StatusName":"",
         "BillingAddress":{
            "Bvin":null,
            "LastUpdatedUtc":"\/Date(1403133574580)\/",
            "StoreId":0,
            "NickName":"",
            "FirstName":"",
            "MiddleInitial":"",
            "LastName":"",
            "Company":"",
            "Line1":"",
            "Line2":"",
            "Line3":"",
            "City":"",
            "RegionName":"",
            "RegionBvin":"",
            "PostalCode":"",
            "CountryName":"United States",
            "CountryBvin":"bf7389a2-9b21-4d33-b276-23c9c18ea0c0",
            "Phone":"",
            "Fax":"",
            "WebSiteUrl":"",
            "UserBvin":"",
            "AddressType":0
         },
         "ShippingAddress":{
            "Bvin":null,
            "LastUpdatedUtc":"\/Date(1403133574580)\/",
            "StoreId":0,
            "NickName":"",
            "FirstName":"",
            "MiddleInitial":"",
            "LastName":"",
            "Company":"",
            "Line1":"",
            "Line2":"",
            "Line3":"",
            "City":"",
            "RegionName":"",
            "RegionBvin":"",
            "PostalCode":"",
            "CountryName":"United States",
            "CountryBvin":"bf7389a2-9b21-4d33-b276-23c9c18ea0c0",
            "Phone":"",
            "Fax":"",
            "WebSiteUrl":"",
            "UserBvin":"",
            "AddressType":0
         },
         "ItemsTax":0.0000000000,
         "ShippingTax":0.0000000000,
         "TotalTax":0.0000000000,
         "TotalOrderBeforeDiscounts":0.0000000000,
         "TotalShippingBeforeDiscounts":0.0000000000,
         "TotalShippingDiscounts":0.0000000000,
         "TotalOrderDiscounts":0.0000000000,
         "TotalHandling":0.0000000000,
         "TotalGrand":0.0000000000,
         "AffiliateID":null,
         "FraudScore":-1.00,
         "Instructions":"",
         "ShippingMethodId":"",
         "ShippingMethodDisplayName":"",
         "ShippingProviderId":"",
         "ShippingProviderServiceCode":""
      },
      {
         "Id":3,
         "bvin":"ebd6aebb-98e6-489e-b672-820fe3cbe616",
         "StoreId":1,
         "LastUpdatedUtc":"\/Date(1406677165403)\/",
         "TimeOfOrderUtc":"\/Date(1406677164743)\/",
         "OrderNumber":"2",
         "ThirdPartyOrderId":"",
         "UserEmail":"host@change.me",
         "UserID":"1",
         "CustomProperties":[
            {
               "DeveloperId":"hcc",
               "Key":"ApplyVATRules",
               "Value":"False"
            }
         ],
         "PaymentStatus":3,
         "ShippingStatus":1,
         "IsPlaced":true,
         "StatusCode":"F37EC405-1EC6-4a91-9AC4-6836215FBBBC",
         "StatusName":"Received",
         "BillingAddress":{
            "Bvin":null,
            "LastUpdatedUtc":"\/Date(1406602989719)\/",
            "StoreId":0,
            "NickName":"",
            "FirstName":"Lara",
            "MiddleInitial":"",
            "LastName":"Ruiz",
            "Company":"Walters Wiggins Co",
            "Line1":"6372 Tshabxfvj Erntil Street",
            "Line2":"3604 Eodfsvoiv Qndlqa Street",
            "Line3":"",
            "City":"San Carlos",
            "RegionName":"California",
            "RegionBvin":"CA",
            "PostalCode":"94070",
            "CountryName":"United States",
            "CountryBvin":"bf7389a2-9b21-4d33-b276-23c9c18ea0c0",
            "Phone":"+614-19-8078020",
            "Fax":"",
            "WebSiteUrl":"",
            "UserBvin":"",
            "AddressType":0
         },
         "ShippingAddress":{
            "Bvin":null,
            "LastUpdatedUtc":"\/Date(1406602989719)\/",
            "StoreId":0,
            "NickName":"",
            "FirstName":"Lara",
            "MiddleInitial":"",
            "LastName":"Ruiz",
            "Company":"Walters Wiggins Co",
            "Line1":"6372 Tshabxfvj Erntil Street",
            "Line2":"3604 Eodfsvoiv Qndlqa Street",
            "Line3":"",
            "City":"San Carlos",
            "RegionName":"California",
            "RegionBvin":"CA",
            "PostalCode":"94070",
            "CountryName":"United States",
            "CountryBvin":"bf7389a2-9b21-4d33-b276-23c9c18ea0c0",
            "Phone":"+614-19-8078020",
            "Fax":"",
            "WebSiteUrl":"",
            "UserBvin":"",
            "AddressType":0
         },
         "ItemsTax":0.0000000000,
         "ShippingTax":0.0000000000,
         "TotalTax":0.0000000000,
         "TotalOrderBeforeDiscounts":79.9000000000,
         "TotalShippingBeforeDiscounts":0.0000000000,
         "TotalShippingDiscounts":0.0000000000,
         "TotalOrderDiscounts":0.0000000000,
         "TotalHandling":0.0000000000,
         "TotalGrand":79.9000000000,
         "AffiliateID":null,
         "FraudScore":0.00,
         "Instructions":"Nam reiciendis fugiat, in ut qui ut necessitatibus lorem odit porro facere consequatur ad repudiandae laborum.",
         "ShippingMethodId":"UNKNOWN",
         "ShippingMethodDisplayName":"To Be Determined. Contact Store for Details",
         "ShippingProviderId":"",
         "ShippingProviderServiceCode":""
      },
      {
         "Id":4,
         "bvin":"ddea7421-501d-44ce-b94f-48e10b8baff5",
         "StoreId":1,
         "LastUpdatedUtc":"\/Date(1406683911700)\/",
         "TimeOfOrderUtc":"\/Date(1406677252240)\/",
         "OrderNumber":"3",
         "ThirdPartyOrderId":"",
         "UserEmail":"host@change.me",
         "UserID":"1",
         "CustomProperties":[
            {
               "DeveloperId":"hcc",
               "Key":"ApplyVATRules",
               "Value":"False"
            }
         ],
         "PaymentStatus":3,
         "ShippingStatus":3,
         "IsPlaced":true,
         "StatusCode":"09D7305D-BD95-48d2-A025-16ADC827582A",
         "StatusName":"Complete",
         "BillingAddress":{
            "Bvin":null,
            "LastUpdatedUtc":"\/Date(1406651965814)\/",
            "StoreId":0,
            "NickName":"",
            "FirstName":"Aurora",
            "MiddleInitial":"",
            "LastName":"Castro",
            "Company":"Berry and Conway Associates",
            "Line1":"6089 Dwdjxcxvv Rbdjat Street",
            "Line2":"6987 Gcnnkpnad Rdqgvr Street",
            "Line3":"",
            "City":"San Carlos",
            "RegionName":"California",
            "RegionBvin":"CA",
            "PostalCode":"94070",
            "CountryName":"United States",
            "CountryBvin":"bf7389a2-9b21-4d33-b276-23c9c18ea0c0",
            "Phone":"+614-19-8078020",
            "Fax":"",
            "WebSiteUrl":"",
            "UserBvin":"",
            "AddressType":0
         },
         "ShippingAddress":{
            "Bvin":null,
            "LastUpdatedUtc":"\/Date(1406651965814)\/",
            "StoreId":0,
            "NickName":"",
            "FirstName":"Aurora",
            "MiddleInitial":"",
            "LastName":"Castro",
            "Company":"Berry and Conway Associates",
            "Line1":"6089 Dwdjxcxvv Rbdjat Street",
            "Line2":"6987 Gcnnkpnad Rdqgvr Street",
            "Line3":"",
            "City":"San Carlos",
            "RegionName":"California",
            "RegionBvin":"CA",
            "PostalCode":"94070",
            "CountryName":"United States",
            "CountryBvin":"bf7389a2-9b21-4d33-b276-23c9c18ea0c0",
            "Phone":"+614-19-8078020",
            "Fax":"",
            "WebSiteUrl":"",
            "UserBvin":"",
            "AddressType":0
         },
         "ItemsTax":0.0000000000,
         "ShippingTax":0.0000000000,
         "TotalTax":0.0000000000,
         "TotalOrderBeforeDiscounts":72.9000000000,
         "TotalShippingBeforeDiscounts":0.0000000000,
         "TotalShippingDiscounts":0.0000000000,
         "TotalOrderDiscounts":-7.2900000000,
         "TotalHandling":0.0000000000,
         "TotalGrand":65.6100000000,
         "AffiliateID":null,
         "FraudScore":0.00,
         "Instructions":"Architecto ut voluptate occaecat illum, voluptatem beatae mollit voluptas rerum ex facere cum sint, commodo quis qui non quia nulla.",
         "ShippingMethodId":"UNKNOWN",
         "ShippingMethodDisplayName":"To Be Determined. Contact Store for Details",
         "ShippingProviderId":"",
         "ShippingProviderServiceCode":""
      },
      {
         "Id":5,
         "bvin":"1e5776ff-fd59-4a02-ba2f-7f699244d3b3",
         "StoreId":1,
         "LastUpdatedUtc":"\/Date(1406684430777)\/",
         "TimeOfOrderUtc":"\/Date(1406684430340)\/",
         "OrderNumber":"4",
         "ThirdPartyOrderId":"",
         "UserEmail":"host@change.me",
         "UserID":"1",
         "CustomProperties":[
            {
               "DeveloperId":"hcc",
               "Key":"ApplyVATRules",
               "Value":"False"
            }
         ],
         "PaymentStatus":3,
         "ShippingStatus":1,
         "IsPlaced":true,
         "StatusCode":"F37EC405-1EC6-4a91-9AC4-6836215FBBBC",
         "StatusName":"Received",
         "BillingAddress":{
            "Bvin":null,
            "LastUpdatedUtc":"\/Date(1406652053029)\/",
            "StoreId":0,
            "NickName":"",
            "FirstName":"Helen",
            "MiddleInitial":"",
            "LastName":"Romero",
            "Company":"Carpenter and Bradley LLC",
            "Line1":"155 Bovet Road",
            "Line2":"",
            "Line3":"",
            "City":"San Mateo",
            "RegionName":"California",
            "RegionBvin":"CA",
            "PostalCode":"94402",
            "CountryName":"United States",
            "CountryBvin":"bf7389a2-9b21-4d33-b276-23c9c18ea0c0",
            "Phone":"+844-78-5044423",
            "Fax":"",
            "WebSiteUrl":"",
            "UserBvin":"",
            "AddressType":0
         },
         "ShippingAddress":{
            "Bvin":null,
            "LastUpdatedUtc":"\/Date(1406652053029)\/",
            "StoreId":0,
            "NickName":"",
            "FirstName":"Helen",
            "MiddleInitial":"",
            "LastName":"Romero",
            "Company":"Carpenter and Bradley LLC",
            "Line1":"155 Bovet Road",
            "Line2":"",
            "Line3":"",
            "City":"San Mateo",
            "RegionName":"California",
            "RegionBvin":"CA",
            "PostalCode":"94402",
            "CountryName":"United States",
            "CountryBvin":"bf7389a2-9b21-4d33-b276-23c9c18ea0c0",
            "Phone":"+844-78-5044423",
            "Fax":"",
            "WebSiteUrl":"",
            "UserBvin":"",
            "AddressType":0
         },
         "ItemsTax":0.0000000000,
         "ShippingTax":0.0000000000,
         "TotalTax":0.0000000000,
         "TotalOrderBeforeDiscounts":72.9000000000,
         "TotalShippingBeforeDiscounts":0.0000000000,
         "TotalShippingDiscounts":0.0000000000,
         "TotalOrderDiscounts":0.0000000000,
         "TotalHandling":0.0000000000,
         "TotalGrand":72.9000000000,
         "AffiliateID":null,
         "FraudScore":0.00,
         "Instructions":"Expedita quis officia fugit, fuga. Velit veritatis modi ex et reiciendis sed accusantium.",
         "ShippingMethodId":"UNKNOWN",
         "ShippingMethodDisplayName":"To Be Determined. Contact Store for Details",
         "ShippingProviderId":"",
         "ShippingProviderServiceCode":""
      },
      {
         "Id":6,
         "bvin":"c0ee144f-045e-4928-8258-7ac7c7e84030",
         "StoreId":1,
         "LastUpdatedUtc":"\/Date(1406684431187)\/",
         "TimeOfOrderUtc":"\/Date(1406684431187)\/",
         "OrderNumber":"",
         "ThirdPartyOrderId":"",
         "UserEmail":"",
         "UserID":"",
         "CustomProperties":[
            {
               "DeveloperId":"hcc",
               "Key":"ApplyVATRules",
               "Value":"False"
            }
         ],
         "PaymentStatus":0,
         "ShippingStatus":0,
         "IsPlaced":false,
         "StatusCode":"",
         "StatusName":"",
         "BillingAddress":{
            "Bvin":null,
            "LastUpdatedUtc":"\/Date(1406659231184)\/",
            "StoreId":0,
            "NickName":"",
            "FirstName":"",
            "MiddleInitial":"",
            "LastName":"",
            "Company":"",
            "Line1":"",
            "Line2":"",
            "Line3":"",
            "City":"",
            "RegionName":"",
            "RegionBvin":"",
            "PostalCode":"",
            "CountryName":"United States",
            "CountryBvin":"bf7389a2-9b21-4d33-b276-23c9c18ea0c0",
            "Phone":"",
            "Fax":"",
            "WebSiteUrl":"",
            "UserBvin":"",
            "AddressType":0
         },
         "ShippingAddress":{
            "Bvin":null,
            "LastUpdatedUtc":"\/Date(1406659231184)\/",
            "StoreId":0,
            "NickName":"",
            "FirstName":"",
            "MiddleInitial":"",
            "LastName":"",
            "Company":"",
            "Line1":"",
            "Line2":"",
            "Line3":"",
            "City":"",
            "RegionName":"",
            "RegionBvin":"",
            "PostalCode":"",
            "CountryName":"United States",
            "CountryBvin":"bf7389a2-9b21-4d33-b276-23c9c18ea0c0",
            "Phone":"",
            "Fax":"",
            "WebSiteUrl":"",
            "UserBvin":"",
            "AddressType":0
         },
         "ItemsTax":0.0000000000,
         "ShippingTax":0.0000000000,
         "TotalTax":0.0000000000,
         "TotalOrderBeforeDiscounts":0.0000000000,
         "TotalShippingBeforeDiscounts":0.0000000000,
         "TotalShippingDiscounts":0.0000000000,
         "TotalOrderDiscounts":0.0000000000,
         "TotalHandling":0.0000000000,
         "TotalGrand":0.0000000000,
         "AffiliateID":null,
         "FraudScore":-1.00,
         "Instructions":"",
         "ShippingMethodId":"",
         "ShippingMethodDisplayName":"",
         "ShippingProviderId":"",
         "ShippingProviderServiceCode":""
      }
   ]
}
Have more questions? Submit a request

Need More Help?

Do you need more assistance with this article? Please review your support options.