---
updatedAt: 2026-04-17T03:23:37.000Z
agentTools:
  projectIndex: https://api-docs.shippedsuite.com/llms.txt
---

# /v1/order_cancellations

Returns OrderCancellations

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Shipped Suite API",
    "description": "API provides access to Shipped Suite functions",
    "contact": {
      "name": "Steven Ou",
      "email": "steven@invisiblecommerce.com"
    },
    "version": "v1"
  },
  "servers": [
    {
      "url": "//api.shippedsuite.com/"
    }
  ],
  "security": [
    {
      "secretKey": []
    }
  ],
  "tags": [
    {
      "name": "Order Cancellations",
      "description": "Operations about Order Cancellations"
    }
  ],
  "paths": {
    "/v1/order_cancellations": {
      "get": {
        "tags": [
          "Order Cancellations"
        ],
        "description": "Returns OrderCancellations",
        "operationId": "getV1OrderCancellations",
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "description": "Page offset to fetch.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 1
            }
          },
          {
            "name": "per_page",
            "in": "query",
            "description": "Number of results to return per page.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 20
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "Pad a number of results.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 0
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns OrderCancellations",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/OrderCancellation"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Shield": {
        "required": [
          "display_fee",
          "fee",
          "payer_type"
        ],
        "type": "object",
        "properties": {
          "fee": {
            "type": "number",
            "description": "Shield fee for this Order in the storefront currency",
            "example": 0.97
          },
          "display_fee": {
            "type": "object",
            "description": "Shield fee for this order in the display currency",
            "allOf": [
              {
                "$ref": "#/components/schemas/Money"
              }
            ]
          },
          "payer_type": {
            "type": "string",
            "description": "Party responsible for payment",
            "example": "customer"
          }
        }
      },
      "Money": {
        "required": [
          "currency",
          "formatted",
          "subunits"
        ],
        "type": "object",
        "properties": {
          "currency": {
            "type": "object",
            "description": "Currency",
            "allOf": [
              {
                "$ref": "#/components/schemas/Currency"
              }
            ]
          },
          "subunits": {
            "type": "integer",
            "description": "The value in the currency's smallest unit",
            "format": "int32",
            "example": 4000
          },
          "formatted": {
            "type": "string",
            "description": "Formatted representation",
            "example": "€40,00"
          }
        }
      },
      "Currency": {
        "required": [
          "decimal_mark",
          "iso_code",
          "name",
          "subunit_to_unit",
          "symbol",
          "symbol_first",
          "thousands_separator"
        ],
        "type": "object",
        "properties": {
          "decimal_mark": {
            "type": "string",
            "description": "Symbol use to separate decimals",
            "example": "."
          },
          "symbol": {
            "type": "number",
            "description": "Currency symbol"
          },
          "symbol_first": {
            "type": "boolean",
            "description": "Whether to display the symbol before or after the number",
            "example": true
          },
          "thousands_separator": {
            "type": "string",
            "description": "Symbol used to separate each thousand units",
            "example": ","
          },
          "subunit_to_unit": {
            "type": "integer",
            "description": "The number of subunits to a unit",
            "format": "int32",
            "example": 100
          },
          "iso_code": {
            "type": "string",
            "description": "The ISO code for the Currency",
            "example": "USD"
          },
          "name": {
            "type": "string",
            "description": "The full name of the Currency",
            "example": "USD"
          }
        },
        "description": "Currency model"
      },
      "CarbonOffset": {
        "required": [
          "display_fee",
          "fee",
          "payer_type"
        ],
        "type": "object",
        "properties": {
          "fee": {
            "type": "number",
            "description": "Green fee for this Order in the storefront currency",
            "example": 0.97
          },
          "display_fee": {
            "type": "object",
            "description": "Green fee for this order in the display currency",
            "allOf": [
              {
                "$ref": "#/components/schemas/Money"
              }
            ]
          },
          "payer_type": {
            "type": "string",
            "description": "Party responsible for payment",
            "example": "customer"
          }
        }
      },
      "OrderItem": {
        "required": [
          "description",
          "external_id",
          "external_product_id",
          "external_variant_id",
          "quantity",
          "subtotal",
          "tax",
          "unit_price"
        ],
        "type": "object",
        "properties": {
          "external_id": {
            "type": "string",
            "description": "Unique ID of OrderItem in partner platform",
            "example": "10312518631616"
          },
          "external_product_id": {
            "type": "string",
            "description": "Unique ID of OrderItem's Product in partner platform",
            "example": "6584397299904"
          },
          "external_variant_id": {
            "type": "string",
            "description": "Unique ID of OrderItem's Variant in partner platform",
            "example": "39432474722496"
          },
          "sku": {
            "type": "string",
            "description": "SKU of the OrderItem's Variant",
            "example": "DN4155-001"
          },
          "description": {
            "type": "string",
            "description": "Description of the OrderItem's Variant",
            "example": "Nike Air Max 90 SE (Size: 9)"
          },
          "quantity": {
            "type": "integer",
            "description": "Quantity of Variant in OrderItem",
            "format": "int32",
            "example": 2
          },
          "unit_price": {
            "type": "number",
            "description": "Unit price of OrderItem in storefront default currency",
            "example": 140
          },
          "discount": {
            "type": "number",
            "description": "Total discount applied to OrderItem (absolute value) in storefront default currency'\n",
            "example": 10
          },
          "tax": {
            "type": "number",
            "description": "Total tax applicable to OrderItem in storefront default currency",
            "example": 12.25
          },
          "subtotal": {
            "type": "number",
            "description": "Quantity * unit_price (auto-calculated) in storefront default currency\n",
            "example": 280
          },
          "display_unit_price": {
            "type": "object",
            "description": "Unit price of OrderItem in the display currency (if different from default currency)\n",
            "allOf": [
              {
                "$ref": "#/components/schemas/Money"
              }
            ]
          },
          "display_discount": {
            "type": "object",
            "description": "Total discount applied to OrderItem (absolute value) in the display currency (if different from default currency)\n",
            "allOf": [
              {
                "$ref": "#/components/schemas/Money"
              }
            ]
          },
          "display_tax": {
            "type": "object",
            "description": "Total tax applicable to OrderItem in the display currency (if different from default currency)\n",
            "allOf": [
              {
                "$ref": "#/components/schemas/Money"
              }
            ]
          },
          "display_subtotal": {
            "type": "object",
            "description": "Quantity * unit_price (auto-calculated) in the display currency (if different from default currency)\n",
            "allOf": [
              {
                "$ref": "#/components/schemas/Money"
              }
            ]
          }
        }
      },
      "OrderCancellation": {
        "required": [
          "full_cancellation",
          "number",
          "order",
          "reason"
        ],
        "type": "object",
        "properties": {
          "number": {
            "type": "string",
            "description": "Unique OrderCancellation number",
            "example": "6198908680"
          },
          "reason": {
            "type": "string",
            "description": "The reason the OrderCancellation was requested",
            "example": "Shipping Too Slow",
            "enum": [
              "Pickup Order",
              "Buyer's Remorse",
              "Purchase Mistake",
              "No Longer Needed",
              "Shipping Too Slow",
              "Better Price Found",
              "Resolution Changed",
              "Other"
            ]
          },
          "full_cancellation": {
            "type": "boolean",
            "description": "Whether or not it is a full (vs partial) order cancellation",
            "example": false
          },
          "order": {
            "type": "object",
            "description": "Order associated with this OrderCancellation.",
            "allOf": [
              {
                "$ref": "#/components/schemas/OrderBasic"
              }
            ]
          },
          "order_cancellation_items": {
            "type": "array",
            "description": "Collection of OrderCancellationItems belonging to the OrderCancellation. Blank if full_cancellation is true.",
            "items": {
              "$ref": "#/components/schemas/OrderCancellationItem"
            }
          }
        },
        "description": "OrderCancellation model"
      },
      "OrderBasic": {
        "required": [
          "canceled_at",
          "carbon_offset",
          "email",
          "external_id",
          "fulfillment_status",
          "number",
          "payment_status",
          "placed_at",
          "shield",
          "shipped_id",
          "taxes_included"
        ],
        "type": "object",
        "properties": {
          "number": {
            "type": "string",
            "description": "Unique Order number",
            "example": "EEF-444323"
          },
          "shipped_id": {
            "type": "string",
            "description": "Globally-unique Shipped order ID",
            "example": "015DBC4801F2547DA2E6"
          },
          "email": {
            "type": "string",
            "description": "The email address associated with the Order",
            "example": "john.doe@shopper.com"
          },
          "external_id": {
            "type": "string",
            "description": "Unique ID of Order in partner platform",
            "example": "12443"
          },
          "placed_at": {
            "type": "string",
            "description": "Date and time the order was placed. RFC 3339.",
            "format": "date-time"
          },
          "canceled_at": {
            "type": "string",
            "description": "Date and time the order was canceled. RFC 3339.",
            "format": "date-time"
          },
          "payment_status": {
            "type": "string",
            "description": "The payment status of the Order",
            "example": "paid",
            "enum": [
              "authorized",
              "voided",
              "paid",
              "partially_paid",
              "refunded",
              "partially_refunded",
              "pending"
            ]
          },
          "fulfillment_status": {
            "type": "string",
            "description": "The fulfillment status of the Order",
            "example": "fulfilled",
            "enum": [
              "fulfilled",
              "in_progress",
              "on_hold",
              "open",
              "partially_fulfilled",
              "pending_fulfillment",
              "request_declined",
              "restocked",
              "scheduled",
              "unfulfilled"
            ]
          },
          "shield": {
            "type": "object",
            "description": "Shipped Shield details, if order is protected by Shipped Shield.",
            "allOf": [
              {
                "$ref": "#/components/schemas/Shield"
              }
            ]
          },
          "carbon_offset": {
            "type": "object",
            "description": "Shipped Green details, if order has Shipped Green carbon offset.",
            "allOf": [
              {
                "$ref": "#/components/schemas/CarbonOffset"
              }
            ]
          },
          "taxes_included": {
            "type": "boolean",
            "description": "Whether or not prices already include taxes"
          }
        }
      },
      "OrderCancellationItem": {
        "required": [
          "order_item",
          "quantity"
        ],
        "type": "object",
        "properties": {
          "quantity": {
            "type": "integer",
            "description": "Quantity of OrderItem in OrderCancellationItem",
            "format": "int32",
            "example": 2
          },
          "order_item": {
            "type": "array",
            "description": "OrderItem affected in this OrderCancellationItem",
            "items": {
              "$ref": "#/components/schemas/OrderItem"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "secretKey": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    }
  },
  "x-original-swagger-version": "2.0"
}
```