Tickets Service Description

The following methods are available at the servlet path /rest/1.3/tickets
POST  /1.3/tickets/{receipt}
Create a ticket with the passed in parameters. Will return the created ticket if it's successful.

Return Type: TicketData

Request Parameters :

NameRequiredDescription
skufalsesku/itemNo of the line item. Used to identify individual purchase in multi-item cart purchase
typetrueThe type of the ticket. Must be either 'rfnd', 'cncl' or 'tech'. For 'rfnd' the parameter refundType must also be specified. If the receipt is for a non-recurring product, either 'rfnd' or 'cncl' will automatically refund that sale. For any receipt of a recurring product, a 'rfnd' will refund that receipt AND cancel any future billing, while a 'cncl' will only cancel future billing without issuing any refunds.
commentfalseThe comments associated with creating a ticket.
reasontrueThe reason associated with the ticket. A ticket reason should be one of the following based on type:

CNCL

  • ticket.type.cancel.1 (I did not receive additional value for the recurring payments).
  • ticket.type.cancel.2 (I was not satisfied with the subscription / Subscription did not meet expectations)
  • ticket.type.cancel.3 (I was unable to get support from the vendor)
  • ticket.type.cancel.4 (Product was not compatible with my computer)
  • ticket.type.cancel.5 (I am unable to afford continuing payments for this subscription)
  • ticket.type.cancel.6 (I did not realize that I accepted the terms for continuing payments)
  • ticket.type.cancel.7 (Other)
  • ticket.type.cancel.not.mobile (Product was not compatible with my mobile device.)

RFND

  • ticket.type.refund.1 (I never received my product)
  • ticket.type.refund.2 (I was not satisfied with the product. / Product did not meet expectations)
  • ticket.type.refund.3 (Product was not compatible with my computer)
  • ticket.type.refund.4 (I was unable to get technical support)
  • ticket.type.refund.5 (I did not authorize the purchase)
  • ticket.type.refund.6 (I do not recognize the purchase)
  • ticket.type.refund.7 (Duplicate purchase. / Or already purchased product previously)
  • ticket.type.refund.returned (Product returned)
  • ticket.type.refund.8 (Other)
  • ticket.type.refund.not.mobile (Product was not compatible with my mobile device.)

TECH

  • ticket.type.tech_support.1 (I am unable to log in.)
  • ticket.type.tech_support.2 (I had problems downloading the product.)
  • ticket.type.tech_support.3 (I never received a valid registration code, please send a valid code.)
  • ticket.type.tech_support.4 (I can't get the product to work.)
  • ticket.type.tech_support.9 (Other)
  • ticket.type.tech_support.10 (I never received my product.)
refundTypefalseThe type of refund. Supported values include 'FULL', 'PARTIAL_PERCENT', 'PARTIAL_AMOUNT' (case sensitive). For 'PARTIAL_PERCENT' and 'PARTIAL_AMOUNT' the parameter refundAmount must be specified. Additionally the vendor associated with the transaction must be enabled for partial refunds in order to use both 'PARTIAL_PERCENT' and 'PARTIAL_AMOUNT', if vendor is not enabled and one of the partial options is specified a 403 will be returned.
refundAmountfalseSpecified for partial refunds indicating the amount of the transaction to be refunded. For 'PARTIAL_PERCENT' this must be a number between 1 and 80, with no more than two digits of precision - for example 50.00. For 'PARTIAL_AMOUNT' this is the amount to refund in the currency the customer used during the purchase. The resource /1.3/tickets/refundAmounts may be used to retrieve what amounts in the customers currency convert to.
retainSubscriptionfalseSpecifies if the subscription should be retained after the refund has been processed

Supported Output Types : application/xml, application/json

Required Roles : api_order_write, HAS_DEVELOPER_KEY

GET  /1.3/tickets/refundAmounts/{receipt}
Returns amounts that would be refunded for a given refund type & value.

Return Type: PartialRefundData

Request Parameters :

NameRequiredDescription
skufalseline item sku/itemNo
refundTypetrueThe type of refund. Supported values include 'FULL', 'PARTIAL_PERCENT', 'PARTIAL_AMOUNT' (case sensitive). For 'PARTIAL_PERCENT' and 'PARTIAL_AMOUNT' the parameter refundAmount must be specified. Additionally the vendor associated with the transaction must be enabled for partial refunds in order to use both 'PARTIAL_PERCENT' and 'PARTIAL_AMOUNT', if vendor is not enabled and one of the partial options is specified a 403 will be returned.
refundAmounttrueSpecified for partial refunds indicating the amount of the transaction to be refunded. For 'PARTIAL_PERCENT' this must be a number between 1 and 80, with no more than two digits of precision - for example 50.00. For 'PARTIAL_AMOUNT' this is the amount to refund in the currency the customer used during the purchase.

Supported Output Types : application/xml, application/json

Required Roles : api_order_read

GET  /1.3/tickets/{id}
Find a ticket by its ID. Will return the ticket with the given ID back. If the ticket does not exist, or the user is not authorized to view the ticket - a status code of 403 will be returned.

Return Type: TicketData

Supported Output Types : application/xml, application/json

Required Roles : api_order_read, HAS_DEVELOPER_KEY

PUT  /1.3/tickets/{id}
Allows the user to close a ticket, comment on a ticket, change type of a ticket, or reopen the ticket. Will return a status code 200 if the action is successful, a 403 if user is not allowed to act on the ticket or the ticket does not exist. Upon success, this will return the ticket data. Please note that closing of a ticket manually means that the ticket is cancelled. So for example closing of an open refund ticket will cancel the refund request. If the action is not specified, the assumption is that the user is trying to comment on the ticket. Also note that reopening is only supported for closed tickets and will return a 400 status code otherwise.

Return Type: TicketData

Request Parameters :

NameRequiredDescription
actionfalseThe action to be taken. Supported actions are 'change', 'close' and 'reopen'.
commentfalseThe comments that go along with the action, or comments on the ticket. Comments are required when reopening a ticket.
typefalseIf changing the type of the ticket, this will be one of rfnd, cncl, or tech. Note: Partial refunds are not allowed when changing to a rfnd ticket type. Tickets changed to rfnd will be full refunds.

Supported Output Types : application/xml, application/json

Required Roles : api_order_write, HAS_DEVELOPER_KEY

POST  /1.3/tickets/{id}/returned
Acknowledges return of physical item from customer, allowing refund of transaction to complete. This call will return a status code of 204 if successful. The body of the response will be empty in this case. A 403 (Forbidden) status code will be return if access is denied. A 400 (Bad Request) will be returned if the ticket isn't found or the ticket is not for a physical purchase.

Return Type: ShipNotice

Supported Output Types : application/xml, application/json

Required Roles : api_order_read, api_order_write, HAS_DEVELOPER_KEY

GET  /1.3/tickets/list
Searches for tickets matching the search criteria. Will return a list of ticket data objects with a status code of 200. If more than 100 results are returned, it will return a status code of 206 [Partial Content]. Users can then use the 'Page' header to determine the page needed.

Return Type: List of TicketDatas

Request Parameters :

NameRequiredDescription
typefalseThe type of the ticket. Must be either 'rfnd' / 'cncl' or 'tech'
statusfalseThe status of the ticket. Can be 'open', 'reopened' or 'closed'
receiptfalseFind a ticket by a given receipt. Will return the ticket(s) associated with the transaction. If the receipt is a subscription, all tickets with associated with each rebill of that subscription will be returned. Must be 4 or more characters in length, not counting the wildcard character ('%'). May not start with the wildcard character.
createDateFromfalseThe start of the createDate range to filter tickets by. If you provide a 'createDateFrom', you must also provide a 'createDateTo' to complete the date range. The range cannot be more than 7 days in length. Dates must be in the format 'yyyy-mm-dd', i.e '2011-12-31' for December 31st, 2011.
createDateTofalseThe end of the createDate range to filter tickets by. If you provide a 'createDateTo', you must also provide a 'createDateFrom' to complete the date range. The range cannot be more than 7 days in length. Dates must be in the format 'yyyy-mm-dd', i.e '2011-12-31' for December 31st, 2011.
updateDateFromfalseThe start of the updateDate range to filter tickets by. If you provide a 'updateDateFrom', you must also provide a 'updateDateTo' to complete the date range. The range cannot be more than 7 days in length. Dates must be in the format 'yyyy-mm-dd', i.e '2011-12-31' for December 31st, 2011.
updateDateTofalseThe end of the updateDate range to filter tickets by. If you provide a 'updateDateTo', you must also provide a 'updateDateFrom' to complete the date range. The range cannot be more than 7 days in length. Dates must be in the format 'yyyy-mm-dd', i.e '2011-12-31' for December 31st, 2011.
closeDateFromfalseThe start of the closeDate range to filter tickets by. If you provide a 'closeDateFrom', you must also provide a 'closeDateTo' to complete the date range. The range cannot be more than 7 days in length. Dates must be in the format 'yyyy-mm-dd', i.e '2011-12-31' for December 31st, 2011.
closeDateTofalseThe end of the closeDate range to filter tickets by. If you provide a 'closeDateTo', you must also provide a 'closeDateFrom' to complete the date range. The range cannot be more than 7 days in length. Dates must be in the format 'yyyy-mm-dd', i.e '2011-12-31' for December 31st, 2011.

Required Roles : api_order_read, HAS_DEVELOPER_KEY

GET  /1.3/tickets/count
Counts the tickets matching the search criteria.

Return Type: Count of matching tickets

Request Parameters :

NameRequiredDescription
typefalseThe type of the ticket. Must be either 'rfnd' / 'cncl' or 'tech'
statusfalseThe status of the ticket. Can be 'open', 'reopened' or 'closed'
receiptfalseCounts a ticket by a given receipt. Will return the ticket(s) associated with the transaction. If the receipt is a subscription, all tickets with associated with each rebill of that subscription will be counted.

Required Roles : api_order_read, HAS_DEVELOPER_KEY

GET  /1.3/tickets/partialRefundDataSchema
Return Type: null

Supported Output Types : application/xml

GET  /1.3/tickets/schema
Returns the XML Schema that describes the format of a TicketData object

Supported Output Types : application/xml