OrderPackageItemDTO Object

Overview

The REST API makes use of the OrderPackageItemDTO object whenever working with orders that have one or more packages to ship.  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. 

OrderPackageItemDTO

The OrderPackageItemDTO object will contain all of the most common details of the items in a package for orders made in your Hotcakes Commerce store.

Members

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

Member Default Description
LineItemId 0 The unique ID of the line item that matches this package.
ProductBvin (empty string) The unique ID or bvin of the product that is in this package.
Quantity 0 Total number of products that are in this package.

 

Example of OrderPackageItemDTO

{
   "Items":[
      {
         "ProductBvin":"964163db-e733-4cbd-ace5-32717d813f3e",
         "LineItemId":18,
         "Quantity":1
      },
      {
         "ProductBvin":"fb975149-2c73-45ad-8082-68961e04915c",
         "LineItemId":19,
         "Quantity":1
      }
   ]
}
Have more questions? Submit a request

Need More Help?

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