POST api/Helper/ORDER_GET_BY_ID

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
ID		integer	None.
ShopID		integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "ShopID": 2
}

application/xml, text/xml

Sample:

<ZOrderGetByIDRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EMS.Entity">
  <ID>1</ID>
  <ShopID>2</ShopID>
</ZOrderGetByIDRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ZOrderGetByIDResponse

Name	Type	Additional information
ID	integer	None.
EMSOneCode	string	None.
OrderCode	string	None.
BatchCode	string	None.
Status	string	None.
StatusName	string	None.
WareHouseID	integer	None.
WareHouseName	string	None.
Customer	ZCustomerResponse	None.
TotalAmount	integer	None.
TotalDiscount	integer	None.
TransportFee	integer	None.
ActualTransportFee	integer	None.
TotalProductValue	integer	None.
TotalOrderValue	integer	None.
TotalCOD	integer	None.
ActualTotalCOD	integer	None.
TotalPHU	integer	None.
PaymentStatus	string	None.
PaymentMethod	integer	None.
CreatedBy	integer	None.
CreatedDate	string	None.
Transport	string	None.
Channel	string	None.
Note	string	None.
Message	string	None.
ReasonCancel	string	None.
UpdatedDate	string	None.
UpdatedName	string	None.
TransportOrderName	string	None.
TransportWeight	decimal number	None.
ActualTransportWeight	decimal number	None.
ExchangeTransportWeight	decimal number	None.
TransportSizeLength	decimal number	None.
TransportSizeWidth	decimal number	None.
TransportSizeHeight	decimal number	None.
TransportQuantity	integer	None.
TransportOrderValue	integer	None.
TransportMainService	integer	None.
TransportMainServiceName	string	None.
TransportExtraService	string	None.
TransportExtraServiceName	string	None.
TransportPayer	integer	None.
TransportPayerName	string	None.
ShipmentDetails	ZOrderAddShipmentInfoRequest	None.
OrderItems	Collection of ZOrderItemGetByOrderIDResponse	None.
listWareHouse	Collection of ZWarehouseProductGetByVariantIDResponse	None.
CollectionType	ZBaseResponse	None.
TypeShop	integer	None.
ShippingCode	string	None.
AcceptancePosCode	string	None.
ListUpdateInformation	Collection of ZRequestSupportHistorySearchListUpdateInformationResponse	None.
PlaceOfCreation	string	None.
DeviceName	string	None.
PostalType	string	None.
ExpectedDeliveryDate	string	None.
CollectionPostOfficeRecent	ZCollectionPostOfficeSearchListResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "EMSOneCode": "sample string 2",
  "OrderCode": "sample string 3",
  "BatchCode": "sample string 4",
  "Status": "sample string 5",
  "StatusName": "sample string 6",
  "WareHouseID": 7,
  "WareHouseName": "sample string 8",
  "Customer": {
    "ID": 1,
    "FullName": "sample string 2",
    "MobileNumber": "sample string 3",
    "Email": "sample string 4",
    "BlackList": "sample string 5",
    "GroupCode": "sample string 6",
    "GroupName": "sample string 7",
    "ProvinceID": 8,
    "DistrictID": 9,
    "WardID": 10,
    "Address": "sample string 11",
    "FullAddress": "sample string 12",
    "SuccessOrder": 13,
    "TotalOrder": 14
  },
  "TotalAmount": 9,
  "TotalDiscount": 10,
  "TransportFee": 11,
  "ActualTransportFee": 12,
  "TotalProductValue": 13,
  "TotalOrderValue": 14,
  "TotalCOD": 15,
  "ActualTotalCOD": 16,
  "TotalPHU": 17,
  "PaymentStatus": "sample string 18",
  "PaymentMethod": 19,
  "CreatedBy": 20,
  "CreatedDate": "sample string 21",
  "Transport": "sample string 22",
  "Channel": "sample string 23",
  "Note": "sample string 24",
  "Message": "sample string 25",
  "ReasonCancel": "sample string 26",
  "UpdatedDate": "sample string 27",
  "UpdatedName": "sample string 28",
  "TransportOrderName": "sample string 29",
  "TransportWeight": 30.1,
  "ActualTransportWeight": 31.1,
  "ExchangeTransportWeight": 32.1,
  "TransportSizeLength": 33.1,
  "TransportSizeWidth": 34.1,
  "TransportSizeHeight": 35.1,
  "TransportQuantity": 36,
  "TransportOrderValue": 37,
  "TransportMainService": 38,
  "TransportMainServiceName": "sample string 39",
  "TransportExtraService": "sample string 40",
  "TransportExtraServiceName": "sample string 41",
  "TransportPayer": 42,
  "TransportPayerName": "sample string 43",
  "ShipmentDetails": {
    "ReceiverName": "sample string 1",
    "MobileNumber": "sample string 2",
    "Channel": "sample string 3",
    "Email": "sample string 4",
    "ProvinceID": 5,
    "ProvinceName": "sample string 6",
    "DistrictID": 7,
    "DistrictName": "sample string 8",
    "WardID": 9,
    "WardName": "sample string 10",
    "Address": "sample string 11",
    "FullAddress": "sample string 12",
    "PickUpAddressID": 13,
    "IsReceiverNewAddress": "sample string 14",
    "PickupFullName": "sample string 15",
    "PickupMobileNumber": "sample string 16",
    "PickupProvinceID": 17,
    "PickupProvinceName": "sample string 18",
    "PickupDistrictID": 19,
    "PickupDistrictName": "sample string 20",
    "PickupWardID": 21,
    "PickupWardName": "sample string 22",
    "PickupStreet": "sample string 23",
    "PickupFullAddress": "sample string 24"
  },
  "OrderItems": [
    {
      "ID": 1,
      "ProductID": 2,
      "ProductCode": "sample string 3",
      "ProductName": "sample string 4",
      "VariantID": 5,
      "VariantSKU": "sample string 6",
      "VariantName": "sample string 7",
      "NumberOfProduct": 8,
      "Price": 9,
      "Discount": 10,
      "Weight": 11,
      "ProductVariantImage": "sample string 12",
      "WareHouseQuantity": 13
    },
    {
      "ID": 1,
      "ProductID": 2,
      "ProductCode": "sample string 3",
      "ProductName": "sample string 4",
      "VariantID": 5,
      "VariantSKU": "sample string 6",
      "VariantName": "sample string 7",
      "NumberOfProduct": 8,
      "Price": 9,
      "Discount": 10,
      "Weight": 11,
      "ProductVariantImage": "sample string 12",
      "WareHouseQuantity": 13
    }
  ],
  "listWareHouse": [
    {
      "WarehouseProductID": 1,
      "WarehouseID": 2,
      "WarehouseName": "sample string 3",
      "Quantity": 4,
      "FirstQuantity": 5,
      "QuantityIn": 6,
      "QuantityOut": 7,
      "QuantityAdjust": 8,
      "FinalQuantity": 9
    },
    {
      "WarehouseProductID": 1,
      "WarehouseID": 2,
      "WarehouseName": "sample string 3",
      "Quantity": 4,
      "FirstQuantity": 5,
      "QuantityIn": 6,
      "QuantityOut": 7,
      "QuantityAdjust": 8,
      "FinalQuantity": 9
    }
  ],
  "CollectionType": {
    "ID": 1,
    "Title": 2,
    "Code": "sample string 3",
    "Name": "sample string 4"
  },
  "TypeShop": 44,
  "ShippingCode": "sample string 45",
  "AcceptancePosCode": "sample string 46",
  "ListUpdateInformation": [
    {
      "RequestSupportType": {
        "ID": 1,
        "Title": 2,
        "Code": "sample string 3",
        "Name": "sample string 4"
      },
      "OldUpdateInformation": "sample string 1",
      "NewUpdateInformation": "sample string 2",
      "CreatedDate": "sample string 3"
    },
    {
      "RequestSupportType": {
        "ID": 1,
        "Title": 2,
        "Code": "sample string 3",
        "Name": "sample string 4"
      },
      "OldUpdateInformation": "sample string 1",
      "NewUpdateInformation": "sample string 2",
      "CreatedDate": "sample string 3"
    }
  ],
  "PlaceOfCreation": "sample string 47",
  "DeviceName": "sample string 48",
  "PostalType": "sample string 49",
  "ExpectedDeliveryDate": "sample string 50",
  "CollectionPostOfficeRecent": {
    "ID": 1,
    "CollectionPostOfficeCode": "sample string 2",
    "CollectionPostOfficeName": "sample string 3",
    "FullAddress": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<ZOrderGetByIDResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EMS.Entity">
  <AcceptancePosCode>sample string 46</AcceptancePosCode>
  <ActualTotalCOD>16</ActualTotalCOD>
  <ActualTransportFee>12</ActualTransportFee>
  <ActualTransportWeight>31.1</ActualTransportWeight>
  <BatchCode>sample string 4</BatchCode>
  <Channel>sample string 23</Channel>
  <CollectionPostOfficeRecent>
    <CollectionPostOfficeCode>sample string 2</CollectionPostOfficeCode>
    <CollectionPostOfficeName>sample string 3</CollectionPostOfficeName>
    <FullAddress>sample string 4</FullAddress>
    <ID>1</ID>
  </CollectionPostOfficeRecent>
  <CollectionType>
    <Code>sample string 3</Code>
    <ID>1</ID>
    <Name>sample string 4</Name>
    <Title>2</Title>
  </CollectionType>
  <CreatedBy>20</CreatedBy>
  <CreatedDate>sample string 21</CreatedDate>
  <Customer>
    <Address>sample string 11</Address>
    <BlackList>sample string 5</BlackList>
    <DistrictID>9</DistrictID>
    <Email>sample string 4</Email>
    <FullAddress>sample string 12</FullAddress>
    <FullName>sample string 2</FullName>
    <GroupCode>sample string 6</GroupCode>
    <GroupName>sample string 7</GroupName>
    <ID>1</ID>
    <MobileNumber>sample string 3</MobileNumber>
    <ProvinceID>8</ProvinceID>
    <SuccessOrder>13</SuccessOrder>
    <TotalOrder>14</TotalOrder>
    <WardID>10</WardID>
  </Customer>
  <DeviceName>sample string 48</DeviceName>
  <EMSOneCode>sample string 2</EMSOneCode>
  <ExchangeTransportWeight>32.1</ExchangeTransportWeight>
  <ExpectedDeliveryDate>sample string 50</ExpectedDeliveryDate>
  <ID>1</ID>
  <ListUpdateInformation>
    <ZRequestSupportHistorySearchListUpdateInformationResponse>
      <CreatedDate>sample string 3</CreatedDate>
      <NewUpdateInformation>sample string 2</NewUpdateInformation>
      <OldUpdateInformation>sample string 1</OldUpdateInformation>
      <RequestSupportType>
        <Code>sample string 3</Code>
        <ID>1</ID>
        <Name>sample string 4</Name>
        <Title>2</Title>
      </RequestSupportType>
    </ZRequestSupportHistorySearchListUpdateInformationResponse>
    <ZRequestSupportHistorySearchListUpdateInformationResponse>
      <CreatedDate>sample string 3</CreatedDate>
      <NewUpdateInformation>sample string 2</NewUpdateInformation>
      <OldUpdateInformation>sample string 1</OldUpdateInformation>
      <RequestSupportType>
        <Code>sample string 3</Code>
        <ID>1</ID>
        <Name>sample string 4</Name>
        <Title>2</Title>
      </RequestSupportType>
    </ZRequestSupportHistorySearchListUpdateInformationResponse>
  </ListUpdateInformation>
  <Message>sample string 25</Message>
  <Note>sample string 24</Note>
  <OrderCode>sample string 3</OrderCode>
  <OrderItems>
    <ZOrderItemGetByOrderIDResponse>
      <Discount>10</Discount>
      <ID>1</ID>
      <NumberOfProduct>8</NumberOfProduct>
      <Price>9</Price>
      <ProductCode>sample string 3</ProductCode>
      <ProductID>2</ProductID>
      <ProductName>sample string 4</ProductName>
      <ProductVariantImage>sample string 12</ProductVariantImage>
      <VariantID>5</VariantID>
      <VariantName>sample string 7</VariantName>
      <VariantSKU>sample string 6</VariantSKU>
      <WareHouseQuantity>13</WareHouseQuantity>
      <Weight>11</Weight>
    </ZOrderItemGetByOrderIDResponse>
    <ZOrderItemGetByOrderIDResponse>
      <Discount>10</Discount>
      <ID>1</ID>
      <NumberOfProduct>8</NumberOfProduct>
      <Price>9</Price>
      <ProductCode>sample string 3</ProductCode>
      <ProductID>2</ProductID>
      <ProductName>sample string 4</ProductName>
      <ProductVariantImage>sample string 12</ProductVariantImage>
      <VariantID>5</VariantID>
      <VariantName>sample string 7</VariantName>
      <VariantSKU>sample string 6</VariantSKU>
      <WareHouseQuantity>13</WareHouseQuantity>
      <Weight>11</Weight>
    </ZOrderItemGetByOrderIDResponse>
  </OrderItems>
  <PaymentMethod>19</PaymentMethod>
  <PaymentStatus>sample string 18</PaymentStatus>
  <PlaceOfCreation>sample string 47</PlaceOfCreation>
  <PostalType>sample string 49</PostalType>
  <ReasonCancel>sample string 26</ReasonCancel>
  <ShipmentDetails>
    <Address>sample string 11</Address>
    <Channel>sample string 3</Channel>
    <DistrictID>7</DistrictID>
    <DistrictName>sample string 8</DistrictName>
    <Email>sample string 4</Email>
    <FullAddress>sample string 12</FullAddress>
    <IsReceiverNewAddress>sample string 14</IsReceiverNewAddress>
    <MobileNumber>sample string 2</MobileNumber>
    <PickUpAddressID>13</PickUpAddressID>
    <PickupDistrictID>19</PickupDistrictID>
    <PickupDistrictName>sample string 20</PickupDistrictName>
    <PickupFullAddress>sample string 24</PickupFullAddress>
    <PickupFullName>sample string 15</PickupFullName>
    <PickupMobileNumber>sample string 16</PickupMobileNumber>
    <PickupProvinceID>17</PickupProvinceID>
    <PickupProvinceName>sample string 18</PickupProvinceName>
    <PickupStreet>sample string 23</PickupStreet>
    <PickupWardID>21</PickupWardID>
    <PickupWardName>sample string 22</PickupWardName>
    <ProvinceID>5</ProvinceID>
    <ProvinceName>sample string 6</ProvinceName>
    <ReceiverName>sample string 1</ReceiverName>
    <WardID>9</WardID>
    <WardName>sample string 10</WardName>
  </ShipmentDetails>
  <ShippingCode>sample string 45</ShippingCode>
  <Status>sample string 5</Status>
  <StatusName>sample string 6</StatusName>
  <TotalAmount>9</TotalAmount>
  <TotalCOD>15</TotalCOD>
  <TotalDiscount>10</TotalDiscount>
  <TotalOrderValue>14</TotalOrderValue>
  <TotalPHU>17</TotalPHU>
  <TotalProductValue>13</TotalProductValue>
  <Transport>sample string 22</Transport>
  <TransportExtraService>sample string 40</TransportExtraService>
  <TransportExtraServiceName>sample string 41</TransportExtraServiceName>
  <TransportFee>11</TransportFee>
  <TransportMainService>38</TransportMainService>
  <TransportMainServiceName>sample string 39</TransportMainServiceName>
  <TransportOrderName>sample string 29</TransportOrderName>
  <TransportOrderValue>37</TransportOrderValue>
  <TransportPayer>42</TransportPayer>
  <TransportPayerName>sample string 43</TransportPayerName>
  <TransportQuantity>36</TransportQuantity>
  <TransportSizeHeight>35.1</TransportSizeHeight>
  <TransportSizeLength>33.1</TransportSizeLength>
  <TransportSizeWidth>34.1</TransportSizeWidth>
  <TransportWeight>30.1</TransportWeight>
  <TypeShop>44</TypeShop>
  <UpdatedDate>sample string 27</UpdatedDate>
  <UpdatedName>sample string 28</UpdatedName>
  <WareHouseID>7</WareHouseID>
  <WareHouseName>sample string 8</WareHouseName>
  <listWareHouse>
    <ZWarehouseProductGetByVariantIDResponse>
      <FinalQuantity>9</FinalQuantity>
      <FirstQuantity>5</FirstQuantity>
      <Quantity>4</Quantity>
      <QuantityAdjust>8</QuantityAdjust>
      <QuantityIn>6</QuantityIn>
      <QuantityOut>7</QuantityOut>
      <WarehouseID>2</WarehouseID>
      <WarehouseName>sample string 3</WarehouseName>
      <WarehouseProductID>1</WarehouseProductID>
    </ZWarehouseProductGetByVariantIDResponse>
    <ZWarehouseProductGetByVariantIDResponse>
      <FinalQuantity>9</FinalQuantity>
      <FirstQuantity>5</FirstQuantity>
      <Quantity>4</Quantity>
      <QuantityAdjust>8</QuantityAdjust>
      <QuantityIn>6</QuantityIn>
      <QuantityOut>7</QuantityOut>
      <WarehouseID>2</WarehouseID>
      <WarehouseName>sample string 3</WarehouseName>
      <WarehouseProductID>1</WarehouseProductID>
    </ZWarehouseProductGetByVariantIDResponse>
  </listWareHouse>
</ZOrderGetByIDResponse>