AfterShip Claims API
The Claims API from AfterShip — 10 operation(s) for claims.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/aftership-claims-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.2.0
info:
title: Aftership Claims API
contact:
name: AfterShip Support
url: https://www.aftership.com/contact-us
email: support@aftership.com
termsOfService: https://www.aftership.com/legal/terms-of-service
version: '1.0'
description: 'Operations tagged Claims across 2 of this provider''s published API definitions: aftership-protection-api-openapi.yml, aftership-warranty-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.aftership.com/admin/2022-01
description: API Endpoint
- url: https://api.aftership.com/warranty/2026-07
description: API Endpoint
tags:
- name: Claims
paths:
/claims:
get:
summary: Query claims
operationId: get-claims
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
meta:
$ref: '#/components/schemas/Meta.v1'
data:
type: object
properties:
claims:
type: array
items:
$ref: '#/components/schemas/Claim.v1'
pagination:
$ref: '#/components/schemas/Pagination.v1'
required:
- meta
- data
parameters:
- schema:
type: string
in: query
name: coverage_id
description: Coverage ID
- schema:
type: number
in: query
name: limit
description: 'Number of claims each page contain. (Default: 20, Max: 20)'
- schema:
type: number
in: query
name: page
description: 'The page to query. (Default: 1, Max: 1000)'
tags:
- Claims
description: Get multiple claims
security:
- as-api-key: []
servers:
- url: https://api.aftership.com/admin/2022-01
description: API Endpoint
/claims/{id}:
parameters:
- schema:
type: string
name: id
in: path
required: true
description: claim id
get:
summary: Get a claim
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
meta:
$ref: '#/components/schemas/Meta.v1'
data:
$ref: '#/components/schemas/Claim.v1'
required:
- meta
- data
operationId: get-claim-id
description: Get a claim by ID.
tags:
- Claims
security:
- as-api-key: []
servers:
- url: https://api.aftership.com/admin/2022-01
description: API Endpoint
/claims/{claim_id}:
parameters:
- name: claim_id
in: path
required: true
description: The unique identifier of the claim.
schema:
type: string
example: 102a899f79c82422c99b1fdc417e01010
get:
tags:
- Claims
summary: Get a claim
operationId: get-claim
description: Retrieves the full Claim resource for a single claim.
responses:
'200':
description: The full Claim resource.
content:
application/json:
schema:
type: object
properties:
meta:
$ref: '#/components/schemas/Meta_20000'
data:
$ref: '#/components/schemas/Claim'
example:
meta:
code: 20000
type: OK
message: The request was successfully processed by AfterShip.
data:
id: 102a899f79c82422c99b1fdc417e01010
note: null
approval_note: null
warranty_page:
id: 006b053d93564aaab58f95c0a90e06eb
name: Default warranty page
items:
- id: c83fd9f0c4e343de9d21fbf0acf5ebd9
source_id: '13501508419800'
title: School Bags
product_title: School Bags
variant_title: '02'
quantity: 1
unit_price:
currency: USD
amount: '280.00'
discounted_price:
currency: USD
amount: '280.00'
tax:
currency: USD
amount: '0.00'
discounted_price_including_tax:
currency: USD
amount: '280.00'
product_tags:
- electronics
- warranty-eligible
image:
url: https://cdn.example.com/products/school-bag.jpg
source_variant_id: null
sku: 21q9grbnf06
issue_description:
reason: damaged
subreason: null
description: The zipper broke after two weeks.
files:
- url: https://files.example.com/warranty/damage.jpg
type: image/jpeg
process_item_resolution_method: replace_item
process_item_details: null
product_source: order
shopper_notes: null
item_tags:
- id: tag_001
name: VIP
created_at: '2026-05-01T10:00:00Z'
merchant_uploaded_image_urls: []
created_at: '2026-05-19T10:00:00Z'
updated_at: '2026-05-19T10:00:00Z'
order:
address:
contact_name: Ada Lovelace
company_name: null
address_line_1: 123 Market St
address_line_2: null
city: San Francisco
state: CA
postal_code: '94105'
country: USA
phone_number: null
email: buyer@example.com
customer:
contact:
email: buyer@example.com
phone_number: null
last_name: Lovelace
first_name: Ada
order_name: '#1001'
place_of_purchase:
proof: []
option: null
status: approved
flow_type: required_order_number
created_at: '2026-05-19T10:00:00Z'
process_at: null
rma_number: RMA-1001
updated_at: '2026-05-19T10:00:00Z'
approved_at: '2026-05-19T10:00:00Z'
canceled_at: null
rejected_at: null
completed_at: null
shipping_address:
contact_name: Ada Lovelace
company_name: null
address_line_1: 123 Market St
address_line_2: null
city: San Francisco
state: CA
postal_code: '94105'
country: USA
phone_number: null
email: buyer@example.com
contact_email: buyer@example.com
organization:
id: org_001
cancel_reason: null
reject_reason: null
dynamic_fields:
order_information: {}
additional_information: {}
inbound_shipments: []
outbound_shipments: []
receiving_status: not_received
received_at: null
security:
- ApiKeyAuth: []
patch:
tags:
- Claims
summary: Update a claim
operationId: patch-claim
description: Updates the note, contact email, or shipping address for a claim.
requestBody:
required: true
content:
application/json:
schema:
type: object
minProperties: 1
properties:
note:
type: string
maxLength: 2000
description: Merchant-facing note attached to the claim. Maximum length is 2000 characters.
contact_email:
type: string
description: The claim-level contact email.
shipping_address:
type: object
title: PatchClaimShippingAddress
description: The shipping address update payload. If this parameter is provided, pass the complete shipping_address object. The response returns the normalized shipping_address resource.
properties:
first_name:
type: string
description: The recipient first name.
last_name:
type: string
description: The recipient last name.
address_line_1:
type: string
description: First line of the street address.
address_line_2:
type: string
description: Second line of the street address.
city:
type: string
description: The city, town, or village.
state:
type: string
description: The state, province, or region.
country:
type: string
description: The address country/region in ISO 3166-1 alpha-3 format.
example: USA
postal_code:
type: string
description: The postal code of the address.
phone_number:
type: string
description: The recipient phone number.
required:
- last_name
- address_line_1
- city
- country
- postal_code
example:
note: Customer confirmed updated contact details.
contact_email: buyer@example.com
shipping_address:
first_name: Ada
last_name: Lovelace
address_line_1: 123 Market St
address_line_2: null
city: San Francisco
state: CA
country: USA
postal_code: '94105'
phone_number: '+14155550100'
responses:
'200':
description: The updated Claim resource.
content:
application/json:
schema:
type: object
properties:
meta:
$ref: '#/components/schemas/Meta_20000'
data:
$ref: '#/components/schemas/Claim'
example:
meta:
code: 20000
type: OK
message: The request was successfully processed by AfterShip.
data:
id: 102a899f79c82422c99b1fdc417e01010
note: Customer confirmed updated contact details.
approval_note: null
warranty_page:
id: 006b053d93564aaab58f95c0a90e06eb
name: Default warranty page
items:
- id: c83fd9f0c4e343de9d21fbf0acf5ebd9
source_id: '13501508419800'
title: School Bags
product_title: School Bags
variant_title: '02'
quantity: 1
unit_price:
currency: USD
amount: '280.00'
discounted_price:
currency: USD
amount: '280.00'
tax:
currency: USD
amount: '0.00'
discounted_price_including_tax:
currency: USD
amount: '280.00'
product_tags:
- electronics
- warranty-eligible
image:
url: https://cdn.example.com/products/school-bag.jpg
source_variant_id: null
sku: 21q9grbnf06
issue_description:
reason: damaged
subreason: null
description: The zipper broke after two weeks.
files:
- url: https://files.example.com/warranty/damage.jpg
type: image/jpeg
process_item_resolution_method: replace_item
process_item_details: null
product_source: order
shopper_notes: null
item_tags:
- id: tag_001
name: VIP
created_at: '2026-05-01T10:00:00Z'
merchant_uploaded_image_urls: []
created_at: '2026-05-19T10:00:00Z'
updated_at: '2026-05-19T10:00:00Z'
order:
address:
contact_name: Ada Lovelace
company_name: null
address_line_1: 123 Market St
address_line_2: null
city: San Francisco
state: CA
postal_code: '94105'
country: USA
phone_number: null
email: buyer@example.com
customer:
contact:
email: buyer@example.com
phone_number: null
last_name: Lovelace
first_name: Ada
order_name: '#1001'
place_of_purchase:
proof: []
option: null
status: approved
flow_type: required_order_number
created_at: '2026-05-19T10:00:00Z'
process_at: null
rma_number: RMA-1001
updated_at: '2026-05-19T10:00:00Z'
approved_at: '2026-05-19T10:00:00Z'
canceled_at: null
rejected_at: null
completed_at: null
shipping_address:
contact_name: Ada Lovelace
company_name: null
address_line_1: 123 Market St
address_line_2: null
city: San Francisco
state: CA
postal_code: '94105'
country: USA
phone_number: null
email: buyer@example.com
contact_email: buyer@example.com
organization:
id: org_001
cancel_reason: null
reject_reason: null
dynamic_fields:
order_information: {}
additional_information: {}
inbound_shipments: []
outbound_shipments: []
receiving_status: not_received
received_at: null
security:
- ApiKeyAuth: []
servers:
- url: https://api.aftership.com/warranty/2026-07
description: API Endpoint
/claims/{claim_id}/approve:
parameters:
- name: claim_id
in: path
required: true
description: The unique identifier of the claim.
schema:
type: string
example: 102a899f79c82422c99b1fdc417e01010
post:
tags:
- Claims
summary: Approve a claim
operationId: approve-claim
description: 'Approves a claim. Allowed source status: under_review.'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
notify_customer:
type: boolean
description: Whether to notify the customer about the claim approval.
approval_note:
type: string
maxLength: 1000
description: Optional note included with the approval. Maximum length is 1000 characters.
example:
notify_customer: true
approval_note: Approved after merchant review.
responses:
'200':
description: The updated Claim resource.
content:
application/json:
schema:
type: object
properties:
meta:
$ref: '#/components/schemas/Meta_20000'
data:
$ref: '#/components/schemas/Claim'
example:
meta:
code: 20000
type: OK
message: The request was successfully processed by AfterShip.
data:
id: 102a899f79c82422c99b1fdc417e01010
note: null
approval_note: Approved after merchant review.
warranty_page:
id: 006b053d93564aaab58f95c0a90e06eb
name: Default warranty page
items:
- id: c83fd9f0c4e343de9d21fbf0acf5ebd9
source_id: '13501508419800'
title: School Bags
product_title: School Bags
variant_title: '02'
quantity: 1
unit_price:
currency: USD
amount: '280.00'
discounted_price:
currency: USD
amount: '280.00'
tax:
currency: USD
amount: '0.00'
discounted_price_including_tax:
currency: USD
amount: '280.00'
product_tags:
- electronics
- warranty-eligible
image:
url: https://cdn.example.com/products/school-bag.jpg
source_variant_id: null
sku: 21q9grbnf06
issue_description:
reason: damaged
subreason: null
description: The zipper broke after two weeks.
files:
- url: https://files.example.com/warranty/damage.jpg
type: image/jpeg
process_item_resolution_method: replace_item
process_item_details: null
product_source: order
shopper_notes: null
item_tags:
- id: tag_001
name: VIP
created_at: '2026-05-01T10:00:00Z'
merchant_uploaded_image_urls: []
created_at: '2026-05-19T10:00:00Z'
updated_at: '2026-05-19T10:00:00Z'
order:
address:
contact_name: Ada Lovelace
company_name: null
address_line_1: 123 Market St
address_line_2: null
city: San Francisco
state: CA
postal_code: '94105'
country: USA
phone_number: null
email: buyer@example.com
customer:
contact:
email: buyer@example.com
phone_number: null
last_name: Lovelace
first_name: Ada
order_name: '#1001'
place_of_purchase:
proof: []
option: null
status: approved
flow_type: required_order_number
created_at: '2026-05-19T10:00:00Z'
process_at: null
rma_number: RMA-1001
updated_at: '2026-05-19T10:00:00Z'
approved_at: '2026-05-19T10:00:00Z'
canceled_at: null
rejected_at: null
completed_at: null
shipping_address:
contact_name: Ada Lovelace
company_name: null
address_line_1: 123 Market St
address_line_2: null
city: San Francisco
state: CA
postal_code: '94105'
country: USA
phone_number: null
email: buyer@example.com
contact_email: buyer@example.com
organization:
id: org_001
cancel_reason: null
reject_reason: null
dynamic_fields:
order_information: {}
additional_information: {}
inbound_shipments: []
outbound_shipments: []
receiving_status: not_received
received_at: null
security:
- ApiKeyAuth: []
servers:
- url: https://api.aftership.com/warranty/2026-07
description: API Endpoint
/claims/{claim_id}/reject:
parameters:
- name: claim_id
in: path
required: true
description: The unique identifier of the claim.
schema:
type: string
example: 102a899f79c82422c99b1fdc417e01010
post:
tags:
- Claims
summary: Reject a claim
operationId: reject-claim
description: 'Rejects a claim. Allowed source status: under_review.'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
notify_customer:
type: boolean
description: Whether to notify the customer about the claim rejection.
reject_reason:
type: string
maxLength: 1000
description: Reason for rejecting the claim. Maximum length is 1000 characters.
permanent_reject:
type: boolean
description: Whether to permanently reject the related order items. This only takes effect for order-flow claims.
required:
- reject_reason
example:
notify_customer: true
reject_reason: The issue is not covered by the warranty policy.
permanent_reject: false
responses:
'200':
description: The updated Claim resource.
content:
application/json:
schema:
type: object
properties:
meta:
$ref: '#/components/schemas/Meta_20000'
data:
$ref: '#/components/schemas/Claim'
example:
meta:
code: 20000
type: OK
message: The request was successfully processed by AfterShip.
data:
id: 102a899f79c82422c99b1fdc417e01010
note: null
approval_note: null
warranty_page:
id: 006b053d93564aaab58f95c0a90e06eb
name: Default warranty page
items:
- id: c83fd9f0c4e343de9d21fbf0acf5ebd9
source_id: '13501508419800'
title: School Bags
product_title: School Bags
variant_title: '02'
quantity: 1
unit_price:
currency: USD
amount: '280.00'
discounted_price:
currency: USD
amount: '280.00'
tax:
currency: USD
amount: '0.00'
discounted_price_including_tax:
currency: USD
amount: '280.00'
product_tags:
- electronics
- warranty-eligible
image:
url: https://cdn.example.com/products/school-bag.jpg
source_variant_id: null
sku: 21q9grbnf06
issue_description:
reason: damaged
subreason: null
description: The zipper broke after two weeks.
files:
- url: https://files.example.com/warranty/damage.jpg
type: image/jpeg
process_item_resolution_method: replace_item
process_item_details: null
product_source: order
shopper_notes: null
item_tags:
- id: tag_001
name: VIP
created_at: '2026-05-01T10:00:00Z'
merchant_uploaded_image_urls: []
created_at: '2026-05-19T10:00:00Z'
updated_at: '2026-05-19T10:00:00Z'
order:
address:
contact_name: Ada Lovelace
company_name: null
address_line_1: 123 Market St
address_line_2: null
city: San Francisco
state: CA
postal_code: '94105'
country: USA
phone_number: null
email: buyer@example.com
customer:
contact:
email: buyer@example.com
phone_number: null
last_name: Lovelace
first_name: Ada
order_name: '#1001'
place_of_purchase:
proof: []
option: null
status: rejected
flow_type: required_order_number
created_at: '2026-05-19T10:00:00Z'
process_at: null
rma_number: RMA-1001
updated_at: '2026-05-19T10:00:00Z'
approved_at: null
canceled_at: null
rejected_at: '2026-05-19T10:00:00Z'
completed_at: null
shipping_address:
contact_name: Ada Lovelace
company_name: null
address_line_1: 123 Market St
address_line_2: null
city: San Francisco
state: CA
postal_code: '94105'
country: USA
phone_number: null
email: buyer@example.com
contact_email: buyer@example.com
organization:
id: org_001
cancel_reason: null
reject_reason: The issue is not covered by the warranty policy.
dynamic_fields:
order_information: {}
additional_information: {}
inbound_shipments: []
outbound_shipments: []
receiving_status: not_received
received_at: null
security:
- ApiKeyAuth: []
servers:
- url: https://api.aftership.com/warranty/2026-07
description: API Endpoint
/claims/{claim_id}/cancel:
parameters:
- name: claim_id
in: path
required: true
description: The unique identifier of the claim.
schema:
type: string
example: 102a899f79c82422c99b1fdc417e01010
post:
tags:
- Claims
summary: Cancel a claim
operationId: cancel-claim
description: 'Cancels a claim. Allowed source statuses: approved, in_process.'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
notify_customer:
type: boolean
description: Whether to notify the customer about the claim cancellation.
cancel_reason:
type: string
maxLength: 1000
description: Reason for canceling the claim. Maximum length is 1000 characters.
required:
- cancel_reason
example:
notify_customer: true
cancel_reason: Customer withdrew the claim.
responses:
'200':
description: The updated Claim resource.
content:
application/json:
schema:
type: object
properties:
meta:
$ref: '#/components/schemas/Meta_20000'
data:
$ref: '#/components/schemas/Claim'
example:
meta:
code: 20000
type: OK
message: The request was successfully processed by AfterShip.
data:
id: 102a899f79c82422c99b1fdc417e01010
note: null
approval_note: null
warranty_page:
id: 006b053d93564aaab58f95c0a90e06eb
name: Default warranty page
items:
- id: c83fd9f0c4e343de9d21fbf0acf5ebd9
source_id: '13501508419800'
title: School Bags
product_title: School Bags
variant_title: '02'
quantity: 1
unit_price:
currency: USD
amount: '280.00'
discounted_price:
currency: USD
amount: '280.00'
tax:
currency: USD
amount: '0.00'
discounted_price_including_tax:
currency: USD
amount: '280.00'
product_tags:
- electronics
- warranty-eligible
image:
url: https://cdn.example.com/products/school-bag.jpg
source_variant_id: null
sku: 21q9grbnf06
issue_description:
reason: damaged
subreason: null
description: The zipper broke after two weeks.
files:
- url: https://files.example.com/warranty/damage.jpg
type: image/jpeg
process_item_resolution_method: replace_item
process_item_details: null
product_source: order
shopper_notes: null
item_tags:
- id: tag_001
name: VIP
created_at: '2026-05-01T10:00:00Z'
merchant_uploaded_image_urls: []
created_at: '2026-05-19T10:00:00Z'
updated_at: '2026-05-19T10:00:00Z'
order:
address:
# --- truncated at 32 KB (88 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aftership/refs/heads/main/openapi/aftership-claims-api-openapi.yml