Refund
POST /v2/b2b/b2b/refunds
Body
A Refund Input JSON Object
Response
A Refund Result JSON Object
JSON Objects
Refund Input JSON Object
Field | Description | Notes |
|---|---|---|
| orderId | The id of the order being refunded or partially refunded. | |
| incidentReasonCode | The reason for the refund, one of (Cancelled Event or Miscellaneous). | |
| notes | Any notes about the refund. | |
| noEmail | Set to true if you don't want to send the customer an email about the refund. Default is to send the refund email | |
| refundItems | The list of items being refunded. | |
| refundItems[x].orderItemId | The order item id of the item being refunded. | |
| refundItems[x].quantity | The number of items being refunded. | |
| refundItems[x].incidentReasonCode | The reason for refunding this item, one of (Cancelled Event or Miscellaneous). |
Refund Result JSON Object
Field | Description | Notes |
|---|---|---|
| incidentNumber | A unique id representing this refund transaction. | |
| refundAmount | The amount that was refunded. | |
| order | The resulting Order JSON Object after the refund. | See Orders |
| refundedEvents | A list of events refunded. | |
| refundedEvents[x].startDate | The date that the event was to occur. | |
| refundedEvents[x].startTime | The start time of the event. | |
| refundedEvents[x].eventName | The name of the event. | |
| refundedEvents[x].refundedItems | The list of items being refunded for this event. | |
| refundedEvents[x].refundedItems[y].ticketType | The name of the ticket type being refunded. | |
| refundedEvents[x].refundedItems[y].pricePerTicket | The price per ticket. | |
| refundedEvents[x].refundedItems[y].refundedCount | The number of tickets refunded. | |
| refundedEvents[x].refundedItems[y].totalRefunded | The total amount refunded for this event, ticket type combination. |