GET api/Order/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

Body Parameters

None.

Response Information

Resource Description

OrderDetail
NameDescriptionTypeAdditional information
invoice_no

string

None.

invoice_date

date

None.

order_no

string

None.

order_date

date

None.

customer_id

string

None.

pick_ticket_no

string

None.

po_no

string

None.

total_amount

decimal number

None.

amount_paid

decimal number

None.

bill2_name

string

None.

bill2_address1

string

None.

bill2_address2

string

None.

bill2_city

string

None.

bill2_state

string

None.

bill2_postal_code

string

None.

bill2_country

string

None.

ship2_name

string

None.

ship2_contact

string

None.

ship2_address1

string

None.

ship2_address2

string

None.

ship2_city

string

None.

ship2_state

string

None.

ship2_postal_code

string

None.

ship2_country

string

None.

terms_desc

string

None.

salesrep_name

string

None.

net_due_date

date

None.

terms_due_date

date

None.

terms_amount

decimal number

None.

freight

decimal number

None.

other_charge_amount

decimal number

None.

tax_amount

decimal number

None.

tracking_no

string

None.

taker

string

None.

placed_by_name

string

None.

carrier

string

None.

bill_to_Address

string

None.

ship_to_Address

string

None.

ship_date

date

None.

items

Collection of OrderItems

None.

Response Formats

application/json, text/json

Sample:
{
  "invoice_no": "sample string 1",
  "invoice_date": "2024-09-19T09:02:20.9642022+00:00",
  "order_no": "sample string 3",
  "order_date": "2024-09-19T09:02:20.9642022+00:00",
  "customer_id": "sample string 4",
  "pick_ticket_no": "sample string 5",
  "po_no": "sample string 6",
  "total_amount": 7.0,
  "amount_paid": 8.0,
  "bill2_name": "sample string 9",
  "bill2_address1": "sample string 10",
  "bill2_address2": "sample string 11",
  "bill2_city": "sample string 12",
  "bill2_state": "sample string 13",
  "bill2_postal_code": "sample string 14",
  "bill2_country": "sample string 15",
  "ship2_name": "sample string 16",
  "ship2_contact": "sample string 17",
  "ship2_address1": "sample string 18",
  "ship2_address2": "sample string 19",
  "ship2_city": "sample string 20",
  "ship2_state": "sample string 21",
  "ship2_postal_code": "sample string 22",
  "ship2_country": "sample string 23",
  "terms_desc": "sample string 24",
  "salesrep_name": "sample string 25",
  "net_due_date": "2024-09-19T09:02:20.9642022+00:00",
  "terms_due_date": "2024-09-19T09:02:20.9642022+00:00",
  "terms_amount": 28.0,
  "freight": 29.0,
  "other_charge_amount": 30.0,
  "tax_amount": 31.0,
  "tracking_no": "sample string 32",
  "taker": "sample string 33",
  "placed_by_name": "sample string 34",
  "carrier": "sample string 35",
  "bill_to_Address": "sample string 36",
  "ship_to_Address": "sample string 37",
  "ship_date": "2024-09-19T09:02:20.9642022+00:00",
  "items": [
    {
      "line_no": 1.0,
      "qty_requested": 2.0,
      "qty_shipped": 3.0,
      "qty_remaining": 4.0,
      "unit_of_measure": "sample string 5",
      "sales_unit_size": 6.0,
      "item_id": "sample string 7",
      "item_desc": "sample string 8",
      "extended_desc": "sample string 9",
      "customer_part_number": "sample string 10",
      "unit_price": 11.0,
      "extended_price": 12.0,
      "pricing_unit": "sample string 13",
      "pricing_unit_size": 14.0,
      "contract_no": "sample string 15"
    },
    {
      "line_no": 1.0,
      "qty_requested": 2.0,
      "qty_shipped": 3.0,
      "qty_remaining": 4.0,
      "unit_of_measure": "sample string 5",
      "sales_unit_size": 6.0,
      "item_id": "sample string 7",
      "item_desc": "sample string 8",
      "extended_desc": "sample string 9",
      "customer_part_number": "sample string 10",
      "unit_price": 11.0,
      "extended_price": 12.0,
      "pricing_unit": "sample string 13",
      "pricing_unit_size": 14.0,
      "contract_no": "sample string 15"
    }
  ]
}

text/xml

Sample:
<OrderDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MagentoAPI.Models">
  <amount_paid>8</amount_paid>
  <bill2_address1>sample string 10</bill2_address1>
  <bill2_address2>sample string 11</bill2_address2>
  <bill2_city>sample string 12</bill2_city>
  <bill2_country>sample string 15</bill2_country>
  <bill2_name>sample string 9</bill2_name>
  <bill2_postal_code>sample string 14</bill2_postal_code>
  <bill2_state>sample string 13</bill2_state>
  <bill_to_Address>sample string 36</bill_to_Address>
  <carrier>sample string 35</carrier>
  <customer_id>sample string 4</customer_id>
  <freight>29</freight>
  <invoice_date>2024-09-19T09:02:20.9642022+00:00</invoice_date>
  <invoice_no>sample string 1</invoice_no>
  <items>
    <OrderItems>
      <contract_no>sample string 15</contract_no>
      <customer_part_number>sample string 10</customer_part_number>
      <extended_desc>sample string 9</extended_desc>
      <extended_price>12</extended_price>
      <item_desc>sample string 8</item_desc>
      <item_id>sample string 7</item_id>
      <line_no>1</line_no>
      <pricing_unit>sample string 13</pricing_unit>
      <pricing_unit_size>14</pricing_unit_size>
      <qty_remaining>4</qty_remaining>
      <qty_requested>2</qty_requested>
      <qty_shipped>3</qty_shipped>
      <sales_unit_size>6</sales_unit_size>
      <unit_of_measure>sample string 5</unit_of_measure>
      <unit_price>11</unit_price>
    </OrderItems>
    <OrderItems>
      <contract_no>sample string 15</contract_no>
      <customer_part_number>sample string 10</customer_part_number>
      <extended_desc>sample string 9</extended_desc>
      <extended_price>12</extended_price>
      <item_desc>sample string 8</item_desc>
      <item_id>sample string 7</item_id>
      <line_no>1</line_no>
      <pricing_unit>sample string 13</pricing_unit>
      <pricing_unit_size>14</pricing_unit_size>
      <qty_remaining>4</qty_remaining>
      <qty_requested>2</qty_requested>
      <qty_shipped>3</qty_shipped>
      <sales_unit_size>6</sales_unit_size>
      <unit_of_measure>sample string 5</unit_of_measure>
      <unit_price>11</unit_price>
    </OrderItems>
  </items>
  <net_due_date>2024-09-19T09:02:20.9642022+00:00</net_due_date>
  <order_date>2024-09-19T09:02:20.9642022+00:00</order_date>
  <order_no>sample string 3</order_no>
  <other_charge_amount>30</other_charge_amount>
  <pick_ticket_no>sample string 5</pick_ticket_no>
  <placed_by_name>sample string 34</placed_by_name>
  <po_no>sample string 6</po_no>
  <salesrep_name>sample string 25</salesrep_name>
  <ship2_address1>sample string 18</ship2_address1>
  <ship2_address2>sample string 19</ship2_address2>
  <ship2_city>sample string 20</ship2_city>
  <ship2_contact>sample string 17</ship2_contact>
  <ship2_country>sample string 23</ship2_country>
  <ship2_name>sample string 16</ship2_name>
  <ship2_postal_code>sample string 22</ship2_postal_code>
  <ship2_state>sample string 21</ship2_state>
  <ship_date>2024-09-19T09:02:20.9642022+00:00</ship_date>
  <ship_to_Address>sample string 37</ship_to_Address>
  <taker>sample string 33</taker>
  <tax_amount>31</tax_amount>
  <terms_amount>28</terms_amount>
  <terms_desc>sample string 24</terms_desc>
  <terms_due_date>2024-09-19T09:02:20.9642022+00:00</terms_due_date>
  <total_amount>7</total_amount>
  <tracking_no>sample string 32</tracking_no>
</OrderDetail>