cancelOrder

Due to Rye requiring Amazon Business accounts be connected to Rye via Amazon's app marketplace, this mutation has been deprecated and will be removed in the future. Cancellations can be handled via your Amazon Business account. See our Connecting your Amazon Business account on how to connect your Amazon Business account to Rye

Arguments

path inputCancelOrderInput!required

The input object contains the orderId.

Returns

path CancelOrderResponse.*CancelOrderResponse!

Any requested field from the CancelOrderResponse object.

Example - request

Query arguments

12345{
  "input": {
    "orderId": "orderId-123-456-789"
  }
}

GraphQL

123456789101112mutation ($input: CancelOrderInput!) {
  cancelOrder(input:$input){
    result {
      ... on CancelAmazonOrderResult { items { amazonOrderId, status, failReason } }
      ... on CancelShopifyOrderResult { status }
    }
    error {
      message
      code
    }
  }
}

Calling the endpoint initiates a cancellation attempt. Response below is an example response for an amazon order

Example - response

Response

12345678910111213141516{
  "data": {
    "cancelOrder": {
      "result": {
        "items": [
          {
            "amazonOrderId": "111-9474033-3741041",
            "status": "CANCEL_PROCESSING",
            "failReason": null
          }
        ]
      },
      "error": null
    }
  }
}

Errors

If a cancellation request has a status CANCEL_FAILED the payload would look like below:

Response

12345678910111213141516{
  "data": {
    "cancelOrder": {
      "result": {
        "items": [
          {
            "amazonOrderId": "111-9474033-3741041",
            "status": "CANCEL_FAILED",
            "failReason": "Error attempting to request cancellation"
          }
        ]
      },
      "error": null
    }
  }
}

The error field will display errors not related to actual status of a cancellation request.

Response

1234567891011{
  "data": {
    "cancelOrder": {
      "result": [],
      "error": {
        "message": "There was a problem cancelling this order. Contact Rye to cancel the order manually.",
        "code": "REQUEST_MANUAL_CANCELLATION"
      },
    }
  }
}