GET api/order/Get?orderNo={orderNo}&orderSuffix={orderSuffix}

Get the sales order by order# and order suffix (optional)

Request Information

URI Parameters

Name	Description	Type	Additional information
orderNo	OrderNo from Coaster	integer	Required
orderSuffix	OrderSuffix from Coaster. Default value is 0	integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

SalesOrder

Name	Type	Additional information
OrderNo	integer	None.
OrderSuf	integer	None.
WarehouseCode	string	None.
CustNo	integer	None.
Status	string	None.
CustomerPoNo	string	None.
ShipTo	string	None.
ShipVia	string	None.
ShipInstruction	string	None.
PromoCode	string	None.
TransType	string	None.
AmountLineOrder	decimal number	None.
AmountDiscount	decimal number	None.
AmountTax	decimal number	None.
AmountOrder	decimal number	None.
AmountInvoice	decimal number	None.
DateOrder	date	None.
DateRequestShip	date	None.
DateShip	date	None.
ShippingAddress	ShippingAddress	None.
Items	Collection of Item	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderNo": 1,
  "OrderSuf": 2,
  "WarehouseCode": "sample string 3",
  "CustNo": 4,
  "Status": "sample string 5",
  "CustomerPoNo": "sample string 6",
  "ShipTo": "sample string 7",
  "ShipVia": "sample string 8",
  "ShipInstruction": "sample string 9",
  "PromoCode": "sample string 10",
  "TransType": "sample string 11",
  "AmountLineOrder": 1.0,
  "AmountDiscount": 1.0,
  "AmountTax": 1.0,
  "AmountOrder": 12.0,
  "AmountInvoice": 1.0,
  "DateOrder": "2024-07-26T13:52:47.2206082-07:00",
  "DateRequestShip": "2024-07-26T13:52:47.2206082-07:00",
  "DateShip": "2024-07-26T13:52:47.2206082-07:00",
  "ShippingAddress": {
    "Name": "sample string 1",
    "Address1": "sample string 2",
    "Address2": "sample string 3",
    "City": "sample string 4",
    "StateCode": "sample string 5",
    "ZipCode": "sample string 6",
    "Phone": "sample string 7",
    "ShipToCode": "sample string 8",
    "Reference": "sample string 9"
  },
  "Items": [
    {
      "ItemNo": "sample string 1",
      "UnitOfMeasure": "sample string 2",
      "QtyOrder": 3,
      "QtyShip": 4,
      "PriceNet": 5.0
    },
    {
      "ItemNo": "sample string 1",
      "UnitOfMeasure": "sample string 2",
      "QtyOrder": 3,
      "QtyShip": 4,
      "PriceNet": 5.0
    }
  ]
}

application/xml, text/xml

Sample:

<SalesOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Coaster.Modals.Sales">
  <AmountDiscount>1</AmountDiscount>
  <AmountInvoice>1</AmountInvoice>
  <AmountLineOrder>1</AmountLineOrder>
  <AmountOrder>12</AmountOrder>
  <AmountTax>1</AmountTax>
  <CustNo>4</CustNo>
  <CustomerPoNo>sample string 6</CustomerPoNo>
  <DateOrder>2024-07-26T13:52:47.2206082-07:00</DateOrder>
  <DateRequestShip>2024-07-26T13:52:47.2206082-07:00</DateRequestShip>
  <DateShip>2024-07-26T13:52:47.2206082-07:00</DateShip>
  <Items>
    <Item>
      <ItemNo>sample string 1</ItemNo>
      <PriceNet>5</PriceNet>
      <QtyOrder>3</QtyOrder>
      <QtyShip>4</QtyShip>
      <UnitOfMeasure>sample string 2</UnitOfMeasure>
    </Item>
    <Item>
      <ItemNo>sample string 1</ItemNo>
      <PriceNet>5</PriceNet>
      <QtyOrder>3</QtyOrder>
      <QtyShip>4</QtyShip>
      <UnitOfMeasure>sample string 2</UnitOfMeasure>
    </Item>
  </Items>
  <OrderNo>1</OrderNo>
  <OrderSuf>2</OrderSuf>
  <PromoCode>sample string 10</PromoCode>
  <ShipInstruction>sample string 9</ShipInstruction>
  <ShipTo>sample string 7</ShipTo>
  <ShipVia>sample string 8</ShipVia>
  <ShippingAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/App.WebAPI.Models">
    <d2p1:Address1>sample string 2</d2p1:Address1>
    <d2p1:Address2>sample string 3</d2p1:Address2>
    <d2p1:City>sample string 4</d2p1:City>
    <d2p1:Name>sample string 1</d2p1:Name>
    <d2p1:Phone>sample string 7</d2p1:Phone>
    <d2p1:Reference>sample string 9</d2p1:Reference>
    <d2p1:ShipToCode>sample string 8</d2p1:ShipToCode>
    <d2p1:StateCode>sample string 5</d2p1:StateCode>
    <d2p1:ZipCode>sample string 6</d2p1:ZipCode>
  </ShippingAddress>
  <Status>sample string 5</Status>
  <TransType>sample string 11</TransType>
  <WarehouseCode>sample string 3</WarehouseCode>
</SalesOrder>