Returns (Operations)
Endpoints to create, update, and read returns.
Returns the item return jobs matching the given parameters.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
sizeinteger · min: 1 · max: 500OptionalDefault:
number of entities to show
25Example: 25startAfterIdstring · min: 1OptionalExample:
entity to start after
6db6a29b-143d-4ffd-ab8b-45cd299cdb00searchTermstring · min: 1OptionalExample:
Term by which to search through the fields
John DoeanonymizedbooleanOptionalDefault:
show anonymized entities or not
falseExample: truefacilityIdstring · min: 1OptionalExample:
origin facility to filter to
6027cece-93b8-4628-9314-a3f455af9e46itemReturnJobScannableCodesstring[] · max: 50Optional
scannableCodes of the item return job to filter the results
itemReturnScannableCodesstring[] · max: 50Optional
scannableCodes of the item return to filter the results
startCreatedstring · date-timeOptionalExample:
Start created date range for item return jobs
2020-02-03T08:45:50.525ZendCreatedstring · date-timeOptionalExample:
End created date range for item return jobs
2020-02-03T08:45:50.525ZreturnFacilityIdstring · min: 1OptionalExample:
return facility to filter to
6027cece-93b8-4628-9314-a3f455af9e46countrystring · min: 2 · max: 2OptionalExample:
Country to filter for. A two-digit country code as per ISO 3166-1 alpha-2
DEorderBystring · enumOptionalExample:
Order in which the result should be returned
LAST_MODIFIED_ASCPossible values: Responses
200
All Item Return Jobs matching the given parameters
application/json
ItemReturnJobs
totalnumberOptionalExample:
Total number of found entities for this query
42401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
get/api/itemreturnjobs
GET /api/itemreturnjobs HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"itemReturnJobsWithSearchPaths": [
{
"anonymized": false,
"consumerAddresses": [
{
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
}
],
"created": "2026-06-17T12:00:00.000Z",
"customAttributes": {},
"id": "text",
"itemReturns": [
{
"created": "2020-02-03T08:45:51.525Z",
"customAttributes": {},
"id": "text",
"lastModified": "2020-02-03T09:45:51.525Z",
"parcelRefs": "672f3f72-b5d3-47c7-941c-9af5348e3cd7",
"returnedLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"refund": {
"percent": 80.6,
"price": {
"currency": "EUR",
"value": 20.55
},
"status": "OPEN"
},
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnedNotReturnableLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnFacilityRef": "text",
"scannableCodes": [
"text"
],
"status": "ANNOUNCED"
}
],
"lastModified": "2026-06-17T12:00:00.000Z",
"notReturnableLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"delivered": 7,
"globalLineItemId": "text",
"id": "611c860f-3f00-4b01-9f4c-64cdee38a30e",
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"returnable": 7,
"returned": 5,
"scannableCodes": [
"text"
],
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"stickers": [],
"tags": []
}
],
"originFacilityRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"processRef": "text",
"returnableLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"delivered": 7,
"globalLineItemId": "text",
"id": "611c860f-3f00-4b01-9f4c-64cdee38a30e",
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"returnable": 7,
"returned": 5,
"scannableCodes": [
"text"
],
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"stickers": [],
"tags": []
}
],
"scannableCodes": [
"text"
],
"searchPaths": [
"text"
],
"shortId": "AS12",
"status": "OPEN",
"tenantOrderId": "text",
"version": 1
}
],
"total": 42
}Creates a new item return job.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ItemReturnJobForCreation
customAttributesobject · nullableOptional
Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
originFacilityRefsstring[] · max: 50RequiredExample:
["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]processRefstringOptional
scannableCodesstring[] · max: 50Optional
shortIdstringOptionalExample:
A short identifier that helps assigning a item return job to a customer. This is automatically created during creation.
AS12statusstring · enumRequiredPossible values:
tenantOrderIdstringOptional
Responses
200
Created entity
application/json
ItemReturnJob
anonymizedbooleanOptionalExample:
Indicates if gdpr related data was anonymized
falsecreatedstring · date-timeOptionalExample:
Creation timestamp
2026-06-17T12:00:00.000ZcustomAttributesobject · nullableOptional
Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
idstringRequired
lastModifiedstring · date-timeOptionalExample:
Last modification timestamp
2026-06-17T12:00:00.000ZoriginFacilityRefsstring[] · max: 50RequiredExample:
["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]processRefstringRequired
scannableCodesstring[] · max: 50Optional
shortIdstringOptionalExample:
A short identifier that helps assigning a item return job to a customer. This is automatically created during creation.
AS12statusstring · enumRequiredPossible values:
tenantOrderIdstringOptional
versionintegerRequiredExample:
The version of the document to be used in optimistic locking mechanisms.
1401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
post/api/itemreturnjobs
POST /api/itemreturnjobs HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2493
{
"consumerAddresses": [
{
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
}
],
"customAttributes": {},
"notReturnableLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"delivered": 7,
"globalLineItemId": "text",
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"recordingRule": "MANDATORY",
"validations": [
{
"allowedValues": [
{
"type": "STRING"
}
],
"type": "EXACT_MATCH"
}
],
"value": "Germany"
}
],
"scannableCodes": [
"text"
],
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"stickers": [],
"tags": []
}
],
"originFacilityRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"processRef": "text",
"returnableLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"delivered": 7,
"globalLineItemId": "text",
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"recordingRule": "MANDATORY",
"validations": [
{
"allowedValues": [
{
"type": "STRING"
}
],
"type": "EXACT_MATCH"
}
],
"value": "Germany"
}
],
"scannableCodes": [
"text"
],
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"stickers": [],
"tags": []
}
],
"scannableCodes": [
"text"
],
"shortId": "AS12",
"status": "OPEN",
"tenantOrderId": "text"
}{
"anonymized": false,
"consumerAddresses": [
{
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
}
],
"created": "2026-06-17T12:00:00.000Z",
"customAttributes": {},
"id": "text",
"itemReturns": [
{
"created": "2020-02-03T08:45:51.525Z",
"customAttributes": {},
"id": "text",
"lastModified": "2020-02-03T09:45:51.525Z",
"parcelRefs": "672f3f72-b5d3-47c7-941c-9af5348e3cd7",
"returnedLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"refund": {
"percent": 80.6,
"price": {
"currency": "EUR",
"value": 20.55
},
"status": "OPEN"
},
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnedNotReturnableLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnFacilityRef": "text",
"scannableCodes": [
"text"
],
"status": "ANNOUNCED"
}
],
"lastModified": "2026-06-17T12:00:00.000Z",
"notReturnableLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"delivered": 7,
"globalLineItemId": "text",
"id": "611c860f-3f00-4b01-9f4c-64cdee38a30e",
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"returnable": 7,
"returned": 5,
"scannableCodes": [
"text"
],
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"stickers": [],
"tags": []
}
],
"originFacilityRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"processRef": "text",
"returnableLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"delivered": 7,
"globalLineItemId": "text",
"id": "611c860f-3f00-4b01-9f4c-64cdee38a30e",
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"returnable": 7,
"returned": 5,
"scannableCodes": [
"text"
],
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"stickers": [],
"tags": []
}
],
"scannableCodes": [
"text"
],
"shortId": "AS12",
"status": "OPEN",
"tenantOrderId": "text",
"version": 1
}Returns an item return job with the provided id.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
itemReturnJobIdstringRequired
Responses
200
Returns Item Return Job with the provided id
application/json
ItemReturnJob
anonymizedbooleanOptionalExample:
Indicates if gdpr related data was anonymized
falsecreatedstring · date-timeOptionalExample:
Creation timestamp
2026-06-17T12:00:00.000ZcustomAttributesobject · nullableOptional
Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
idstringRequired
lastModifiedstring · date-timeOptionalExample:
Last modification timestamp
2026-06-17T12:00:00.000ZoriginFacilityRefsstring[] · max: 50RequiredExample:
["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]processRefstringRequired
scannableCodesstring[] · max: 50Optional
shortIdstringOptionalExample:
A short identifier that helps assigning a item return job to a customer. This is automatically created during creation.
AS12statusstring · enumRequiredPossible values:
tenantOrderIdstringOptional
versionintegerRequiredExample:
The version of the document to be used in optimistic locking mechanisms.
1401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
404
The requested entity was not found
application/json
get/api/itemreturnjobs/{itemReturnJobId}
GET /api/itemreturnjobs/{itemReturnJobId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"anonymized": false,
"consumerAddresses": [
{
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
}
],
"created": "2026-06-17T12:00:00.000Z",
"customAttributes": {},
"id": "text",
"itemReturns": [
{
"created": "2020-02-03T08:45:51.525Z",
"customAttributes": {},
"id": "text",
"lastModified": "2020-02-03T09:45:51.525Z",
"parcelRefs": "672f3f72-b5d3-47c7-941c-9af5348e3cd7",
"returnedLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"refund": {
"percent": 80.6,
"price": {
"currency": "EUR",
"value": 20.55
},
"status": "OPEN"
},
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnedNotReturnableLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnFacilityRef": "text",
"scannableCodes": [
"text"
],
"status": "ANNOUNCED"
}
],
"lastModified": "2026-06-17T12:00:00.000Z",
"notReturnableLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"delivered": 7,
"globalLineItemId": "text",
"id": "611c860f-3f00-4b01-9f4c-64cdee38a30e",
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"returnable": 7,
"returned": 5,
"scannableCodes": [
"text"
],
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"stickers": [],
"tags": []
}
],
"originFacilityRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"processRef": "text",
"returnableLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"delivered": 7,
"globalLineItemId": "text",
"id": "611c860f-3f00-4b01-9f4c-64cdee38a30e",
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"returnable": 7,
"returned": 5,
"scannableCodes": [
"text"
],
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"stickers": [],
"tags": []
}
],
"scannableCodes": [
"text"
],
"shortId": "AS12",
"status": "OPEN",
"tenantOrderId": "text",
"version": 1
}Applies an action to an Item Return Job. Check ItemReturnJobActionsParameters for available actions.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
itemReturnJobIdstringRequired
Body
or
or
or
or
or
Responses
200
Updated entity
application/json
ItemReturnJob
anonymizedbooleanOptionalExample:
Indicates if gdpr related data was anonymized
falsecreatedstring · date-timeOptionalExample:
Creation timestamp
2026-06-17T12:00:00.000ZcustomAttributesobject · nullableOptional
Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
idstringRequired
lastModifiedstring · date-timeOptionalExample:
Last modification timestamp
2026-06-17T12:00:00.000ZoriginFacilityRefsstring[] · max: 50RequiredExample:
["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]processRefstringRequired
scannableCodesstring[] · max: 50Optional
shortIdstringOptionalExample:
A short identifier that helps assigning a item return job to a customer. This is automatically created during creation.
AS12statusstring · enumRequiredPossible values:
tenantOrderIdstringOptional
versionintegerRequiredExample:
The version of the document to be used in optimistic locking mechanisms.
1401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
404
The requested entity was not found
application/json
post/api/itemreturnjobs/{itemReturnJobId}/actions
POST /api/itemreturnjobs/{itemReturnJobId}/actions HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42
{
"name": "FinishItemReturnJob",
"version": 1
}{
"anonymized": false,
"consumerAddresses": [
{
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
}
],
"created": "2026-06-17T12:00:00.000Z",
"customAttributes": {},
"id": "text",
"itemReturns": [
{
"created": "2020-02-03T08:45:51.525Z",
"customAttributes": {},
"id": "text",
"lastModified": "2020-02-03T09:45:51.525Z",
"parcelRefs": "672f3f72-b5d3-47c7-941c-9af5348e3cd7",
"returnedLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"refund": {
"percent": 80.6,
"price": {
"currency": "EUR",
"value": 20.55
},
"status": "OPEN"
},
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnedNotReturnableLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnFacilityRef": "text",
"scannableCodes": [
"text"
],
"status": "ANNOUNCED"
}
],
"lastModified": "2026-06-17T12:00:00.000Z",
"notReturnableLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"delivered": 7,
"globalLineItemId": "text",
"id": "611c860f-3f00-4b01-9f4c-64cdee38a30e",
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"returnable": 7,
"returned": 5,
"scannableCodes": [
"text"
],
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"stickers": [],
"tags": []
}
],
"originFacilityRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"processRef": "text",
"returnableLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"delivered": 7,
"globalLineItemId": "text",
"id": "611c860f-3f00-4b01-9f4c-64cdee38a30e",
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"returnable": 7,
"returned": 5,
"scannableCodes": [
"text"
],
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"stickers": [],
"tags": []
}
],
"scannableCodes": [
"text"
],
"shortId": "AS12",
"status": "OPEN",
"tenantOrderId": "text",
"version": 1
}Returns the item returns for a given item return job.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
itemReturnJobIdstringRequired
Responses
200
Get all item returns for a given item return job
application/json
ItemReturn
createdstring · date-timeOptionalExample:
The date this entity was created at the platform. This value is generated by the service.
2020-02-03T08:45:51.525ZcustomAttributesobject · nullableOptional
Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
idstringRequired
lastModifiedstring · date-timeOptionalExample:
The date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525ZparcelRefsstring[] · max: 50OptionalExample:
references the parcel
672f3f72-b5d3-47c7-941c-9af5348e3cd7returnFacilityRefstringRequired
scannableCodesstring[] · max: 50Optional
statusstring · enumRequiredPossible values:
tenantOrderIdstringOptionalDeprecatedExample:
deprecated: will be automatically deducted from related itemReturnJob
MY_ORDER_ID401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
404
The requested entity was not found
application/json
get/api/itemreturnjobs/{itemReturnJobId}/itemreturns
GET /api/itemreturnjobs/{itemReturnJobId}/itemreturns HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"created": "2020-02-03T08:45:51.525Z",
"customAttributes": {},
"id": "text",
"lastModified": "2020-02-03T09:45:51.525Z",
"parcelRefs": "672f3f72-b5d3-47c7-941c-9af5348e3cd7",
"returnedLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"refund": {
"percent": 80.6,
"price": {
"currency": "EUR",
"value": 20.55
},
"status": "OPEN"
},
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnedNotReturnableLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnFacilityRef": "text",
"scannableCodes": [
"text"
],
"status": "ANNOUNCED"
}
]Create a new item return for an item return job
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
itemReturnJobIdstringRequired
Body
AddItemReturnToItemReturnJob
itemReturnJobVersionintegerRequiredExample:
Version of the itemReturnJob the itemReturn gets added to
1Responses
200
ItemReturnJob containing the newly created item return
application/json
ItemReturnJob
anonymizedbooleanOptionalExample:
Indicates if gdpr related data was anonymized
falsecreatedstring · date-timeOptionalExample:
Creation timestamp
2026-06-17T12:00:00.000ZcustomAttributesobject · nullableOptional
Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
idstringRequired
lastModifiedstring · date-timeOptionalExample:
Last modification timestamp
2026-06-17T12:00:00.000ZoriginFacilityRefsstring[] · max: 50RequiredExample:
["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]processRefstringRequired
scannableCodesstring[] · max: 50Optional
shortIdstringOptionalExample:
A short identifier that helps assigning a item return job to a customer. This is automatically created during creation.
AS12statusstring · enumRequiredPossible values:
tenantOrderIdstringOptional
versionintegerRequiredExample:
The version of the document to be used in optimistic locking mechanisms.
1401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
post/api/itemreturnjobs/{itemReturnJobId}/itemreturns
POST /api/itemreturnjobs/{itemReturnJobId}/itemreturns HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1843
{
"itemReturnForCreation": {
"returnedLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged"
},
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRef": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"recordingRule": "MANDATORY",
"validations": [
{
"allowedValues": [
{
"type": "STRING"
}
],
"type": "EXACT_MATCH"
}
],
"value": "Germany"
}
],
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnedNotReturnableLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged"
},
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRef": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"recordingRule": "MANDATORY",
"validations": [
{
"allowedValues": [
{
"type": "STRING"
}
],
"type": "EXACT_MATCH"
}
],
"value": "Germany"
}
],
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnFacilityRef": "text",
"scannableCodes": [
"text"
],
"status": "ANNOUNCED"
},
"itemReturnJobVersion": 1
}{
"anonymized": false,
"consumerAddresses": [
{
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
}
],
"created": "2026-06-17T12:00:00.000Z",
"customAttributes": {},
"id": "text",
"itemReturns": [
{
"created": "2020-02-03T08:45:51.525Z",
"customAttributes": {},
"id": "text",
"lastModified": "2020-02-03T09:45:51.525Z",
"parcelRefs": "672f3f72-b5d3-47c7-941c-9af5348e3cd7",
"returnedLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"refund": {
"percent": 80.6,
"price": {
"currency": "EUR",
"value": 20.55
},
"status": "OPEN"
},
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnedNotReturnableLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnFacilityRef": "text",
"scannableCodes": [
"text"
],
"status": "ANNOUNCED"
}
],
"lastModified": "2026-06-17T12:00:00.000Z",
"notReturnableLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"delivered": 7,
"globalLineItemId": "text",
"id": "611c860f-3f00-4b01-9f4c-64cdee38a30e",
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"returnable": 7,
"returned": 5,
"scannableCodes": [
"text"
],
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"stickers": [],
"tags": []
}
],
"originFacilityRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"processRef": "text",
"returnableLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"delivered": 7,
"globalLineItemId": "text",
"id": "611c860f-3f00-4b01-9f4c-64cdee38a30e",
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"returnable": 7,
"returned": 5,
"scannableCodes": [
"text"
],
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"stickers": [],
"tags": []
}
],
"scannableCodes": [
"text"
],
"shortId": "AS12",
"status": "OPEN",
"tenantOrderId": "text",
"version": 1
}Returns a specific item return for a given item return job.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
itemReturnJobIdstringRequired
itemReturnIdstringRequired
id of the item return you want to read
Responses
200
Get a specific item return
application/json
ItemReturn
createdstring · date-timeOptionalExample:
The date this entity was created at the platform. This value is generated by the service.
2020-02-03T08:45:51.525ZcustomAttributesobject · nullableOptional
Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
idstringRequired
lastModifiedstring · date-timeOptionalExample:
The date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525ZparcelRefsstring[] · max: 50OptionalExample:
references the parcel
672f3f72-b5d3-47c7-941c-9af5348e3cd7returnFacilityRefstringRequired
scannableCodesstring[] · max: 50Optional
statusstring · enumRequiredPossible values:
tenantOrderIdstringOptionalDeprecatedExample:
deprecated: will be automatically deducted from related itemReturnJob
MY_ORDER_ID401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
404
The requested entity was not found
application/json
get/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}
GET /api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"created": "2020-02-03T08:45:51.525Z",
"customAttributes": {},
"id": "text",
"lastModified": "2020-02-03T09:45:51.525Z",
"parcelRefs": "672f3f72-b5d3-47c7-941c-9af5348e3cd7",
"returnedLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"refund": {
"percent": 80.6,
"price": {
"currency": "EUR",
"value": 20.55
},
"status": "OPEN"
},
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnedNotReturnableLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnFacilityRef": "text",
"scannableCodes": [
"text"
],
"status": "ANNOUNCED"
}This part of the API is deprecated. For details, see the API release lifecycle documentation. Delete an item return from an item return job
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
itemReturnJobIdstringRequired
itemReturnIdstringRequired
id of the item return you want to delete
Query parameters
itemReturnJobVersionnumberRequired
version of the item return job to delete the item return for
Responses
200
item return was found and successfully deleted. Updated item return job is returned.
application/json
ItemReturnJob
anonymizedbooleanOptionalExample:
Indicates if gdpr related data was anonymized
falsecreatedstring · date-timeOptionalExample:
Creation timestamp
2026-06-17T12:00:00.000ZcustomAttributesobject · nullableOptional
Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
idstringRequired
lastModifiedstring · date-timeOptionalExample:
Last modification timestamp
2026-06-17T12:00:00.000ZoriginFacilityRefsstring[] · max: 50RequiredExample:
["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]processRefstringRequired
scannableCodesstring[] · max: 50Optional
shortIdstringOptionalExample:
A short identifier that helps assigning a item return job to a customer. This is automatically created during creation.
AS12statusstring · enumRequiredPossible values:
tenantOrderIdstringOptional
versionintegerRequiredExample:
The version of the document to be used in optimistic locking mechanisms.
1401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
404
The requested entity was not found
application/json
delete/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}
DELETE /api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}?itemReturnJobVersion=1 HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"anonymized": false,
"consumerAddresses": [
{
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
}
],
"created": "2026-06-17T12:00:00.000Z",
"customAttributes": {},
"id": "text",
"itemReturns": [
{
"created": "2020-02-03T08:45:51.525Z",
"customAttributes": {},
"id": "text",
"lastModified": "2020-02-03T09:45:51.525Z",
"parcelRefs": "672f3f72-b5d3-47c7-941c-9af5348e3cd7",
"returnedLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"refund": {
"percent": 80.6,
"price": {
"currency": "EUR",
"value": 20.55
},
"status": "OPEN"
},
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnedNotReturnableLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnFacilityRef": "text",
"scannableCodes": [
"text"
],
"status": "ANNOUNCED"
}
],
"lastModified": "2026-06-17T12:00:00.000Z",
"notReturnableLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"delivered": 7,
"globalLineItemId": "text",
"id": "611c860f-3f00-4b01-9f4c-64cdee38a30e",
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"returnable": 7,
"returned": 5,
"scannableCodes": [
"text"
],
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"stickers": [],
"tags": []
}
],
"originFacilityRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"processRef": "text",
"returnableLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"delivered": 7,
"globalLineItemId": "text",
"id": "611c860f-3f00-4b01-9f4c-64cdee38a30e",
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"returnable": 7,
"returned": 5,
"scannableCodes": [
"text"
],
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"stickers": [],
"tags": []
}
],
"scannableCodes": [
"text"
],
"shortId": "AS12",
"status": "OPEN",
"tenantOrderId": "text",
"version": 1
}Applies an action to an Item Return. Check ItemReturnActionsParameters for available actions.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
itemReturnJobIdstringRequired
itemReturnIdstringRequired
Body
or
or
or
or
or
or
Responses
200
Updated entity
application/json
ItemReturnJob
anonymizedbooleanOptionalExample:
Indicates if gdpr related data was anonymized
falsecreatedstring · date-timeOptionalExample:
Creation timestamp
2026-06-17T12:00:00.000ZcustomAttributesobject · nullableOptional
Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
idstringRequired
lastModifiedstring · date-timeOptionalExample:
Last modification timestamp
2026-06-17T12:00:00.000ZoriginFacilityRefsstring[] · max: 50RequiredExample:
["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]processRefstringRequired
scannableCodesstring[] · max: 50Optional
shortIdstringOptionalExample:
A short identifier that helps assigning a item return job to a customer. This is automatically created during creation.
AS12statusstring · enumRequiredPossible values:
tenantOrderIdstringOptional
versionintegerRequiredExample:
The version of the document to be used in optimistic locking mechanisms.
1401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
404
The requested entity was not found
application/json
post/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/actions
POST /api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/actions HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 54
{
"itemReturnJobVersion": 1,
"name": "AnnounceItemReturn"
}{
"anonymized": false,
"consumerAddresses": [
{
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
}
],
"created": "2026-06-17T12:00:00.000Z",
"customAttributes": {},
"id": "text",
"itemReturns": [
{
"created": "2020-02-03T08:45:51.525Z",
"customAttributes": {},
"id": "text",
"lastModified": "2020-02-03T09:45:51.525Z",
"parcelRefs": "672f3f72-b5d3-47c7-941c-9af5348e3cd7",
"returnedLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"refund": {
"percent": 80.6,
"price": {
"currency": "EUR",
"value": 20.55
},
"status": "OPEN"
},
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnedNotReturnableLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnFacilityRef": "text",
"scannableCodes": [
"text"
],
"status": "ANNOUNCED"
}
],
"lastModified": "2026-06-17T12:00:00.000Z",
"notReturnableLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"delivered": 7,
"globalLineItemId": "text",
"id": "611c860f-3f00-4b01-9f4c-64cdee38a30e",
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"returnable": 7,
"returned": 5,
"scannableCodes": [
"text"
],
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"stickers": [],
"tags": []
}
],
"originFacilityRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"processRef": "text",
"returnableLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"delivered": 7,
"globalLineItemId": "text",
"id": "611c860f-3f00-4b01-9f4c-64cdee38a30e",
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"returnable": 7,
"returned": 5,
"scannableCodes": [
"text"
],
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"stickers": [],
"tags": []
}
],
"scannableCodes": [
"text"
],
"shortId": "AS12",
"status": "OPEN",
"tenantOrderId": "text",
"version": 1
}This part of the API is in Beta status. For details, see the API release lifecycle documentation. Create a parcel matching the item return values to represent the return label
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
itemReturnJobIdstringRequired
itemReturnIdstringRequired
Body
ParcelForCreation
carrierProductstringOptionalExample:
Desired product of given carrier to choose when ordering a label
EXPRESScarrierRefstringOptional
references the carrier to be used for sending. Can not be set when creating a parcel for an existing shipment.
customAttributesobjectOptional
Attributes that can be added to the parcel. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.
customProductValuenumberOptionalExample:
Set this value if you want to overwrite the calculated product value of the parcel.
12.5loadUnitRefsstring[]Optional
Reference to array of load unit Refs
parentRefstringOptional
Reference to the parent container of this parcel
productValuenumberOptionalExample:
Monetary value of all goods in this parcel. Needed for sending cross border packages (customs) To be interpreted as money in the currency given under paymentInformation.currency. This value is calculated from the items in the parcel.
12.5productValueTypestring · enumOptionalExample:
ProductValueType
INSURANCEPossible values: shortIdstringOptionalExample:
AA12-1statusstring · enumOptionalPossible values:
ParcelStatus
tenantOrderIdstringOptionalExample:
Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.
R456728546tenantParcelIdstringOptionalExample:
Tenant specific parcel id, needs to be unique for non obsolete or canceled parcel
MY-PARCEL-12345Responses
201
Created Parcel
application/json
BaseOperationalContainer
createdstring · date-timeOptionalExample:
The date this entity was created at the platform. This value is generated by the service.
2020-02-03T08:45:51.525ZlastModifiedstring · date-timeOptionalExample:
The date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525Zversioninteger · int64RequiredExample:
The version of the document to be used in optimistic locking mechanisms.
42sequenceNumberinteger · int32 · max: 10000OptionalExample:
Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.
100anonymizedbooleanOptionalExample:
Indicates if gdpr related data was anonymized
falsecarrierProductstringOptionalExample:
Desired product of given carrier to choose when ordering a label
EXPRESScarrierRefstringRequiredExample:
Reference to the carrier this parcel should be send by
cf00e102-34f2-45c1-a846-6a21f384321ecustomAttributesobjectOptional
Attributes that can be added to the parcel. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.
customProductValuenumberOptionalExample:
Set this value if you want to overwrite the calculated product value of the parcel. This field uses the smallest denomination, e.g. Euro Cents. So a value of 1250 represents 12,50€.
12.5documentsRefstringOptional
Reference to the documents collection from this entity
facilityRefstringOptional
idstringRequiredExample:
The id of this parcel. It is generated during creation automatically and suits as the primary identifier of the described entity.
95EWrieX09OmeriXIUbbloadUnitRefsstring[]Required
Reference to array of load unit Refs
operativeProcessRefstringOptional
processRefstringRequired
productValuenumberOptionalExample:
Monetary value of all goods in this parcel. Needed for sending cross border packages (customs) To be interpreted as money in the currency given under paymentInformation.currency. This field uses the smallest denomination, e.g. Euro Cents. So a value of 1250 represents 12,50€.
1250productValueTypestring · enumOptionalExample:
ProductValueType
INSURANCEPossible values: shipmentRefstringOptionalExample:
The id of this shipment this parcel has been created for.
95EWrieX09OmeriXIUbbshortIdstringOptionalExample:
AA12-1statusstring · enumRequiredPossible values:
ParcelStatus
tenantOrderIdstringOptionalExample:
Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.
R456728546tenantParcelIdstringOptionalExample:
Tenant specific parcel id, needs to be unique for non obsolete or canceled parcel
MY-PARCEL-12345workflowInformationone ofRequired
or
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
404
The requested entity was not found
application/json
post/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/parcels
POST /api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/parcels HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 5193
{
"carrierInformation": {
"shippingContainerNumber": "123456-ABC"
},
"carrierProduct": "EXPRESS",
"carrierRef": "text",
"customAttributes": {},
"customProductValue": 12.5,
"dimensions": {
"customWeight": 1,
"height": 1,
"length": 1,
"weight": 1,
"width": 1
},
"invoice": {
"addressType": "POSTAL_ADDRESS",
"companyName": "Speedy Boxales Ltd.",
"coordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"email": "test@try.de",
"firstName": "Maxine",
"lastName": "Muller",
"personalTitle": "Dr.",
"salutation": "Frau",
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
},
"items": [
{
"article": {},
"customAttributes": {},
"globalLineItemId": "text",
"measurementUnitKey": "pcs",
"quantity": 1,
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"recordingRule": "MANDATORY",
"validations": [
{
"allowedValues": [
{
"type": "STRING"
}
],
"type": "EXACT_MATCH"
}
],
"value": "Germany"
}
],
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "g",
"secondaryQuantity": 42,
"substituteForOrderedItem": {
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"imageUrl": "https://example.com/resource",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"globalLineItemId": "text"
},
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
]
}
],
"loadUnitRefs": [
"text"
],
"parentRef": "text",
"paymentInformation": {
"currency": "EUR"
},
"pickUpInformation": {
"endTime": "2026-01-01T00:00:00.000Z",
"startTime": "2026-01-01T00:00:00.000Z"
},
"productValue": 12.5,
"productValueCurrency": {
"currency": "EUR",
"decimalPlaces": 2
},
"productValueType": "INSURANCE",
"recipient": {
"addressType": "POSTAL_ADDRESS",
"companyName": "Speedy Boxales Ltd.",
"coordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"email": "test@try.de",
"firstName": "Maxine",
"lastName": "Muller",
"personalTitle": "Dr.",
"salutation": "Frau",
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
},
"result": {
"carrierParcelRef": "84168117830018",
"carrierTrackingNumber": "84168117830018",
"carrierTrackingStatus": "registered",
"customsDocumentId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
"customsDocumentUrl": "someCepProvider.com/pathToReturnLabel.pdf",
"errors": {
"labelError": "text",
"returnLabelError": "text"
},
"labelUrl": "%%HOST%%/api/parcels/{parcelId}/labels/84168117830018.pdf",
"proxyId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
"returnLabelId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
"returnLabelUrl": "someCepProvider.com/pathToReturnLabel.pdf",
"returnTrackingUrl": "http://track.io/3a186c51d4",
"sendLabelUrl": "someCepProvider.com/pathToSendLabel.pdf",
"summary": "Package label was successfully requested at DHL.",
"trackingStatus": "registered",
"trackingUrl": "http://track.io/3a186c51d4"
},
"returnAddress": {
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr.",
"companyName": "Speedy Boxales Ltd.",
"emailAddresses": [
{
"recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
"value": "text"
}
],
"resolvedCoordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"resolvedTimeZone": {
"offsetInSeconds": 28800,
"source": "Google Maps API",
"timeZoneId": "America/Los_Angeles",
"timeZoneName": "Pacific Standard Time"
}
},
"sender": {
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr.",
"companyName": "Speedy Boxales Ltd.",
"emailAddresses": [
{
"recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
"value": "text"
}
],
"resolvedCoordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"resolvedTimeZone": {
"offsetInSeconds": 28800,
"source": "Google Maps API",
"timeZoneId": "America/Los_Angeles",
"timeZoneName": "Pacific Standard Time"
}
},
"services": {
"additionalTransportInsurance": true,
"adultSignature": true,
"bulkyGoods": true,
"customerSignature": true,
"handoverToRecipientOnly": true,
"identityAgeCheck18": true,
"identityCheckCompany": true,
"identityCheckPrivate": true,
"noNeighborDelivery": true,
"saturdayDelivery": true,
"signature": true
},
"shortId": "AA12-1",
"status": "OPEN",
"tenantOrderId": "R456728546",
"tenantParcelId": "MY-PARCEL-12345",
"transfers": [
{
"id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
"type": "RECEIVER"
}
]
}{
"created": "2020-02-03T08:45:51.525Z",
"lastModified": "2020-02-03T09:45:51.525Z",
"version": 42,
"sequenceNumber": 100,
"anonymized": false,
"carrierInformation": {
"shippingContainerNumber": "123456-ABC"
},
"carrierProduct": "EXPRESS",
"carrierRef": "cf00e102-34f2-45c1-a846-6a21f384321e",
"customAttributes": {},
"customProductValue": 12.5,
"dimensions": {
"customWeight": 1,
"height": 1,
"length": 1,
"weight": 1,
"width": 1
},
"documentsRef": "text",
"facilityRef": "text",
"id": "95EWrieX09OmeriXIUbb",
"invoice": {
"addressType": "POSTAL_ADDRESS",
"companyName": "Speedy Boxales Ltd.",
"coordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"email": "test@try.de",
"firstName": "Maxine",
"lastName": "Muller",
"personalTitle": "Dr.",
"salutation": "Frau",
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
},
"items": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"imageUrl": "https://example.com/resource",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1,
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
]
},
"customAttributes": {},
"globalLineItemId": "text",
"id": "ae3ba67c-a42c-4816-96ac-16231e49640c",
"measurementUnitKey": "pcs",
"quantity": 5,
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "g",
"secondaryQuantity": 42,
"substituteForOrderedItem": {
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"imageUrl": "https://example.com/resource",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"globalLineItemId": "text"
},
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"originId": "df671041-10dd-4600-a2ff-e9ffe2556bba"
}
],
"loadUnitRefs": [
"text"
],
"operativeProcessRef": "text",
"paymentInformation": {
"currency": "EUR"
},
"pickUpInformation": {
"endTime": "2026-01-01T00:00:00.000Z",
"startTime": "2026-01-01T00:00:00.000Z"
},
"postalCharges": {
"currency": "EUR",
"value": 15.5
},
"processRef": "text",
"productValue": 1250,
"productValueCurrency": {
"currency": "EUR",
"decimalPlaces": 2
},
"productValueType": "INSURANCE",
"recipient": {
"addressType": "POSTAL_ADDRESS",
"companyName": "Speedy Boxales Ltd.",
"coordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"email": "test@try.de",
"firstName": "Maxine",
"lastName": "Muller",
"personalTitle": "Dr.",
"salutation": "Frau",
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
},
"result": {
"carrierParcelRef": "84168117830018",
"carrierTrackingNumber": "84168117830018",
"carrierTrackingStatus": "registered",
"customsDocumentId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
"customsDocumentUrl": "someCepProvider.com/pathToReturnLabel.pdf",
"errors": {
"labelError": "text",
"returnLabelError": "text"
},
"labelUrl": "%%HOST%%/api/parcels/{parcelId}/labels/84168117830018.pdf",
"proxyId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
"returnLabelId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
"returnLabelUrl": "someCepProvider.com/pathToReturnLabel.pdf",
"returnTrackingUrl": "http://track.io/3a186c51d4",
"sendLabelUrl": "someCepProvider.com/pathToSendLabel.pdf",
"summary": "Package label was successfully requested at DHL.",
"trackingStatus": "registered",
"trackingUrl": "http://track.io/3a186c51d4"
},
"returnAddress": {
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr.",
"companyName": "Speedy Boxales Ltd.",
"emailAddresses": [
{
"recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
"value": "text"
}
],
"resolvedCoordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"resolvedTimeZone": {
"offsetInSeconds": 28800,
"source": "Google Maps API",
"timeZoneId": "America/Los_Angeles",
"timeZoneName": "Pacific Standard Time"
}
},
"sender": {
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr.",
"companyName": "Speedy Boxales Ltd.",
"emailAddresses": [
{
"recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
"value": "text"
}
],
"resolvedCoordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"resolvedTimeZone": {
"offsetInSeconds": 28800,
"source": "Google Maps API",
"timeZoneId": "America/Los_Angeles",
"timeZoneName": "Pacific Standard Time"
}
},
"services": {
"additionalTransportInsurance": true,
"adultSignature": true,
"bulkyGoods": true,
"customerSignature": true,
"handoverToRecipientOnly": true,
"identityAgeCheck18": true,
"identityCheckCompany": true,
"identityCheckPrivate": true,
"noNeighborDelivery": true,
"saturdayDelivery": true,
"signature": true
},
"shipmentRef": "95EWrieX09OmeriXIUbb",
"shortId": "AA12-1",
"status": "OPEN",
"tenantOrderId": "R456728546",
"tenantParcelId": "MY-PARCEL-12345",
"transfers": [
{
"id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
"type": "RECEIVER"
}
],
"workflowInformation": {
"instanceRef": "64c13ab08edf48a008793cac",
"isAvailable": true,
"nodeRef": "text"
}
}Replace returned line items of an item return of an item return job.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
itemReturnJobIdstringRequired
itemReturnIdstringRequired
Body
ReplaceReturnedLineItems
itemReturnJobVersionintegerRequiredExample:
Version of the entity to be changed
1Responses
200
The returned line items were successfully updated. Updated item return job is returned.
application/json
ItemReturnJob
anonymizedbooleanOptionalExample:
Indicates if gdpr related data was anonymized
falsecreatedstring · date-timeOptionalExample:
Creation timestamp
2026-06-17T12:00:00.000ZcustomAttributesobject · nullableOptional
Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
idstringRequired
lastModifiedstring · date-timeOptionalExample:
Last modification timestamp
2026-06-17T12:00:00.000ZoriginFacilityRefsstring[] · max: 50RequiredExample:
["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]processRefstringRequired
scannableCodesstring[] · max: 50Optional
shortIdstringOptionalExample:
A short identifier that helps assigning a item return job to a customer. This is automatically created during creation.
AS12statusstring · enumRequiredPossible values:
tenantOrderIdstringOptional
versionintegerRequiredExample:
The version of the document to be used in optimistic locking mechanisms.
1400
Invalid input. See response for details.
application/json
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
409
A version conflict occurred.
application/json
put/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/returnedlineitems
PUT /api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/returnedlineitems HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 878
{
"itemReturnJobVersion": 1,
"returnedLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged"
},
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRef": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"recordingRule": "MANDATORY",
"validations": [
{
"allowedValues": [
{
"type": "STRING"
}
],
"type": "EXACT_MATCH"
}
],
"value": "Germany"
}
],
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
]
}{
"anonymized": false,
"consumerAddresses": [
{
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
}
],
"created": "2026-06-17T12:00:00.000Z",
"customAttributes": {},
"id": "text",
"itemReturns": [
{
"created": "2020-02-03T08:45:51.525Z",
"customAttributes": {},
"id": "text",
"lastModified": "2020-02-03T09:45:51.525Z",
"parcelRefs": "672f3f72-b5d3-47c7-941c-9af5348e3cd7",
"returnedLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"refund": {
"percent": 80.6,
"price": {
"currency": "EUR",
"value": 20.55
},
"status": "OPEN"
},
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnedNotReturnableLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnFacilityRef": "text",
"scannableCodes": [
"text"
],
"status": "ANNOUNCED"
}
],
"lastModified": "2026-06-17T12:00:00.000Z",
"notReturnableLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"delivered": 7,
"globalLineItemId": "text",
"id": "611c860f-3f00-4b01-9f4c-64cdee38a30e",
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"returnable": 7,
"returned": 5,
"scannableCodes": [
"text"
],
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"stickers": [],
"tags": []
}
],
"originFacilityRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"processRef": "text",
"returnableLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"delivered": 7,
"globalLineItemId": "text",
"id": "611c860f-3f00-4b01-9f4c-64cdee38a30e",
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"returnable": 7,
"returned": 5,
"scannableCodes": [
"text"
],
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"stickers": [],
"tags": []
}
],
"scannableCodes": [
"text"
],
"shortId": "AS12",
"status": "OPEN",
"tenantOrderId": "text",
"version": 1
}Patch for a ItemReturn LineItem. This is used to update the returned line item.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
itemReturnJobIdstringRequired
itemReturnIdstringRequired
returnedLineItemIdstringRequired
id of the returnedLineItem
Body
ItemReturnLineItemForUpdate
itemReturnJobVersionintegerRequiredExample:
version of the overlaying itemReturnJob
42statusstring · enumOptionalPossible values:
Responses
200
Updated ItemReturnJob
application/json
ItemReturnJob
anonymizedbooleanOptionalExample:
Indicates if gdpr related data was anonymized
falsecreatedstring · date-timeOptionalExample:
Creation timestamp
2026-06-17T12:00:00.000ZcustomAttributesobject · nullableOptional
Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
idstringRequired
lastModifiedstring · date-timeOptionalExample:
Last modification timestamp
2026-06-17T12:00:00.000ZoriginFacilityRefsstring[] · max: 50RequiredExample:
["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]processRefstringRequired
scannableCodesstring[] · max: 50Optional
shortIdstringOptionalExample:
A short identifier that helps assigning a item return job to a customer. This is automatically created during creation.
AS12statusstring · enumRequiredPossible values:
tenantOrderIdstringOptional
versionintegerRequiredExample:
The version of the document to be used in optimistic locking mechanisms.
1400
Invalid input. See response for details.
application/json
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
404
The requested entity was not found
application/json
patch/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/returnedlineitems/{returnedLineItemId}
PATCH /api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/returnedlineitems/{returnedLineItemId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 256
{
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged"
},
"itemReturnJobVersion": 42,
"refund": {
"percent": 80.6,
"price": {
"currency": "EUR",
"value": 20.55
},
"status": "OPEN"
},
"status": "OPEN"
}{
"anonymized": false,
"consumerAddresses": [
{
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
}
],
"created": "2026-06-17T12:00:00.000Z",
"customAttributes": {},
"id": "text",
"itemReturns": [
{
"created": "2020-02-03T08:45:51.525Z",
"customAttributes": {},
"id": "text",
"lastModified": "2020-02-03T09:45:51.525Z",
"parcelRefs": "672f3f72-b5d3-47c7-941c-9af5348e3cd7",
"returnedLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"refund": {
"percent": 80.6,
"price": {
"currency": "EUR",
"value": 20.55
},
"status": "OPEN"
},
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnedNotReturnableLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnFacilityRef": "text",
"scannableCodes": [
"text"
],
"status": "ANNOUNCED"
}
],
"lastModified": "2026-06-17T12:00:00.000Z",
"notReturnableLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"delivered": 7,
"globalLineItemId": "text",
"id": "611c860f-3f00-4b01-9f4c-64cdee38a30e",
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"returnable": 7,
"returned": 5,
"scannableCodes": [
"text"
],
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"stickers": [],
"tags": []
}
],
"originFacilityRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"processRef": "text",
"returnableLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"delivered": 7,
"globalLineItemId": "text",
"id": "611c860f-3f00-4b01-9f4c-64cdee38a30e",
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"returnable": 7,
"returned": 5,
"scannableCodes": [
"text"
],
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"stickers": [],
"tags": []
}
],
"scannableCodes": [
"text"
],
"shortId": "AS12",
"status": "OPEN",
"tenantOrderId": "text",
"version": 1
}Replace returned not returnable line items of an item return of an item return job.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
itemReturnJobIdstringRequired
itemReturnIdstringRequired
Body
ReplaceReturnedNotReturnableLineItems
itemReturnJobVersionintegerRequiredExample:
Version of the entity to be changed
1Responses
200
The not returnable returned line items were successfully updated. Updated item return job is returned.
application/json
ItemReturnJob
anonymizedbooleanOptionalExample:
Indicates if gdpr related data was anonymized
falsecreatedstring · date-timeOptionalExample:
Creation timestamp
2026-06-17T12:00:00.000ZcustomAttributesobject · nullableOptional
Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
idstringRequired
lastModifiedstring · date-timeOptionalExample:
Last modification timestamp
2026-06-17T12:00:00.000ZoriginFacilityRefsstring[] · max: 50RequiredExample:
["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]processRefstringRequired
scannableCodesstring[] · max: 50Optional
shortIdstringOptionalExample:
A short identifier that helps assigning a item return job to a customer. This is automatically created during creation.
AS12statusstring · enumRequiredPossible values:
tenantOrderIdstringOptional
versionintegerRequiredExample:
The version of the document to be used in optimistic locking mechanisms.
1400
Invalid input. See response for details.
application/json
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
409
A version conflict occurred.
application/json
put/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/returnednotreturnablelineitems
PUT /api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/returnednotreturnablelineitems HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 891
{
"itemReturnJobVersion": 1,
"returnedNotReturnableLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged"
},
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRef": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"recordingRule": "MANDATORY",
"validations": [
{
"allowedValues": [
{
"type": "STRING"
}
],
"type": "EXACT_MATCH"
}
],
"value": "Germany"
}
],
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
]
}{
"anonymized": false,
"consumerAddresses": [
{
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
}
],
"created": "2026-06-17T12:00:00.000Z",
"customAttributes": {},
"id": "text",
"itemReturns": [
{
"created": "2020-02-03T08:45:51.525Z",
"customAttributes": {},
"id": "text",
"lastModified": "2020-02-03T09:45:51.525Z",
"parcelRefs": "672f3f72-b5d3-47c7-941c-9af5348e3cd7",
"returnedLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"refund": {
"percent": 80.6,
"price": {
"currency": "EUR",
"value": 20.55
},
"status": "OPEN"
},
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnedNotReturnableLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnFacilityRef": "text",
"scannableCodes": [
"text"
],
"status": "ANNOUNCED"
}
],
"lastModified": "2026-06-17T12:00:00.000Z",
"notReturnableLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"delivered": 7,
"globalLineItemId": "text",
"id": "611c860f-3f00-4b01-9f4c-64cdee38a30e",
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"returnable": 7,
"returned": 5,
"scannableCodes": [
"text"
],
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"stickers": [],
"tags": []
}
],
"originFacilityRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"processRef": "text",
"returnableLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"delivered": 7,
"globalLineItemId": "text",
"id": "611c860f-3f00-4b01-9f4c-64cdee38a30e",
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"returnable": 7,
"returned": 5,
"scannableCodes": [
"text"
],
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"stickers": [],
"tags": []
}
],
"scannableCodes": [
"text"
],
"shortId": "AS12",
"status": "OPEN",
"tenantOrderId": "text",
"version": 1
}Patch for a ItemReturn LineItem. This is used to update a returned not returnable line item.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
itemReturnJobIdstringRequired
itemReturnIdstringRequired
returnedNotReturnableLineItemIdstringRequired
id of the returnedLineItem
Body
ItemReturnNotReturnableLineItemForUpdate
itemReturnJobVersionintegerRequiredExample:
version of the overlaying itemReturnJob
42statusstring · enumOptionalPossible values:
Responses
200
Updated ItemReturnJob
application/json
ItemReturnJob
anonymizedbooleanOptionalExample:
Indicates if gdpr related data was anonymized
falsecreatedstring · date-timeOptionalExample:
Creation timestamp
2026-06-17T12:00:00.000ZcustomAttributesobject · nullableOptional
Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
idstringRequired
lastModifiedstring · date-timeOptionalExample:
Last modification timestamp
2026-06-17T12:00:00.000ZoriginFacilityRefsstring[] · max: 50RequiredExample:
["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]processRefstringRequired
scannableCodesstring[] · max: 50Optional
shortIdstringOptionalExample:
A short identifier that helps assigning a item return job to a customer. This is automatically created during creation.
AS12statusstring · enumRequiredPossible values:
tenantOrderIdstringOptional
versionintegerRequiredExample:
The version of the document to be used in optimistic locking mechanisms.
1400
Invalid input. See response for details.
application/json
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
404
The requested entity was not found
application/json
patch/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/returnednotreturnablelineitems/{returnedNotReturnableLineItemId}
PATCH /api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/returnednotreturnablelineitems/{returnedNotReturnableLineItemId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 173
{
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged"
},
"itemReturnJobVersion": 42,
"status": "OPEN"
}{
"anonymized": false,
"consumerAddresses": [
{
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
}
],
"created": "2026-06-17T12:00:00.000Z",
"customAttributes": {},
"id": "text",
"itemReturns": [
{
"created": "2020-02-03T08:45:51.525Z",
"customAttributes": {},
"id": "text",
"lastModified": "2020-02-03T09:45:51.525Z",
"parcelRefs": "672f3f72-b5d3-47c7-941c-9af5348e3cd7",
"returnedLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"refund": {
"percent": 80.6,
"price": {
"currency": "EUR",
"value": 20.55
},
"status": "OPEN"
},
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnedNotReturnableLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnFacilityRef": "text",
"scannableCodes": [
"text"
],
"status": "ANNOUNCED"
}
],
"lastModified": "2026-06-17T12:00:00.000Z",
"notReturnableLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"delivered": 7,
"globalLineItemId": "text",
"id": "611c860f-3f00-4b01-9f4c-64cdee38a30e",
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"returnable": 7,
"returned": 5,
"scannableCodes": [
"text"
],
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"stickers": [],
"tags": []
}
],
"originFacilityRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"processRef": "text",
"returnableLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"delivered": 7,
"globalLineItemId": "text",
"id": "611c860f-3f00-4b01-9f4c-64cdee38a30e",
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"returnable": 7,
"returned": 5,
"scannableCodes": [
"text"
],
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"stickers": [],
"tags": []
}
],
"scannableCodes": [
"text"
],
"shortId": "AS12",
"status": "OPEN",
"tenantOrderId": "text",
"version": 1
}Returns the item returns matching the given parameters.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
searchTermstringOptional
Search term you want to get the corresponding item returns. Search will be performed on multiple fields, including return id, tenant order id, customer name, tenant article ids, artile titles
itemReturnStatusstring[]Optional
ItemReturnStatus of an included ItemReturn to filter the results
itemReturnLineItemStatusstring[]Optional
ItemReturnLineItemStatus of an included itemReturnLineItem to filter the results
sizeintegerOptional
number of entities to show
startAfterIdstringOptional
entity to start after
orderBystringOptional
sorting for the results
anonymizedbooleanOptional
show anonymized entities or not
facilityRefsstring[]Optional
facilities to filter the results
Responses
200
All Item Returns matching the given parameters
application/json
ItemReturns
totalCountnumberRequiredExample:
Total number of found entities for this query
42401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
get/api/itemreturns
GET /api/itemreturns HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"itemReturns": [
{
"created": "2020-02-03T08:45:51.525Z",
"customAttributes": {},
"id": "text",
"lastModified": "2020-02-03T09:45:51.525Z",
"parcelRefs": "672f3f72-b5d3-47c7-941c-9af5348e3cd7",
"returnedLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"refund": {
"percent": 80.6,
"price": {
"currency": "EUR",
"value": 20.55
},
"status": "OPEN"
},
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnedNotReturnableLineItems": [
{
"itemConditionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"decisionReason": {
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
},
"id": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"itemCondition": "Damaged",
"itemConditionComment": "Upper corner damaged",
"itemReturnJobLineItemRefs": "a69006ba-7100-4b4d-a610-1ca28016a4eb",
"reasons": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "Upper corner damaged",
"reason": "text"
}
],
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"scannedCodes": [
"text"
],
"status": "OPEN",
"tenantArticleId": "a69006ba-7100-4b4d-a610-1ca28016a4eb"
}
],
"returnFacilityRef": "text",
"scannableCodes": [
"text"
],
"searchPaths": [
"text"
],
"status": "ANNOUNCED"
}
],
"totalCount": 42
}Last updated
Was this helpful?