# Returns (Operations)
Endpoints to create, update and read returns.
## List item return jobs
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Returns the item return jobs matching the given parameters.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update and read returns.","name":"Returns (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ItemReturnJob":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"consumerAddresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"type":"array"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"itemReturns":{"items":{"$ref":"#/components/schemas/ItemReturn"},"minItems":0,"type":"array"},"notReturnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItem"},"minItems":0,"type":"array"},"originFacilityRefs":{"items":{"type":"string"},"type":"array"},"processRef":{"type":"string"},"returnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItem"},"minItems":1,"type":"array"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"shortId":{"description":"A short identifier that helps assigning a item return job to a customer. This is automatically created during creation.","type":"string"},"status":{"$ref":"#/components/schemas/ItemReturnJobStatus"},"tenantOrderId":{"type":"string"}},"required":["id","processRef","originFacilityRefs","status","consumerAddresses","returnableLineItems","itemReturns"],"type":"object","title":"ItemReturnJob","description":"ItemReturnJob"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"ItemReturn":{"additionalProperties":false,"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"parcelRefs":{"items":{"description":"references the parcel","type":"string"},"type":"array"},"returnedLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItem"},"minItems":1,"type":"array"},"returnFacilityRef":{"type":"string"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnStatus"},"tenantOrderId":{"type":"string"}},"required":["id","status","returnedLineItems","returnFacilityRef"],"title":"ItemReturn","description":"ItemReturn"},"ItemReturnLineItem":{"additionalProperties":false,"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"refund":{"$ref":"#/components/schemas/ReturnedLineItemRefund"},"scannedCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnLineItemStatus"},"tenantArticleId":{"type":"string"}},"required":["id","status","itemReturnJobLineItemRefs","tenantArticleId"],"title":"ItemReturnLineItem","description":"ItemReturnLineItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","description":"ItemReturnLineItemReason"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ReturnedLineItemRefund":{"additionalProperties":false,"description":"Either price or percent must be set, not both.","properties":{"percent":{"description":"0.0 - 100.0 amount of the line item price that should be refunded","type":"number"},"price":{"$ref":"#/components/schemas/ReturnedLineItemRefundPrice"},"status":{"$ref":"#/components/schemas/ReturnedLineItemRefundStatus"}},"required":["status"],"title":"ReturnedLineItemRefund"},"ReturnedLineItemRefundPrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"value":{"description":"0.0 till line item price that should be refunded","type":"number"}},"required":["value","currency"],"title":"ReturnedLineItemRefundPrice","description":"ReturnedLineItemRefundPrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ReturnedLineItemRefundStatus":{"enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","title":"ReturnedLineItemRefundStatus","description":"ReturnedLineItemRefundStatus"},"ItemReturnLineItemStatus":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string","title":"ItemReturnLineItemStatus","description":"ItemReturnLineItemStatus"},"ItemReturnStatus":{"enum":["ANNOUNCED","OPEN","IN_PROGRESS","PAUSED","FINISHED","WAITING_FOR_INPUT"],"type":"string","title":"ItemReturnStatus","description":"ItemReturnStatus"},"ItemReturnJobLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/ItemReturnJobLineItemForCreation"}],"properties":{"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"Generated identifier of this entity","type":"string"},"notReturnableItemsExists":{"deprecated":true,"description":"Add items to notReturnableLineItems array in itemReturnJob instead.","type":"boolean"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"returnable":{"description":"Quantity of this line item that can be returned","minimum":0,"type":"number"},"returned":{"description":"Quantity of this line item that has been returned","minimum":0,"type":"number"},"serviceJobRefs":{"description":"refs of the service jobs that altered this line item during the workflow","items":{"type":"string"},"type":"array"}},"required":["id","article","delivered","returned","returnable"],"title":"ItemReturnJobLineItem","description":"ItemReturnJobLineItem"},"ItemReturnJobLineItemForCreation":{"additionalProperties":false,"properties":{"article":{"$ref":"#/components/schemas/ItemReturnJobLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"delivered":{"description":"Quantity of this line item that has been delivered","minimum":1,"type":"number"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"notReturnableItemsExists":{"deprecated":true,"description":"Add items to notReturnableLineItems array in itemReturnJob instead.","type":"boolean"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"nullable":true,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this line item","items":{"type":"string"},"type":"array"},"serviceJobRefs":{"description":"refs of the service jobs that altered this line item during the workflow","items":{"type":"string"},"type":"array"}},"required":["article","delivered"],"title":"ItemReturnJobLineItemForCreation","description":"ItemReturnJobLineItemForCreation"},"ItemReturnJobLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"type":"array"},"prices":{"description":"Deprecated: Use attributes with keys: 'valuePerUnit', 'currency' and 'numberOfDecimalPlaces'","items":{"$ref":"#/components/schemas/ArticlePrice"},"type":"array"}},"type":"object"}],"xml":{"name":"PickLineItemArticle"},"title":"ItemReturnJobLineItemArticle","description":"ItemReturnJobLineItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"ItemReturnJobStatus":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string","title":"ItemReturnJobStatus","description":"ItemReturnJobStatus"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/itemreturnjobs":{"get":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns the item return jobs matching the given parameters.","operationId":"getItemReturnJobs","parameters":[{"description":"facility to filter the results","in":"query","name":"facilityId","required":false,"schema":{"type":"string"}},{"description":"scannableCodes of the item return job to filter the results","in":"query","name":"itemReturnJobScannableCodes","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"description":"scannableCodes of the item return to filter the results","in":"query","name":"itemReturnScannableCodes","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"description":"ItemReturnJobStatus to filter the results","in":"query","name":"itemReturnJobStatus","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"description":"ItemReturnStatus of an included ItemReturn to filter the results","in":"query","name":"itemReturnStatus","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"description":"Term by which to search through the fields","in":"query","name":"searchTerm","required":false,"schema":{"type":"string"}},{"description":"entity to start after","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"description":"number of entities to show","in":"query","name":"size","required":false,"schema":{"default":25,"type":"integer"}},{"description":"show anonymized entities or not","in":"query","name":"anonymized","required":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ItemReturnJob"}}}},"description":"All Item Return Jobs matching the given parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List item return jobs","tags":["Returns (Operations)"]}}}}
```
## Create item return job
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Creates a new item return job.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update and read returns.","name":"Returns (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ItemReturnJobForCreation":{"additionalProperties":false,"properties":{"consumerAddresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"type":"array"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"notReturnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItemForCreation"},"minItems":0,"type":"array"},"originFacilityRefs":{"items":{"type":"string"},"type":"array"},"processRef":{"type":"string"},"returnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItemForCreation"},"minItems":0,"type":"array"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"shortId":{"description":"A short identifier that helps assigning a item return job to a customer. This is automatically created during creation.","type":"string"},"status":{"$ref":"#/components/schemas/ItemReturnJobStatus"},"tenantOrderId":{"type":"string"}},"required":["originFacilityRefs","status","consumerAddresses","returnableLineItems"],"type":"object","title":"ItemReturnJobForCreation","description":"ItemReturnJobForCreation"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"ItemReturnJobLineItemForCreation":{"additionalProperties":false,"properties":{"article":{"$ref":"#/components/schemas/ItemReturnJobLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"delivered":{"description":"Quantity of this line item that has been delivered","minimum":1,"type":"number"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"notReturnableItemsExists":{"deprecated":true,"description":"Add items to notReturnableLineItems array in itemReturnJob instead.","type":"boolean"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"nullable":true,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this line item","items":{"type":"string"},"type":"array"},"serviceJobRefs":{"description":"refs of the service jobs that altered this line item during the workflow","items":{"type":"string"},"type":"array"}},"required":["article","delivered"],"title":"ItemReturnJobLineItemForCreation","description":"ItemReturnJobLineItemForCreation"},"ItemReturnJobLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"type":"array"},"prices":{"description":"Deprecated: Use attributes with keys: 'valuePerUnit', 'currency' and 'numberOfDecimalPlaces'","items":{"$ref":"#/components/schemas/ArticlePrice"},"type":"array"}},"type":"object"}],"xml":{"name":"PickLineItemArticle"},"title":"ItemReturnJobLineItemArticle","description":"ItemReturnJobLineItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"ItemReturnJobStatus":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string","title":"ItemReturnJobStatus","description":"ItemReturnJobStatus"},"ItemReturnJob":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"consumerAddresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"type":"array"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"itemReturns":{"items":{"$ref":"#/components/schemas/ItemReturn"},"minItems":0,"type":"array"},"notReturnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItem"},"minItems":0,"type":"array"},"originFacilityRefs":{"items":{"type":"string"},"type":"array"},"processRef":{"type":"string"},"returnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItem"},"minItems":1,"type":"array"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"shortId":{"description":"A short identifier that helps assigning a item return job to a customer. This is automatically created during creation.","type":"string"},"status":{"$ref":"#/components/schemas/ItemReturnJobStatus"},"tenantOrderId":{"type":"string"}},"required":["id","processRef","originFacilityRefs","status","consumerAddresses","returnableLineItems","itemReturns"],"type":"object","title":"ItemReturnJob","description":"ItemReturnJob"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ItemReturn":{"additionalProperties":false,"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"parcelRefs":{"items":{"description":"references the parcel","type":"string"},"type":"array"},"returnedLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItem"},"minItems":1,"type":"array"},"returnFacilityRef":{"type":"string"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnStatus"},"tenantOrderId":{"type":"string"}},"required":["id","status","returnedLineItems","returnFacilityRef"],"title":"ItemReturn","description":"ItemReturn"},"ItemReturnLineItem":{"additionalProperties":false,"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"refund":{"$ref":"#/components/schemas/ReturnedLineItemRefund"},"scannedCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnLineItemStatus"},"tenantArticleId":{"type":"string"}},"required":["id","status","itemReturnJobLineItemRefs","tenantArticleId"],"title":"ItemReturnLineItem","description":"ItemReturnLineItem"},"ItemReturnLineItemReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","description":"ItemReturnLineItemReason"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ReturnedLineItemRefund":{"additionalProperties":false,"description":"Either price or percent must be set, not both.","properties":{"percent":{"description":"0.0 - 100.0 amount of the line item price that should be refunded","type":"number"},"price":{"$ref":"#/components/schemas/ReturnedLineItemRefundPrice"},"status":{"$ref":"#/components/schemas/ReturnedLineItemRefundStatus"}},"required":["status"],"title":"ReturnedLineItemRefund"},"ReturnedLineItemRefundPrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"value":{"description":"0.0 till line item price that should be refunded","type":"number"}},"required":["value","currency"],"title":"ReturnedLineItemRefundPrice","description":"ReturnedLineItemRefundPrice"},"ReturnedLineItemRefundStatus":{"enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","title":"ReturnedLineItemRefundStatus","description":"ReturnedLineItemRefundStatus"},"ItemReturnLineItemStatus":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string","title":"ItemReturnLineItemStatus","description":"ItemReturnLineItemStatus"},"ItemReturnStatus":{"enum":["ANNOUNCED","OPEN","IN_PROGRESS","PAUSED","FINISHED","WAITING_FOR_INPUT"],"type":"string","title":"ItemReturnStatus","description":"ItemReturnStatus"},"ItemReturnJobLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/ItemReturnJobLineItemForCreation"}],"properties":{"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"Generated identifier of this entity","type":"string"},"notReturnableItemsExists":{"deprecated":true,"description":"Add items to notReturnableLineItems array in itemReturnJob instead.","type":"boolean"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"returnable":{"description":"Quantity of this line item that can be returned","minimum":0,"type":"number"},"returned":{"description":"Quantity of this line item that has been returned","minimum":0,"type":"number"},"serviceJobRefs":{"description":"refs of the service jobs that altered this line item during the workflow","items":{"type":"string"},"type":"array"}},"required":["id","article","delivered","returned","returnable"],"title":"ItemReturnJobLineItem","description":"ItemReturnJobLineItem"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/itemreturnjobs":{"post":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Creates a new item return job.","operationId":"createItemReturnJob","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemReturnJobForCreation"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemReturnJob"}}},"description":"Created entity"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Create item return job","tags":["Returns (Operations)"]}}}}
```
## Get item return job
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Returns an item return job with the provided id.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update and read returns.","name":"Returns (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ItemReturnJob":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"consumerAddresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"type":"array"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"itemReturns":{"items":{"$ref":"#/components/schemas/ItemReturn"},"minItems":0,"type":"array"},"notReturnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItem"},"minItems":0,"type":"array"},"originFacilityRefs":{"items":{"type":"string"},"type":"array"},"processRef":{"type":"string"},"returnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItem"},"minItems":1,"type":"array"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"shortId":{"description":"A short identifier that helps assigning a item return job to a customer. This is automatically created during creation.","type":"string"},"status":{"$ref":"#/components/schemas/ItemReturnJobStatus"},"tenantOrderId":{"type":"string"}},"required":["id","processRef","originFacilityRefs","status","consumerAddresses","returnableLineItems","itemReturns"],"type":"object","title":"ItemReturnJob","description":"ItemReturnJob"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"ItemReturn":{"additionalProperties":false,"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"parcelRefs":{"items":{"description":"references the parcel","type":"string"},"type":"array"},"returnedLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItem"},"minItems":1,"type":"array"},"returnFacilityRef":{"type":"string"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnStatus"},"tenantOrderId":{"type":"string"}},"required":["id","status","returnedLineItems","returnFacilityRef"],"title":"ItemReturn","description":"ItemReturn"},"ItemReturnLineItem":{"additionalProperties":false,"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"refund":{"$ref":"#/components/schemas/ReturnedLineItemRefund"},"scannedCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnLineItemStatus"},"tenantArticleId":{"type":"string"}},"required":["id","status","itemReturnJobLineItemRefs","tenantArticleId"],"title":"ItemReturnLineItem","description":"ItemReturnLineItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","description":"ItemReturnLineItemReason"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ReturnedLineItemRefund":{"additionalProperties":false,"description":"Either price or percent must be set, not both.","properties":{"percent":{"description":"0.0 - 100.0 amount of the line item price that should be refunded","type":"number"},"price":{"$ref":"#/components/schemas/ReturnedLineItemRefundPrice"},"status":{"$ref":"#/components/schemas/ReturnedLineItemRefundStatus"}},"required":["status"],"title":"ReturnedLineItemRefund"},"ReturnedLineItemRefundPrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"value":{"description":"0.0 till line item price that should be refunded","type":"number"}},"required":["value","currency"],"title":"ReturnedLineItemRefundPrice","description":"ReturnedLineItemRefundPrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ReturnedLineItemRefundStatus":{"enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","title":"ReturnedLineItemRefundStatus","description":"ReturnedLineItemRefundStatus"},"ItemReturnLineItemStatus":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string","title":"ItemReturnLineItemStatus","description":"ItemReturnLineItemStatus"},"ItemReturnStatus":{"enum":["ANNOUNCED","OPEN","IN_PROGRESS","PAUSED","FINISHED","WAITING_FOR_INPUT"],"type":"string","title":"ItemReturnStatus","description":"ItemReturnStatus"},"ItemReturnJobLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/ItemReturnJobLineItemForCreation"}],"properties":{"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"Generated identifier of this entity","type":"string"},"notReturnableItemsExists":{"deprecated":true,"description":"Add items to notReturnableLineItems array in itemReturnJob instead.","type":"boolean"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"returnable":{"description":"Quantity of this line item that can be returned","minimum":0,"type":"number"},"returned":{"description":"Quantity of this line item that has been returned","minimum":0,"type":"number"},"serviceJobRefs":{"description":"refs of the service jobs that altered this line item during the workflow","items":{"type":"string"},"type":"array"}},"required":["id","article","delivered","returned","returnable"],"title":"ItemReturnJobLineItem","description":"ItemReturnJobLineItem"},"ItemReturnJobLineItemForCreation":{"additionalProperties":false,"properties":{"article":{"$ref":"#/components/schemas/ItemReturnJobLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"delivered":{"description":"Quantity of this line item that has been delivered","minimum":1,"type":"number"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"notReturnableItemsExists":{"deprecated":true,"description":"Add items to notReturnableLineItems array in itemReturnJob instead.","type":"boolean"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"nullable":true,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this line item","items":{"type":"string"},"type":"array"},"serviceJobRefs":{"description":"refs of the service jobs that altered this line item during the workflow","items":{"type":"string"},"type":"array"}},"required":["article","delivered"],"title":"ItemReturnJobLineItemForCreation","description":"ItemReturnJobLineItemForCreation"},"ItemReturnJobLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"type":"array"},"prices":{"description":"Deprecated: Use attributes with keys: 'valuePerUnit', 'currency' and 'numberOfDecimalPlaces'","items":{"$ref":"#/components/schemas/ArticlePrice"},"type":"array"}},"type":"object"}],"xml":{"name":"PickLineItemArticle"},"title":"ItemReturnJobLineItemArticle","description":"ItemReturnJobLineItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"ItemReturnJobStatus":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string","title":"ItemReturnJobStatus","description":"ItemReturnJobStatus"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/itemreturnjobs/{itemReturnJobId}":{"get":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns an item return job with the provided id.","operationId":"getItemReturnJob","parameters":[{"description":"id of the item return job","in":"path","name":"itemReturnJobId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemReturnJob"}}},"description":"Returns Item Return Job with the provided id"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Get item return job","tags":["Returns (Operations)"]}}}}
```
## Call item return job action
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Applies an action to an Item Return Job. Check ItemReturnJobActionsParameters for available actions.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update and read returns.","name":"Returns (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ItemReturnJobActionsParameter":{"anyOf":[{"$ref":"#/components/schemas/StartItemReturnJobActionParameter"},{"$ref":"#/components/schemas/FinishItemReturnJobActionParameter"},{"$ref":"#/components/schemas/RestartItemReturnJobActionParameter"},{"$ref":"#/components/schemas/ChangeLineItemsToNotReturnableInItemReturnJobActionParameter"},{"$ref":"#/components/schemas/ChangeLineItemsToReturnableInItemReturnJobActionParameter"}],"title":"ItemReturnJobActionsParameter","description":"ItemReturnJobActionsParameter"},"StartItemReturnJobActionParameter":{"additionalProperties":false,"description":"Action to start a ItemReturnJob.","properties":{"name":{"$ref":"#/components/schemas/StartItemReturnJobActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"StartItemReturnJobActionParameter"},"StartItemReturnJobActionEnum":{"enum":["StartItemReturnJob"],"type":"string","title":"StartItemReturnJobActionEnum","description":"StartItemReturnJobActionEnum"},"FinishItemReturnJobActionParameter":{"additionalProperties":false,"description":"Action to finish a ItemReturnJob.","properties":{"name":{"$ref":"#/components/schemas/FinishItemReturnJobActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"FinishItemReturnJobActionParameter"},"FinishItemReturnJobActionEnum":{"enum":["FinishItemReturnJob"],"type":"string","title":"FinishItemReturnJobActionEnum","description":"FinishItemReturnJobActionEnum"},"RestartItemReturnJobActionParameter":{"additionalProperties":false,"description":"Action to restart a ItemReturnJob.","properties":{"name":{"$ref":"#/components/schemas/RestartItemReturnJobActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"RestartItemReturnJobActionParameter"},"RestartItemReturnJobActionEnum":{"enum":["RestartItemReturnJob"],"type":"string","title":"RestartItemReturnJobActionEnum","description":"RestartItemReturnJobActionEnum"},"ChangeLineItemsToNotReturnableInItemReturnJobActionParameter":{"additionalProperties":false,"description":"Action to move line items from returnableLineItems to notReturnableLineItems.","properties":{"lineItemIds":{"items":{"type":"string"},"type":"array"},"name":{"$ref":"#/components/schemas/ChangeLineItemsToNotReturnableInItemReturnJobActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","lineItemIds"],"title":"ChangeLineItemsToNotReturnableInItemReturnJobActionParameter"},"ChangeLineItemsToNotReturnableInItemReturnJobActionEnum":{"enum":["CHANGE_LINE_ITEMS_TO_NOT_RETURNABLE_IN_ITEM_RETURN_JOB"],"type":"string","title":"ChangeLineItemsToNotReturnableInItemReturnJobActionEnum","description":"ChangeLineItemsToNotReturnableInItemReturnJobActionEnum"},"ChangeLineItemsToReturnableInItemReturnJobActionParameter":{"additionalProperties":false,"description":"Action to move line items from notReturnableLineItems to returnableLineItems.","properties":{"lineItemIds":{"items":{"type":"string"},"type":"array"},"name":{"$ref":"#/components/schemas/ChangeLineItemsToReturnableInItemReturnJobActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","lineItemIds"],"title":"ChangeLineItemsToReturnableInItemReturnJobActionParameter"},"ChangeLineItemsToReturnableInItemReturnJobActionEnum":{"enum":["CHANGE_LINE_ITEMS_TO_RETURNABLE_IN_ITEM_RETURN_JOB"],"type":"string","title":"ChangeLineItemsToReturnableInItemReturnJobActionEnum","description":"ChangeLineItemsToReturnableInItemReturnJobActionEnum"},"ItemReturnJob":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"consumerAddresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"type":"array"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"itemReturns":{"items":{"$ref":"#/components/schemas/ItemReturn"},"minItems":0,"type":"array"},"notReturnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItem"},"minItems":0,"type":"array"},"originFacilityRefs":{"items":{"type":"string"},"type":"array"},"processRef":{"type":"string"},"returnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItem"},"minItems":1,"type":"array"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"shortId":{"description":"A short identifier that helps assigning a item return job to a customer. This is automatically created during creation.","type":"string"},"status":{"$ref":"#/components/schemas/ItemReturnJobStatus"},"tenantOrderId":{"type":"string"}},"required":["id","processRef","originFacilityRefs","status","consumerAddresses","returnableLineItems","itemReturns"],"type":"object","title":"ItemReturnJob","description":"ItemReturnJob"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"ItemReturn":{"additionalProperties":false,"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"parcelRefs":{"items":{"description":"references the parcel","type":"string"},"type":"array"},"returnedLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItem"},"minItems":1,"type":"array"},"returnFacilityRef":{"type":"string"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnStatus"},"tenantOrderId":{"type":"string"}},"required":["id","status","returnedLineItems","returnFacilityRef"],"title":"ItemReturn","description":"ItemReturn"},"ItemReturnLineItem":{"additionalProperties":false,"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"refund":{"$ref":"#/components/schemas/ReturnedLineItemRefund"},"scannedCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnLineItemStatus"},"tenantArticleId":{"type":"string"}},"required":["id","status","itemReturnJobLineItemRefs","tenantArticleId"],"title":"ItemReturnLineItem","description":"ItemReturnLineItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","description":"ItemReturnLineItemReason"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ReturnedLineItemRefund":{"additionalProperties":false,"description":"Either price or percent must be set, not both.","properties":{"percent":{"description":"0.0 - 100.0 amount of the line item price that should be refunded","type":"number"},"price":{"$ref":"#/components/schemas/ReturnedLineItemRefundPrice"},"status":{"$ref":"#/components/schemas/ReturnedLineItemRefundStatus"}},"required":["status"],"title":"ReturnedLineItemRefund"},"ReturnedLineItemRefundPrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"value":{"description":"0.0 till line item price that should be refunded","type":"number"}},"required":["value","currency"],"title":"ReturnedLineItemRefundPrice","description":"ReturnedLineItemRefundPrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ReturnedLineItemRefundStatus":{"enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","title":"ReturnedLineItemRefundStatus","description":"ReturnedLineItemRefundStatus"},"ItemReturnLineItemStatus":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string","title":"ItemReturnLineItemStatus","description":"ItemReturnLineItemStatus"},"ItemReturnStatus":{"enum":["ANNOUNCED","OPEN","IN_PROGRESS","PAUSED","FINISHED","WAITING_FOR_INPUT"],"type":"string","title":"ItemReturnStatus","description":"ItemReturnStatus"},"ItemReturnJobLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/ItemReturnJobLineItemForCreation"}],"properties":{"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"Generated identifier of this entity","type":"string"},"notReturnableItemsExists":{"deprecated":true,"description":"Add items to notReturnableLineItems array in itemReturnJob instead.","type":"boolean"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"returnable":{"description":"Quantity of this line item that can be returned","minimum":0,"type":"number"},"returned":{"description":"Quantity of this line item that has been returned","minimum":0,"type":"number"},"serviceJobRefs":{"description":"refs of the service jobs that altered this line item during the workflow","items":{"type":"string"},"type":"array"}},"required":["id","article","delivered","returned","returnable"],"title":"ItemReturnJobLineItem","description":"ItemReturnJobLineItem"},"ItemReturnJobLineItemForCreation":{"additionalProperties":false,"properties":{"article":{"$ref":"#/components/schemas/ItemReturnJobLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"delivered":{"description":"Quantity of this line item that has been delivered","minimum":1,"type":"number"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"notReturnableItemsExists":{"deprecated":true,"description":"Add items to notReturnableLineItems array in itemReturnJob instead.","type":"boolean"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"nullable":true,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this line item","items":{"type":"string"},"type":"array"},"serviceJobRefs":{"description":"refs of the service jobs that altered this line item during the workflow","items":{"type":"string"},"type":"array"}},"required":["article","delivered"],"title":"ItemReturnJobLineItemForCreation","description":"ItemReturnJobLineItemForCreation"},"ItemReturnJobLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"type":"array"},"prices":{"description":"Deprecated: Use attributes with keys: 'valuePerUnit', 'currency' and 'numberOfDecimalPlaces'","items":{"$ref":"#/components/schemas/ArticlePrice"},"type":"array"}},"type":"object"}],"xml":{"name":"PickLineItemArticle"},"title":"ItemReturnJobLineItemArticle","description":"ItemReturnJobLineItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"ItemReturnJobStatus":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string","title":"ItemReturnJobStatus","description":"ItemReturnJobStatus"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/itemreturnjobs/{itemReturnJobId}/actions":{"post":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Applies an action to an Item Return Job. Check ItemReturnJobActionsParameters for available actions.","operationId":"updateItemReturnJob","parameters":[{"description":"id of the Item Return Job","in":"path","name":"itemReturnJobId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemReturnJobActionsParameter"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemReturnJob"}}},"description":"Updated entity"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Call item return job action","tags":["Returns (Operations)"]}}}}
```
## List item returns
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Returns the item returns for a given item return job.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update and read returns.","name":"Returns (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ItemReturn":{"additionalProperties":false,"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"parcelRefs":{"items":{"description":"references the parcel","type":"string"},"type":"array"},"returnedLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItem"},"minItems":1,"type":"array"},"returnFacilityRef":{"type":"string"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnStatus"},"tenantOrderId":{"type":"string"}},"required":["id","status","returnedLineItems","returnFacilityRef"],"title":"ItemReturn","description":"ItemReturn"},"ItemReturnLineItem":{"additionalProperties":false,"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"refund":{"$ref":"#/components/schemas/ReturnedLineItemRefund"},"scannedCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnLineItemStatus"},"tenantArticleId":{"type":"string"}},"required":["id","status","itemReturnJobLineItemRefs","tenantArticleId"],"title":"ItemReturnLineItem","description":"ItemReturnLineItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","description":"ItemReturnLineItemReason"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ReturnedLineItemRefund":{"additionalProperties":false,"description":"Either price or percent must be set, not both.","properties":{"percent":{"description":"0.0 - 100.0 amount of the line item price that should be refunded","type":"number"},"price":{"$ref":"#/components/schemas/ReturnedLineItemRefundPrice"},"status":{"$ref":"#/components/schemas/ReturnedLineItemRefundStatus"}},"required":["status"],"title":"ReturnedLineItemRefund"},"ReturnedLineItemRefundPrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"value":{"description":"0.0 till line item price that should be refunded","type":"number"}},"required":["value","currency"],"title":"ReturnedLineItemRefundPrice","description":"ReturnedLineItemRefundPrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ReturnedLineItemRefundStatus":{"enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","title":"ReturnedLineItemRefundStatus","description":"ReturnedLineItemRefundStatus"},"ItemReturnLineItemStatus":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string","title":"ItemReturnLineItemStatus","description":"ItemReturnLineItemStatus"},"ItemReturnStatus":{"enum":["ANNOUNCED","OPEN","IN_PROGRESS","PAUSED","FINISHED","WAITING_FOR_INPUT"],"type":"string","title":"ItemReturnStatus","description":"ItemReturnStatus"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/itemreturnjobs/{itemReturnJobId}/itemreturns":{"get":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns the item returns for a given item return job.","operationId":"getItemReturns","parameters":[{"description":"item return job to read the item return for","in":"path","name":"itemReturnJobId","required":true,"schema":{"type":"string"}},{"description":"entity to start after","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"description":"number of entities to show","in":"query","name":"size","required":false,"schema":{"default":25,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ItemReturn"}}}},"description":"Get all item returns for a given item return job"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"List item returns","tags":["Returns (Operations)"]}}}}
```
## Create item return
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Create a new item return for an item return job
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update and read returns.","name":"Returns (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"AddItemReturnToItemReturnJob":{"additionalProperties":false,"properties":{"itemReturnForCreation":{"$ref":"#/components/schemas/ItemReturnForCreation"},"itemReturnJobVersion":{"description":"Version of the itemReturnJob the itemReturn gets added to","minimum":0,"type":"integer"}},"required":["itemReturnForCreation","itemReturnJobVersion"],"title":"AddItemReturnToItemReturnJob","description":"AddItemReturnToItemReturnJob"},"ItemReturnForCreation":{"additionalProperties":false,"properties":{"returnedLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemForCreation"},"minItems":1,"type":"array"},"returnFacilityRef":{"type":"string"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnStatus"},"tenantOrderId":{"deprecated":true,"description":"deprecated: will be automatically deducted from related itemReturnJob","type":"string"}},"required":["returnedLineItems","status","returnFacilityRef"],"title":"ItemReturnForCreation","description":"ItemReturnForCreation"},"ItemReturnLineItemForCreation":{"additionalProperties":false,"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRef":{"description":"id of the item return job line item that is returned","type":"string"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"nullable":true,"type":"array"},"scannedCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnLineItemStatus"},"tenantArticleId":{"type":"string"}},"required":["itemReturnJobLineItemRef","status"],"title":"ItemReturnLineItemForCreation","description":"ItemReturnLineItemForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","description":"ItemReturnLineItemReason"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"ItemReturnLineItemStatus":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string","title":"ItemReturnLineItemStatus","description":"ItemReturnLineItemStatus"},"ItemReturnStatus":{"enum":["ANNOUNCED","OPEN","IN_PROGRESS","PAUSED","FINISHED","WAITING_FOR_INPUT"],"type":"string","title":"ItemReturnStatus","description":"ItemReturnStatus"},"ItemReturnJob":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"consumerAddresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"type":"array"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"itemReturns":{"items":{"$ref":"#/components/schemas/ItemReturn"},"minItems":0,"type":"array"},"notReturnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItem"},"minItems":0,"type":"array"},"originFacilityRefs":{"items":{"type":"string"},"type":"array"},"processRef":{"type":"string"},"returnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItem"},"minItems":1,"type":"array"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"shortId":{"description":"A short identifier that helps assigning a item return job to a customer. This is automatically created during creation.","type":"string"},"status":{"$ref":"#/components/schemas/ItemReturnJobStatus"},"tenantOrderId":{"type":"string"}},"required":["id","processRef","originFacilityRefs","status","consumerAddresses","returnableLineItems","itemReturns"],"type":"object","title":"ItemReturnJob","description":"ItemReturnJob"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"ItemReturn":{"additionalProperties":false,"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"parcelRefs":{"items":{"description":"references the parcel","type":"string"},"type":"array"},"returnedLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItem"},"minItems":1,"type":"array"},"returnFacilityRef":{"type":"string"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnStatus"},"tenantOrderId":{"type":"string"}},"required":["id","status","returnedLineItems","returnFacilityRef"],"title":"ItemReturn","description":"ItemReturn"},"ItemReturnLineItem":{"additionalProperties":false,"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"refund":{"$ref":"#/components/schemas/ReturnedLineItemRefund"},"scannedCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnLineItemStatus"},"tenantArticleId":{"type":"string"}},"required":["id","status","itemReturnJobLineItemRefs","tenantArticleId"],"title":"ItemReturnLineItem","description":"ItemReturnLineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ReturnedLineItemRefund":{"additionalProperties":false,"description":"Either price or percent must be set, not both.","properties":{"percent":{"description":"0.0 - 100.0 amount of the line item price that should be refunded","type":"number"},"price":{"$ref":"#/components/schemas/ReturnedLineItemRefundPrice"},"status":{"$ref":"#/components/schemas/ReturnedLineItemRefundStatus"}},"required":["status"],"title":"ReturnedLineItemRefund"},"ReturnedLineItemRefundPrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"value":{"description":"0.0 till line item price that should be refunded","type":"number"}},"required":["value","currency"],"title":"ReturnedLineItemRefundPrice","description":"ReturnedLineItemRefundPrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ReturnedLineItemRefundStatus":{"enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","title":"ReturnedLineItemRefundStatus","description":"ReturnedLineItemRefundStatus"},"ItemReturnJobLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/ItemReturnJobLineItemForCreation"}],"properties":{"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"Generated identifier of this entity","type":"string"},"notReturnableItemsExists":{"deprecated":true,"description":"Add items to notReturnableLineItems array in itemReturnJob instead.","type":"boolean"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"returnable":{"description":"Quantity of this line item that can be returned","minimum":0,"type":"number"},"returned":{"description":"Quantity of this line item that has been returned","minimum":0,"type":"number"},"serviceJobRefs":{"description":"refs of the service jobs that altered this line item during the workflow","items":{"type":"string"},"type":"array"}},"required":["id","article","delivered","returned","returnable"],"title":"ItemReturnJobLineItem","description":"ItemReturnJobLineItem"},"ItemReturnJobLineItemForCreation":{"additionalProperties":false,"properties":{"article":{"$ref":"#/components/schemas/ItemReturnJobLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"delivered":{"description":"Quantity of this line item that has been delivered","minimum":1,"type":"number"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"notReturnableItemsExists":{"deprecated":true,"description":"Add items to notReturnableLineItems array in itemReturnJob instead.","type":"boolean"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"nullable":true,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this line item","items":{"type":"string"},"type":"array"},"serviceJobRefs":{"description":"refs of the service jobs that altered this line item during the workflow","items":{"type":"string"},"type":"array"}},"required":["article","delivered"],"title":"ItemReturnJobLineItemForCreation","description":"ItemReturnJobLineItemForCreation"},"ItemReturnJobLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"type":"array"},"prices":{"description":"Deprecated: Use attributes with keys: 'valuePerUnit', 'currency' and 'numberOfDecimalPlaces'","items":{"$ref":"#/components/schemas/ArticlePrice"},"type":"array"}},"type":"object"}],"xml":{"name":"PickLineItemArticle"},"title":"ItemReturnJobLineItemArticle","description":"ItemReturnJobLineItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"ItemReturnJobStatus":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string","title":"ItemReturnJobStatus","description":"ItemReturnJobStatus"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/itemreturnjobs/{itemReturnJobId}/itemreturns":{"post":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Create a new item return for an item return job","operationId":"createItemReturn","parameters":[{"description":"Id of the item return job to create the item return for","in":"path","name":"itemReturnJobId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddItemReturnToItemReturnJob"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemReturnJob"}}},"description":"ItemReturnJob containing the newly created item return"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Create item return","tags":["Returns (Operations)"]}}}}
```
## Get item return
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Returns a specific item return for a given item return job.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update and read returns.","name":"Returns (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ItemReturn":{"additionalProperties":false,"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"parcelRefs":{"items":{"description":"references the parcel","type":"string"},"type":"array"},"returnedLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItem"},"minItems":1,"type":"array"},"returnFacilityRef":{"type":"string"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnStatus"},"tenantOrderId":{"type":"string"}},"required":["id","status","returnedLineItems","returnFacilityRef"],"title":"ItemReturn","description":"ItemReturn"},"ItemReturnLineItem":{"additionalProperties":false,"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"refund":{"$ref":"#/components/schemas/ReturnedLineItemRefund"},"scannedCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnLineItemStatus"},"tenantArticleId":{"type":"string"}},"required":["id","status","itemReturnJobLineItemRefs","tenantArticleId"],"title":"ItemReturnLineItem","description":"ItemReturnLineItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","description":"ItemReturnLineItemReason"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ReturnedLineItemRefund":{"additionalProperties":false,"description":"Either price or percent must be set, not both.","properties":{"percent":{"description":"0.0 - 100.0 amount of the line item price that should be refunded","type":"number"},"price":{"$ref":"#/components/schemas/ReturnedLineItemRefundPrice"},"status":{"$ref":"#/components/schemas/ReturnedLineItemRefundStatus"}},"required":["status"],"title":"ReturnedLineItemRefund"},"ReturnedLineItemRefundPrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"value":{"description":"0.0 till line item price that should be refunded","type":"number"}},"required":["value","currency"],"title":"ReturnedLineItemRefundPrice","description":"ReturnedLineItemRefundPrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ReturnedLineItemRefundStatus":{"enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","title":"ReturnedLineItemRefundStatus","description":"ReturnedLineItemRefundStatus"},"ItemReturnLineItemStatus":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string","title":"ItemReturnLineItemStatus","description":"ItemReturnLineItemStatus"},"ItemReturnStatus":{"enum":["ANNOUNCED","OPEN","IN_PROGRESS","PAUSED","FINISHED","WAITING_FOR_INPUT"],"type":"string","title":"ItemReturnStatus","description":"ItemReturnStatus"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}":{"get":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns a specific item return for a given item return job.","operationId":"getItemReturn","parameters":[{"description":"item return job to read the item return for","in":"path","name":"itemReturnJobId","required":true,"schema":{"type":"string"}},{"description":"id of the item return you want to read","in":"path","name":"itemReturnId","required":true,"schema":{"type":"string"}},{"description":"entity to start after","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"description":"number of entities to show","in":"query","name":"size","required":false,"schema":{"default":25,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemReturn"}}},"description":"Get a specific item return"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Get item return","tags":["Returns (Operations)"]}}}}
```
## Delete item return
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Delete an item return from an item return job
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update and read returns.","name":"Returns (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ItemReturn":{"additionalProperties":false,"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"parcelRefs":{"items":{"description":"references the parcel","type":"string"},"type":"array"},"returnedLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItem"},"minItems":1,"type":"array"},"returnFacilityRef":{"type":"string"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnStatus"},"tenantOrderId":{"type":"string"}},"required":["id","status","returnedLineItems","returnFacilityRef"],"title":"ItemReturn","description":"ItemReturn"},"ItemReturnLineItem":{"additionalProperties":false,"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"refund":{"$ref":"#/components/schemas/ReturnedLineItemRefund"},"scannedCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnLineItemStatus"},"tenantArticleId":{"type":"string"}},"required":["id","status","itemReturnJobLineItemRefs","tenantArticleId"],"title":"ItemReturnLineItem","description":"ItemReturnLineItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","description":"ItemReturnLineItemReason"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ReturnedLineItemRefund":{"additionalProperties":false,"description":"Either price or percent must be set, not both.","properties":{"percent":{"description":"0.0 - 100.0 amount of the line item price that should be refunded","type":"number"},"price":{"$ref":"#/components/schemas/ReturnedLineItemRefundPrice"},"status":{"$ref":"#/components/schemas/ReturnedLineItemRefundStatus"}},"required":["status"],"title":"ReturnedLineItemRefund"},"ReturnedLineItemRefundPrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"value":{"description":"0.0 till line item price that should be refunded","type":"number"}},"required":["value","currency"],"title":"ReturnedLineItemRefundPrice","description":"ReturnedLineItemRefundPrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ReturnedLineItemRefundStatus":{"enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","title":"ReturnedLineItemRefundStatus","description":"ReturnedLineItemRefundStatus"},"ItemReturnLineItemStatus":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string","title":"ItemReturnLineItemStatus","description":"ItemReturnLineItemStatus"},"ItemReturnStatus":{"enum":["ANNOUNCED","OPEN","IN_PROGRESS","PAUSED","FINISHED","WAITING_FOR_INPUT"],"type":"string","title":"ItemReturnStatus","description":"ItemReturnStatus"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}":{"delete":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Delete an item return from an item return job","operationId":"deleteItemReturn","parameters":[{"description":"id of the item return job to delete the item return for","in":"path","name":"itemReturnJobId","required":true,"schema":{"type":"string"}},{"description":"id of the item return you want to delete","in":"path","name":"itemReturnId","required":true,"schema":{"type":"string"}},{"description":"version of the item return job to delete the item return for","in":"query","name":"itemReturnJobVersion","required":true,"schema":{"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemReturn"}}},"description":"item return was found and successfully deleted. Updated item return job is returned."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Delete item return","tags":["Returns (Operations)"]}}}}
```
## Call item return action
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Applies an action to an Item Return. Check ItemReturnActionsParameters for available actions.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update and read returns.","name":"Returns (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ItemReturnActionsParameter":{"anyOf":[{"$ref":"#/components/schemas/AnnounceItemReturnActionParameter"},{"$ref":"#/components/schemas/OpenItemReturnActionParameter"},{"$ref":"#/components/schemas/StartItemReturnActionParameter"},{"$ref":"#/components/schemas/PauseItemReturnActionParameter"},{"$ref":"#/components/schemas/FinishItemReturnActionParameter"},{"$ref":"#/components/schemas/WaitForInputItemReturnActionParameter"}],"title":"ItemReturnActionsParameter","description":"ItemReturnActionsParameter"},"AnnounceItemReturnActionParameter":{"additionalProperties":false,"description":"Action to announce an ItemReturn.","properties":{"itemReturnJobVersion":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"},"name":{"$ref":"#/components/schemas/AnnounceItemReturnActionEnum"}},"required":["name","itemReturnJobVersion"],"title":"AnnounceItemReturnActionParameter"},"AnnounceItemReturnActionEnum":{"enum":["AnnounceItemReturn"],"type":"string","title":"AnnounceItemReturnActionEnum","description":"AnnounceItemReturnActionEnum"},"OpenItemReturnActionParameter":{"additionalProperties":false,"description":"Action to open an ItemReturn.","properties":{"itemReturnJobVersion":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"},"name":{"$ref":"#/components/schemas/OpenItemReturnActionEnum"}},"required":["name","itemReturnJobVersion"],"title":"OpenItemReturnActionParameter"},"OpenItemReturnActionEnum":{"enum":["OpenItemReturn"],"type":"string","title":"OpenItemReturnActionEnum","description":"OpenItemReturnActionEnum"},"StartItemReturnActionParameter":{"additionalProperties":false,"description":"Action to start an ItemReturn.","properties":{"itemReturnJobVersion":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"},"name":{"$ref":"#/components/schemas/StartItemReturnActionEnum"}},"required":["name","itemReturnJobVersion"],"title":"StartItemReturnActionParameter"},"StartItemReturnActionEnum":{"enum":["StartItemReturn"],"type":"string","title":"StartItemReturnActionEnum","description":"StartItemReturnActionEnum"},"PauseItemReturnActionParameter":{"additionalProperties":false,"description":"Action to pause an ItemReturn.","properties":{"itemReturnJobVersion":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"},"name":{"$ref":"#/components/schemas/PauseItemReturnActionEnum"}},"required":["name","itemReturnJobVersion"],"title":"PauseItemReturnActionParameter"},"PauseItemReturnActionEnum":{"enum":["PauseItemReturn"],"type":"string","title":"PauseItemReturnActionEnum","description":"PauseItemReturnActionEnum"},"FinishItemReturnActionParameter":{"additionalProperties":false,"description":"Action to finish an ItemReturn.","properties":{"itemReturnJobVersion":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"},"name":{"$ref":"#/components/schemas/FinishItemReturnActionEnum"}},"required":["name","itemReturnJobVersion"],"title":"FinishItemReturnActionParameter"},"FinishItemReturnActionEnum":{"enum":["FinishItemReturn"],"type":"string","title":"FinishItemReturnActionEnum","description":"FinishItemReturnActionEnum"},"WaitForInputItemReturnActionParameter":{"additionalProperties":false,"properties":{"itemReturnJobVersion":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"},"name":{"$ref":"#/components/schemas/WaitForInputItemReturnActionEnum"}},"required":["name","itemReturnJobVersion"],"title":"WaitForInputItemReturnActionParameter","description":"WaitForInputItemReturnActionParameter"},"WaitForInputItemReturnActionEnum":{"enum":["WaitForInputItemReturn"],"type":"string","title":"WaitForInputItemReturnActionEnum","description":"WaitForInputItemReturnActionEnum"},"ItemReturnJob":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"consumerAddresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"type":"array"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"itemReturns":{"items":{"$ref":"#/components/schemas/ItemReturn"},"minItems":0,"type":"array"},"notReturnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItem"},"minItems":0,"type":"array"},"originFacilityRefs":{"items":{"type":"string"},"type":"array"},"processRef":{"type":"string"},"returnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItem"},"minItems":1,"type":"array"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"shortId":{"description":"A short identifier that helps assigning a item return job to a customer. This is automatically created during creation.","type":"string"},"status":{"$ref":"#/components/schemas/ItemReturnJobStatus"},"tenantOrderId":{"type":"string"}},"required":["id","processRef","originFacilityRefs","status","consumerAddresses","returnableLineItems","itemReturns"],"type":"object","title":"ItemReturnJob","description":"ItemReturnJob"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"ItemReturn":{"additionalProperties":false,"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"parcelRefs":{"items":{"description":"references the parcel","type":"string"},"type":"array"},"returnedLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItem"},"minItems":1,"type":"array"},"returnFacilityRef":{"type":"string"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnStatus"},"tenantOrderId":{"type":"string"}},"required":["id","status","returnedLineItems","returnFacilityRef"],"title":"ItemReturn","description":"ItemReturn"},"ItemReturnLineItem":{"additionalProperties":false,"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"refund":{"$ref":"#/components/schemas/ReturnedLineItemRefund"},"scannedCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnLineItemStatus"},"tenantArticleId":{"type":"string"}},"required":["id","status","itemReturnJobLineItemRefs","tenantArticleId"],"title":"ItemReturnLineItem","description":"ItemReturnLineItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","description":"ItemReturnLineItemReason"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ReturnedLineItemRefund":{"additionalProperties":false,"description":"Either price or percent must be set, not both.","properties":{"percent":{"description":"0.0 - 100.0 amount of the line item price that should be refunded","type":"number"},"price":{"$ref":"#/components/schemas/ReturnedLineItemRefundPrice"},"status":{"$ref":"#/components/schemas/ReturnedLineItemRefundStatus"}},"required":["status"],"title":"ReturnedLineItemRefund"},"ReturnedLineItemRefundPrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"value":{"description":"0.0 till line item price that should be refunded","type":"number"}},"required":["value","currency"],"title":"ReturnedLineItemRefundPrice","description":"ReturnedLineItemRefundPrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ReturnedLineItemRefundStatus":{"enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","title":"ReturnedLineItemRefundStatus","description":"ReturnedLineItemRefundStatus"},"ItemReturnLineItemStatus":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string","title":"ItemReturnLineItemStatus","description":"ItemReturnLineItemStatus"},"ItemReturnStatus":{"enum":["ANNOUNCED","OPEN","IN_PROGRESS","PAUSED","FINISHED","WAITING_FOR_INPUT"],"type":"string","title":"ItemReturnStatus","description":"ItemReturnStatus"},"ItemReturnJobLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/ItemReturnJobLineItemForCreation"}],"properties":{"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"Generated identifier of this entity","type":"string"},"notReturnableItemsExists":{"deprecated":true,"description":"Add items to notReturnableLineItems array in itemReturnJob instead.","type":"boolean"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"returnable":{"description":"Quantity of this line item that can be returned","minimum":0,"type":"number"},"returned":{"description":"Quantity of this line item that has been returned","minimum":0,"type":"number"},"serviceJobRefs":{"description":"refs of the service jobs that altered this line item during the workflow","items":{"type":"string"},"type":"array"}},"required":["id","article","delivered","returned","returnable"],"title":"ItemReturnJobLineItem","description":"ItemReturnJobLineItem"},"ItemReturnJobLineItemForCreation":{"additionalProperties":false,"properties":{"article":{"$ref":"#/components/schemas/ItemReturnJobLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"delivered":{"description":"Quantity of this line item that has been delivered","minimum":1,"type":"number"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"notReturnableItemsExists":{"deprecated":true,"description":"Add items to notReturnableLineItems array in itemReturnJob instead.","type":"boolean"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"nullable":true,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this line item","items":{"type":"string"},"type":"array"},"serviceJobRefs":{"description":"refs of the service jobs that altered this line item during the workflow","items":{"type":"string"},"type":"array"}},"required":["article","delivered"],"title":"ItemReturnJobLineItemForCreation","description":"ItemReturnJobLineItemForCreation"},"ItemReturnJobLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"type":"array"},"prices":{"description":"Deprecated: Use attributes with keys: 'valuePerUnit', 'currency' and 'numberOfDecimalPlaces'","items":{"$ref":"#/components/schemas/ArticlePrice"},"type":"array"}},"type":"object"}],"xml":{"name":"PickLineItemArticle"},"title":"ItemReturnJobLineItemArticle","description":"ItemReturnJobLineItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"ItemReturnJobStatus":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string","title":"ItemReturnJobStatus","description":"ItemReturnJobStatus"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/actions":{"post":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Applies an action to an Item Return. Check ItemReturnActionsParameters for available actions.","operationId":"itemReturnActions","parameters":[{"description":"id of the Item Return Job","in":"path","name":"itemReturnJobId","required":true,"schema":{"type":"string"}},{"description":"id of the Item Return","in":"path","name":"itemReturnId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemReturnActionsParameter"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemReturnJob"}}},"description":"Updated entity"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Call item return action","tags":["Returns (Operations)"]}}}}
```
## Create item return parcel
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Returns all parcels for an itemReturn.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update and read returns.","name":"Returns (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ParcelForCreation":{"additionalProperties":false,"properties":{"carrierInformation":{"$ref":"#/components/schemas/ParcelCarrierInformation"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label","type":"string"},"carrierRef":{"description":"references the carrier to be used for sending. Can not be set when creating a parcel for an existing shipment.","type":"string"},"customAttributes":{"description":"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.","type":"object"},"customProductValue":{"description":"Set this value if you want to overwrite the calculated product value of the parcel.","type":"number"},"dimensions":{"$ref":"#/components/schemas/ParcelDimensions"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"items":{"items":{"$ref":"#/components/schemas/ParcelItemForCreation"},"type":"array"},"loadUnitRefs":{"description":"Reference to array of load unit Refs","items":{"type":"string"},"type":"array"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickUpInformation":{"$ref":"#/components/schemas/ParcelPickUpInformation"},"productValue":{"description":"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.","type":"number"},"productValueCurrency":{"$ref":"#/components/schemas/ProductValueCurrency"},"productValueType":{"$ref":"#/components/schemas/ProductValueType"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"result":{"$ref":"#/components/schemas/ParcelResult"},"returnAddress":{"$ref":"#/components/schemas/FacilityAddress"},"sender":{"$ref":"#/components/schemas/FacilityAddress"},"services":{"$ref":"#/components/schemas/ParcelServices"},"shortId":{"type":"string"},"status":{"$ref":"#/components/schemas/ParcelStatus"},"tenantOrderId":{"description":"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.","type":"string"},"tenantParcelId":{"description":"Tenant specific parcel id, needs to be unique for non obsolete or canceled parcel","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"}},"type":"object","title":"ParcelForCreation","description":"ParcelForCreation"},"ParcelCarrierInformation":{"additionalProperties":false,"description":"Carrier specific information about the parcel for the label creation","properties":{"shippingContainerNumber":{"description":"Specific shipping container number for the parcel","type":"string"}},"type":"object","title":"ParcelCarrierInformation"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"description":"Set this value if you want to overwrite the calculated weight of the parcel (in g).","type":"number"},"height":{"description":"The height of the package (in cm)","type":"number"},"length":{"description":"The length of the package (in cm)","type":"number"},"weight":{"description":"The weight of the package (in g)","type":"number"},"width":{"description":"The width of the package (in cm)","type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"ParcelItemForCreation":{"allOf":[{"$ref":"#/components/schemas/LineItemForCreation"}],"properties":{"article":{"$ref":"#/components/schemas/ParcelItemArticle"},"countryOfManufacture":{"deprecated":true,"description":"Deprecated - use article.attribute.countryOfManufacture instead","type":"string"},"description":{"description":"Description of the given item/items","type":"string"},"hsCode":{"deprecated":true,"description":"Deprecated - use article.attribute.hsCode instead","maxLength":50,"type":"string"},"parcelItemValue":{"$ref":"#/components/schemas/ParcelItemValue","deprecated":true,"description":"Deprecated - use article.attribute.pricePerUnit and article.attribute.currency instead"},"quantity":{"description":"amount of the given items","minimum":1,"type":"integer"},"weightInGram":{"deprecated":true,"description":"Weight of a single item in gram. Deprecated - Use article.attribute.weightPerUnit instead","type":"integer"}},"required":["quantity"],"type":"object","xml":{"name":"ParcelItemForCreation"},"title":"ParcelItemForCreation","description":"ParcelItemForCreation"},"LineItemForCreation":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"title":"LineItemForCreation","type":"object","description":"LineItemForCreation"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ParcelItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ParcelItemArticle"},"title":"ParcelItemArticle","description":"ParcelItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"ParcelItemValue":{"description":"deprecated, use MandatoryShippingArticleAttribute.attributes.pricePerUnit instead","nullable":true,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"},"type":{"$ref":"#/components/schemas/ProductValueType"},"value":{"description":"Monetary Value of a single item in the given currency","type":"number"}},"required":["value","currency"],"type":"object","title":"ParcelItemValue"},"ProductValueType":{"enum":["INSURANCE","CUSTOMS","SHOP_PRICE"],"type":"string","title":"ProductValueType","description":"ProductValueType"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"ParcelPickUpInformation":{"additionalProperties":false,"nullable":true,"properties":{"endTime":{"description":"needs to be after start time","format":"date-time","type":"string"},"startTime":{"description":"needs to be before end time","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object","xml":{"name":"ParcelItemForCreation"},"title":"ParcelPickUpInformation","description":"ParcelPickUpInformation"},"ProductValueCurrency":{"additionalProperties":false,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"}},"required":["currency"],"type":"object","title":"ProductValueCurrency","description":"ProductValueCurrency"},"ParcelResult":{"description":"Within this object you can find the result of the request after it has been processed (status = DONE or FAILED)","properties":{"carrierParcelRef":{"description":"The reference number of the parcel by the carrier","maxLength":120,"minLength":1,"type":"string"},"carrierTrackingNumber":{"type":"string"},"carrierTrackingStatus":{"oneOf":[{"$ref":"#/components/schemas/TrackingStatus"},{"$ref":"#/components/schemas/DhlTrackingStatus"}]},"customsDocumentId":{"description":"The customs document id","type":"string"},"customsDocumentUrl":{"description":"The original customs document URL","type":"string"},"errors":{"additionalProperties":false,"description":"temporary field to show errors during parcel creation, will be removed in the future. used to create summary in error case","properties":{"labelError":{"type":"string"},"returnLabelError":{"type":"string"}},"type":"object"},"labelUrl":{"description":"The URL where you can download the label relative to the path of this resource","type":"string"},"proxyId":{"description":"The ID of the corresponding job at the CEP proxy (if used)","type":"string"},"returnLabelId":{"description":"The original return label id","type":"string"},"returnLabelUrl":{"description":"The original return label URL","type":"string"},"returnTrackingUrl":{"description":"The URL to track the return of this parcel","type":"string"},"sendLabelUrl":{"description":"The original send label URL","type":"string"},"summary":{"description":"Summary of the result of the request in a human readable form.","type":"string"},"trackingStatus":{"$ref":"#/components/schemas/TrackingStatus"},"trackingUrl":{"description":"The URL to track this parcel","type":"string"}},"required":["summary"],"type":"object","title":"ParcelResult"},"TrackingStatus":{"description":"The state of the KEP","enum":["registered","picked_up","delivered","not_delivered","transit","exception","out_for_delivery","destroyed","unknown","canceled","awaits_pickup_by_receiver","delayed","notification"],"title":"TrackingStatus","type":"string"},"DhlTrackingStatus":{"additionalProperties":false,"description":"Native trackingStatus provided by carrier","properties":{"description":{"description":"Description of the status","type":"string"},"location":{"$ref":"#/components/schemas/DhlTrackingLocation"},"remark":{"description":"Remark of the status","type":"string"},"status":{"description":"Status of the parcel as provided by carrier","type":"string"},"statusCode":{"description":"Status code of the parcel as provided by carrier","type":"string"},"statusDetailed":{"description":"Second status description","type":"string"},"timestamp":{"description":"Timestamp this status was set by the carrier","format":"date-time","type":"string"}},"required":["status"],"title":"DhlTrackingStatus","type":"object"},"DhlTrackingLocation":{"additionalProperties":false,"description":"Location information provided by DHL","properties":{"address":{"properties":{"addressLocality":{"type":"string"}},"type":"object"}},"title":"DhlTrackingLocation"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZoneForCreation","description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"ParcelServices":{"additionalProperties":false,"nullable":true,"properties":{"additionalTransportInsurance":{"description":"Additional insurance for the parcel by the carrier","type":"boolean"},"adultSignature":{"description":"Signature from some adult","type":"boolean"},"bulkyGoods":{"type":"boolean"},"customerSignature":{"description":"Signature from the ordering customer needed","type":"boolean"},"identityCheckCompany":{"description":"Identity check that can be done by a person of receiving company","type":"boolean"},"identityCheckPrivate":{"description":"Identity check that can be done by the receiving person","type":"boolean"},"saturdayDelivery":{"description":"Saturday Delivery","type":"boolean"},"signature":{"description":"Signature from anyone needed","type":"boolean"}},"type":"object","title":"ParcelServices","description":"ParcelServices"},"ParcelStatus":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string","title":"ParcelStatus","description":"ParcelStatus"},"OperativeTransfer":{"additionalProperties":false,"properties":{"id":{"description":"The id of the transfer","type":"string"},"type":{"description":"The type of the transfer","enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["id","type"],"title":"OperativeTransfer","type":"object","description":"OperativeTransfer"},"Parcel":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"carrierInformation":{"$ref":"#/components/schemas/ParcelCarrierInformation"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label","type":"string"},"carrierRef":{"description":"Reference to the carrier this parcel should be send by","type":"string"},"customAttributes":{"description":"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.","type":"object"},"customProductValue":{"description":"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€.","type":"number"},"dimensions":{"$ref":"#/components/schemas/ParcelDimensions"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"facilityRef":{"type":"string"},"id":{"description":"The id of this parcel. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"items":{"items":{"$ref":"#/components/schemas/ParcelItem"},"type":"array"},"loadUnitRefs":{"description":"Reference to array of load unit Refs","items":{"type":"string"},"type":"array"},"operativeProcessRef":{"type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickUpInformation":{"$ref":"#/components/schemas/ParcelPickUpInformation"},"postalCharges":{"$ref":"#/components/schemas/ParcelPostalCharge"},"processRef":{"type":"string"},"productValue":{"description":"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€.","type":"number"},"productValueCurrency":{"$ref":"#/components/schemas/ProductValueCurrency"},"productValueType":{"$ref":"#/components/schemas/ProductValueType"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"result":{"$ref":"#/components/schemas/ParcelResult"},"returnAddress":{"$ref":"#/components/schemas/FacilityAddress"},"sender":{"$ref":"#/components/schemas/FacilityAddress"},"services":{"$ref":"#/components/schemas/ParcelServices"},"shipmentRef":{"description":"The id of this shipment this parcel has been created for.","type":"string"},"shortId":{"type":"string"},"status":{"$ref":"#/components/schemas/ParcelStatus"},"tenantOrderId":{"description":"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.","type":"string"},"tenantParcelId":{"description":"Tenant specific parcel id, needs to be unique for non obsolete or canceled parcel","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"}},"required":["id","status","carrierRef","processRef","sender","recipient","loadUnitRefs"],"type":"object"}],"title":"Parcel","description":"Parcel"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ParcelItem":{"allOf":[{"$ref":"#/components/schemas/LineItem"}],"properties":{"article":{"$ref":"#/components/schemas/ParcelItemArticle"},"countryOfManufacture":{"deprecated":true,"description":"Deprecated - use article.attribute.countryOfManufacture instead","type":"string"},"description":{"deprecated":true,"description":"Description - article.title will be used instead - of the given item/items","type":"string"},"hsCode":{"deprecated":true,"description":"Deprecated - use article.attribute.hsCode instead","maxLength":50,"type":"string"},"id":{"description":"The id of this parcelItem.","type":"string"},"originId":{"description":"The id of the line item this line item was originated from, before any split has happened. This can be used to restore the ‘pre-split’ status.","nullable":true,"type":"string"},"parcelItemValue":{"$ref":"#/components/schemas/ParcelItemValue","deprecated":true,"description":"Deprecated - use article.attribute.pricePerUnit and article.attribute.currency instead"},"quantity":{"description":"amount of the given items","minimum":1,"type":"integer"},"weightInGram":{"deprecated":true,"description":"Deprecated - use article.attribute.weightPerUnit instead - Weight of a single item in gram","type":"integer"}},"required":["id","quantity"],"type":"object","xml":{"name":"ParcelItem"},"title":"ParcelItem","description":"ParcelItem"},"LineItem":{"properties":{"article":{"description":"information about the lineItem","type":"object"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id"],"title":"LineItem","type":"object","description":"LineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ParcelPostalCharge":{"properties":{"currency":{"description":"Currency of the given value","type":"string"},"value":{"description":"Monetary Value in the given currency","type":"number"}},"required":["currency","value"],"title":"ParcelPostalCharge","description":"ParcelPostalCharge"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/parcels":{"post":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns all parcels for an itemReturn.","operationId":"createItemReturnParcel","parameters":[{"description":"itemReturnJobId","in":"path","name":"itemReturnJobId","required":true,"schema":{"type":"string"}},{"description":"id of the itemReturn to create a parcel for","in":"path","name":"itemReturnId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParcelForCreation"}}},"description":"Payload of the parcel you want to create","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Parcel"}}},"description":"Create a parcel for an itemReturn"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Create item return parcel","tags":["Returns (Operations)"]}}}}
```
## Update returned line items
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Replace returned line items of an item return of an item return job.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update and read returns.","name":"Returns (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ReplaceReturnedLineItems":{"additionalProperties":false,"properties":{"itemReturnJobVersion":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"},"returnedLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemForCreation"},"minItems":1,"type":"array"}},"required":["itemReturnJobVersion","returnedLineItems"],"title":"ReplaceReturnedLineItems","description":"ReplaceReturnedLineItems"},"ItemReturnLineItemForCreation":{"additionalProperties":false,"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRef":{"description":"id of the item return job line item that is returned","type":"string"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"nullable":true,"type":"array"},"scannedCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnLineItemStatus"},"tenantArticleId":{"type":"string"}},"required":["itemReturnJobLineItemRef","status"],"title":"ItemReturnLineItemForCreation","description":"ItemReturnLineItemForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","description":"ItemReturnLineItemReason"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"ItemReturnLineItemStatus":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string","title":"ItemReturnLineItemStatus","description":"ItemReturnLineItemStatus"},"ItemReturnJob":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"consumerAddresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"type":"array"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"itemReturns":{"items":{"$ref":"#/components/schemas/ItemReturn"},"minItems":0,"type":"array"},"notReturnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItem"},"minItems":0,"type":"array"},"originFacilityRefs":{"items":{"type":"string"},"type":"array"},"processRef":{"type":"string"},"returnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItem"},"minItems":1,"type":"array"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"shortId":{"description":"A short identifier that helps assigning a item return job to a customer. This is automatically created during creation.","type":"string"},"status":{"$ref":"#/components/schemas/ItemReturnJobStatus"},"tenantOrderId":{"type":"string"}},"required":["id","processRef","originFacilityRefs","status","consumerAddresses","returnableLineItems","itemReturns"],"type":"object","title":"ItemReturnJob","description":"ItemReturnJob"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"ItemReturn":{"additionalProperties":false,"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"parcelRefs":{"items":{"description":"references the parcel","type":"string"},"type":"array"},"returnedLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItem"},"minItems":1,"type":"array"},"returnFacilityRef":{"type":"string"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnStatus"},"tenantOrderId":{"type":"string"}},"required":["id","status","returnedLineItems","returnFacilityRef"],"title":"ItemReturn","description":"ItemReturn"},"ItemReturnLineItem":{"additionalProperties":false,"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"refund":{"$ref":"#/components/schemas/ReturnedLineItemRefund"},"scannedCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnLineItemStatus"},"tenantArticleId":{"type":"string"}},"required":["id","status","itemReturnJobLineItemRefs","tenantArticleId"],"title":"ItemReturnLineItem","description":"ItemReturnLineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ReturnedLineItemRefund":{"additionalProperties":false,"description":"Either price or percent must be set, not both.","properties":{"percent":{"description":"0.0 - 100.0 amount of the line item price that should be refunded","type":"number"},"price":{"$ref":"#/components/schemas/ReturnedLineItemRefundPrice"},"status":{"$ref":"#/components/schemas/ReturnedLineItemRefundStatus"}},"required":["status"],"title":"ReturnedLineItemRefund"},"ReturnedLineItemRefundPrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"value":{"description":"0.0 till line item price that should be refunded","type":"number"}},"required":["value","currency"],"title":"ReturnedLineItemRefundPrice","description":"ReturnedLineItemRefundPrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ReturnedLineItemRefundStatus":{"enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","title":"ReturnedLineItemRefundStatus","description":"ReturnedLineItemRefundStatus"},"ItemReturnStatus":{"enum":["ANNOUNCED","OPEN","IN_PROGRESS","PAUSED","FINISHED","WAITING_FOR_INPUT"],"type":"string","title":"ItemReturnStatus","description":"ItemReturnStatus"},"ItemReturnJobLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/ItemReturnJobLineItemForCreation"}],"properties":{"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"Generated identifier of this entity","type":"string"},"notReturnableItemsExists":{"deprecated":true,"description":"Add items to notReturnableLineItems array in itemReturnJob instead.","type":"boolean"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"returnable":{"description":"Quantity of this line item that can be returned","minimum":0,"type":"number"},"returned":{"description":"Quantity of this line item that has been returned","minimum":0,"type":"number"},"serviceJobRefs":{"description":"refs of the service jobs that altered this line item during the workflow","items":{"type":"string"},"type":"array"}},"required":["id","article","delivered","returned","returnable"],"title":"ItemReturnJobLineItem","description":"ItemReturnJobLineItem"},"ItemReturnJobLineItemForCreation":{"additionalProperties":false,"properties":{"article":{"$ref":"#/components/schemas/ItemReturnJobLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"delivered":{"description":"Quantity of this line item that has been delivered","minimum":1,"type":"number"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"notReturnableItemsExists":{"deprecated":true,"description":"Add items to notReturnableLineItems array in itemReturnJob instead.","type":"boolean"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"nullable":true,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this line item","items":{"type":"string"},"type":"array"},"serviceJobRefs":{"description":"refs of the service jobs that altered this line item during the workflow","items":{"type":"string"},"type":"array"}},"required":["article","delivered"],"title":"ItemReturnJobLineItemForCreation","description":"ItemReturnJobLineItemForCreation"},"ItemReturnJobLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"type":"array"},"prices":{"description":"Deprecated: Use attributes with keys: 'valuePerUnit', 'currency' and 'numberOfDecimalPlaces'","items":{"$ref":"#/components/schemas/ArticlePrice"},"type":"array"}},"type":"object"}],"xml":{"name":"PickLineItemArticle"},"title":"ItemReturnJobLineItemArticle","description":"ItemReturnJobLineItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"ItemReturnJobStatus":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string","title":"ItemReturnJobStatus","description":"ItemReturnJobStatus"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/returnedlineitems":{"put":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Replace returned line items of an item return of an item return job.","operationId":"replaceReturnedLineItems","parameters":[{"description":"id of the item return job the item return belongs to","in":"path","name":"itemReturnJobId","required":true,"schema":{"type":"string"}},{"description":"id of the item return the returned line items belong to","in":"path","name":"itemReturnId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplaceReturnedLineItems"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemReturnJob"}}},"description":"The returned line items were successfully updated. Updated item return job is returned."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity version conflict"}},"summary":"Update returned line items","tags":["Returns (Operations)"]}}}}
```
## Update returned line item
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Patch for a ItemReturn LineItem. This is used to update the returned line item.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update and read returns.","name":"Returns (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ItemReturnLineItemForUpdate":{"additionalProperties":false,"properties":{"itemReturnJobVersion":{"description":"version of the overlaying itemReturnJob","type":"number"},"refund":{"$ref":"#/components/schemas/ReturnedLineItemRefund"},"status":{"$ref":"#/components/schemas/ItemReturnLineItemStatus"}},"required":["itemReturnJobVersion"],"title":"ItemReturnLineItemForUpdate","description":"ItemReturnLineItemForUpdate"},"ReturnedLineItemRefund":{"additionalProperties":false,"description":"Either price or percent must be set, not both.","properties":{"percent":{"description":"0.0 - 100.0 amount of the line item price that should be refunded","type":"number"},"price":{"$ref":"#/components/schemas/ReturnedLineItemRefundPrice"},"status":{"$ref":"#/components/schemas/ReturnedLineItemRefundStatus"}},"required":["status"],"title":"ReturnedLineItemRefund"},"ReturnedLineItemRefundPrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"value":{"description":"0.0 till line item price that should be refunded","type":"number"}},"required":["value","currency"],"title":"ReturnedLineItemRefundPrice","description":"ReturnedLineItemRefundPrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ReturnedLineItemRefundStatus":{"enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","title":"ReturnedLineItemRefundStatus","description":"ReturnedLineItemRefundStatus"},"ItemReturnLineItemStatus":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string","title":"ItemReturnLineItemStatus","description":"ItemReturnLineItemStatus"},"ItemReturnJob":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"consumerAddresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"type":"array"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"itemReturns":{"items":{"$ref":"#/components/schemas/ItemReturn"},"minItems":0,"type":"array"},"notReturnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItem"},"minItems":0,"type":"array"},"originFacilityRefs":{"items":{"type":"string"},"type":"array"},"processRef":{"type":"string"},"returnableLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnJobLineItem"},"minItems":1,"type":"array"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"shortId":{"description":"A short identifier that helps assigning a item return job to a customer. This is automatically created during creation.","type":"string"},"status":{"$ref":"#/components/schemas/ItemReturnJobStatus"},"tenantOrderId":{"type":"string"}},"required":["id","processRef","originFacilityRefs","status","consumerAddresses","returnableLineItems","itemReturns"],"type":"object","title":"ItemReturnJob","description":"ItemReturnJob"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"ItemReturn":{"additionalProperties":false,"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"parcelRefs":{"items":{"description":"references the parcel","type":"string"},"type":"array"},"returnedLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItem"},"minItems":1,"type":"array"},"returnFacilityRef":{"type":"string"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnStatus"},"tenantOrderId":{"type":"string"}},"required":["id","status","returnedLineItems","returnFacilityRef"],"title":"ItemReturn","description":"ItemReturn"},"ItemReturnLineItem":{"additionalProperties":false,"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"refund":{"$ref":"#/components/schemas/ReturnedLineItemRefund"},"scannedCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnLineItemStatus"},"tenantArticleId":{"type":"string"}},"required":["id","status","itemReturnJobLineItemRefs","tenantArticleId"],"title":"ItemReturnLineItem","description":"ItemReturnLineItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","description":"ItemReturnLineItemReason"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ItemReturnStatus":{"enum":["ANNOUNCED","OPEN","IN_PROGRESS","PAUSED","FINISHED","WAITING_FOR_INPUT"],"type":"string","title":"ItemReturnStatus","description":"ItemReturnStatus"},"ItemReturnJobLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/ItemReturnJobLineItemForCreation"}],"properties":{"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"Generated identifier of this entity","type":"string"},"notReturnableItemsExists":{"deprecated":true,"description":"Add items to notReturnableLineItems array in itemReturnJob instead.","type":"boolean"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"returnable":{"description":"Quantity of this line item that can be returned","minimum":0,"type":"number"},"returned":{"description":"Quantity of this line item that has been returned","minimum":0,"type":"number"},"serviceJobRefs":{"description":"refs of the service jobs that altered this line item during the workflow","items":{"type":"string"},"type":"array"}},"required":["id","article","delivered","returned","returnable"],"title":"ItemReturnJobLineItem","description":"ItemReturnJobLineItem"},"ItemReturnJobLineItemForCreation":{"additionalProperties":false,"properties":{"article":{"$ref":"#/components/schemas/ItemReturnJobLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"delivered":{"description":"Quantity of this line item that has been delivered","minimum":1,"type":"number"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"notReturnableItemsExists":{"deprecated":true,"description":"Add items to notReturnableLineItems array in itemReturnJob instead.","type":"boolean"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"nullable":true,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this line item","items":{"type":"string"},"type":"array"},"serviceJobRefs":{"description":"refs of the service jobs that altered this line item during the workflow","items":{"type":"string"},"type":"array"}},"required":["article","delivered"],"title":"ItemReturnJobLineItemForCreation","description":"ItemReturnJobLineItemForCreation"},"ItemReturnJobLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"type":"array"},"prices":{"description":"Deprecated: Use attributes with keys: 'valuePerUnit', 'currency' and 'numberOfDecimalPlaces'","items":{"$ref":"#/components/schemas/ArticlePrice"},"type":"array"}},"type":"object"}],"xml":{"name":"PickLineItemArticle"},"title":"ItemReturnJobLineItemArticle","description":"ItemReturnJobLineItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"ItemReturnJobStatus":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string","title":"ItemReturnJobStatus","description":"ItemReturnJobStatus"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/returnedlineitems/{returnedLineItemId}":{"patch":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Patch for a ItemReturn LineItem. This is used to update the returned line item.","operationId":"updateItemReturnLineItem","parameters":[{"description":"id of the Item Return Job","in":"path","name":"itemReturnJobId","required":true,"schema":{"type":"string"}},{"description":"id of the Item Return","in":"path","name":"itemReturnId","required":true,"schema":{"type":"string"}},{"description":"id of the returnedLineItem","in":"path","name":"returnedLineItemId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemReturnLineItemForUpdate"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemReturnJob"}}},"description":"Updated ItemReturnJob"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Update returned line item","tags":["Returns (Operations)"]}}}}
```
## Get item returns
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Returns the item returns matching the given parameters.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update and read returns.","name":"Returns (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ItemReturn":{"additionalProperties":false,"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"parcelRefs":{"items":{"description":"references the parcel","type":"string"},"type":"array"},"returnedLineItems":{"items":{"$ref":"#/components/schemas/ItemReturnLineItem"},"minItems":1,"type":"array"},"returnFacilityRef":{"type":"string"},"scannableCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnStatus"},"tenantOrderId":{"type":"string"}},"required":["id","status","returnedLineItems","returnFacilityRef"],"title":"ItemReturn","description":"ItemReturn"},"ItemReturnLineItem":{"additionalProperties":false,"properties":{"itemConditionLocalized":{"$ref":"#/components/schemas/LocaleString"},"customAttributes":{"description":"Attributes that can be added to the entity. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"id":{"type":"string"},"itemCondition":{"type":"string"},"itemConditionComment":{"minLength":1,"type":"string"},"itemReturnJobLineItemRefs":{"items":{"type":"string"},"type":"array"},"reasons":{"items":{"$ref":"#/components/schemas/ItemReturnLineItemReason"},"type":"array"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"refund":{"$ref":"#/components/schemas/ReturnedLineItemRefund"},"scannedCodes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/ItemReturnLineItemStatus"},"tenantArticleId":{"type":"string"}},"required":["id","status","itemReturnJobLineItemRefs","tenantArticleId"],"title":"ItemReturnLineItem","description":"ItemReturnLineItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ItemReturnLineItemReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"minLength":1,"type":"string"},"reason":{"description":"Translated reasonLocalized","type":"string"}},"required":["reasonLocalized"],"title":"ItemReturnLineItemReason","description":"ItemReturnLineItemReason"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ReturnedLineItemRefund":{"additionalProperties":false,"description":"Either price or percent must be set, not both.","properties":{"percent":{"description":"0.0 - 100.0 amount of the line item price that should be refunded","type":"number"},"price":{"$ref":"#/components/schemas/ReturnedLineItemRefundPrice"},"status":{"$ref":"#/components/schemas/ReturnedLineItemRefundStatus"}},"required":["status"],"title":"ReturnedLineItemRefund"},"ReturnedLineItemRefundPrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"value":{"description":"0.0 till line item price that should be refunded","type":"number"}},"required":["value","currency"],"title":"ReturnedLineItemRefundPrice","description":"ReturnedLineItemRefundPrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ReturnedLineItemRefundStatus":{"enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","title":"ReturnedLineItemRefundStatus","description":"ReturnedLineItemRefundStatus"},"ItemReturnLineItemStatus":{"enum":["OPEN","IN_PROGRESS","WAITING_FOR_INPUT","REJECTED","ACCEPTED","CANCELED"],"type":"string","title":"ItemReturnLineItemStatus","description":"ItemReturnLineItemStatus"},"ItemReturnStatus":{"enum":["ANNOUNCED","OPEN","IN_PROGRESS","PAUSED","FINISHED","WAITING_FOR_INPUT"],"type":"string","title":"ItemReturnStatus","description":"ItemReturnStatus"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/itemreturns":{"get":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns the item returns matching the given parameters.","operationId":"findItemReturns","parameters":[{"description":"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","in":"query","name":"searchTerm","required":false,"schema":{"type":"string"}},{"description":"facilities to filter the results","in":"query","name":"facilityRefs","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"description":"ItemReturnStatus of an included ItemReturn to filter the results","in":"query","name":"itemReturnStatus","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"description":"ItemReturnLineItemStatus of an included itemReturnLineItem to filter the results","in":"query","name":"itemReturnLineItemStatus","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"description":"entity to start after","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"description":"number of entities to show","in":"query","name":"size","required":false,"schema":{"default":25,"type":"integer"}},{"description":"show anonymized entities or not","in":"query","name":"anonymized","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"sorting for the results","in":"query","name":"orderBy","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ItemReturn"}}}},"description":"All Item Returns matching the given parameters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Get item returns","tags":["Returns (Operations)"]}}}}
```