---
updatedAt: 2025-04-24T20:27:59.000Z
agentTools:
  projectIndex: https://api-docs.shippedsuite.com/llms.txt
---

# /v1/reversals

Creates or updates a Reversal

# 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": "Reversals",
      "description": "Operations about Reversals"
    }
  ],
  "paths": {
    "/v1/reversals": {
      "post": {
        "tags": [
          "Reversals"
        ],
        "description": "Creates or updates a Reversal",
        "operationId": "postV1Reversals",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/postV1Reversals"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Creates or updates a Reversal",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Reversal"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "postV1Reversals"
      }
    }
  },
  "components": {
    "schemas": {
      "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"
      },
      "Reversal": {
        "required": [
          "external_id",
          "reversal_adjustments",
          "reversal_items"
        ],
        "type": "object",
        "properties": {
          "external_id": {
            "type": "string",
            "description": "Unique ID of Reversal in partner platform",
            "example": "60297622"
          },
          "notes": {
            "type": "string",
            "description": "Notes related to the Reversal",
            "example": "Customer received damaged item"
          },
          "reversal_items": {
            "type": "array",
            "description": "Collection of ReversalItems belonging to the Reversal",
            "items": {
              "$ref": "#/components/schemas/ReversalItem"
            }
          },
          "reversal_adjustments": {
            "type": "array",
            "description": "Collection of ReversalAdjustments belonging to the Reversal",
            "items": {
              "$ref": "#/components/schemas/ReversalAdjustment"
            }
          }
        },
        "description": "Reversal model"
      },
      "ReversalItem": {
        "required": [
          "external_id",
          "external_order_item_id",
          "quantity",
          "subtotal",
          "tax",
          "unit_price"
        ],
        "type": "object",
        "properties": {
          "external_id": {
            "type": "string",
            "description": "Unique ID of ReversalItem in partner platform",
            "example": "769209090444"
          },
          "external_order_item_id": {
            "type": "string",
            "description": "Unique ID of ReversalItem's OrderItem in partner platform",
            "example": "10312518631616"
          },
          "quantity": {
            "type": "integer",
            "description": "Quantity of OrderItem in ReversalItem",
            "format": "int32",
            "example": 1
          },
          "unit_price": {
            "type": "number",
            "description": "Unit price of ReversalItem in storefront default currency",
            "example": 140
          },
          "discount": {
            "type": "number",
            "description": "Total discount applied to ReversalItem (absolute value) in storefront default currency'\n",
            "example": 10
          },
          "tax": {
            "type": "number",
            "description": "Total tax applicable to ReversalItem 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 ReversalItem in the display currency (if different from default currency)\n",
            "allOf": [
              {
                "$ref": "#/components/schemas/Money"
              }
            ]
          },
          "display_discount": {
            "type": "object",
            "description": "Total discount applied to ReversalItem (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 ReversalItem 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"
              }
            ]
          }
        }
      },
      "ReversalAdjustment": {
        "required": [
          "amount",
          "category",
          "description",
          "external_id",
          "tax"
        ],
        "type": "object",
        "properties": {
          "external_id": {
            "type": "string",
            "description": "Unique ID of ReversalAdjustment in partner platform",
            "example": "55909293"
          },
          "category": {
            "type": "string",
            "description": "The type of ReversalAdjustment",
            "example": "shipping",
            "enum": [
              "shipping",
              "discount",
              "tip"
            ]
          },
          "description": {
            "type": "string",
            "description": "Description of the ReversalAdjustment",
            "example": "Priority (1-3 business days)"
          },
          "amount": {
            "type": "number",
            "description": "Value of the ReversalAdjustment in the storefront default currency",
            "example": 15
          },
          "tax": {
            "type": "number",
            "description": "Total tax applicable to ReversalAdjustment in the storefront default currency\n",
            "example": 1.29
          },
          "display_amount": {
            "type": "object",
            "description": "Value of the ReversalAdjustment in the display currency (if different from default currency)\n",
            "allOf": [
              {
                "$ref": "#/components/schemas/Money"
              }
            ]
          },
          "display_tax": {
            "type": "object",
            "description": "Total tax applicable to ReversalAdjustment in the display currency (if different from default currency)\n",
            "allOf": [
              {
                "$ref": "#/components/schemas/Money"
              }
            ]
          }
        }
      },
      "postV1Reversals": {
        "required": [
          "external_id",
          "external_order_id",
          "processed_at"
        ],
        "type": "object",
        "properties": {
          "external_order_id": {
            "type": "string",
            "description": "Unique ID of Order the Reversal belongs to in partner platform",
            "example": "308573"
          },
          "external_id": {
            "type": "string",
            "description": "Unique ID of Reversal in partner platform",
            "example": "790293"
          },
          "notes": {
            "type": "string",
            "description": "Notes related to the Reversal",
            "example": "Customer received damaged item"
          },
          "processed_at": {
            "type": "string",
            "description": "Date and time the Reversal was processed. RFC 3339.",
            "format": "date-time",
            "example": "2021-08-27T09:12:28Z"
          },
          "reversal_items": {
            "type": "array",
            "items": {
              "required": [
                "external_id",
                "external_order_item_id",
                "quantity",
                "tax",
                "unit_price"
              ],
              "type": "object",
              "properties": {
                "external_id": {
                  "type": "string",
                  "description": "Unique ID of ReversalItem in partner platform",
                  "example": "702780062"
                },
                "external_order_item_id": {
                  "type": "string",
                  "description": "Unique ID of ReversalItem's OrderItem in partner platform",
                  "example": "19884792"
                },
                "quantity": {
                  "type": "integer",
                  "description": "Quantity of OrderItem in ReversalItem",
                  "format": "int32",
                  "example": 1
                },
                "unit_price": {
                  "type": "number",
                  "description": "Unit price of ReversalItem in storefront default currency",
                  "format": "double",
                  "example": 140
                },
                "discount": {
                  "type": "number",
                  "description": "Total discount applied to ReversalItem (absolute value) in storefront default currency",
                  "format": "double",
                  "example": 10
                },
                "tax": {
                  "type": "number",
                  "description": "Total tax applicable to ReversalItem in storefront default currency",
                  "format": "double",
                  "example": 12.25
                },
                "display_unit_price": {
                  "type": "number",
                  "description": "Unit price of ReversalItem in display currency",
                  "format": "double",
                  "example": 700
                },
                "display_discount": {
                  "type": "number",
                  "description": "Total discount applied to ReversalItem (absolute value) in display currency",
                  "format": "double",
                  "example": 50
                },
                "display_tax": {
                  "type": "number",
                  "description": "Total tax applicable to ReversalItem in display currency",
                  "format": "double",
                  "example": 61.25
                }
              }
            }
          },
          "reversal_adjustments": {
            "type": "array",
            "items": {
              "required": [
                "amount",
                "category",
                "description",
                "external_id",
                "tax"
              ],
              "type": "object",
              "properties": {
                "external_id": {
                  "type": "string",
                  "description": "Unique ID of ReversalAdjustment in partner platform",
                  "example": "62000346"
                },
                "category": {
                  "type": "string",
                  "description": "The type of ReversalAdjustment",
                  "example": "shipping",
                  "enum": [
                    "shipping",
                    "discount",
                    "tip"
                  ]
                },
                "description": {
                  "type": "string",
                  "description": "Description of the ReversalAdjustment",
                  "example": "Priority (1-3 business days)"
                },
                "amount": {
                  "type": "number",
                  "description": "Dollar value of the ReversalAdjustment in storefront default currency",
                  "format": "double",
                  "example": 15
                },
                "tax": {
                  "type": "number",
                  "description": "Total tax applicable to ReversalAdjustment in storefront default currency",
                  "format": "double",
                  "example": 1.29
                },
                "display_amount": {
                  "type": "number",
                  "description": "Dollar value of the ReversalAdjustment in display currency",
                  "format": "double",
                  "example": 75
                },
                "display_tax": {
                  "type": "number",
                  "description": "Total tax applicable to ReversalAdjustment in display currency",
                  "format": "double",
                  "example": 6.45
                }
              }
            }
          }
        },
        "description": "Creates or updates a Reversal"
      }
    },
    "securitySchemes": {
      "secretKey": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    }
  },
  "x-original-swagger-version": "2.0"
}
```