# Handover endpoints
## The Handoverjob object
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Handoverjob":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"assignedUsers":{"description":"Assigned users for this entity","items":{"$ref":"#/components/schemas/AssignedUser"},"type":"array"},"cancelReason":{"$ref":"#/components/schemas/HandoverJobCancelReason"},"carrierKey":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"carrierLogoUrl":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"carrierRef":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"carrierTrackingNumber":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"channel":{"enum":["DELIVERY","COLLECT"],"type":"string"},"customAttributes":{"description":"Attributes that can be added to the handover job. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"documents":{"items":{"$ref":"#/components/schemas/PrintableDocument"},"type":"array"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"expectedHandoverJobLineItems":{"items":{"$ref":"#/components/schemas/ExpectedHandoverLineItem"},"type":"array"},"facilityRef":{"description":"The id of the facility reference.","type":"string"},"fullIdentifier":{"description":"An information to identify the recipient","type":"string"},"handoverJobLineItems":{"items":{"$ref":"#/components/schemas/HandoverLineItem"}},"handoverJobParcelInfo":{"$ref":"#/components/schemas/HandoverJobParcelInfo"},"id":{"description":"The id of this handoverjob. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"loadUnitRefs":{"description":"Reference to array of load unit Refs","items":{"type":"string"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"paid":{"description":"Indicates if the order is already paid","type":"boolean"},"parcelRef":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"pickJobRef":{"description":"The reference to the pickjob for which the handoverjob is assigned to","type":"string"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"recipientAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"shipmentRef":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"shortIdentifier":{"description":"The short identifier of the shipment.","type":"string"},"status":{"$ref":"#/components/schemas/HandoverjobStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"targetTime":{"description":"The time the handoverjob is expected to be picked up at the facility.","format":"date-time","type":"string"},"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"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"tags":{"description":"Tags can only be set when there is no process related with this handoverJob. Setting processId and tags will lead to an validationError.","items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}}}],"required":["id","status","facilityRef","targetTime","channel","orderDate"],"type":"object","title":"Handoverjob","description":"Handoverjob"},"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"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"HandoverJobCancelReason":{"enum":["CONSUMER_NO_SHOW","CONSUMER_REJECTS","ORDER_CANCELED"],"type":"string","title":"HandoverJobCancelReason","description":"HandoverJobCancelReason"},"PrintableDocument":{"properties":{"customAttributes":{"description":"Attributes that can be added to the document. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"documentCategory":{"$ref":"#/components/schemas/DocumentCategory"},"documentType":{"$ref":"#/components/schemas/DocumentType"},"id":{"type":"string"},"name":{"type":"string"},"operations":{"description":"Offered operations for this document","items":{"$ref":"#/components/schemas/DocumentOperations"},"type":"array"},"path":{"type":"string"},"priority":{"minimum":0,"type":"number"},"status":{"$ref":"#/components/schemas/DocumentStatus"}},"required":["documentType","id","status","documentCategory"],"type":"object","title":"PrintableDocument","description":"PrintableDocument"},"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","CUSTOMS"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"DocumentType":{"enum":["PDF","PNG","JPG","GIF","JPEG","XML","JSON"],"type":"string","title":"DocumentType","description":"DocumentType"},"DocumentOperations":{"enum":["PRINT","VIEW"],"type":"string","title":"DocumentOperations","description":"DocumentOperations"},"DocumentStatus":{"enum":["AVAILABLE","LOADING","REQUESTABLE","CANCELED","WAITING_FOR_INPUT"],"type":"string","title":"DocumentStatus","description":"DocumentStatus"},"ExpectedHandoverLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/ExpectedHandoverLineItemForCreation"}],"properties":{"id":{"type":"string"}},"required":["id"],"type":"object","title":"ExpectedHandoverLineItem","description":"ExpectedHandoverLineItem"},"ExpectedHandoverLineItemForCreation":{"additionalProperties":false,"properties":{"article":{"$ref":"#/components/schemas/HandoverLineItemArticle"},"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"},"quantity":{"description":"quantity of the specific item that has been provided for handover","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/HandoverLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"transferId":{"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article","transferId"],"type":"object","title":"ExpectedHandoverLineItemForCreation","description":"ExpectedHandoverLineItemForCreation"},"HandoverLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"HandoverLineItemArticle"},"title":"HandoverLineItemArticle","description":"HandoverLineItemArticle"},"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"},"HandoverLineItemStatus":{"enum":["OPEN","CLOSED"],"type":"string","title":"HandoverLineItemStatus","description":"HandoverLineItemStatus"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"HandoverLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"}],"properties":{"article":{"$ref":"#/components/schemas/HandoverLineItemArticle"},"handedOverQuantity":{"description":"quantity of the specific item that has been handed over","format":"int64","minimum":0,"type":"integer"},"id":{"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"},"quantity":{"description":"quantity of the specific item that has been provided for handover","format":"int64","minimum":1,"type":"integer"},"refused":{"items":{"$ref":"#/components/schemas/RefusedItem"},"type":"array"},"status":{"$ref":"#/components/schemas/HandoverLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"substituteLineItems":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
","items":{"$ref":"#/components/schemas/HandoverSubstituteLineItem"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","article","quantity","handedOverQuantity"],"title":"HandoverLineItem","description":"HandoverLineItem"},"MandatoryLineItem":{"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","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"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"},"RefusedItem":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"},"reason":{"type":"string"}},"required":["quantity"],"title":"RefusedItem","description":"RefusedItem"},"HandoverSubstituteLineItem":{"properties":{"article":{"$ref":"#/components/schemas/SubstituteLineItemArticle"},"handedOverQuantity":{"description":"quantity of the specific item to substitute the original line item that has been handed over","format":"int64","minimum":0,"type":"integer"},"id":{"type":"string"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/SubstituteLineItemPartialStockLocation"},"type":"array"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"quantity":{"description":"quantity of the specific item to substitute the original line item that has been provided for handover","format":"int64","minimum":1,"type":"integer"},"refused":{"items":{"$ref":"#/components/schemas/RefusedItem"},"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"}},"required":["quantity","article","id"],"title":"HandoverSubstituteLineItem","description":"HandoverSubstituteLineItem"},"SubstituteLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"SubstituteLineItemArticle"},"title":"SubstituteLineItemArticle","description":"SubstituteLineItemArticle"},"SubstituteLineItemPartialStockLocation":{"properties":{"location":{"$ref":"#/components/schemas/Location"},"picked":{"format":"int64","minimum":0,"type":"number"},"quantity":{"format":"int64","minimum":0,"type":"number"},"ratingScore":{"type":"number"},"sequenceScore":{"type":"number"},"stockProperties":{"anyOf":[{"$ref":"#/components/schemas/PickingStockPropertyPreset"},{"$ref":"#/components/schemas/PickingStockProperty"}]},"stockRef":{"type":"string"},"tenantPartialStockId":{"type":"string"},"zoneName":{"type":"string"}},"required":["location","quantity"],"type":"object","title":"SubstituteLineItemPartialStockLocation","description":"SubstituteLineItemPartialStockLocation"},"Location":{"properties":{"locationRef":{"description":"The id of the location","type":"string"},"scannableCodes":{"description":"Represents barcodes that may be scanned at this location","items":{"type":"string"},"type":"array"}},"xml":{"name":"Location"},"title":"Location","description":"Location"},"PickingStockPropertyPreset":{"description":"Preset of Picking Stock Property.","properties":{"expiry":{"type":"string"}},"title":"PickingStockPropertyPreset","type":"object"},"PickingStockProperty":{"additionalProperties":{"type":"string"},"description":"Picking Stock Property.","title":"PickingStockProperty","type":"object"},"HandoverJobParcelInfo":{"allOf":[{"$ref":"#/components/schemas/HandoverJobParcelInfoForCreation"},{"properties":{"carrierKey":{"description":"the key of the carrier","type":"string"}}}],"type":"object","title":"HandoverJobParcelInfo","description":"HandoverJobParcelInfo"},"HandoverJobParcelInfoForCreation":{"additionalProperties":false,"properties":{"carrierLogoUrl":{"description":"The URL to the carrier logo","type":"string"},"carrierParcelRef":{"description":"The reference number of the parcel by the carrier","maxLength":120,"minLength":1,"type":"string"},"carrierRef":{"description":"the reference to the related carrier","type":"string"},"carrierTrackingNumber":{"description":"the tracking number of the parcel","type":"string"},"parcelRef":{"description":"the reference to the related parcel","type":"string"},"shipmentRef":{"description":"the reference to the related shipment","type":"string"}},"type":"object","title":"HandoverJobParcelInfoForCreation","description":"HandoverJobParcelInfoForCreation"},"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"},"HandoverjobStatus":{"description":"Status of a Handover Job.\n- OPEN: Active and ready for processing (default initial state)\n- WAITING_FOR_INPUT: Waiting for line items to be populated\n- HANDED_OVER: Items have been handed over (completion state)\n- CANCELED: Handover job was canceled\n- OBSOLETE: No longer relevant (terminal state, cannot transition out)\n","enum":["OPEN","HANDED_OVER","OBSOLETE","CANCELED","WAITING_FOR_INPUT"],"type":"string","title":"HandoverjobStatus"},"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"}}}}
```
## POST /api/handoverjobs
> Create handover job
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints manage the handover process.","name":"Handovers (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":{"HandoverjobForCreation":{"additionalProperties":false,"properties":{"assignedUsers":{"description":"Assigned users for this entity","items":{"anyOf":[{"$ref":"#/components/schemas/AssignedUserForCreationByName"},{"$ref":"#/components/schemas/AssignedUserForCreationById"}]},"type":"array"},"cancelReason":{"$ref":"#/components/schemas/HandoverJobCancelReason"},"carrierLogoUrl":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"carrierRef":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"carrierTrackingNumber":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"channel":{"enum":["DELIVERY","COLLECT"],"type":"string"},"customAttributes":{"description":"Attributes that can be added to the handover job. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"expectedHandoverJobLineItems":{"items":{"$ref":"#/components/schemas/ExpectedHandoverLineItemForCreation"},"type":"array"},"facilityRef":{"description":"The id of the facility reference.","type":"string"},"fullIdentifier":{"description":"An information to identify the recipient","type":"string"},"handoverJobLineItems":{"items":{"$ref":"#/components/schemas/HandoverLineItemForCreation"},"type":"array"},"handoverJobParcelInfo":{"$ref":"#/components/schemas/HandoverJobParcelInfoForCreation"},"invoiceAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"loadUnitRefs":{"description":"Reference to array of load unit Refs","items":{"type":"string"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"paid":{"description":"Indicates if the order is already paid","type":"boolean"},"parcelRef":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"pickJobRef":{"description":"The reference to the pickjob for which the handoverjob is assigned to","type":"string"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"recipientAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"routingPlanRef":{"description":"The reference to the routing plan for which the handoverjob is assigned to","type":"string"},"shipmentRef":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"shortIdentifier":{"description":"The short identifier of the shipment.","type":"string"},"status":{"$ref":"#/components/schemas/HandoverjobStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"minItems":1,"type":"array"},"targetTime":{"description":"The time the handoverjob is expected to be picked up at the facility.","format":"date-time","type":"string"},"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"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"tags":{"description":"Tags can only be set when there is no process related with this handoverJob. Setting processId and tags will lead to an validationError.","items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["facilityRef","targetTime","channel","orderDate"],"type":"object","title":"HandoverjobForCreation","description":"HandoverjobForCreation"},"AssignedUserForCreationByName":{"description":"Create a assigned user by giving a valid name","properties":{"username":{"description":"username of the user should be assigned","type":"string"}},"required":["username"],"title":"AssignedUserForCreationByName","type":"object"},"AssignedUserForCreationById":{"description":"Create a assigned user by giving a valid id","properties":{"userId":{"description":"userId of the user should be assigned","type":"string"}},"required":["userId"],"title":"AssignedUserForCreationById","type":"object"},"HandoverJobCancelReason":{"enum":["CONSUMER_NO_SHOW","CONSUMER_REJECTS","ORDER_CANCELED"],"type":"string","title":"HandoverJobCancelReason","description":"HandoverJobCancelReason"},"ExpectedHandoverLineItemForCreation":{"additionalProperties":false,"properties":{"article":{"$ref":"#/components/schemas/HandoverLineItemArticle"},"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"},"quantity":{"description":"quantity of the specific item that has been provided for handover","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/HandoverLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"transferId":{"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article","transferId"],"type":"object","title":"ExpectedHandoverLineItemForCreation","description":"ExpectedHandoverLineItemForCreation"},"HandoverLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"HandoverLineItemArticle"},"title":"HandoverLineItemArticle","description":"HandoverLineItemArticle"},"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"},"HandoverLineItemStatus":{"enum":["OPEN","CLOSED"],"type":"string","title":"HandoverLineItemStatus","description":"HandoverLineItemStatus"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"HandoverLineItemForCreation":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"}],"properties":{"article":{"$ref":"#/components/schemas/HandoverLineItemArticle"},"handedOverQuantity":{"description":"quantity of the specific item that has been handed over","format":"int64","minimum":0,"type":"integer"},"quantity":{"description":"quantity of the specific item that has been provided for handover","format":"int64","minimum":1,"type":"integer"},"refused":{"items":{"$ref":"#/components/schemas/RefusedItem"},"type":"array"},"status":{"$ref":"#/components/schemas/HandoverLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"substituteLineItems":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
","items":{"$ref":"#/components/schemas/HandoverSubstituteLineItemForCreation"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article","handedOverQuantity"],"type":"object","title":"HandoverLineItemForCreation","description":"HandoverLineItemForCreation"},"MandatoryLineItemForCreation":{"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"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"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"},"RefusedItem":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"},"reason":{"type":"string"}},"required":["quantity"],"title":"RefusedItem","description":"RefusedItem"},"HandoverSubstituteLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/SubstituteLineItemArticle"},"handedOverQuantity":{"description":"quantity of the specific item to substitute the original line item that has been handed over","format":"int64","minimum":0,"type":"integer"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/SubstituteLineItemPartialStockLocation"},"type":"array"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"quantity":{"description":"quantity of the specific item to substitute the original line item that has been provided for handover","format":"int64","minimum":1,"type":"integer"},"refused":{"items":{"$ref":"#/components/schemas/RefusedItem"},"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"}},"required":["quantity","article"],"title":"HandoverSubstituteLineItemForCreation","description":"HandoverSubstituteLineItemForCreation"},"SubstituteLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"SubstituteLineItemArticle"},"title":"SubstituteLineItemArticle","description":"SubstituteLineItemArticle"},"SubstituteLineItemPartialStockLocation":{"properties":{"location":{"$ref":"#/components/schemas/Location"},"picked":{"format":"int64","minimum":0,"type":"number"},"quantity":{"format":"int64","minimum":0,"type":"number"},"ratingScore":{"type":"number"},"sequenceScore":{"type":"number"},"stockProperties":{"anyOf":[{"$ref":"#/components/schemas/PickingStockPropertyPreset"},{"$ref":"#/components/schemas/PickingStockProperty"}]},"stockRef":{"type":"string"},"tenantPartialStockId":{"type":"string"},"zoneName":{"type":"string"}},"required":["location","quantity"],"type":"object","title":"SubstituteLineItemPartialStockLocation","description":"SubstituteLineItemPartialStockLocation"},"Location":{"properties":{"locationRef":{"description":"The id of the location","type":"string"},"scannableCodes":{"description":"Represents barcodes that may be scanned at this location","items":{"type":"string"},"type":"array"}},"xml":{"name":"Location"},"title":"Location","description":"Location"},"PickingStockPropertyPreset":{"description":"Preset of Picking Stock Property.","properties":{"expiry":{"type":"string"}},"title":"PickingStockPropertyPreset","type":"object"},"PickingStockProperty":{"additionalProperties":{"type":"string"},"description":"Picking Stock Property.","title":"PickingStockProperty","type":"object"},"HandoverJobParcelInfoForCreation":{"additionalProperties":false,"properties":{"carrierLogoUrl":{"description":"The URL to the carrier logo","type":"string"},"carrierParcelRef":{"description":"The reference number of the parcel by the carrier","maxLength":120,"minLength":1,"type":"string"},"carrierRef":{"description":"the reference to the related carrier","type":"string"},"carrierTrackingNumber":{"description":"the tracking number of the parcel","type":"string"},"parcelRef":{"description":"the reference to the related parcel","type":"string"},"shipmentRef":{"description":"the reference to the related shipment","type":"string"}},"type":"object","title":"HandoverJobParcelInfoForCreation","description":"HandoverJobParcelInfoForCreation"},"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"},"HandoverjobStatus":{"description":"Status of a Handover Job.\n- OPEN: Active and ready for processing (default initial state)\n- WAITING_FOR_INPUT: Waiting for line items to be populated\n- HANDED_OVER: Items have been handed over (completion state)\n- CANCELED: Handover job was canceled\n- OBSOLETE: No longer relevant (terminal state, cannot transition out)\n","enum":["OPEN","HANDED_OVER","OBSOLETE","CANCELED","WAITING_FOR_INPUT"],"type":"string","title":"HandoverjobStatus"},"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"},"Handoverjob":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"assignedUsers":{"description":"Assigned users for this entity","items":{"$ref":"#/components/schemas/AssignedUser"},"type":"array"},"cancelReason":{"$ref":"#/components/schemas/HandoverJobCancelReason"},"carrierKey":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"carrierLogoUrl":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"carrierRef":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"carrierTrackingNumber":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"channel":{"enum":["DELIVERY","COLLECT"],"type":"string"},"customAttributes":{"description":"Attributes that can be added to the handover job. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"documents":{"items":{"$ref":"#/components/schemas/PrintableDocument"},"type":"array"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"expectedHandoverJobLineItems":{"items":{"$ref":"#/components/schemas/ExpectedHandoverLineItem"},"type":"array"},"facilityRef":{"description":"The id of the facility reference.","type":"string"},"fullIdentifier":{"description":"An information to identify the recipient","type":"string"},"handoverJobLineItems":{"items":{"$ref":"#/components/schemas/HandoverLineItem"}},"handoverJobParcelInfo":{"$ref":"#/components/schemas/HandoverJobParcelInfo"},"id":{"description":"The id of this handoverjob. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"loadUnitRefs":{"description":"Reference to array of load unit Refs","items":{"type":"string"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"paid":{"description":"Indicates if the order is already paid","type":"boolean"},"parcelRef":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"pickJobRef":{"description":"The reference to the pickjob for which the handoverjob is assigned to","type":"string"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"recipientAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"shipmentRef":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"shortIdentifier":{"description":"The short identifier of the shipment.","type":"string"},"status":{"$ref":"#/components/schemas/HandoverjobStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"targetTime":{"description":"The time the handoverjob is expected to be picked up at the facility.","format":"date-time","type":"string"},"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"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"tags":{"description":"Tags can only be set when there is no process related with this handoverJob. Setting processId and tags will lead to an validationError.","items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}}}],"required":["id","status","facilityRef","targetTime","channel","orderDate"],"type":"object","title":"Handoverjob","description":"Handoverjob"},"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"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"PrintableDocument":{"properties":{"customAttributes":{"description":"Attributes that can be added to the document. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"documentCategory":{"$ref":"#/components/schemas/DocumentCategory"},"documentType":{"$ref":"#/components/schemas/DocumentType"},"id":{"type":"string"},"name":{"type":"string"},"operations":{"description":"Offered operations for this document","items":{"$ref":"#/components/schemas/DocumentOperations"},"type":"array"},"path":{"type":"string"},"priority":{"minimum":0,"type":"number"},"status":{"$ref":"#/components/schemas/DocumentStatus"}},"required":["documentType","id","status","documentCategory"],"type":"object","title":"PrintableDocument","description":"PrintableDocument"},"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","CUSTOMS"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"DocumentType":{"enum":["PDF","PNG","JPG","GIF","JPEG","XML","JSON"],"type":"string","title":"DocumentType","description":"DocumentType"},"DocumentOperations":{"enum":["PRINT","VIEW"],"type":"string","title":"DocumentOperations","description":"DocumentOperations"},"DocumentStatus":{"enum":["AVAILABLE","LOADING","REQUESTABLE","CANCELED","WAITING_FOR_INPUT"],"type":"string","title":"DocumentStatus","description":"DocumentStatus"},"ExpectedHandoverLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/ExpectedHandoverLineItemForCreation"}],"properties":{"id":{"type":"string"}},"required":["id"],"type":"object","title":"ExpectedHandoverLineItem","description":"ExpectedHandoverLineItem"},"HandoverLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"}],"properties":{"article":{"$ref":"#/components/schemas/HandoverLineItemArticle"},"handedOverQuantity":{"description":"quantity of the specific item that has been handed over","format":"int64","minimum":0,"type":"integer"},"id":{"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"},"quantity":{"description":"quantity of the specific item that has been provided for handover","format":"int64","minimum":1,"type":"integer"},"refused":{"items":{"$ref":"#/components/schemas/RefusedItem"},"type":"array"},"status":{"$ref":"#/components/schemas/HandoverLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"substituteLineItems":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
","items":{"$ref":"#/components/schemas/HandoverSubstituteLineItem"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","article","quantity","handedOverQuantity"],"title":"HandoverLineItem","description":"HandoverLineItem"},"MandatoryLineItem":{"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","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"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"},"HandoverSubstituteLineItem":{"properties":{"article":{"$ref":"#/components/schemas/SubstituteLineItemArticle"},"handedOverQuantity":{"description":"quantity of the specific item to substitute the original line item that has been handed over","format":"int64","minimum":0,"type":"integer"},"id":{"type":"string"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/SubstituteLineItemPartialStockLocation"},"type":"array"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"quantity":{"description":"quantity of the specific item to substitute the original line item that has been provided for handover","format":"int64","minimum":1,"type":"integer"},"refused":{"items":{"$ref":"#/components/schemas/RefusedItem"},"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"}},"required":["quantity","article","id"],"title":"HandoverSubstituteLineItem","description":"HandoverSubstituteLineItem"},"HandoverJobParcelInfo":{"allOf":[{"$ref":"#/components/schemas/HandoverJobParcelInfoForCreation"},{"properties":{"carrierKey":{"description":"the key of the carrier","type":"string"}}}],"type":"object","title":"HandoverJobParcelInfo","description":"HandoverJobParcelInfo"},"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/handoverjobs":{"post":{"operationId":"addHandoverjob","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandoverjobForCreation"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Handoverjob"}}},"description":"The handoverjob was successfully created. The Location header contains the URL of it."},"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"}},"summary":"Create handover job","tags":["Handovers (Operations)"]}}}}
```
## GET /api/handoverjobs/{handoverjobId}
> Get handover job
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints manage the handover process.","name":"Handovers (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":{"Handoverjob":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"assignedUsers":{"description":"Assigned users for this entity","items":{"$ref":"#/components/schemas/AssignedUser"},"type":"array"},"cancelReason":{"$ref":"#/components/schemas/HandoverJobCancelReason"},"carrierKey":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"carrierLogoUrl":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"carrierRef":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"carrierTrackingNumber":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"channel":{"enum":["DELIVERY","COLLECT"],"type":"string"},"customAttributes":{"description":"Attributes that can be added to the handover job. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"documents":{"items":{"$ref":"#/components/schemas/PrintableDocument"},"type":"array"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"expectedHandoverJobLineItems":{"items":{"$ref":"#/components/schemas/ExpectedHandoverLineItem"},"type":"array"},"facilityRef":{"description":"The id of the facility reference.","type":"string"},"fullIdentifier":{"description":"An information to identify the recipient","type":"string"},"handoverJobLineItems":{"items":{"$ref":"#/components/schemas/HandoverLineItem"}},"handoverJobParcelInfo":{"$ref":"#/components/schemas/HandoverJobParcelInfo"},"id":{"description":"The id of this handoverjob. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"loadUnitRefs":{"description":"Reference to array of load unit Refs","items":{"type":"string"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"paid":{"description":"Indicates if the order is already paid","type":"boolean"},"parcelRef":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"pickJobRef":{"description":"The reference to the pickjob for which the handoverjob is assigned to","type":"string"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"recipientAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"shipmentRef":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"shortIdentifier":{"description":"The short identifier of the shipment.","type":"string"},"status":{"$ref":"#/components/schemas/HandoverjobStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"targetTime":{"description":"The time the handoverjob is expected to be picked up at the facility.","format":"date-time","type":"string"},"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"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"tags":{"description":"Tags can only be set when there is no process related with this handoverJob. Setting processId and tags will lead to an validationError.","items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}}}],"required":["id","status","facilityRef","targetTime","channel","orderDate"],"type":"object","title":"Handoverjob","description":"Handoverjob"},"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"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"HandoverJobCancelReason":{"enum":["CONSUMER_NO_SHOW","CONSUMER_REJECTS","ORDER_CANCELED"],"type":"string","title":"HandoverJobCancelReason","description":"HandoverJobCancelReason"},"PrintableDocument":{"properties":{"customAttributes":{"description":"Attributes that can be added to the document. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"documentCategory":{"$ref":"#/components/schemas/DocumentCategory"},"documentType":{"$ref":"#/components/schemas/DocumentType"},"id":{"type":"string"},"name":{"type":"string"},"operations":{"description":"Offered operations for this document","items":{"$ref":"#/components/schemas/DocumentOperations"},"type":"array"},"path":{"type":"string"},"priority":{"minimum":0,"type":"number"},"status":{"$ref":"#/components/schemas/DocumentStatus"}},"required":["documentType","id","status","documentCategory"],"type":"object","title":"PrintableDocument","description":"PrintableDocument"},"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","CUSTOMS"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"DocumentType":{"enum":["PDF","PNG","JPG","GIF","JPEG","XML","JSON"],"type":"string","title":"DocumentType","description":"DocumentType"},"DocumentOperations":{"enum":["PRINT","VIEW"],"type":"string","title":"DocumentOperations","description":"DocumentOperations"},"DocumentStatus":{"enum":["AVAILABLE","LOADING","REQUESTABLE","CANCELED","WAITING_FOR_INPUT"],"type":"string","title":"DocumentStatus","description":"DocumentStatus"},"ExpectedHandoverLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/ExpectedHandoverLineItemForCreation"}],"properties":{"id":{"type":"string"}},"required":["id"],"type":"object","title":"ExpectedHandoverLineItem","description":"ExpectedHandoverLineItem"},"ExpectedHandoverLineItemForCreation":{"additionalProperties":false,"properties":{"article":{"$ref":"#/components/schemas/HandoverLineItemArticle"},"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"},"quantity":{"description":"quantity of the specific item that has been provided for handover","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/HandoverLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"transferId":{"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article","transferId"],"type":"object","title":"ExpectedHandoverLineItemForCreation","description":"ExpectedHandoverLineItemForCreation"},"HandoverLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"HandoverLineItemArticle"},"title":"HandoverLineItemArticle","description":"HandoverLineItemArticle"},"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"},"HandoverLineItemStatus":{"enum":["OPEN","CLOSED"],"type":"string","title":"HandoverLineItemStatus","description":"HandoverLineItemStatus"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"HandoverLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"}],"properties":{"article":{"$ref":"#/components/schemas/HandoverLineItemArticle"},"handedOverQuantity":{"description":"quantity of the specific item that has been handed over","format":"int64","minimum":0,"type":"integer"},"id":{"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"},"quantity":{"description":"quantity of the specific item that has been provided for handover","format":"int64","minimum":1,"type":"integer"},"refused":{"items":{"$ref":"#/components/schemas/RefusedItem"},"type":"array"},"status":{"$ref":"#/components/schemas/HandoverLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"substituteLineItems":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
","items":{"$ref":"#/components/schemas/HandoverSubstituteLineItem"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","article","quantity","handedOverQuantity"],"title":"HandoverLineItem","description":"HandoverLineItem"},"MandatoryLineItem":{"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","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"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"},"RefusedItem":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"},"reason":{"type":"string"}},"required":["quantity"],"title":"RefusedItem","description":"RefusedItem"},"HandoverSubstituteLineItem":{"properties":{"article":{"$ref":"#/components/schemas/SubstituteLineItemArticle"},"handedOverQuantity":{"description":"quantity of the specific item to substitute the original line item that has been handed over","format":"int64","minimum":0,"type":"integer"},"id":{"type":"string"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/SubstituteLineItemPartialStockLocation"},"type":"array"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"quantity":{"description":"quantity of the specific item to substitute the original line item that has been provided for handover","format":"int64","minimum":1,"type":"integer"},"refused":{"items":{"$ref":"#/components/schemas/RefusedItem"},"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"}},"required":["quantity","article","id"],"title":"HandoverSubstituteLineItem","description":"HandoverSubstituteLineItem"},"SubstituteLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"SubstituteLineItemArticle"},"title":"SubstituteLineItemArticle","description":"SubstituteLineItemArticle"},"SubstituteLineItemPartialStockLocation":{"properties":{"location":{"$ref":"#/components/schemas/Location"},"picked":{"format":"int64","minimum":0,"type":"number"},"quantity":{"format":"int64","minimum":0,"type":"number"},"ratingScore":{"type":"number"},"sequenceScore":{"type":"number"},"stockProperties":{"anyOf":[{"$ref":"#/components/schemas/PickingStockPropertyPreset"},{"$ref":"#/components/schemas/PickingStockProperty"}]},"stockRef":{"type":"string"},"tenantPartialStockId":{"type":"string"},"zoneName":{"type":"string"}},"required":["location","quantity"],"type":"object","title":"SubstituteLineItemPartialStockLocation","description":"SubstituteLineItemPartialStockLocation"},"Location":{"properties":{"locationRef":{"description":"The id of the location","type":"string"},"scannableCodes":{"description":"Represents barcodes that may be scanned at this location","items":{"type":"string"},"type":"array"}},"xml":{"name":"Location"},"title":"Location","description":"Location"},"PickingStockPropertyPreset":{"description":"Preset of Picking Stock Property.","properties":{"expiry":{"type":"string"}},"title":"PickingStockPropertyPreset","type":"object"},"PickingStockProperty":{"additionalProperties":{"type":"string"},"description":"Picking Stock Property.","title":"PickingStockProperty","type":"object"},"HandoverJobParcelInfo":{"allOf":[{"$ref":"#/components/schemas/HandoverJobParcelInfoForCreation"},{"properties":{"carrierKey":{"description":"the key of the carrier","type":"string"}}}],"type":"object","title":"HandoverJobParcelInfo","description":"HandoverJobParcelInfo"},"HandoverJobParcelInfoForCreation":{"additionalProperties":false,"properties":{"carrierLogoUrl":{"description":"The URL to the carrier logo","type":"string"},"carrierParcelRef":{"description":"The reference number of the parcel by the carrier","maxLength":120,"minLength":1,"type":"string"},"carrierRef":{"description":"the reference to the related carrier","type":"string"},"carrierTrackingNumber":{"description":"the tracking number of the parcel","type":"string"},"parcelRef":{"description":"the reference to the related parcel","type":"string"},"shipmentRef":{"description":"the reference to the related shipment","type":"string"}},"type":"object","title":"HandoverJobParcelInfoForCreation","description":"HandoverJobParcelInfoForCreation"},"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"},"HandoverjobStatus":{"description":"Status of a Handover Job.\n- OPEN: Active and ready for processing (default initial state)\n- WAITING_FOR_INPUT: Waiting for line items to be populated\n- HANDED_OVER: Items have been handed over (completion state)\n- CANCELED: Handover job was canceled\n- OBSOLETE: No longer relevant (terminal state, cannot transition out)\n","enum":["OPEN","HANDED_OVER","OBSOLETE","CANCELED","WAITING_FOR_INPUT"],"type":"string","title":"HandoverjobStatus"},"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"},"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/handoverjobs/{handoverjobId}":{"get":{"description":"","operationId":"getHandoverjob","parameters":[{"description":"ID of the handoverjob you want to get","in":"path","name":"handoverjobId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Handoverjob"}}},"description":"Handoverjob was found & you were allowed to access it. The result is in the body."},"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 handover job","tags":["Handovers (Operations)"]}}}}
```
## POST /api/handoverjobs/{handoverJobId}/actions
> Call handover job action
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints manage the handover process.","name":"Handovers (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":{"HandoverJobActionsParameter":{"anyOf":[{"$ref":"#/components/schemas/HandoverJobCancelActionParameter"},{"$ref":"#/components/schemas/HandoverJobLineItemUpdateActionParameter"},{"$ref":"#/components/schemas/FinishHandoverJobActionParameter"},{"$ref":"#/components/schemas/SetHandoverJobToWaitingForInputActionParameter"},{"$ref":"#/components/schemas/HandoverJobReplaceAssignedUsersActionParameter"},{"$ref":"#/components/schemas/HandoverJobSplitLineItemsActionParameter"},{"$ref":"#/components/schemas/UpdateHandoverLineItemRecordableAttributesActionParameter"}],"title":"HandoverJobActionsParameter","description":"HandoverJobActionsParameter"},"HandoverJobCancelActionParameter":{"additionalProperties":false,"description":"Action to cancel a handoverjob.","properties":{"name":{"$ref":"#/components/schemas/HandoverJobCancelActionEnum"},"payload":{"additionalProperties":false,"properties":{"handoverJobCancelReason":{"$ref":"#/components/schemas/HandoverJobCancelReason"}},"required":["handoverJobCancelReason"]},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","payload"],"title":"HandoverJobCancelActionParameter"},"HandoverJobCancelActionEnum":{"enum":["CANCEL"],"type":"string","title":"HandoverJobCancelActionEnum","description":"HandoverJobCancelActionEnum"},"HandoverJobCancelReason":{"enum":["CONSUMER_NO_SHOW","CONSUMER_REJECTS","ORDER_CANCELED"],"type":"string","title":"HandoverJobCancelReason","description":"HandoverJobCancelReason"},"HandoverJobLineItemUpdateActionParameter":{"additionalProperties":false,"description":"Action to update a lineItem of a handoverjob.","properties":{"lineItem":{"additionalProperties":false,"properties":{"id":{"type":"string"},"refused":{"items":{"$ref":"#/components/schemas/RefusedItemForUpdate"},"type":"array"},"status":{"$ref":"#/components/schemas/HandoverLineItemStatus"},"substituteItems":{"items":{"$ref":"#/components/schemas/HandoverSubstituteLineItemForUpdate"},"type":"array"}},"required":["id"]},"name":{"$ref":"#/components/schemas/HandoverJobLineItemUpdateActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","lineItem"],"title":"HandoverJobLineItemUpdateActionParameter"},"RefusedItemForUpdate":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"}},"required":["quantity"],"title":"RefusedItemForUpdate","description":"RefusedItemForUpdate"},"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"},"HandoverLineItemStatus":{"enum":["OPEN","CLOSED"],"type":"string","title":"HandoverLineItemStatus","description":"HandoverLineItemStatus"},"HandoverSubstituteLineItemForUpdate":{"properties":{"id":{"type":"string"},"refused":{"items":{"$ref":"#/components/schemas/RefusedItemForUpdate"},"type":"array"}},"required":["id"],"title":"HandoverSubstituteLineItemForUpdate","description":"HandoverSubstituteLineItemForUpdate"},"HandoverJobLineItemUpdateActionEnum":{"enum":["UPDATE_LINEITEM"],"type":"string","title":"HandoverJobLineItemUpdateActionEnum","description":"HandoverJobLineItemUpdateActionEnum"},"FinishHandoverJobActionParameter":{"additionalProperties":false,"description":"Action to finish a handoverjob.","properties":{"lineItems":{"additionalProperties":false,"items":{"$ref":"#/components/schemas/FinishHandoverJobLineItem"},"type":"array"},"name":{"$ref":"#/components/schemas/FinishHandoverJobActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","lineItems"],"title":"FinishHandoverJobActionParameter"},"FinishHandoverJobLineItem":{"additionalProperties":false,"properties":{"handedOverQuantity":{"type":"number"},"id":{"type":"string"},"refused":{"items":{"$ref":"#/components/schemas/RefusedItemForUpdate"},"type":"array"},"substituteLineItems":{"items":{"$ref":"#/components/schemas/FinishHandoverJobSubstituteLineItem"},"type":"array"}},"required":["id","handedOverQuantity"],"title":"FinishHandoverJobLineItem","description":"FinishHandoverJobLineItem"},"FinishHandoverJobSubstituteLineItem":{"properties":{"handedOverQuantity":{"minimum":0,"type":"integer"},"id":{"type":"string"},"refused":{"items":{"$ref":"#/components/schemas/RefusedItemForUpdate"},"type":"array"}},"required":["id","handedOverQuantity"],"title":"FinishHandoverJobSubstituteLineItem","description":"FinishHandoverJobSubstituteLineItem"},"FinishHandoverJobActionEnum":{"enum":["FINISH_HANDOVER_JOB"],"type":"string","title":"FinishHandoverJobActionEnum","description":"FinishHandoverJobActionEnum"},"SetHandoverJobToWaitingForInputActionParameter":{"additionalProperties":false,"description":"Action to set a handoverjob to waiting for input.","properties":{"name":{"$ref":"#/components/schemas/SetHandoverJobToWaitingForInputActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"SetHandoverJobToWaitingForInputActionParameter"},"SetHandoverJobToWaitingForInputActionEnum":{"enum":["WAITING_FOR_INPUT"],"type":"string","title":"SetHandoverJobToWaitingForInputActionEnum","description":"SetHandoverJobToWaitingForInputActionEnum"},"HandoverJobReplaceAssignedUsersActionParameter":{"additionalProperties":false,"description":"Action to replace the assigned users.","properties":{"assignedUsers":{"description":"Assigned users for this entity","items":{"anyOf":[{"$ref":"#/components/schemas/AssignedUserForCreationByName"},{"$ref":"#/components/schemas/AssignedUserForCreationById"}]},"type":"array"},"name":{"$ref":"#/components/schemas/HandoverJobReplaceAssignedUsersActionEnum"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","assignedUsers"],"title":"HandoverJobReplaceAssignedUsersActionParameter"},"AssignedUserForCreationByName":{"description":"Create a assigned user by giving a valid name","properties":{"username":{"description":"username of the user should be assigned","type":"string"}},"required":["username"],"title":"AssignedUserForCreationByName","type":"object"},"AssignedUserForCreationById":{"description":"Create a assigned user by giving a valid id","properties":{"userId":{"description":"userId of the user should be assigned","type":"string"}},"required":["userId"],"title":"AssignedUserForCreationById","type":"object"},"HandoverJobReplaceAssignedUsersActionEnum":{"enum":["REPLACE_ASSIGNED_USERS"],"type":"string","title":"HandoverJobReplaceAssignedUsersActionEnum","description":"HandoverJobReplaceAssignedUsersActionEnum"},"HandoverJobSplitLineItemsActionParameter":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/HandoverJobSplitLineItemsActionEnum"},"splitLineItemsInfo":{"items":{"$ref":"#/components/schemas/HandoverJobSplitLineItemsInfo"},"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["name","version","splitLineItemsInfo"],"title":"HandoverJobSplitLineItemsActionParameter","type":"object","description":"HandoverJobSplitLineItemsActionParameter"},"HandoverJobSplitLineItemsActionEnum":{"enum":["SPLIT_LINES_HANDOVER_JOB"],"type":"string","title":"HandoverJobSplitLineItemsActionEnum","description":"HandoverJobSplitLineItemsActionEnum"},"HandoverJobSplitLineItemsInfo":{"additionalProperties":false,"properties":{"handedOverQuantity":{"description":"The amount of articles that were handed over for this line item.","format":"int64","minimum":0,"type":"integer"},"lineItemId":{"description":"references the id of the line item of a handover job","type":"string"},"quantity":{"description":"quantity of the specific item that has been ordered","minimum":1,"type":"integer"}},"required":["lineItemId","quantity","handedOverQuantity"],"type":"object","title":"HandoverJobSplitLineItemsInfo","description":"HandoverJobSplitLineItemsInfo"},"UpdateHandoverLineItemRecordableAttributesActionParameter":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/UpdateHandoverLineItemRecordableAttributesActionEnum"},"recordableAttributeUpdates":{"items":{"$ref":"#/components/schemas/RecordableAttributeForUpdate"},"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"integer"}},"required":["name","version","recordableAttributeUpdates"],"title":"UpdateHandoverLineItemRecordableAttributesActionParameter","type":"object","description":"UpdateHandoverLineItemRecordableAttributesActionParameter"},"UpdateHandoverLineItemRecordableAttributesActionEnum":{"enum":["UPDATE_HANDOVER_LINE_ITEM_RECORDABLE_ATTRIBUTES"],"type":"string","title":"UpdateHandoverLineItemRecordableAttributesActionEnum","description":"UpdateHandoverLineItemRecordableAttributesActionEnum"},"RecordableAttributeForUpdate":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute to set","minLength":1,"nullable":true,"type":"string"},"recordableAttributeId":{"description":"id of the recordable attribute to update","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 to set","nullable":true,"type":"string"}},"required":["recordableAttributeId"],"title":"RecordableAttributeForUpdate","type":"object","description":"RecordableAttributeForUpdate"},"Handoverjob":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"assignedUsers":{"description":"Assigned users for this entity","items":{"$ref":"#/components/schemas/AssignedUser"},"type":"array"},"cancelReason":{"$ref":"#/components/schemas/HandoverJobCancelReason"},"carrierKey":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"carrierLogoUrl":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"carrierRef":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"carrierTrackingNumber":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"channel":{"enum":["DELIVERY","COLLECT"],"type":"string"},"customAttributes":{"description":"Attributes that can be added to the handover job. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"documents":{"items":{"$ref":"#/components/schemas/PrintableDocument"},"type":"array"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"expectedHandoverJobLineItems":{"items":{"$ref":"#/components/schemas/ExpectedHandoverLineItem"},"type":"array"},"facilityRef":{"description":"The id of the facility reference.","type":"string"},"fullIdentifier":{"description":"An information to identify the recipient","type":"string"},"handoverJobLineItems":{"items":{"$ref":"#/components/schemas/HandoverLineItem"}},"handoverJobParcelInfo":{"$ref":"#/components/schemas/HandoverJobParcelInfo"},"id":{"description":"The id of this handoverjob. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"loadUnitRefs":{"description":"Reference to array of load unit Refs","items":{"type":"string"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"paid":{"description":"Indicates if the order is already paid","type":"boolean"},"parcelRef":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"pickJobRef":{"description":"The reference to the pickjob for which the handoverjob is assigned to","type":"string"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"recipientAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"shipmentRef":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"shortIdentifier":{"description":"The short identifier of the shipment.","type":"string"},"status":{"$ref":"#/components/schemas/HandoverjobStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"targetTime":{"description":"The time the handoverjob is expected to be picked up at the facility.","format":"date-time","type":"string"},"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"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"tags":{"description":"Tags can only be set when there is no process related with this handoverJob. Setting processId and tags will lead to an validationError.","items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}}}],"required":["id","status","facilityRef","targetTime","channel","orderDate"],"type":"object","title":"Handoverjob","description":"Handoverjob"},"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"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"PrintableDocument":{"properties":{"customAttributes":{"description":"Attributes that can be added to the document. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"documentCategory":{"$ref":"#/components/schemas/DocumentCategory"},"documentType":{"$ref":"#/components/schemas/DocumentType"},"id":{"type":"string"},"name":{"type":"string"},"operations":{"description":"Offered operations for this document","items":{"$ref":"#/components/schemas/DocumentOperations"},"type":"array"},"path":{"type":"string"},"priority":{"minimum":0,"type":"number"},"status":{"$ref":"#/components/schemas/DocumentStatus"}},"required":["documentType","id","status","documentCategory"],"type":"object","title":"PrintableDocument","description":"PrintableDocument"},"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","CUSTOMS"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"DocumentType":{"enum":["PDF","PNG","JPG","GIF","JPEG","XML","JSON"],"type":"string","title":"DocumentType","description":"DocumentType"},"DocumentOperations":{"enum":["PRINT","VIEW"],"type":"string","title":"DocumentOperations","description":"DocumentOperations"},"DocumentStatus":{"enum":["AVAILABLE","LOADING","REQUESTABLE","CANCELED","WAITING_FOR_INPUT"],"type":"string","title":"DocumentStatus","description":"DocumentStatus"},"ExpectedHandoverLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/ExpectedHandoverLineItemForCreation"}],"properties":{"id":{"type":"string"}},"required":["id"],"type":"object","title":"ExpectedHandoverLineItem","description":"ExpectedHandoverLineItem"},"ExpectedHandoverLineItemForCreation":{"additionalProperties":false,"properties":{"article":{"$ref":"#/components/schemas/HandoverLineItemArticle"},"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"},"quantity":{"description":"quantity of the specific item that has been provided for handover","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/HandoverLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"transferId":{"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article","transferId"],"type":"object","title":"ExpectedHandoverLineItemForCreation","description":"ExpectedHandoverLineItemForCreation"},"HandoverLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"HandoverLineItemArticle"},"title":"HandoverLineItemArticle","description":"HandoverLineItemArticle"},"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"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"HandoverLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"}],"properties":{"article":{"$ref":"#/components/schemas/HandoverLineItemArticle"},"handedOverQuantity":{"description":"quantity of the specific item that has been handed over","format":"int64","minimum":0,"type":"integer"},"id":{"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"},"quantity":{"description":"quantity of the specific item that has been provided for handover","format":"int64","minimum":1,"type":"integer"},"refused":{"items":{"$ref":"#/components/schemas/RefusedItem"},"type":"array"},"status":{"$ref":"#/components/schemas/HandoverLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"substituteLineItems":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
","items":{"$ref":"#/components/schemas/HandoverSubstituteLineItem"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","article","quantity","handedOverQuantity"],"title":"HandoverLineItem","description":"HandoverLineItem"},"MandatoryLineItem":{"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","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"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"},"RefusedItem":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"},"reason":{"type":"string"}},"required":["quantity"],"title":"RefusedItem","description":"RefusedItem"},"HandoverSubstituteLineItem":{"properties":{"article":{"$ref":"#/components/schemas/SubstituteLineItemArticle"},"handedOverQuantity":{"description":"quantity of the specific item to substitute the original line item that has been handed over","format":"int64","minimum":0,"type":"integer"},"id":{"type":"string"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/SubstituteLineItemPartialStockLocation"},"type":"array"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"quantity":{"description":"quantity of the specific item to substitute the original line item that has been provided for handover","format":"int64","minimum":1,"type":"integer"},"refused":{"items":{"$ref":"#/components/schemas/RefusedItem"},"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"}},"required":["quantity","article","id"],"title":"HandoverSubstituteLineItem","description":"HandoverSubstituteLineItem"},"SubstituteLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"SubstituteLineItemArticle"},"title":"SubstituteLineItemArticle","description":"SubstituteLineItemArticle"},"SubstituteLineItemPartialStockLocation":{"properties":{"location":{"$ref":"#/components/schemas/Location"},"picked":{"format":"int64","minimum":0,"type":"number"},"quantity":{"format":"int64","minimum":0,"type":"number"},"ratingScore":{"type":"number"},"sequenceScore":{"type":"number"},"stockProperties":{"anyOf":[{"$ref":"#/components/schemas/PickingStockPropertyPreset"},{"$ref":"#/components/schemas/PickingStockProperty"}]},"stockRef":{"type":"string"},"tenantPartialStockId":{"type":"string"},"zoneName":{"type":"string"}},"required":["location","quantity"],"type":"object","title":"SubstituteLineItemPartialStockLocation","description":"SubstituteLineItemPartialStockLocation"},"Location":{"properties":{"locationRef":{"description":"The id of the location","type":"string"},"scannableCodes":{"description":"Represents barcodes that may be scanned at this location","items":{"type":"string"},"type":"array"}},"xml":{"name":"Location"},"title":"Location","description":"Location"},"PickingStockPropertyPreset":{"description":"Preset of Picking Stock Property.","properties":{"expiry":{"type":"string"}},"title":"PickingStockPropertyPreset","type":"object"},"PickingStockProperty":{"additionalProperties":{"type":"string"},"description":"Picking Stock Property.","title":"PickingStockProperty","type":"object"},"HandoverJobParcelInfo":{"allOf":[{"$ref":"#/components/schemas/HandoverJobParcelInfoForCreation"},{"properties":{"carrierKey":{"description":"the key of the carrier","type":"string"}}}],"type":"object","title":"HandoverJobParcelInfo","description":"HandoverJobParcelInfo"},"HandoverJobParcelInfoForCreation":{"additionalProperties":false,"properties":{"carrierLogoUrl":{"description":"The URL to the carrier logo","type":"string"},"carrierParcelRef":{"description":"The reference number of the parcel by the carrier","maxLength":120,"minLength":1,"type":"string"},"carrierRef":{"description":"the reference to the related carrier","type":"string"},"carrierTrackingNumber":{"description":"the tracking number of the parcel","type":"string"},"parcelRef":{"description":"the reference to the related parcel","type":"string"},"shipmentRef":{"description":"the reference to the related shipment","type":"string"}},"type":"object","title":"HandoverJobParcelInfoForCreation","description":"HandoverJobParcelInfoForCreation"},"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"},"HandoverjobStatus":{"description":"Status of a Handover Job.\n- OPEN: Active and ready for processing (default initial state)\n- WAITING_FOR_INPUT: Waiting for line items to be populated\n- HANDED_OVER: Items have been handed over (completion state)\n- CANCELED: Handover job was canceled\n- OBSOLETE: No longer relevant (terminal state, cannot transition out)\n","enum":["OPEN","HANDED_OVER","OBSOLETE","CANCELED","WAITING_FOR_INPUT"],"type":"string","title":"HandoverjobStatus"},"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"},"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/handoverjobs/{handoverJobId}/actions":{"post":{"operationId":"handoverJobAction","parameters":[{"description":"Reference to the handover job you want to call the action for","in":"path","name":"handoverJobId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandoverJobActionsParameter"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Handoverjob"}}},"description":"Updated Handover job in the body."},"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":"Call handover job action","tags":["Handovers (Operations)"]}}}}
```
## PATCH /api/handoverjobs/{handoverjobId}
> Update handover job
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints manage the handover process.","name":"Handovers (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":{"HandoverjobPatchActions":{"properties":{"actions":{"items":{"anyOf":[{"$ref":"#/components/schemas/ModifyHandoverjob"},{"$ref":"#/components/schemas/CancelHandoverjob"}]},"minItems":1,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version","actions"],"type":"object","xml":{"name":"HandoverjobPatchActions"},"title":"HandoverjobPatchActions","description":"HandoverjobPatchActions"},"ModifyHandoverjob":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'ModifyHandoverjob', because you want to modify a handoverjob","enum":["ModifyHandoverjob"],"type":"string"},"customAttributes":{"description":"Attributes that can be added to the handoverJob. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"status":{"$ref":"#/components/schemas/HandoverjobStatus"}},"required":["action"],"type":"object"}],"description":"Action to modify a HandoverJob.","title":"ModifyHandoverjobAction","xml":{"name":"ModifyHandoverjob"}},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyPickJob","ModifyPickJobLastEditor","RestartPickJob","ResetPickJob","CancelPickRun","CancelHandoverjob","AbortPickJob","FinishPickRun","StartPickRun","ModifyPickLineItem","ModifyPickRunLineItem","ModifyPackJob","PausePackJob","ModifyPackLineItem","SplitLineItemsPackJob","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyShipment","ModifyHandoverjob","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyLoadUnitType","ModifyFeature","ModifyParcel","ModifyParcelLoadUnit","ModifyRestowItem","RemovePickJobFromPickRun","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","ModifyPackingContainerType","ModifyPackingContainerTypeIcon","ReplaceCodesInPackingTargetContainer","ReplaceLoadUnitLineItems","AddLineItemToPackingTargetContainer","RemoveLineItemFromPackingTargetContainer","UpdateLineItemOnPackingTargetContainer","UpdatePackingTargetContainerLineItemRecordableAttributes","ModifyCustomService","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"HandoverjobStatus":{"description":"Status of a Handover Job.\n- OPEN: Active and ready for processing (default initial state)\n- WAITING_FOR_INPUT: Waiting for line items to be populated\n- HANDED_OVER: Items have been handed over (completion state)\n- CANCELED: Handover job was canceled\n- OBSOLETE: No longer relevant (terminal state, cannot transition out)\n","enum":["OPEN","HANDED_OVER","OBSOLETE","CANCELED","WAITING_FOR_INPUT"],"type":"string","title":"HandoverjobStatus"},"CancelHandoverjob":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'CancelHandoverjob', because you want to cancel a handover job","enum":["CancelHandoverjob"],"type":"string"},"handoverJobCancelReason":{"$ref":"#/components/schemas/HandoverJobCancelReason"}},"required":["action","handoverJobCancelReason"],"type":"object"}],"deprecated":true,"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated Use api/handoverjobs/:id/actions instead","title":"CancelHandoverjob","xml":{"name":"CancelHandoverjob"}},"HandoverJobCancelReason":{"enum":["CONSUMER_NO_SHOW","CONSUMER_REJECTS","ORDER_CANCELED"],"type":"string","title":"HandoverJobCancelReason","description":"HandoverJobCancelReason"},"Handoverjob":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"assignedUsers":{"description":"Assigned users for this entity","items":{"$ref":"#/components/schemas/AssignedUser"},"type":"array"},"cancelReason":{"$ref":"#/components/schemas/HandoverJobCancelReason"},"carrierKey":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"carrierLogoUrl":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"carrierRef":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"carrierTrackingNumber":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"channel":{"enum":["DELIVERY","COLLECT"],"type":"string"},"customAttributes":{"description":"Attributes that can be added to the handover job. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"documents":{"items":{"$ref":"#/components/schemas/PrintableDocument"},"type":"array"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"expectedHandoverJobLineItems":{"items":{"$ref":"#/components/schemas/ExpectedHandoverLineItem"},"type":"array"},"facilityRef":{"description":"The id of the facility reference.","type":"string"},"fullIdentifier":{"description":"An information to identify the recipient","type":"string"},"handoverJobLineItems":{"items":{"$ref":"#/components/schemas/HandoverLineItem"}},"handoverJobParcelInfo":{"$ref":"#/components/schemas/HandoverJobParcelInfo"},"id":{"description":"The id of this handoverjob. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"loadUnitRefs":{"description":"Reference to array of load unit Refs","items":{"type":"string"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"paid":{"description":"Indicates if the order is already paid","type":"boolean"},"parcelRef":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"pickJobRef":{"description":"The reference to the pickjob for which the handoverjob is assigned to","type":"string"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"recipientAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"shipmentRef":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"shortIdentifier":{"description":"The short identifier of the shipment.","type":"string"},"status":{"$ref":"#/components/schemas/HandoverjobStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"targetTime":{"description":"The time the handoverjob is expected to be picked up at the facility.","format":"date-time","type":"string"},"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"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"tags":{"description":"Tags can only be set when there is no process related with this handoverJob. Setting processId and tags will lead to an validationError.","items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}}}],"required":["id","status","facilityRef","targetTime","channel","orderDate"],"type":"object","title":"Handoverjob","description":"Handoverjob"},"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"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"PrintableDocument":{"properties":{"customAttributes":{"description":"Attributes that can be added to the document. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"documentCategory":{"$ref":"#/components/schemas/DocumentCategory"},"documentType":{"$ref":"#/components/schemas/DocumentType"},"id":{"type":"string"},"name":{"type":"string"},"operations":{"description":"Offered operations for this document","items":{"$ref":"#/components/schemas/DocumentOperations"},"type":"array"},"path":{"type":"string"},"priority":{"minimum":0,"type":"number"},"status":{"$ref":"#/components/schemas/DocumentStatus"}},"required":["documentType","id","status","documentCategory"],"type":"object","title":"PrintableDocument","description":"PrintableDocument"},"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","CUSTOMS"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"DocumentType":{"enum":["PDF","PNG","JPG","GIF","JPEG","XML","JSON"],"type":"string","title":"DocumentType","description":"DocumentType"},"DocumentOperations":{"enum":["PRINT","VIEW"],"type":"string","title":"DocumentOperations","description":"DocumentOperations"},"DocumentStatus":{"enum":["AVAILABLE","LOADING","REQUESTABLE","CANCELED","WAITING_FOR_INPUT"],"type":"string","title":"DocumentStatus","description":"DocumentStatus"},"ExpectedHandoverLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/ExpectedHandoverLineItemForCreation"}],"properties":{"id":{"type":"string"}},"required":["id"],"type":"object","title":"ExpectedHandoverLineItem","description":"ExpectedHandoverLineItem"},"ExpectedHandoverLineItemForCreation":{"additionalProperties":false,"properties":{"article":{"$ref":"#/components/schemas/HandoverLineItemArticle"},"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"},"quantity":{"description":"quantity of the specific item that has been provided for handover","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/HandoverLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"transferId":{"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article","transferId"],"type":"object","title":"ExpectedHandoverLineItemForCreation","description":"ExpectedHandoverLineItemForCreation"},"HandoverLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"HandoverLineItemArticle"},"title":"HandoverLineItemArticle","description":"HandoverLineItemArticle"},"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"},"HandoverLineItemStatus":{"enum":["OPEN","CLOSED"],"type":"string","title":"HandoverLineItemStatus","description":"HandoverLineItemStatus"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"HandoverLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"}],"properties":{"article":{"$ref":"#/components/schemas/HandoverLineItemArticle"},"handedOverQuantity":{"description":"quantity of the specific item that has been handed over","format":"int64","minimum":0,"type":"integer"},"id":{"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"},"quantity":{"description":"quantity of the specific item that has been provided for handover","format":"int64","minimum":1,"type":"integer"},"refused":{"items":{"$ref":"#/components/schemas/RefusedItem"},"type":"array"},"status":{"$ref":"#/components/schemas/HandoverLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"substituteLineItems":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
","items":{"$ref":"#/components/schemas/HandoverSubstituteLineItem"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","article","quantity","handedOverQuantity"],"title":"HandoverLineItem","description":"HandoverLineItem"},"MandatoryLineItem":{"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","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"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"},"RefusedItem":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"},"reason":{"type":"string"}},"required":["quantity"],"title":"RefusedItem","description":"RefusedItem"},"HandoverSubstituteLineItem":{"properties":{"article":{"$ref":"#/components/schemas/SubstituteLineItemArticle"},"handedOverQuantity":{"description":"quantity of the specific item to substitute the original line item that has been handed over","format":"int64","minimum":0,"type":"integer"},"id":{"type":"string"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/SubstituteLineItemPartialStockLocation"},"type":"array"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"quantity":{"description":"quantity of the specific item to substitute the original line item that has been provided for handover","format":"int64","minimum":1,"type":"integer"},"refused":{"items":{"$ref":"#/components/schemas/RefusedItem"},"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"}},"required":["quantity","article","id"],"title":"HandoverSubstituteLineItem","description":"HandoverSubstituteLineItem"},"SubstituteLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"SubstituteLineItemArticle"},"title":"SubstituteLineItemArticle","description":"SubstituteLineItemArticle"},"SubstituteLineItemPartialStockLocation":{"properties":{"location":{"$ref":"#/components/schemas/Location"},"picked":{"format":"int64","minimum":0,"type":"number"},"quantity":{"format":"int64","minimum":0,"type":"number"},"ratingScore":{"type":"number"},"sequenceScore":{"type":"number"},"stockProperties":{"anyOf":[{"$ref":"#/components/schemas/PickingStockPropertyPreset"},{"$ref":"#/components/schemas/PickingStockProperty"}]},"stockRef":{"type":"string"},"tenantPartialStockId":{"type":"string"},"zoneName":{"type":"string"}},"required":["location","quantity"],"type":"object","title":"SubstituteLineItemPartialStockLocation","description":"SubstituteLineItemPartialStockLocation"},"Location":{"properties":{"locationRef":{"description":"The id of the location","type":"string"},"scannableCodes":{"description":"Represents barcodes that may be scanned at this location","items":{"type":"string"},"type":"array"}},"xml":{"name":"Location"},"title":"Location","description":"Location"},"PickingStockPropertyPreset":{"description":"Preset of Picking Stock Property.","properties":{"expiry":{"type":"string"}},"title":"PickingStockPropertyPreset","type":"object"},"PickingStockProperty":{"additionalProperties":{"type":"string"},"description":"Picking Stock Property.","title":"PickingStockProperty","type":"object"},"HandoverJobParcelInfo":{"allOf":[{"$ref":"#/components/schemas/HandoverJobParcelInfoForCreation"},{"properties":{"carrierKey":{"description":"the key of the carrier","type":"string"}}}],"type":"object","title":"HandoverJobParcelInfo","description":"HandoverJobParcelInfo"},"HandoverJobParcelInfoForCreation":{"additionalProperties":false,"properties":{"carrierLogoUrl":{"description":"The URL to the carrier logo","type":"string"},"carrierParcelRef":{"description":"The reference number of the parcel by the carrier","maxLength":120,"minLength":1,"type":"string"},"carrierRef":{"description":"the reference to the related carrier","type":"string"},"carrierTrackingNumber":{"description":"the tracking number of the parcel","type":"string"},"parcelRef":{"description":"the reference to the related parcel","type":"string"},"shipmentRef":{"description":"the reference to the related shipment","type":"string"}},"type":"object","title":"HandoverJobParcelInfoForCreation","description":"HandoverJobParcelInfoForCreation"},"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"},"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"},"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/handoverjobs/{handoverjobId}":{"patch":{"description":"","operationId":"patchHandoverjob","parameters":[{"description":"ID of handoverjob you want to patch","in":"path","name":"handoverjobId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandoverjobPatchActions"}}},"description":"Patch set","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Handoverjob"}}},"description":"Handoverjob was found & patch-set has been applied. The patched entity is in the body."},"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"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity version conflict"}},"summary":"Update handover job","tags":["Handovers (Operations)"]}}}}
```
## GET /api/handoverjobs
> List handover jobs
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints manage the handover process.","name":"Handovers (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":{"StrippedHandoverjobs":{"properties":{"handoverjobs":{"items":{"$ref":"#/components/schemas/StrippedHandoverjob"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"type":"object","title":"StrippedHandoverjobs","description":"StrippedHandoverjobs"},"StrippedHandoverjob":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"carrierKey":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo","type":"string","deprecated":true},"carrierRef":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo","type":"string","deprecated":true},"channel":{"enum":["DELIVERY","COLLECT"],"type":"string"},"facilityRef":{"description":"The id of the facility reference.","type":"string"},"fullIdentifier":{"description":"An information to identify the recipient","type":"string"},"handoverJobParcelInfo":{"$ref":"#/components/schemas/HandoverJobParcelInfo"},"id":{"description":"The id of this handoverjob. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"loadUnitRefs":{"description":"Reference to array of load unit Refs","items":{"type":"string"},"type":"array"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"parcelRef":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo","type":"string","deprecated":true},"pickJobRef":{"description":"The reference to the pickjob for which the handoverjob is assigned to","type":"string"},"recipientAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"searchPaths":{"description":"This is the search term that was used to find the handover job","items":{"type":"string"},"minItems":0,"type":"array"},"shipmentRef":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo","type":"string","deprecated":true},"status":{"$ref":"#/components/schemas/HandoverjobStatus"},"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"}},"required":["id","status","facilityRef","channel"],"type":"object"}],"title":"StrippedHandoverjob","description":"StrippedHandoverjob"},"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"},"HandoverJobParcelInfo":{"allOf":[{"$ref":"#/components/schemas/HandoverJobParcelInfoForCreation"},{"properties":{"carrierKey":{"description":"the key of the carrier","type":"string"}}}],"type":"object","title":"HandoverJobParcelInfo","description":"HandoverJobParcelInfo"},"HandoverJobParcelInfoForCreation":{"additionalProperties":false,"properties":{"carrierLogoUrl":{"description":"The URL to the carrier logo","type":"string"},"carrierParcelRef":{"description":"The reference number of the parcel by the carrier","maxLength":120,"minLength":1,"type":"string"},"carrierRef":{"description":"the reference to the related carrier","type":"string"},"carrierTrackingNumber":{"description":"the tracking number of the parcel","type":"string"},"parcelRef":{"description":"the reference to the related parcel","type":"string"},"shipmentRef":{"description":"the reference to the related shipment","type":"string"}},"type":"object","title":"HandoverJobParcelInfoForCreation","description":"HandoverJobParcelInfoForCreation"},"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"},"HandoverjobStatus":{"description":"Status of a Handover Job.\n- OPEN: Active and ready for processing (default initial state)\n- WAITING_FOR_INPUT: Waiting for line items to be populated\n- HANDED_OVER: Items have been handed over (completion state)\n- CANCELED: Handover job was canceled\n- OBSOLETE: No longer relevant (terminal state, cannot transition out)\n","enum":["OPEN","HANDED_OVER","OBSOLETE","CANCELED","WAITING_FOR_INPUT"],"type":"string","title":"HandoverjobStatus"},"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/handoverjobs":{"get":{"description":"","operationId":"getAllHandoverjobs","parameters":[{"description":"all entities after given Id","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":"This query can be used to find handoverjobs for a referenced pickjob","in":"query","name":"pickJobRef","required":false,"schema":{"type":"string"}},{"description":"This query can be used to find handoverjobs for a referenced shipment","in":"query","name":"shipmentRef","required":false,"schema":{"type":"string"}},{"description":"Reference the assigned user on this entity - id or username","in":"query","name":"assignedUser","required":false,"schema":{"type":"string"}},{"description":"Reference to the facility you want to get the corresponding handoverJobs","in":"query","name":"facilityRef","required":false,"schema":{"type":"string"}},{"description":"Reference to the status you want to get the corresponding handoverJobs","explode":true,"in":"query","name":"status","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"description":"Reference to the carriers you want to get the corresponding handoverJobs","in":"query","name":"carrierRefs","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"description":"Reference to the channel you want to get the corresponding handoverJobs","in":"query","name":"channel","required":false,"schema":{"type":"string"}},{"description":"Parameter to filter anonymized handover jobs","in":"query","name":"anonymized","required":false,"schema":{"type":"boolean"}},{"description":"This query can be used to find handoverjobs with the given tenantOrderId","in":"query","name":"tenantOrderId","required":false,"schema":{"type":"string"}},{"description":"Perform full text search over all searchable attributes","in":"query","name":"searchTerm","required":false,"schema":{"type":"string"}},{"description":"Start date range for pick jobs","in":"query","name":"startTargetTime","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"End date range for pick jobs","in":"query","name":"endTargetTime","required":false,"schema":{"format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StrippedHandoverjobs"}}},"description":"Handoverjobs are found."},"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 handover jobs","tags":["Handovers (Operations)"]}}}}
```
## List handover job (search)
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Search for HandoverJob
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"These endpoints manage the handover process.","name":"Handovers (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":{"HandoverJobSearchPayload":{"properties":{"after":{"deprecated":false,"description":"The cursor to start after for forward pagination. The value is provided in the `pageInfo.endCursor` field of the response. Cannot be used with `before` or `last`.","type":"string"},"before":{"description":"The cursor to start before for backward pagination. The value is provided in the `pageInfo.startCursor` field of the response. Cannot be used with `after` or `size` (first).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"$ref":"#/components/schemas/SearchOptions"},"query":{"$ref":"#/components/schemas/HandoverJobSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/HandoverJobSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"HandoverJobSearchPayload","type":"object","description":"HandoverJobSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"HandoverJobSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/HandoverJobSearchQuery"},"maxItems":500,"type":"array"},"anonymized":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by anonymized"},"assignedUsers":{"allOf":[{"$ref":"#/components/schemas/HandoverJobAssignedUsersListFilter"}],"description":"Nested list search by assignedUsers"},"channel":{"allOf":[{"$ref":"#/components/schemas/HandoverJobChannelEnumEnumFilter"}],"description":"Search by channel"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"fullIdentifier":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by fullIdentifier"},"handoverJobLineItems":{"allOf":[{"$ref":"#/components/schemas/HandoverJobHandoverJobLineItemsListFilter"}],"description":"Nested list search by handoverJobLineItems"},"handoverJobParcelInfo":{"allOf":[{"$ref":"#/components/schemas/HandoverJobHandoverJobParcelInfoFilter"}],"description":"Nested search by handoverJobParcelInfo"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"invoiceAddress":{"allOf":[{"$ref":"#/components/schemas/HandoverJobInvoiceAddressFilter"}],"description":"Nested search by invoiceAddress"},"or":{"items":{"$ref":"#/components/schemas/HandoverJobSearchQuery"},"maxItems":500,"type":"array"},"pickJobRef":{"allOf":[{"$ref":"#/components/schemas/StringEqFilter"}],"description":"Search by pickJobRef"},"recipientAddress":{"allOf":[{"$ref":"#/components/schemas/HandoverJobRecipientAddressFilter"}],"description":"Nested search by recipientAddress"},"shortIdentifier":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by shortIdentifier"},"status":{"allOf":[{"$ref":"#/components/schemas/HandoverJobHandoverjobStatusEnumFilter"}],"description":"Search by status"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantOrderId"}},"title":"HandoverJobSearchQuery","type":"object","description":"HandoverJobSearchQuery"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"HandoverJobAssignedUsersListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/HandoverJobAssignedUsersFilter"}],"description":"Contains returns if at least one entry matches"}},"title":"HandoverJobAssignedUsersListFilter","type":"object","description":"HandoverJobAssignedUsersListFilter"},"HandoverJobAssignedUsersFilter":{"properties":{"userId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by userId"},"username":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by username"}},"title":"HandoverJobAssignedUsersFilter","type":"object","description":"HandoverJobAssignedUsersFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"maxLength":256,"type":"string"},"notIn":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"StringSearchFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"like":{"description":"Search by regex pattern","maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"},"notIn":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringSearchFilter","type":"object","description":"StringSearchFilter"},"HandoverJobChannelEnumEnumFilter":{"properties":{"eq":{"description":"Search by channel","enum":["DELIVERY","COLLECT"],"type":"string"},"in":{"description":"Search by channel","items":{"enum":["DELIVERY","COLLECT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by channel","enum":["DELIVERY","COLLECT"],"type":"string"}},"title":"HandoverJobChannelEnumEnumFilter","type":"object","description":"HandoverJobChannelEnumEnumFilter"},"HandoverJobHandoverJobLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/HandoverJobHandoverJobLineItemsFilter"}],"description":"Contains returns if at least one entry matches"}},"title":"HandoverJobHandoverJobLineItemsListFilter","type":"object","description":"HandoverJobHandoverJobLineItemsListFilter"},"HandoverJobHandoverJobLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/HandoverJobHandoverJobLineItemsArticleFilter"}],"description":"Nested search by article"},"substituteLineItems":{"allOf":[{"$ref":"#/components/schemas/HandoverJobHandoverJobLineItemsSubstituteLineItemsListFilter"}],"description":"Nested list search by substituteLineItems"}},"title":"HandoverJobHandoverJobLineItemsFilter","type":"object","description":"HandoverJobHandoverJobLineItemsFilter"},"HandoverJobHandoverJobLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"HandoverJobHandoverJobLineItemsArticleFilter","type":"object","description":"HandoverJobHandoverJobLineItemsArticleFilter"},"HandoverJobHandoverJobLineItemsSubstituteLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/HandoverJobHandoverJobLineItemsSubstituteLineItemsFilter"}],"description":"Contains returns if at least one entry matches"}},"title":"HandoverJobHandoverJobLineItemsSubstituteLineItemsListFilter","type":"object","description":"HandoverJobHandoverJobLineItemsSubstituteLineItemsListFilter"},"HandoverJobHandoverJobLineItemsSubstituteLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/HandoverJobHandoverJobLineItemsSubstituteLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"HandoverJobHandoverJobLineItemsSubstituteLineItemsFilter","type":"object","description":"HandoverJobHandoverJobLineItemsSubstituteLineItemsFilter"},"HandoverJobHandoverJobLineItemsSubstituteLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"HandoverJobHandoverJobLineItemsSubstituteLineItemsArticleFilter","type":"object","description":"HandoverJobHandoverJobLineItemsSubstituteLineItemsArticleFilter"},"HandoverJobHandoverJobParcelInfoFilter":{"properties":{"carrierKey":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierKey"},"carrierRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierRef"},"carrierTrackingNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierTrackingNumber"},"shipmentRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by shipmentRef"}},"title":"HandoverJobHandoverJobParcelInfoFilter","type":"object","description":"HandoverJobHandoverJobParcelInfoFilter"},"HandoverJobInvoiceAddressFilter":{"properties":{"companyName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by companyName"},"email":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by email"},"firstName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by firstName"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by lastName"}},"title":"HandoverJobInvoiceAddressFilter","type":"object","description":"HandoverJobInvoiceAddressFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"HandoverJobRecipientAddressFilter":{"properties":{"companyName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by companyName"},"email":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by email"},"firstName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by firstName"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by lastName"}},"title":"HandoverJobRecipientAddressFilter","type":"object","description":"HandoverJobRecipientAddressFilter"},"HandoverJobHandoverjobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","HANDED_OVER","OBSOLETE","CANCELED","WAITING_FOR_INPUT"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","HANDED_OVER","OBSOLETE","CANCELED","WAITING_FOR_INPUT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","HANDED_OVER","OBSOLETE","CANCELED","WAITING_FOR_INPUT"],"type":"string"}},"title":"HandoverJobHandoverjobStatusEnumFilter","type":"object","description":"HandoverJobHandoverjobStatusEnumFilter"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"HandoverJobSort":{"properties":{"targetTime":{"enum":["ASC","DESC"],"type":"string"}},"title":"HandoverJobSort","type":"object","description":"HandoverJobSort"},"HandoverJobPaginatedResult":{"properties":{"handoverJobs":{"items":{"$ref":"#/components/schemas/Handoverjob"},"type":"array"},"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","handoverJobs"],"title":"HandoverJobPaginatedResult","type":"object","description":"HandoverJobPaginatedResult"},"Handoverjob":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"assignedUsers":{"description":"Assigned users for this entity","items":{"$ref":"#/components/schemas/AssignedUser"},"type":"array"},"cancelReason":{"$ref":"#/components/schemas/HandoverJobCancelReason"},"carrierKey":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"carrierLogoUrl":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"carrierRef":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"carrierTrackingNumber":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"channel":{"enum":["DELIVERY","COLLECT"],"type":"string"},"customAttributes":{"description":"Attributes that can be added to the handover job. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"documents":{"items":{"$ref":"#/components/schemas/PrintableDocument"},"type":"array"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"expectedHandoverJobLineItems":{"items":{"$ref":"#/components/schemas/ExpectedHandoverLineItem"},"type":"array"},"facilityRef":{"description":"The id of the facility reference.","type":"string"},"fullIdentifier":{"description":"An information to identify the recipient","type":"string"},"handoverJobLineItems":{"items":{"$ref":"#/components/schemas/HandoverLineItem"}},"handoverJobParcelInfo":{"$ref":"#/components/schemas/HandoverJobParcelInfo"},"id":{"description":"The id of this handoverjob. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"loadUnitRefs":{"description":"Reference to array of load unit Refs","items":{"type":"string"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"paid":{"description":"Indicates if the order is already paid","type":"boolean"},"parcelRef":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"pickJobRef":{"description":"The reference to the pickjob for which the handoverjob is assigned to","type":"string"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"recipientAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"shipmentRef":{"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"shortIdentifier":{"description":"The short identifier of the shipment.","type":"string"},"status":{"$ref":"#/components/schemas/HandoverjobStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"targetTime":{"description":"The time the handoverjob is expected to be picked up at the facility.","format":"date-time","type":"string"},"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"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"tags":{"description":"Tags can only be set when there is no process related with this handoverJob. Setting processId and tags will lead to an validationError.","items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}}}],"required":["id","status","facilityRef","targetTime","channel","orderDate"],"type":"object","title":"Handoverjob","description":"Handoverjob"},"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"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"HandoverJobCancelReason":{"enum":["CONSUMER_NO_SHOW","CONSUMER_REJECTS","ORDER_CANCELED"],"type":"string","title":"HandoverJobCancelReason","description":"HandoverJobCancelReason"},"PrintableDocument":{"properties":{"customAttributes":{"description":"Attributes that can be added to the document. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"documentCategory":{"$ref":"#/components/schemas/DocumentCategory"},"documentType":{"$ref":"#/components/schemas/DocumentType"},"id":{"type":"string"},"name":{"type":"string"},"operations":{"description":"Offered operations for this document","items":{"$ref":"#/components/schemas/DocumentOperations"},"type":"array"},"path":{"type":"string"},"priority":{"minimum":0,"type":"number"},"status":{"$ref":"#/components/schemas/DocumentStatus"}},"required":["documentType","id","status","documentCategory"],"type":"object","title":"PrintableDocument","description":"PrintableDocument"},"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","CUSTOMS"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"DocumentType":{"enum":["PDF","PNG","JPG","GIF","JPEG","XML","JSON"],"type":"string","title":"DocumentType","description":"DocumentType"},"DocumentOperations":{"enum":["PRINT","VIEW"],"type":"string","title":"DocumentOperations","description":"DocumentOperations"},"DocumentStatus":{"enum":["AVAILABLE","LOADING","REQUESTABLE","CANCELED","WAITING_FOR_INPUT"],"type":"string","title":"DocumentStatus","description":"DocumentStatus"},"ExpectedHandoverLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/ExpectedHandoverLineItemForCreation"}],"properties":{"id":{"type":"string"}},"required":["id"],"type":"object","title":"ExpectedHandoverLineItem","description":"ExpectedHandoverLineItem"},"ExpectedHandoverLineItemForCreation":{"additionalProperties":false,"properties":{"article":{"$ref":"#/components/schemas/HandoverLineItemArticle"},"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"},"quantity":{"description":"quantity of the specific item that has been provided for handover","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/HandoverLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"transferId":{"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article","transferId"],"type":"object","title":"ExpectedHandoverLineItemForCreation","description":"ExpectedHandoverLineItemForCreation"},"HandoverLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"HandoverLineItemArticle"},"title":"HandoverLineItemArticle","description":"HandoverLineItemArticle"},"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"},"HandoverLineItemStatus":{"enum":["OPEN","CLOSED"],"type":"string","title":"HandoverLineItemStatus","description":"HandoverLineItemStatus"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"HandoverLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"}],"properties":{"article":{"$ref":"#/components/schemas/HandoverLineItemArticle"},"handedOverQuantity":{"description":"quantity of the specific item that has been handed over","format":"int64","minimum":0,"type":"integer"},"id":{"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"},"quantity":{"description":"quantity of the specific item that has been provided for handover","format":"int64","minimum":1,"type":"integer"},"refused":{"items":{"$ref":"#/components/schemas/RefusedItem"},"type":"array"},"status":{"$ref":"#/components/schemas/HandoverLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"substituteLineItems":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
","items":{"$ref":"#/components/schemas/HandoverSubstituteLineItem"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","article","quantity","handedOverQuantity"],"title":"HandoverLineItem","description":"HandoverLineItem"},"MandatoryLineItem":{"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","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"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"},"RefusedItem":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"},"reason":{"type":"string"}},"required":["quantity"],"title":"RefusedItem","description":"RefusedItem"},"HandoverSubstituteLineItem":{"properties":{"article":{"$ref":"#/components/schemas/SubstituteLineItemArticle"},"handedOverQuantity":{"description":"quantity of the specific item to substitute the original line item that has been handed over","format":"int64","minimum":0,"type":"integer"},"id":{"type":"string"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/SubstituteLineItemPartialStockLocation"},"type":"array"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"quantity":{"description":"quantity of the specific item to substitute the original line item that has been provided for handover","format":"int64","minimum":1,"type":"integer"},"refused":{"items":{"$ref":"#/components/schemas/RefusedItem"},"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"}},"required":["quantity","article","id"],"title":"HandoverSubstituteLineItem","description":"HandoverSubstituteLineItem"},"SubstituteLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"SubstituteLineItemArticle"},"title":"SubstituteLineItemArticle","description":"SubstituteLineItemArticle"},"SubstituteLineItemPartialStockLocation":{"properties":{"location":{"$ref":"#/components/schemas/Location"},"picked":{"format":"int64","minimum":0,"type":"number"},"quantity":{"format":"int64","minimum":0,"type":"number"},"ratingScore":{"type":"number"},"sequenceScore":{"type":"number"},"stockProperties":{"anyOf":[{"$ref":"#/components/schemas/PickingStockPropertyPreset"},{"$ref":"#/components/schemas/PickingStockProperty"}]},"stockRef":{"type":"string"},"tenantPartialStockId":{"type":"string"},"zoneName":{"type":"string"}},"required":["location","quantity"],"type":"object","title":"SubstituteLineItemPartialStockLocation","description":"SubstituteLineItemPartialStockLocation"},"Location":{"properties":{"locationRef":{"description":"The id of the location","type":"string"},"scannableCodes":{"description":"Represents barcodes that may be scanned at this location","items":{"type":"string"},"type":"array"}},"xml":{"name":"Location"},"title":"Location","description":"Location"},"PickingStockPropertyPreset":{"description":"Preset of Picking Stock Property.","properties":{"expiry":{"type":"string"}},"title":"PickingStockPropertyPreset","type":"object"},"PickingStockProperty":{"additionalProperties":{"type":"string"},"description":"Picking Stock Property.","title":"PickingStockProperty","type":"object"},"HandoverJobParcelInfo":{"allOf":[{"$ref":"#/components/schemas/HandoverJobParcelInfoForCreation"},{"properties":{"carrierKey":{"description":"the key of the carrier","type":"string"}}}],"type":"object","title":"HandoverJobParcelInfo","description":"HandoverJobParcelInfo"},"HandoverJobParcelInfoForCreation":{"additionalProperties":false,"properties":{"carrierLogoUrl":{"description":"The URL to the carrier logo","type":"string"},"carrierParcelRef":{"description":"The reference number of the parcel by the carrier","maxLength":120,"minLength":1,"type":"string"},"carrierRef":{"description":"the reference to the related carrier","type":"string"},"carrierTrackingNumber":{"description":"the tracking number of the parcel","type":"string"},"parcelRef":{"description":"the reference to the related parcel","type":"string"},"shipmentRef":{"description":"the reference to the related shipment","type":"string"}},"type":"object","title":"HandoverJobParcelInfoForCreation","description":"HandoverJobParcelInfoForCreation"},"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"},"HandoverjobStatus":{"description":"Status of a Handover Job.\n- OPEN: Active and ready for processing (default initial state)\n- WAITING_FOR_INPUT: Waiting for line items to be populated\n- HANDED_OVER: Items have been handed over (completion state)\n- CANCELED: Handover job was canceled\n- OBSOLETE: No longer relevant (terminal state, cannot transition out)\n","enum":["OPEN","HANDED_OVER","OBSOLETE","CANCELED","WAITING_FOR_INPUT"],"type":"string","title":"HandoverjobStatus"},"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"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"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/handoverjobs/search":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Search for HandoverJob","operationId":"searchHandoverJob","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandoverJobSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandoverJobPaginatedResult"}}},"description":"Your search result"},"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"}},"summary":"List handover job (search)","tags":["Handovers (Operations)"]}}}}
```
## Get handover config
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Returns the handover configuration for the tenant
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update and read handover configuration.","name":"Handovers Configuration (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":{"HandoverConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"availableRefusedReasons":{"items":{"$ref":"#/components/schemas/AvailableRefusedReason"},"type":"array"},"createStandaloneHandoverJobs":{"deprecated":true,"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
If true, a handover job will be created out of a valid routing plan. It is only possible, if no pickjob nor pack jobs are used for this tenant. This is a alpha feature and might be completely replaced in the future. Please only use in communication with the fulfillmenttools team.","type":"boolean"}},"type":"object","title":"HandoverConfiguration","description":"HandoverConfiguration"},"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"},"AvailableRefusedReason":{"additionalProperties":false,"properties":{"refusedReasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"refusedReason":{"description":"translated refusedReason selected from refusedReasonLocalized","type":"string"}},"required":["refusedReasonLocalized","active"],"title":"AvailableRefusedReason","description":"AvailableRefusedReason"},"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"},"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/configurations/handover":{"get":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns the handover configuration for the tenant","operationId":"getHandoverConfiguration","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandoverConfiguration"}}},"description":"Handover configuration was found & you were allowed to access it. The result is in the body."},"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 handover config","tags":["Handovers Configuration (Operations)"]}}}}
```
## Update handover configuration
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Updates the handover configuration for the tenant. If the configuration does not exist, it will be created.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update and read handover configuration.","name":"Handovers Configuration (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":{"HandoverConfigurationForCreate":{"additionalProperties":false,"properties":{"availableRefusedReasons":{"items":{"$ref":"#/components/schemas/AvailableRefuseReasonForCreation"},"type":"array"},"createStandaloneHandoverJobs":{"deprecated":true,"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
If true, a handover job will be created out of a valid routing plan. It is only possible, if no pickjob nor packjobs are used for this tenant. This is a alpha feature and might be completly replaced in the future. Please only use in communication with the FFT team.","type":"boolean"},"version":{"type":"number"}},"required":["version"],"type":"object","title":"HandoverConfigurationForCreate","description":"HandoverConfigurationForCreate"},"AvailableRefuseReasonForCreation":{"additionalProperties":false,"properties":{"refusedReasonLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Localized reason"},"active":{"type":"boolean"}},"required":["active","refusedReasonLocalized"],"title":"AvailableRefuseReasonForCreation","description":"AvailableRefuseReasonForCreation"},"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"},"HandoverConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"availableRefusedReasons":{"items":{"$ref":"#/components/schemas/AvailableRefusedReason"},"type":"array"},"createStandaloneHandoverJobs":{"deprecated":true,"description":"This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
If true, a handover job will be created out of a valid routing plan. It is only possible, if no pickjob nor pack jobs are used for this tenant. This is a alpha feature and might be completely replaced in the future. Please only use in communication with the fulfillmenttools team.","type":"boolean"}},"type":"object","title":"HandoverConfiguration","description":"HandoverConfiguration"},"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"},"AvailableRefusedReason":{"additionalProperties":false,"properties":{"refusedReasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"refusedReason":{"description":"translated refusedReason selected from refusedReasonLocalized","type":"string"}},"required":["refusedReasonLocalized","active"],"title":"AvailableRefusedReason","description":"AvailableRefusedReason"},"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/configurations/handover":{"put":{"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Updates the handover configuration for the tenant. If the configuration does not exist, it will be created.","operationId":"upsertHandoverConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandoverConfigurationForCreate"}}},"description":"Desired HandoverConfiguration","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandoverConfiguration"}}},"description":"The handover configuration was successfully updated."},"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"}},"summary":"Update handover configuration","tags":["Handovers Configuration (Operations)"]}}}}
```
## GET /api/configurations/handover/refusereasons
> List refuse reasons
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update and read handover configuration.","name":"Handovers Configuration (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":{"AvailableRefusedReason":{"additionalProperties":false,"properties":{"refusedReasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"active":{"type":"boolean"},"refusedReason":{"description":"translated refusedReason selected from refusedReasonLocalized","type":"string"}},"required":["refusedReasonLocalized","active"],"title":"AvailableRefusedReason","description":"AvailableRefusedReason"},"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"},"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/configurations/handover/refusereasons":{"get":{"description":"","operationId":"getAllRefuseReasons","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AvailableRefusedReason"},"type":"array"}}},"description":"Existing refuse reasons"},"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"}},"summary":"List refuse reasons","tags":["Handovers Configuration (Operations)"]}}}}
```