GetOrderRefundHistory

Overview

Retrieve a history of all refunds issued on an order.

Request

Field Name

Data Type

Description

accountID

string

A unique identifier representing the ChannelAdvisor account you wish to access. This is required.

orderID

int

The ChannelAdvisor order identifier. This is required.

Response

Field Name

Data Type

Description

OrderID

int

The ChannelAdvisor order identifier.

ClientOrderIdentifier

string

The order number as seen in the ChannelAdvisor user interface.

RefundStatus

OrderRefundStatusCode

An enumeration indicating the types of refunds issued on the order:

  • NoRefunds
  • OrderLevel
  • LineItemLevel
  • OrderAndLineItemLevel
  • FailedAttemptsOnly

LineItemRefunds

OrderLineItemRefundHistoryResponse[]

An array containing the history of all refunds issued on the order.

XML Samples


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://api.channeladvisor.com/webservices/">
   <soapenv:Header>
      <web:APICredentials>
         <web:DeveloperKey>11111111-2222-3333-4444-555555555555</web:DeveloperKey>
         <web:Password>Password</web:Password>
      </web:APICredentials>
   </soapenv:Header>
   <soapenv:Body>
      <web:GetOrderRefundHistory>
         <web:accountID>66666666-7777-8888-9999-000000000000</web:accountID>
         <web:orderID>12345678</web:orderID>
      </web:GetOrderRefundHistory>
   </soapenv:Body>
</soapenv:Envelope>

References