POST Subscriber/{subscriberId}/order/{orderId}/return

Returns an order

Request Information

URI Parameters

Name	Description	Type	Additional information
orderId		integer	Required
subscriberId		string	None.

Body Parameters

ReturnOrderRequest

Name	Type	Additional information
OrderId	integer	None.
Reason	string	None.
RefundDate	date	None.
ReplenishInventory	boolean	None.
LocationId	integer	None.
OrderPaymentRefundRequests	Collection of OrderPaymentRefundRequest	None.
OrderItemReturnRequests	Collection of OrderItemReturnRequest	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderId": 1,
  "Reason": "sample string 2",
  "RefundDate": "2025-01-17T21:00:43.6117957-08:00",
  "ReplenishInventory": true,
  "LocationId": 5,
  "OrderPaymentRefundRequests": [
    {
      "PaymentMethodType": "sample string 1",
      "PaymentMethodId": 2,
      "RefundPaymentMethodIdentifier": "sample string 3",
      "Amount": 4.0
    },
    {
      "PaymentMethodType": "sample string 1",
      "PaymentMethodId": 2,
      "RefundPaymentMethodIdentifier": "sample string 3",
      "Amount": 4.0
    }
  ],
  "OrderItemReturnRequests": [
    {
      "OrderItemId": 1
    },
    {
      "OrderItemId": 1
    }
  ]
}

application/xml, text/xml

Sample:

<ReturnOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mindbody.Contract.MarketplacePayments.Requests">
  <LocationId>5</LocationId>
  <OrderId>1</OrderId>
  <OrderItemReturnRequests>
    <OrderItemReturnRequest>
      <OrderItemId>1</OrderItemId>
    </OrderItemReturnRequest>
    <OrderItemReturnRequest>
      <OrderItemId>1</OrderItemId>
    </OrderItemReturnRequest>
  </OrderItemReturnRequests>
  <OrderPaymentRefundRequests>
    <OrderPaymentRefundRequest>
      <Amount>4</Amount>
      <PaymentMethodId>2</PaymentMethodId>
      <PaymentMethodType>sample string 1</PaymentMethodType>
      <RefundPaymentMethodIdentifier>sample string 3</RefundPaymentMethodIdentifier>
    </OrderPaymentRefundRequest>
    <OrderPaymentRefundRequest>
      <Amount>4</Amount>
      <PaymentMethodId>2</PaymentMethodId>
      <PaymentMethodType>sample string 1</PaymentMethodType>
      <RefundPaymentMethodIdentifier>sample string 3</RefundPaymentMethodIdentifier>
    </OrderPaymentRefundRequest>
  </OrderPaymentRefundRequests>
  <Reason>sample string 2</Reason>
  <RefundDate>2025-01-17T21:00:43.6117957-08:00</RefundDate>
  <ReplenishInventory>true</ReplenishInventory>
</ReturnOrderRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ReturnOrderResponse

Name	Description	Type	Additional information
OrderId		integer	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderId": 1
}

application/xml, text/xml

Sample:

<ReturnOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mindbody.Contract.MarketplacePayments.Requests">
  <OrderId>1</OrderId>
</ReturnOrderResponse>