GET api/disDispute/Instances

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of DisputeInstanceSummary
NameDescriptionTypeAdditional information
InstanceID

integer

None.

CarrierID

integer

None.

CarrierName

string

None.

Status

string

None.

ChargesCount

integer

None.

DisputeAmount

decimal number

None.

BatchesCount

integer

None.

CreatedBy

integer

None.

PersonName

string

None.

CreatedDate

date

None.

UpdatedBy

integer

None.

UpdatedDate

date

None.

Charges

Collection of DisputeInstanceChargesSummary

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "InstanceID": 1,
    "CarrierID": 2,
    "CarrierName": "sample string 3",
    "Status": "sample string 4",
    "ChargesCount": 5,
    "DisputeAmount": 6.0,
    "BatchesCount": 7,
    "CreatedBy": 8,
    "PersonName": "sample string 9",
    "CreatedDate": "2025-12-06T23:41:29.9537566+00:00",
    "UpdatedBy": 11,
    "UpdatedDate": "2025-12-06T23:41:29.9537566+00:00",
    "Charges": [
      {
        "RatedChargeID": 1,
        "Status": "sample string 2",
        "TrackingNumber": "sample string 3",
        "ExternalServiceMethod": "sample string 4",
        "DateShipped": "2025-12-06T23:41:29.9537566+00:00",
        "InvoiceNumber": "sample string 6",
        "InvoiceCreatedDate": "2025-12-06T23:41:29.9537566+00:00",
        "ChargeDescription": "sample string 8",
        "ReRateDiscountRate": 1.0,
        "DisputeAmount": 1.0,
        "Note": "sample string 9",
        "BilledWeight": 1.0,
        "Length": 1,
        "Width": 1,
        "Height": 1,
        "ExpectedLength": 1,
        "ExpectedWidth": 1,
        "ExpectedHeight": 1,
        "ConsigneeAddress1": "sample string 10",
        "ConsigneeAddress2": "sample string 11",
        "ConsigneeCity": "sample string 12",
        "ConsigneeStateProvince": "sample string 13",
        "ConsigneePostalCode": "sample string 14",
        "ConsigneeCountry": "sample string 15"
      },
      {
        "RatedChargeID": 1,
        "Status": "sample string 2",
        "TrackingNumber": "sample string 3",
        "ExternalServiceMethod": "sample string 4",
        "DateShipped": "2025-12-06T23:41:29.9537566+00:00",
        "InvoiceNumber": "sample string 6",
        "InvoiceCreatedDate": "2025-12-06T23:41:29.9537566+00:00",
        "ChargeDescription": "sample string 8",
        "ReRateDiscountRate": 1.0,
        "DisputeAmount": 1.0,
        "Note": "sample string 9",
        "BilledWeight": 1.0,
        "Length": 1,
        "Width": 1,
        "Height": 1,
        "ExpectedLength": 1,
        "ExpectedWidth": 1,
        "ExpectedHeight": 1,
        "ConsigneeAddress1": "sample string 10",
        "ConsigneeAddress2": "sample string 11",
        "ConsigneeCity": "sample string 12",
        "ConsigneeStateProvince": "sample string 13",
        "ConsigneePostalCode": "sample string 14",
        "ConsigneeCountry": "sample string 15"
      }
    ]
  },
  {
    "InstanceID": 1,
    "CarrierID": 2,
    "CarrierName": "sample string 3",
    "Status": "sample string 4",
    "ChargesCount": 5,
    "DisputeAmount": 6.0,
    "BatchesCount": 7,
    "CreatedBy": 8,
    "PersonName": "sample string 9",
    "CreatedDate": "2025-12-06T23:41:29.9537566+00:00",
    "UpdatedBy": 11,
    "UpdatedDate": "2025-12-06T23:41:29.9537566+00:00",
    "Charges": [
      {
        "RatedChargeID": 1,
        "Status": "sample string 2",
        "TrackingNumber": "sample string 3",
        "ExternalServiceMethod": "sample string 4",
        "DateShipped": "2025-12-06T23:41:29.9537566+00:00",
        "InvoiceNumber": "sample string 6",
        "InvoiceCreatedDate": "2025-12-06T23:41:29.9537566+00:00",
        "ChargeDescription": "sample string 8",
        "ReRateDiscountRate": 1.0,
        "DisputeAmount": 1.0,
        "Note": "sample string 9",
        "BilledWeight": 1.0,
        "Length": 1,
        "Width": 1,
        "Height": 1,
        "ExpectedLength": 1,
        "ExpectedWidth": 1,
        "ExpectedHeight": 1,
        "ConsigneeAddress1": "sample string 10",
        "ConsigneeAddress2": "sample string 11",
        "ConsigneeCity": "sample string 12",
        "ConsigneeStateProvince": "sample string 13",
        "ConsigneePostalCode": "sample string 14",
        "ConsigneeCountry": "sample string 15"
      },
      {
        "RatedChargeID": 1,
        "Status": "sample string 2",
        "TrackingNumber": "sample string 3",
        "ExternalServiceMethod": "sample string 4",
        "DateShipped": "2025-12-06T23:41:29.9537566+00:00",
        "InvoiceNumber": "sample string 6",
        "InvoiceCreatedDate": "2025-12-06T23:41:29.9537566+00:00",
        "ChargeDescription": "sample string 8",
        "ReRateDiscountRate": 1.0,
        "DisputeAmount": 1.0,
        "Note": "sample string 9",
        "BilledWeight": 1.0,
        "Length": 1,
        "Width": 1,
        "Height": 1,
        "ExpectedLength": 1,
        "ExpectedWidth": 1,
        "ExpectedHeight": 1,
        "ConsigneeAddress1": "sample string 10",
        "ConsigneeAddress2": "sample string 11",
        "ConsigneeCity": "sample string 12",
        "ConsigneeStateProvince": "sample string 13",
        "ConsigneePostalCode": "sample string 14",
        "ConsigneeCountry": "sample string 15"
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfDisputeInstanceSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Tables">
  <DisputeInstanceSummary>
    <BatchesCount>7</BatchesCount>
    <CarrierID>2</CarrierID>
    <CarrierName>sample string 3</CarrierName>
    <Charges>
      <DisputeInstanceChargesSummary>
        <BilledWeight>1</BilledWeight>
        <ChargeDescription>sample string 8</ChargeDescription>
        <ConsigneeAddress1>sample string 10</ConsigneeAddress1>
        <ConsigneeAddress2>sample string 11</ConsigneeAddress2>
        <ConsigneeCity>sample string 12</ConsigneeCity>
        <ConsigneeCountry>sample string 15</ConsigneeCountry>
        <ConsigneePostalCode>sample string 14</ConsigneePostalCode>
        <ConsigneeStateProvince>sample string 13</ConsigneeStateProvince>
        <DateShipped xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2025-12-06T23:41:29.9537566Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </DateShipped>
        <DisputeAmount>1</DisputeAmount>
        <ExpectedHeight>1</ExpectedHeight>
        <ExpectedLength>1</ExpectedLength>
        <ExpectedWidth>1</ExpectedWidth>
        <ExternalServiceMethod>sample string 4</ExternalServiceMethod>
        <Height>1</Height>
        <InvoiceCreatedDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2025-12-06T23:41:29.9537566Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </InvoiceCreatedDate>
        <InvoiceNumber>sample string 6</InvoiceNumber>
        <Length>1</Length>
        <Note>sample string 9</Note>
        <RatedChargeID>1</RatedChargeID>
        <ReRateDiscountRate>1</ReRateDiscountRate>
        <Status>sample string 2</Status>
        <TrackingNumber>sample string 3</TrackingNumber>
        <Width>1</Width>
      </DisputeInstanceChargesSummary>
      <DisputeInstanceChargesSummary>
        <BilledWeight>1</BilledWeight>
        <ChargeDescription>sample string 8</ChargeDescription>
        <ConsigneeAddress1>sample string 10</ConsigneeAddress1>
        <ConsigneeAddress2>sample string 11</ConsigneeAddress2>
        <ConsigneeCity>sample string 12</ConsigneeCity>
        <ConsigneeCountry>sample string 15</ConsigneeCountry>
        <ConsigneePostalCode>sample string 14</ConsigneePostalCode>
        <ConsigneeStateProvince>sample string 13</ConsigneeStateProvince>
        <DateShipped xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2025-12-06T23:41:29.9537566Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </DateShipped>
        <DisputeAmount>1</DisputeAmount>
        <ExpectedHeight>1</ExpectedHeight>
        <ExpectedLength>1</ExpectedLength>
        <ExpectedWidth>1</ExpectedWidth>
        <ExternalServiceMethod>sample string 4</ExternalServiceMethod>
        <Height>1</Height>
        <InvoiceCreatedDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2025-12-06T23:41:29.9537566Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </InvoiceCreatedDate>
        <InvoiceNumber>sample string 6</InvoiceNumber>
        <Length>1</Length>
        <Note>sample string 9</Note>
        <RatedChargeID>1</RatedChargeID>
        <ReRateDiscountRate>1</ReRateDiscountRate>
        <Status>sample string 2</Status>
        <TrackingNumber>sample string 3</TrackingNumber>
        <Width>1</Width>
      </DisputeInstanceChargesSummary>
    </Charges>
    <ChargesCount>5</ChargesCount>
    <CreatedBy>8</CreatedBy>
    <CreatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:41:29.9537566Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </CreatedDate>
    <DisputeAmount>6</DisputeAmount>
    <InstanceID>1</InstanceID>
    <PersonName>sample string 9</PersonName>
    <Status>sample string 4</Status>
    <UpdatedBy>11</UpdatedBy>
    <UpdatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:41:29.9537566Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </UpdatedDate>
  </DisputeInstanceSummary>
  <DisputeInstanceSummary>
    <BatchesCount>7</BatchesCount>
    <CarrierID>2</CarrierID>
    <CarrierName>sample string 3</CarrierName>
    <Charges>
      <DisputeInstanceChargesSummary>
        <BilledWeight>1</BilledWeight>
        <ChargeDescription>sample string 8</ChargeDescription>
        <ConsigneeAddress1>sample string 10</ConsigneeAddress1>
        <ConsigneeAddress2>sample string 11</ConsigneeAddress2>
        <ConsigneeCity>sample string 12</ConsigneeCity>
        <ConsigneeCountry>sample string 15</ConsigneeCountry>
        <ConsigneePostalCode>sample string 14</ConsigneePostalCode>
        <ConsigneeStateProvince>sample string 13</ConsigneeStateProvince>
        <DateShipped xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2025-12-06T23:41:29.9537566Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </DateShipped>
        <DisputeAmount>1</DisputeAmount>
        <ExpectedHeight>1</ExpectedHeight>
        <ExpectedLength>1</ExpectedLength>
        <ExpectedWidth>1</ExpectedWidth>
        <ExternalServiceMethod>sample string 4</ExternalServiceMethod>
        <Height>1</Height>
        <InvoiceCreatedDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2025-12-06T23:41:29.9537566Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </InvoiceCreatedDate>
        <InvoiceNumber>sample string 6</InvoiceNumber>
        <Length>1</Length>
        <Note>sample string 9</Note>
        <RatedChargeID>1</RatedChargeID>
        <ReRateDiscountRate>1</ReRateDiscountRate>
        <Status>sample string 2</Status>
        <TrackingNumber>sample string 3</TrackingNumber>
        <Width>1</Width>
      </DisputeInstanceChargesSummary>
      <DisputeInstanceChargesSummary>
        <BilledWeight>1</BilledWeight>
        <ChargeDescription>sample string 8</ChargeDescription>
        <ConsigneeAddress1>sample string 10</ConsigneeAddress1>
        <ConsigneeAddress2>sample string 11</ConsigneeAddress2>
        <ConsigneeCity>sample string 12</ConsigneeCity>
        <ConsigneeCountry>sample string 15</ConsigneeCountry>
        <ConsigneePostalCode>sample string 14</ConsigneePostalCode>
        <ConsigneeStateProvince>sample string 13</ConsigneeStateProvince>
        <DateShipped xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2025-12-06T23:41:29.9537566Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </DateShipped>
        <DisputeAmount>1</DisputeAmount>
        <ExpectedHeight>1</ExpectedHeight>
        <ExpectedLength>1</ExpectedLength>
        <ExpectedWidth>1</ExpectedWidth>
        <ExternalServiceMethod>sample string 4</ExternalServiceMethod>
        <Height>1</Height>
        <InvoiceCreatedDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2025-12-06T23:41:29.9537566Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </InvoiceCreatedDate>
        <InvoiceNumber>sample string 6</InvoiceNumber>
        <Length>1</Length>
        <Note>sample string 9</Note>
        <RatedChargeID>1</RatedChargeID>
        <ReRateDiscountRate>1</ReRateDiscountRate>
        <Status>sample string 2</Status>
        <TrackingNumber>sample string 3</TrackingNumber>
        <Width>1</Width>
      </DisputeInstanceChargesSummary>
    </Charges>
    <ChargesCount>5</ChargesCount>
    <CreatedBy>8</CreatedBy>
    <CreatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:41:29.9537566Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </CreatedDate>
    <DisputeAmount>6</DisputeAmount>
    <InstanceID>1</InstanceID>
    <PersonName>sample string 9</PersonName>
    <Status>sample string 4</Status>
    <UpdatedBy>11</UpdatedBy>
    <UpdatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:41:29.9537566Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </UpdatedDate>
  </DisputeInstanceSummary>
</ArrayOfDisputeInstanceSummary>