---
updatedAt: 2026-06-06T23:57:39.000Z
agentTools:
  projectIndex: https://docs.shipscience.com/llms.txt
---

# Create

Open a dispute against the claim's resolution with the carrier. Provide a
`reason` (e.g. "Proof of Delivery" or "Proof of Value") and a supporting
`note` — both are required, and a missing field returns `422`. Only one
active (pending or in-process) dispute may exist per claim at a time;
attempting to open a second also returns `422`. Optionally upload evidence
images (jpeg/png/tiff, max 3 per claim, 5 MB each) via `attachments[]`;
a disallowed or invalid image rolls back the dispute and returns `422`.


# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Shipscience API",
    "version": "v1",
    "description": "ShipScience's REST API for partners and customers.\n\n## Authentication\n\nMost endpoints require a bearer JWT in the `Authorization` header. Tokens\nare issued by the ShipScience login flow and are valid for 4 hours.\nClients are responsible for refreshing tokens before expiry. The\n`/api/v1/tokens` endpoint is an exception — it authenticates with the\n`api-key` header rather than a bearer JWT, since its purpose is to\nissue the JWT itself.\n\n## Partner endpoints\n\nThe **Sub Accounts** section is only available to accounts explicitly\nenabled as partners. If you receive `403 Forbidden`, contact\n**support@shipscience.com** to request access.\n"
  },
  "tags": [
    {
      "name": "SimpleClaim Disputes",
      "description": "Disputes opened against a claim's carrier resolution. List existing disputes\nfor a claim or open a new one with a `reason` and supporting `note`. Only one\nactive (pending or in-process) dispute may exist per claim at a time.\nThe parent claim is addressed by its id or tracking number.\n"
    }
  ],
  "paths": {
    "/api/v1/simple_claims/{tracking_number}/simple_claim_disputes": {
      "parameters": [
        {
          "name": "tracking_number",
          "in": "path",
          "description": "The claim's id or tracking number",
          "required": true,
          "schema": {
            "type": "string"
          }
        }
      ],
      "post": {
        "summary": "Create",
        "tags": [
          "SimpleClaim Disputes"
        ],
        "description": "Open a dispute against the claim's resolution with the carrier. Provide a\n`reason` (e.g. \"Proof of Delivery\" or \"Proof of Value\") and a supporting\n`note` — both are required, and a missing field returns `422`. Only one\nactive (pending or in-process) dispute may exist per claim at a time;\nattempting to open a second also returns `422`. Optionally upload evidence\nimages (jpeg/png/tiff, max 3 per claim, 5 MB each) via `attachments[]`;\na disallowed or invalid image rolls back the dispute and returns `422`.\n",
        "security": [
          {
            "bearer_auth": []
          }
        ],
        "parameters": [],
        "responses": {
          "201": {
            "description": "successful",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/simple_claim_dispute"
                }
              }
            }
          },
          "404": {
            "description": "claim not found"
          },
          "422": {
            "description": "unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/api_error"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "reason": {
                    "type": "string",
                    "example": "Proof of Delivery",
                    "description": "Why the claim resolution is being disputed."
                  },
                  "note": {
                    "type": "string",
                    "example": "Delivered on time per the carrier scan.",
                    "description": "Supporting detail for the dispute."
                  },
                  "attachments": {
                    "type": "array",
                    "description": "Optional evidence images (jpeg/png/tiff), max 3 per claim, 5 MB each.",
                    "items": {
                      "type": "string",
                      "format": "binary"
                    }
                  }
                },
                "required": [
                  "reason",
                  "note"
                ]
              }
            }
          },
          "required": true
        }
      }
    }
  },
  "components": {
    "schemas": {
      "simple_claim_dispute": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "scd_abc123",
            "description": "The dispute id."
          },
          "reason": {
            "type": "string",
            "example": "Proof of Delivery"
          },
          "note": {
            "type": "string",
            "example": "The package was delivered on time per the carrier scan."
          },
          "status": {
            "type": "string",
            "example": "Pending",
            "description": "Pending, In Process, or Completed."
          },
          "source": {
            "type": "string",
            "example": "manual"
          },
          "case_number": {
            "type": "string",
            "nullable": true
          },
          "response": {
            "type": "string",
            "nullable": true,
            "description": "The carrier's response to the dispute, once received."
          },
          "tracking_number": {
            "type": "string",
            "example": "1Z999AA10123456784",
            "description": "Tracking number of the parent claim."
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "in_process_at": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "completed_at": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          }
        }
      },
      "api_error": {
        "type": "object",
        "properties": {
          "error": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string"
              },
              "details": {
                "type": "object",
                "additionalProperties": true
              }
            },
            "required": [
              "message"
            ]
          }
        },
        "required": [
          "error"
        ]
      }
    },
    "securitySchemes": {
      "bearer_auth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "servers": [
    {
      "url": "https://app.shipscience.com",
      "variables": {
        "defaultHost": {
          "default": "app.shipscience.com"
        }
      }
    }
  ]
}
```