POST Offsite/CompleteOrder

Complete Order

Request Information

URI Parameters

None.

Body Parameters

Order

OrderDetails
NameDescriptionTypeAdditional information
OrderId

If not sent, order will be created

 integer

None.
DonorId

Donor Id needed if OrderId is not sent

 integer

None.
ShippingLabel

If sent, shipment record will be created

 string

None.
Panels

Collection of Panels

 Collection of PanelModel

None.
RoundTrip

boolean

None.
StartAddress

Address

None.
EndAddress

Address

None.
StartOdometer

integer

None.
ArrivedDate

date

None.

Request Formats

application/json, text/json

Sample: 
{
  "OrderId": 1,
  "DonorId": 1,
  "ShippingLabel": "sample string 1",
  "Panels": [
    {
      "Id": 1,
      "OffsiteOrderId": 1,
      "CollectionType": "sample string 2",
      "Status": "sample string 3",
      "CollectionId": 1,
      "Barcode": "sample string 4",
      "Result": "sample string 5",
      "Reason": "sample string 6",
      "IsCustomPanel": true,
      "ShippingLabel": "sample string 8",
      "First": "sample string 9",
      "Last": "sample string 10"
    },
    {
      "Id": 1,
      "OffsiteOrderId": 1,
      "CollectionType": "sample string 2",
      "Status": "sample string 3",
      "CollectionId": 1,
      "Barcode": "sample string 4",
      "Result": "sample string 5",
      "Reason": "sample string 6",
      "IsCustomPanel": true,
      "ShippingLabel": "sample string 8",
      "First": "sample string 9",
      "Last": "sample string 10"
    }
  ],
  "RoundTrip": true,
  "StartAddress": {
    "Address1": "sample string 1",
    "Address2": "sample string 2",
    "City": "sample string 3",
    "State": "sample string 4",
    "Zip": "sample string 5"
  },
  "EndAddress": {
    "Address1": "sample string 1",
    "Address2": "sample string 2",
    "City": "sample string 3",
    "State": "sample string 4",
    "Zip": "sample string 5"
  },
  "StartOdometer": 1,
  "ArrivedDate": "2024-11-14T15:13:35.9855389+00:00"
}

application/xml, text/xml

Sample: 
<OrderDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Avertest.Aversys.DataLayer.Offsite">
  <ArrivedDate>2024-11-14T15:13:35.9855389+00:00</ArrivedDate>
  <DonorId>1</DonorId>
  <EndAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/Avertest.Aversys.DataLayer.Helper">
    <d2p1:Address1>sample string 1</d2p1:Address1>
    <d2p1:Address2>sample string 2</d2p1:Address2>
    <d2p1:City>sample string 3</d2p1:City>
    <d2p1:State>sample string 4</d2p1:State>
    <d2p1:Zip>sample string 5</d2p1:Zip>
  </EndAddress>
  <OrderId>1</OrderId>
  <Panels>
    <PanelModel>
      <Barcode>sample string 4</Barcode>
      <CollectionId>1</CollectionId>
      <CollectionType>sample string 2</CollectionType>
      <First>sample string 9</First>
      <Id>1</Id>
      <IsCustomPanel>true</IsCustomPanel>
      <Last>sample string 10</Last>
      <OffsiteOrderId>1</OffsiteOrderId>
      <Reason>sample string 6</Reason>
      <Result>sample string 5</Result>
      <ShippingLabel>sample string 8</ShippingLabel>
      <Status>sample string 3</Status>
    </PanelModel>
    <PanelModel>
      <Barcode>sample string 4</Barcode>
      <CollectionId>1</CollectionId>
      <CollectionType>sample string 2</CollectionType>
      <First>sample string 9</First>
      <Id>1</Id>
      <IsCustomPanel>true</IsCustomPanel>
      <Last>sample string 10</Last>
      <OffsiteOrderId>1</OffsiteOrderId>
      <Reason>sample string 6</Reason>
      <Result>sample string 5</Result>
      <ShippingLabel>sample string 8</ShippingLabel>
      <Status>sample string 3</Status>
    </PanelModel>
  </Panels>
  <RoundTrip>true</RoundTrip>
  <ShippingLabel>sample string 1</ShippingLabel>
  <StartAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/Avertest.Aversys.DataLayer.Helper">
    <d2p1:Address1>sample string 1</d2p1:Address1>
    <d2p1:Address2>sample string 2</d2p1:Address2>
    <d2p1:City>sample string 3</d2p1:City>
    <d2p1:State>sample string 4</d2p1:State>
    <d2p1:Zip>sample string 5</d2p1:Zip>
  </StartAddress>
  <StartOdometer>1</StartOdometer>
</OrderDetails>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'OrderDetails'.

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample: 
"sample string 1"

application/xml, text/xml

Sample: 
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>