GET api/v1/Orders/ShortOrderNumber/{shortOrderNumber}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| shortOrderNumber | string |
Required |
Body Parameters
Response Information
Resource Description
Order| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer | ||
| ShortOrderNumber |
Short order number for the order. System generated |
string | |
| ClientId |
Client ID for the order |
integer | |
| MemberId |
Member ID for the order |
integer | |
| OrderTypeId |
Order Type ID for the order |
TOrderType | |
| DisplayOrderType | string | ||
| DisplayOrderStatus | string | ||
| OrderSourceId |
Order Type ID for the order |
TOrderSource | |
| OrderStatusId |
Order Status ID for the order |
TOrderStatus | |
| OrderDate |
Order Date for the order |
date | |
| OrderTemplateId |
Not required for all orders. If you supply it, please make it accurate |
integer | |
| ShipName |
Shipping name for the order |
string | |
| ShipAddress1 |
Shipping address line 1 for the order |
string | |
| ShipAddress2 |
Shipping address line 2 for the order |
string | |
| ShipAddress3 |
Shipping address line 3 for the order |
string | |
| ShipCity |
Shipping city for the order |
string | |
| ShipState |
Shipping state for the order |
string | |
| ShipZip |
Shipping zip code for the order |
string | |
| ShipPhone |
Shipping phone number for the order |
string | |
|
Email address for the order |
string | ||
| ShippingServiceLevel |
Shipping service level for the order |
string | |
| PreferredShipMethod |
Preferred shipping method for the order |
string | |
| PackslipMessage |
Packslip message for the order |
string | |
| MustShipByDate |
Must ship by date for the order |
date | |
| OrderItems |
Collection of order items |
Collection of OrderItem | |
| OrderShipments |
Collection of order shipments |
Collection of OrderShipment | |
| Client |
Client associated with the order |
Client | |
| ExecutionTime |
How long the method took in milliseconds. System supplied value. |
integer | |
| TxID |
Transaction ID of the call. Will be added for the response. Not needed in the request. |
string |
Response Formats
application/json, text/json
{
"id": 1,
"shortOrderNumber": "sample string 3",
"clientId": 4,
"memberId": 5,
"orderTypeId": "Unknown",
"displayOrderType": "sample string 6",
"displayOrderStatus": "sample string 7",
"orderSourceId": "Unknown",
"orderStatusId": "Unknown",
"orderDate": "2026-04-06T22:56:48.279506+00:00",
"orderTemplateId": 1,
"shipName": "sample string 9",
"shipAddress1": "sample string 10",
"shipAddress2": "sample string 11",
"shipAddress3": "sample string 12",
"shipCity": "sample string 13",
"shipState": "sample string 14",
"shipZip": "sample string 15",
"shipPhone": "sample string 16",
"email": "sample string 17",
"shippingServiceLevel": "sample string 18",
"preferredShipMethod": "sample string 19",
"packslipMessage": "sample string 20",
"mustShipByDate": "2026-04-06T22:56:48.279506+00:00",
"orderItems": [
{
"itemCode": "sample string 4",
"quantity": 5,
"item": {
"id": 1,
"itemCode": "sample string 2",
"alternateItemCode": "sample string 3",
"mfgItemCode": "sample string 4",
"gtin": "sample string 5",
"harmonizedCode": "sample string 6",
"erpId": "sample string 7",
"description": "sample string 8",
"itemTypeId": "Unknown",
"image": "QEA=",
"itemStatusId": "Inactive",
"itemUoM": "sample string 9",
"upcCode": "sample string 10",
"billingCode": "sample string 11",
"weight": 13.0,
"weightUoM": "sample string 14",
"prop65": true,
"dimLength": 16.0,
"dimWidth": 17.0,
"dimHeight": 18.0,
"dimUoM": "sample string 19",
"itemPrice": 20.0,
"lotControlled": true,
"hasSerialNumber": true,
"volume": 1.0,
"volumeUoM": "sample string 23",
"cost": 24.0,
"barCodeNumber": "sample string 25",
"itemKits": [
{
"id": 1,
"itemId": 2,
"itemCode": "sample string 3",
"componentItemId": 4,
"componentItemCode": "sample string 5",
"componentQuantity": 6.0,
"componentGTIN": "sample string 7",
"executionTime": 10,
"txID": "sample string 11"
},
{
"id": 1,
"itemId": 2,
"itemCode": "sample string 3",
"componentItemId": 4,
"componentItemCode": "sample string 5",
"componentQuantity": 6.0,
"componentGTIN": "sample string 7",
"executionTime": 10,
"txID": "sample string 11"
}
],
"vendor": {
"name": "sample string 2"
},
"executionTime": 28,
"txID": "sample string 29"
},
"executionTime": 8,
"txID": "sample string 9"
},
{
"itemCode": "sample string 4",
"quantity": 5,
"item": {
"id": 1,
"itemCode": "sample string 2",
"alternateItemCode": "sample string 3",
"mfgItemCode": "sample string 4",
"gtin": "sample string 5",
"harmonizedCode": "sample string 6",
"erpId": "sample string 7",
"description": "sample string 8",
"itemTypeId": "Unknown",
"image": "QEA=",
"itemStatusId": "Inactive",
"itemUoM": "sample string 9",
"upcCode": "sample string 10",
"billingCode": "sample string 11",
"weight": 13.0,
"weightUoM": "sample string 14",
"prop65": true,
"dimLength": 16.0,
"dimWidth": 17.0,
"dimHeight": 18.0,
"dimUoM": "sample string 19",
"itemPrice": 20.0,
"lotControlled": true,
"hasSerialNumber": true,
"volume": 1.0,
"volumeUoM": "sample string 23",
"cost": 24.0,
"barCodeNumber": "sample string 25",
"itemKits": [
{
"id": 1,
"itemId": 2,
"itemCode": "sample string 3",
"componentItemId": 4,
"componentItemCode": "sample string 5",
"componentQuantity": 6.0,
"componentGTIN": "sample string 7",
"executionTime": 10,
"txID": "sample string 11"
},
{
"id": 1,
"itemId": 2,
"itemCode": "sample string 3",
"componentItemId": 4,
"componentItemCode": "sample string 5",
"componentQuantity": 6.0,
"componentGTIN": "sample string 7",
"executionTime": 10,
"txID": "sample string 11"
}
],
"vendor": {
"name": "sample string 2"
},
"executionTime": 28,
"txID": "sample string 29"
},
"executionTime": 8,
"txID": "sample string 9"
}
],
"orderShipments": [
{
"id": 1,
"orderId": 2,
"shortOrderNumber": "sample string 3",
"orderShipmentDate": "2026-04-06T22:56:48.279506+00:00",
"orderShipmentPackageNumber": 5,
"orderShipmentStatusId": "Unknown",
"warehouseId": 6,
"shipName": "sample string 7",
"shipAddress1": "sample string 8",
"shipAddress2": "sample string 9",
"shipAddress3": "sample string 10",
"shipCity": "sample string 11",
"shipState": "sample string 12",
"shipZip": "sample string 13",
"shipPhone": "sample string 14",
"weight": 15.0,
"orderShipmentItems": [
{
"id": 1,
"orderShipmentId": 2,
"itemId": 3,
"itemCode": "sample string 4",
"quantity": 5,
"locationName": "sample string 6",
"pickedQuantity": 1,
"pickedDateTime": "2026-04-06T22:56:48.279506+00:00",
"kitBuildBarcode": "sample string 7",
"executionTime": 10,
"txID": "sample string 11"
},
{
"id": 1,
"orderShipmentId": 2,
"itemId": 3,
"itemCode": "sample string 4",
"quantity": 5,
"locationName": "sample string 6",
"pickedQuantity": 1,
"pickedDateTime": "2026-04-06T22:56:48.279506+00:00",
"kitBuildBarcode": "sample string 7",
"executionTime": 10,
"txID": "sample string 11"
}
],
"orderShipmentPackages": [
{
"id": 1,
"orderShipmentId": 2,
"packageNumber": 3,
"actualShipWeight": 1.0,
"shipCarrier": "sample string 4",
"trackingNumber1": "sample string 5",
"trackingNumber2": "sample string 6",
"trackingLink": "sample string 7",
"deliveryStatus": "sample string 8",
"carrierReceiveDate": "2026-04-06T22:56:48.279506+00:00",
"transitDays": 10.0,
"deliveryDate": "2026-04-06T22:56:48.279506+00:00",
"executionTime": 14,
"txID": "sample string 15"
},
{
"id": 1,
"orderShipmentId": 2,
"packageNumber": 3,
"actualShipWeight": 1.0,
"shipCarrier": "sample string 4",
"trackingNumber1": "sample string 5",
"trackingNumber2": "sample string 6",
"trackingLink": "sample string 7",
"deliveryStatus": "sample string 8",
"carrierReceiveDate": "2026-04-06T22:56:48.279506+00:00",
"transitDays": 10.0,
"deliveryDate": "2026-04-06T22:56:48.279506+00:00",
"executionTime": 14,
"txID": "sample string 15"
}
],
"executionTime": 18,
"txID": "sample string 19"
},
{
"id": 1,
"orderId": 2,
"shortOrderNumber": "sample string 3",
"orderShipmentDate": "2026-04-06T22:56:48.279506+00:00",
"orderShipmentPackageNumber": 5,
"orderShipmentStatusId": "Unknown",
"warehouseId": 6,
"shipName": "sample string 7",
"shipAddress1": "sample string 8",
"shipAddress2": "sample string 9",
"shipAddress3": "sample string 10",
"shipCity": "sample string 11",
"shipState": "sample string 12",
"shipZip": "sample string 13",
"shipPhone": "sample string 14",
"weight": 15.0,
"orderShipmentItems": [
{
"id": 1,
"orderShipmentId": 2,
"itemId": 3,
"itemCode": "sample string 4",
"quantity": 5,
"locationName": "sample string 6",
"pickedQuantity": 1,
"pickedDateTime": "2026-04-06T22:56:48.279506+00:00",
"kitBuildBarcode": "sample string 7",
"executionTime": 10,
"txID": "sample string 11"
},
{
"id": 1,
"orderShipmentId": 2,
"itemId": 3,
"itemCode": "sample string 4",
"quantity": 5,
"locationName": "sample string 6",
"pickedQuantity": 1,
"pickedDateTime": "2026-04-06T22:56:48.279506+00:00",
"kitBuildBarcode": "sample string 7",
"executionTime": 10,
"txID": "sample string 11"
}
],
"orderShipmentPackages": [
{
"id": 1,
"orderShipmentId": 2,
"packageNumber": 3,
"actualShipWeight": 1.0,
"shipCarrier": "sample string 4",
"trackingNumber1": "sample string 5",
"trackingNumber2": "sample string 6",
"trackingLink": "sample string 7",
"deliveryStatus": "sample string 8",
"carrierReceiveDate": "2026-04-06T22:56:48.279506+00:00",
"transitDays": 10.0,
"deliveryDate": "2026-04-06T22:56:48.279506+00:00",
"executionTime": 14,
"txID": "sample string 15"
},
{
"id": 1,
"orderShipmentId": 2,
"packageNumber": 3,
"actualShipWeight": 1.0,
"shipCarrier": "sample string 4",
"trackingNumber1": "sample string 5",
"trackingNumber2": "sample string 6",
"trackingLink": "sample string 7",
"deliveryStatus": "sample string 8",
"carrierReceiveDate": "2026-04-06T22:56:48.279506+00:00",
"transitDays": 10.0,
"deliveryDate": "2026-04-06T22:56:48.279506+00:00",
"executionTime": 14,
"txID": "sample string 15"
}
],
"executionTime": 18,
"txID": "sample string 19"
}
],
"client": {
"id": 1,
"name": "sample string 2",
"shortName": "sample string 3",
"code": "sample string 4",
"active": true,
"clientTypeId": 0,
"parentClient": "sample string 6",
"description": "sample string 7",
"erpId": "sample string 8",
"erpNumber": "sample string 9",
"address1": "sample string 10",
"address2": "sample string 11",
"city": "sample string 12",
"state": "sample string 13",
"zip": "sample string 14",
"email": "sample string 15",
"phone": "sample string 16",
"clientContracts": [
{
"$id": "1",
"executionTime": 12,
"txID": "sample string 13"
},
{
"$ref": "1"
}
],
"executionTime": 19,
"txID": "sample string 20"
},
"executionTime": 24,
"txID": "sample string 25"
}
application/xml, text/xml
<Order xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Models">
<ExecutionTime xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">24</ExecutionTime>
<TxID xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">sample string 25</TxID>
<Client z:Id="i2">
<ExecutionTime xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">19</ExecutionTime>
<TxID xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">sample string 20</TxID>
<Active>true</Active>
<Address1>sample string 10</Address1>
<Address2>sample string 11</Address2>
<City>sample string 12</City>
<ClientContracts>
<ClientContract z:Id="i3">
<ExecutionTime xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">12</ExecutionTime>
<TxID xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">sample string 13</TxID>
<Client z:Ref="i2" />
<ClientContractDetails>
<ClientContractDetail z:Id="i4">
<ExecutionTime xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">30</ExecutionTime>
<TxID xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">sample string 31</TxID>
<AdditionalDieticianCallDiscountAmount>11</AdditionalDieticianCallDiscountAmount>
<AdditionalDieticianCallItemId>12</AdditionalDieticianCallItemId>
<AdditionalDieticianCallPrice>10</AdditionalDieticianCallPrice>
<AdditionalHealthCoachCallDiscountAmount>6</AdditionalHealthCoachCallDiscountAmount>
<AdditionalHealthCoachCallItemId>7</AdditionalHealthCoachCallItemId>
<AdditionalHealthCoachCallPrice>5</AdditionalHealthCoachCallPrice>
<AdditionalNurseCallDiscountAmount>14</AdditionalNurseCallDiscountAmount>
<AdditionalNurseCallItemId>15</AdditionalNurseCallItemId>
<AdditionalNurseCallPrice>13</AdditionalNurseCallPrice>
<ClientContract z:Ref="i3" />
<ClientContractId>2</ClientContractId>
<ClinicalCalls>8</ClinicalCalls>
<ClinicalCallsMax>9</ClinicalCallsMax>
<CollectBiometricData>true</CollectBiometricData>
<HealthCoachInboundCalls>3</HealthCoachInboundCalls>
<HealthCoachInboundCallsMax>4</HealthCoachInboundCallsMax>
<Id>1</Id>
<NutritionPlans>true</NutritionPlans>
<ReplacementDeviceBandItemId>27</ReplacementDeviceBandItemId>
<ReplacementDeviceBandPrice>26</ReplacementDeviceBandPrice>
<ReplacementGlucometerItemId>25</ReplacementGlucometerItemId>
<ReplacementGlucometerPrice>24</ReplacementGlucometerPrice>
<ReplacementWelcomeKitItemId>23</ReplacementWelcomeKitItemId>
<ReplacementWelcomeKitPrice>22</ReplacementWelcomeKitPrice>
<ReportingType>sample string 16</ReportingType>
<ResupplyGoal>20</ResupplyGoal>
<ResupplyLimit>21</ResupplyLimit>
<RewardsProgram>true</RewardsProgram>
</ClientContractDetail>
<ClientContractDetail z:Ref="i4" />
</ClientContractDetails>
<ClientId>2</ClientId>
<DiscountAmount>9</DiscountAmount>
<EffectiveDateEnd>2026-04-06T22:56:48.279506+00:00</EffectiveDateEnd>
<EffectiveDateStart>2026-04-06T22:56:48.279506+00:00</EffectiveDateStart>
<Id>1</Id>
<ItemId>7</ItemId>
<PlanBillingCode>sample string 6</PlanBillingCode>
<PlanName>sample string 5</PlanName>
<Price>8</Price>
</ClientContract>
<ClientContract z:Ref="i3" />
</ClientContracts>
<ClientTypeId>Unknown</ClientTypeId>
<Code>sample string 4</Code>
<Description>sample string 7</Description>
<Email>sample string 15</Email>
<ErpId>sample string 8</ErpId>
<ErpNumber>sample string 9</ErpNumber>
<Id>1</Id>
<Name>sample string 2</Name>
<ParentClient>sample string 6</ParentClient>
<Phone>sample string 16</Phone>
<ShortName>sample string 3</ShortName>
<State>sample string 13</State>
<Zip>sample string 14</Zip>
</Client>
<ClientId>4</ClientId>
<DisplayOrderStatus>sample string 7</DisplayOrderStatus>
<DisplayOrderType>sample string 6</DisplayOrderType>
<Email>sample string 17</Email>
<Id>1</Id>
<MemberId>5</MemberId>
<MustShipByDate>2026-04-06T22:56:48.279506+00:00</MustShipByDate>
<OrderDate>2026-04-06T22:56:48.279506+00:00</OrderDate>
<OrderItems>
<OrderItem z:Id="i5">
<ExecutionTime xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">8</ExecutionTime>
<TxID xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">sample string 9</TxID>
<Item z:Id="i6">
<ExecutionTime xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">28</ExecutionTime>
<TxID xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">sample string 29</TxID>
<AlternateItemCode>sample string 3</AlternateItemCode>
<BarCodeNumber>sample string 25</BarCodeNumber>
<BillingCode>sample string 11</BillingCode>
<Cost>24</Cost>
<Description>sample string 8</Description>
<DimHeight>18</DimHeight>
<DimLength>16</DimLength>
<DimUoM>sample string 19</DimUoM>
<DimWidth>17</DimWidth>
<ErpId>sample string 7</ErpId>
<GTIN>sample string 5</GTIN>
<HarmonizedCode>sample string 6</HarmonizedCode>
<HasSerialNumber>true</HasSerialNumber>
<Id>1</Id>
<Image>QEA=</Image>
<ItemCode>sample string 2</ItemCode>
<ItemKits>
<ItemKit z:Id="i7">
<ExecutionTime xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">10</ExecutionTime>
<TxID xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">sample string 11</TxID>
<ComponentGTIN>sample string 7</ComponentGTIN>
<ComponentItemCode>sample string 5</ComponentItemCode>
<ComponentItemId>4</ComponentItemId>
<ComponentQuantity>6</ComponentQuantity>
<Id>1</Id>
<ItemCode>sample string 3</ItemCode>
<ItemId>2</ItemId>
</ItemKit>
<ItemKit z:Ref="i7" />
</ItemKits>
<ItemPrice>20</ItemPrice>
<ItemStatusId>Inactive</ItemStatusId>
<ItemTypeId>Unknown</ItemTypeId>
<ItemUoM>sample string 9</ItemUoM>
<LotControlled>true</LotControlled>
<MfgItemCode>sample string 4</MfgItemCode>
<Prop65>true</Prop65>
<UPCCode>sample string 10</UPCCode>
<Vendor>
<Name>sample string 2</Name>
</Vendor>
<Volume>1</Volume>
<VolumeUoM>sample string 23</VolumeUoM>
<Weight>13</Weight>
<WeightUoM>sample string 14</WeightUoM>
</Item>
<ItemCode>sample string 4</ItemCode>
<Quantity>5</Quantity>
</OrderItem>
<OrderItem z:Ref="i5" />
</OrderItems>
<OrderShipments>
<OrderShipment z:Id="i8">
<ExecutionTime xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">18</ExecutionTime>
<TxID xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">sample string 19</TxID>
<Id>1</Id>
<OrderId>2</OrderId>
<OrderShipmentDate>2026-04-06T22:56:48.279506+00:00</OrderShipmentDate>
<OrderShipmentItems>
<OrderShipmentItem z:Id="i9">
<ExecutionTime xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">10</ExecutionTime>
<TxID xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">sample string 11</TxID>
<Id>1</Id>
<ItemCode>sample string 4</ItemCode>
<ItemId>3</ItemId>
<KitBuildBarcode>sample string 7</KitBuildBarcode>
<LocationName>sample string 6</LocationName>
<OrderShipmentId>2</OrderShipmentId>
<PickedDateTime>2026-04-06T22:56:48.279506+00:00</PickedDateTime>
<PickedQuantity>1</PickedQuantity>
<Quantity>5</Quantity>
</OrderShipmentItem>
<OrderShipmentItem z:Ref="i9" />
</OrderShipmentItems>
<OrderShipmentPackageNumber>5</OrderShipmentPackageNumber>
<OrderShipmentPackages>
<OrderShipmentPackage z:Id="i10">
<ExecutionTime xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">14</ExecutionTime>
<TxID xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">sample string 15</TxID>
<ActualShipWeight>1</ActualShipWeight>
<CarrierReceiveDate>2026-04-06T22:56:48.279506+00:00</CarrierReceiveDate>
<DeliveryDate>2026-04-06T22:56:48.279506+00:00</DeliveryDate>
<DeliveryStatus>sample string 8</DeliveryStatus>
<Id>1</Id>
<OrderShipmentId>2</OrderShipmentId>
<PackageNumber>3</PackageNumber>
<ShipCarrier>sample string 4</ShipCarrier>
<TrackingLink>sample string 7</TrackingLink>
<TrackingNumber1>sample string 5</TrackingNumber1>
<TrackingNumber2>sample string 6</TrackingNumber2>
<TransitDays>10</TransitDays>
</OrderShipmentPackage>
<OrderShipmentPackage z:Ref="i10" />
</OrderShipmentPackages>
<OrderShipmentStatusId>Unknown</OrderShipmentStatusId>
<ShipAddress1>sample string 8</ShipAddress1>
<ShipAddress2>sample string 9</ShipAddress2>
<ShipAddress3>sample string 10</ShipAddress3>
<ShipCity>sample string 11</ShipCity>
<ShipName>sample string 7</ShipName>
<ShipPhone>sample string 14</ShipPhone>
<ShipState>sample string 12</ShipState>
<ShipZip>sample string 13</ShipZip>
<ShortOrderNumber>sample string 3</ShortOrderNumber>
<WarehouseId>6</WarehouseId>
<Weight>15</Weight>
</OrderShipment>
<OrderShipment z:Ref="i8" />
</OrderShipments>
<OrderSourceId>Unknown</OrderSourceId>
<OrderStatusId>Unknown</OrderStatusId>
<OrderTemplateId>1</OrderTemplateId>
<OrderTypeId>Unknown</OrderTypeId>
<PackslipMessage>sample string 20</PackslipMessage>
<PreferredShipMethod>sample string 19</PreferredShipMethod>
<ShipAddress1>sample string 10</ShipAddress1>
<ShipAddress2>sample string 11</ShipAddress2>
<ShipAddress3>sample string 12</ShipAddress3>
<ShipCity>sample string 13</ShipCity>
<ShipName>sample string 9</ShipName>
<ShipPhone>sample string 16</ShipPhone>
<ShipState>sample string 14</ShipState>
<ShipZip>sample string 15</ShipZip>
<ShippingServiceLevel>sample string 18</ShippingServiceLevel>
<ShortOrderNumber>sample string 3</ShortOrderNumber>
</Order>