Order Refunds

V1

The Refunds endpoint allows products to be refunded.


Endpoints

Verb Endpoint Description
POST /v1/orders/token-{token}/refunds Refund an order in full or partial
POST /v1/orders/{orderId}/payments/{lineNumber}/refunds Retry a failed order tender refund
POST /v1/orders/{orderId}/products/{lineNumber}/refunds Retry a failed order item refund
GET v1/refund-windows Get the vendor lead times for refundable products
GET v1/orders/token-{token}/will-call-check Returns the picked-up and refundable statuses for each order item

Examples

Refund the full order
POST  /v1/orders/token-8ada0d8e-25ff-4a35-aa82-1ff11098745a/refunds

Request

{
  "refundReasonName": "WrongTheatre"
}

Response

HTTP/1.1 200 OK
Refund the full order via self-service
POST  /v1/orders/token-8ada0d8e-25ff-4a35-aa82-1ff11098745a/refunds

Request

{
  "refundReasonName": "WrongTheatre",
  "selfService": "true"
}

Response

HTTP/1.1 200 OK
Refund the first 2 line items in the order
POST  /v1/orders/token-8ada0d8e-25ff-4a35-aa82-1ff11098745a/refunds

Request

{
  "refundReasonName": "WrongTheatre",
  "lineNumbers": [
    1,
    2
  ]
}

Response

HTTP/1.1 200 OK
Refund the first 2 line items and the first convenience fee in the order
POST  /v1/orders/token-8ada0d8e-25ff-4a35-aa82-1ff11098745a/refunds

Request

{
  "refundReasonName": "WrongTheatre",
  "lineNumbers": [
    1,
    2
  ],
  "convenienceFeeLineNumbers": [
    1
  ]
}

Response

HTTP/1.1 200 OK
Refund the first 2 line items in the order via self-service
POST  /v1/orders/token-8ada0d8e-25ff-4a35-aa82-1ff11098745a/refunds

Request

{
  "refundReasonName": "WrongTheatre",
  "selfService": "true",
  "lineNumbers": [
    1,
    2
  ]
}

Response

HTTP/1.1 200 OK
Retry a failed order tender refund
POST  /v1/orders/101992/payments/1/refunds

Response

HTTP/1.1 200 OK
Retry a failed order item refund
POST  /v1/orders/101992/products/1/refunds

Response

HTTP/1.1 200 OK
Get the refund window lead times
GET  v1/refund-windows

Response

{
  "refundWindows": [
    {
      "name": "Showtime",
      "leadTime": 10
    },
    {
      "name": "DeliveryToSeat",
      "leadTime": 15
    },
    {
      "name": "ExpressPickup",
      "leadTime": 20
    }
  ],
  "_links": {
    "self": {
      "href": "https://api.amctheatres.com/v1/refund-windows",
      "templated": false
    }
  }
}
Get the picked-up and refundable statuses for an order
GET  v1/orders/token-8ada0d8e-25ff-4a35-aa82-1ff11098745a/will-call-check

Response

{
  "lineItems": [
    {
      "lineNumber": 1,
      "refundable": true,
      "selfServiceRefundable": true,
      "pickedUp": false
    },
    {
      "lineNumber": 2,
      "refundable": false,
      "selfServiceRefundable": false,
      "pickedUp": false,
      "nonRefundableReason": "The product has already been refunded.",
      "nonSelfServiceRefundableReason": "The product has already been refunded."
    },
    {
      "lineNumber": 3,
      "refundable": true,
      "selfServiceRefundable": false,
      "pickedUp": false,
      "nonSelfServiceRefundableReason": "Specified order is past the refund window."
    }
  ],
  "_links": {
    "self": {
      "href": "https://api.amctheatres.com/v1/orders/token-8ada0d8e-25ff-4a35-aa82-1ff11098745a/will-call-check",
      "templated": false
    },
    "refund": {
      "href": "https://api.amctheatres.com/v1/orders/token-8ada0d8e-25ff-4a35-aa82-1ff11098745a/refunds",
      "templated": false
    }
  }
}