Create Missing Item Claim

curl --request POST \ --url https://api.example.com/claims/missing-item \ --header 'Content-Type: application/json' \ --data ' { "missingItemDescription": "The item is missing", "shipmentId": "2340923434", "trackingCode": "DE062750105355XZ", "shopOrderId": "20314532264784", "carrier": { "name": "dhl", "country": "de" }, "isReturnShipment": false, "firstHubScanDate": "2019-06-30T12:34:06+00:00", "netValue": 10.5, "netValueCurrency": "EUR", "recipientName": "Federico Garcia", "recipientCity": "Berlin", "recipientZipCode": "<string>", "trackingScreenshot": 102545, "weight": 1.52, "deliveryDate": "2019-06-30T12:34:06+00:00", "postalReturnDeliveryDate": "2019-06-30T12:34:06+00:00", "picturesOfMissingItem": [ 102545 ] } '

{ "id": "20200301_DE062750105355XZ", "shipmentId": "2340923434", "trackingCode": "DE062750105355XZ", "shopOrderId": "20314532264784", "carrier": { "name": "dhl", "country": "de" }, "isReturnShipment": false, "firstHubScanDate": "2019-06-30T12:34:06+00:00", "deliveryDate": "2019-06-30T12:34:06+00:00", "postalReturnDeliveryDate": "2019-06-30T12:34:06+00:00", "netValue": 10.5, "netValueCurrency": "EUR", "recipientName": "Federico Garcia", "recipientCity": "Berlin", "recipientZipCode": "<string>", "weight": 1.52 }

Body

application/json

missingItemDescription

string

required

Example:

"The item is missing"

shipmentId

string

Example:

"2340923434"

trackingCode

string

Example:

"DE062750105355XZ"

shopOrderId

string

Example:

"20314532264784"

carrier

object

Show child attributes

isReturnShipment

boolean

Example:

false

firstHubScanDate

string<date-time>

Example:

"2019-06-30T12:34:06+00:00"

netValue

number<float>

Invoice net value

Example:

10.5

netValueCurrency

string

Currency of the invoice net value

Example:

"EUR"

recipientName

string

Example:

"Federico Garcia"

recipientCity

string

Example:

"Berlin"

recipientZipCode

string

The recipient zipcode

trackingScreenshot

integer

File ID

Example:

102545

weight

number<float>

Weight (kg)

Example:

1.52

deliveryDate

string<date-time>

Example:

"2019-06-30T12:34:06+00:00"

postalReturnDeliveryDate

string<date-time>

Example:

"2019-06-30T12:34:06+00:00"

picturesOfMissingItem

integer[]

File ID

Response

201 - application/json

Claim created successfully

string

Example:

"20200301_DE062750105355XZ"

claimType

enum<string>

Available options:

investigation,

partial_damage,

whole_damage,

missing_item

status

enum<string>

Available options:

submitted,

action_required,

in_progress,

accepted,

declined,

successful,

paid

shipmentId

string

Example:

"2340923434"

trackingCode

string

Example:

"DE062750105355XZ"

shopOrderId

string

Example:

"20314532264784"

carrier

object

Show child attributes

isReturnShipment

boolean

Example:

false

firstHubScanDate

string<date-time>

Example:

"2019-06-30T12:34:06+00:00"

deliveryDate

string<date-time>

Example:

"2019-06-30T12:34:06+00:00"

postalReturnDeliveryDate

string<date-time>

Example:

"2019-06-30T12:34:06+00:00"

netValue

number<float>

Invoice net value

Example:

10.5

netValueCurrency

string

Currency of the invoice net value

Example:

"EUR"

recipientName

string

Example:

"Federico Garcia"

recipientCity

string

Example:

"Berlin"

recipientZipCode

string

The recipient zipcode

weight

number<float>

Weight (kg)

Example:

1.52

Documentation Index

Body

Response