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

# /v1/shipments/{external_shipment_id}/claim

Returns Claim for a Shipment

# 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": "Claims",
      "description": "Operations about Claims"
    }
  ],
  "paths": {
    "/v1/shipments/{external_shipment_id}/claim": {
      "get": {
        "tags": [
          "Claims"
        ],
        "description": "Returns Claim for a Shipment",
        "operationId": "getV1ShipmentsExternalShipmentIdClaim",
        "parameters": [
          {
            "name": "external_shipment_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns Claim for a Shipment",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Claim"
                }
              }
            }
          }
        }
      }
    }
  },
  "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"
      },
      "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"
              }
            ]
          }
        }
      },
      "Shipment": {
        "required": [
          "external_id",
          "shipment_items",
          "tracking_number"
        ],
        "type": "object",
        "properties": {
          "external_id": {
            "type": "string",
            "description": "Unique ID of Shipment in partner platform",
            "example": "9477990309572"
          },
          "tracking_number": {
            "type": "string",
            "description": "Tracking number associated with the Shipment",
            "example": "1Z71E8390396779841"
          },
          "shipment_items": {
            "type": "array",
            "description": "Collection of ShipmentItems belonging to the Shipment",
            "items": {
              "$ref": "#/components/schemas/ShipmentItem"
            }
          }
        },
        "description": "Shipment model"
      },
      "ShipmentItem": {
        "required": [
          "external_id",
          "external_order_item_id",
          "quantity"
        ],
        "type": "object",
        "properties": {
          "external_id": {
            "type": "string",
            "description": "Unique ID of ShipmentItem in partner platform",
            "example": "769209090444"
          },
          "external_order_item_id": {
            "type": "string",
            "description": "Unique ID of ShipmentItem's OrderItem in partner platform",
            "example": "10312518631616"
          },
          "quantity": {
            "type": "integer",
            "description": "Quantity of OrderItem in ShipmentItem",
            "format": "int32",
            "example": 1
          }
        }
      },
      "Claim": {
        "required": [
          "claim_items",
          "final_resolution_type",
          "number",
          "reason",
          "rejection_reason",
          "resolution_type",
          "resolved_at",
          "shipment",
          "status"
        ],
        "type": "object",
        "properties": {
          "number": {
            "type": "string",
            "description": "Unique Claim number",
            "example": "EEF-444323"
          },
          "reason": {
            "type": "string",
            "description": "The reason the Customer field a Claim",
            "example": "lost"
          },
          "note": {
            "type": "string",
            "description": "Additional notes provided by Customer regarding Claim",
            "example": "I have not received any tracking updates from FedEx for 2 weeks"
          },
          "status": {
            "type": "string",
            "description": "The current state of the Claim",
            "example": "approved",
            "enum": [
              "submitted",
              "need_more_information",
              "rejected",
              "approved",
              "invalidated"
            ]
          },
          "resolution_type": {
            "type": "string",
            "description": "Preferred type of resolution",
            "example": "replacement",
            "enum": [
              "manual",
              "refund",
              "store_credit",
              "replacement"
            ]
          },
          "rejection_reason": {
            "type": "string",
            "description": "The reason the Claim was rejected (if in rejected status)",
            "example": "Customer lied to us as proven by his own signature"
          },
          "final_resolution_type": {
            "type": "string",
            "description": "Type of resolution approved for this Claim",
            "example": "refund"
          },
          "resolved_at": {
            "type": "string",
            "description": "Date and time the Claim was approved or rejected. RFC 3339.",
            "format": "date-time"
          },
          "shipment": {
            "type": "object",
            "description": "Shipment the Claim is for",
            "allOf": [
              {
                "$ref": "#/components/schemas/Shipment"
              }
            ]
          },
          "claim_items": {
            "type": "array",
            "description": "Collection of ClaimItems belonging to the Order",
            "items": {
              "$ref": "#/components/schemas/ClaimItem"
            }
          }
        },
        "description": "Claim model"
      },
      "ClaimItem": {
        "required": [
          "order_item",
          "quantity"
        ],
        "type": "object",
        "properties": {
          "quantity": {
            "type": "integer",
            "description": "Quantity of OrderItem in ClaimItem",
            "format": "int32",
            "example": 2
          },
          "order_item": {
            "type": "array",
            "description": "OrderItem affected in this ClaimItem",
            "items": {
              "$ref": "#/components/schemas/OrderItem"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "secretKey": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    }
  },
  "x-original-swagger-version": "2.0"
}
```